Module cloudformation

@pulumi/aws > cloudformation

Index

cloudformation/getExport.ts cloudformation/getStack.ts cloudformation/stack.ts

class Stack

Provides a CloudFormation Stack resource.

constructor

new Stack(name: string, args?: StackArgs, opts?: pulumi.CustomResourceOptions)

Create a Stack resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: StackState): Stack

Get an existing Stack resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

static isInstance(obj: any): boolean

Returns true if the given object is an instance of CustomResource. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property capabilities

public capabilities: pulumi.Output<string[] | undefined>;

A list of capabilities. Valid values: CAPABILITY_IAM or CAPABILITY_NAMED_IAM

property disableRollback

public disableRollback: pulumi.Output<boolean | undefined>;

Set to true to disable rollback of the stack if stack creation failed. Conflicts with on_failure.

property iamRoleArn

public iamRoleArn: pulumi.Output<string | undefined>;

The ARN of an IAM role that AWS CloudFormation assumes to create the stack. If you don’t specify a value, AWS CloudFormation uses the role that was previously associated with the stack. If no role is available, AWS CloudFormation uses a temporary session that is generated from your user credentials.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property name

public name: pulumi.Output<string>;

Stack name.

property notificationArns

public notificationArns: pulumi.Output<string[] | undefined>;

A list of SNS topic ARNs to publish stack related events.

property onFailure

public onFailure: pulumi.Output<string | undefined>;

Action to be taken if stack creation fails. This must be one of: DO_NOTHING, ROLLBACK, or DELETE. Conflicts with disable_rollback.

property outputs

public outputs: pulumi.Output<{ ... }>;

A map of outputs from the stack.

property parameters

public parameters: pulumi.Output<{ ... }>;

A map of Parameter structures that specify input parameters for the stack.

property policyBody

public policyBody: pulumi.Output<string>;

Structure containing the stack policy body. Conflicts w/ policy_url.

property policyUrl

public policyUrl: pulumi.Output<string | undefined>;

Location of a file containing the stack policy. Conflicts w/ policy_body.

property tags

public tags: pulumi.Output<Tags | undefined>;

A list of tags to associate with this stack.

property templateBody

public templateBody: pulumi.Output<string>;

Structure containing the template body (max size: 51,200 bytes).

property templateUrl

public templateUrl: pulumi.Output<string | undefined>;

Location of a file containing the template body (max size: 460,800 bytes).

property timeoutInMinutes

public timeoutInMinutes: pulumi.Output<number | undefined>;

The amount of time that can pass before the stack status becomes CREATE_FAILED.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

function getExport

getExport(args: GetExportArgs, opts?: pulumi.InvokeOptions): Promise<GetExportResult>

The CloudFormation Export data source allows access to stack exports specified in the Output section of the Cloudformation Template using the optional Export Property.

-> Note: If you are trying to use a value from a Cloudformation Stack in the same Terraform run please use normal interpolation or Cloudformation Outputs.

function getStack

getStack(args: GetStackArgs, opts?: pulumi.InvokeOptions): Promise<GetStackResult>

The CloudFormation Stack data source allows access to stack outputs and other useful data including the template body.

interface GetExportArgs

A collection of arguments for invoking getExport.

property name

name: string;

The name of the export as it appears in the console or from list-exports

interface GetExportResult

A collection of values returned by getExport.

property exportingStackId

exportingStackId: string;

The exporting_stack_id (AWS ARNs) equivalent ExportingStackId from list-exports

property id

id: string;

id is the provider-assigned unique ID for this managed resource.

property value

value: string;

The value from Cloudformation export identified by the export name found from list-exports

interface GetStackArgs

A collection of arguments for invoking getStack.

property name

name: string;

The name of the stack

interface GetStackResult

A collection of values returned by getStack.

property capabilities

capabilities: string[];

A list of capabilities

property description

description: string;

Description of the stack

property disableRollback

disableRollback: boolean;

Whether the rollback of the stack is disabled when stack creation fails

property iamRoleArn

iamRoleArn: string;

The ARN of the IAM role used to create the stack.

property id

id: string;

id is the provider-assigned unique ID for this managed resource.

property notificationArns

notificationArns: string[];

A list of SNS topic ARNs to publish stack related events

property outputs

outputs: { ... };

A map of outputs from the stack.

property parameters

parameters: { ... };

A map of parameters that specify input parameters for the stack.

property tags

tags: { ... };

A map of tags associated with this stack.

property templateBody

templateBody: string;

Structure containing the template body.

property timeoutInMinutes

timeoutInMinutes: number;

The amount of time that can pass before the stack status becomes CREATE_FAILED

interface StackArgs

The set of arguments for constructing a Stack resource.

property capabilities

capabilities?: pulumi.Input<pulumi.Input<string>[]>;

A list of capabilities. Valid values: CAPABILITY_IAM or CAPABILITY_NAMED_IAM

property disableRollback

disableRollback?: pulumi.Input<boolean>;

Set to true to disable rollback of the stack if stack creation failed. Conflicts with on_failure.

property iamRoleArn

iamRoleArn?: pulumi.Input<string>;

The ARN of an IAM role that AWS CloudFormation assumes to create the stack. If you don’t specify a value, AWS CloudFormation uses the role that was previously associated with the stack. If no role is available, AWS CloudFormation uses a temporary session that is generated from your user credentials.

property name

name?: pulumi.Input<string>;

Stack name.

property notificationArns

notificationArns?: pulumi.Input<pulumi.Input<string>[]>;

A list of SNS topic ARNs to publish stack related events.

property onFailure

onFailure?: pulumi.Input<string>;

Action to be taken if stack creation fails. This must be one of: DO_NOTHING, ROLLBACK, or DELETE. Conflicts with disable_rollback.

property parameters

parameters?: pulumi.Input<{ ... }>;

A map of Parameter structures that specify input parameters for the stack.

property policyBody

policyBody?: pulumi.Input<string>;

Structure containing the stack policy body. Conflicts w/ policy_url.

property policyUrl

policyUrl?: pulumi.Input<string>;

Location of a file containing the stack policy. Conflicts w/ policy_body.

property tags

tags?: pulumi.Input<Tags>;

A list of tags to associate with this stack.

property templateBody

templateBody?: pulumi.Input<string>;

Structure containing the template body (max size: 51,200 bytes).

property templateUrl

templateUrl?: pulumi.Input<string>;

Location of a file containing the template body (max size: 460,800 bytes).

property timeoutInMinutes

timeoutInMinutes?: pulumi.Input<number>;

The amount of time that can pass before the stack status becomes CREATE_FAILED.

interface StackState

Input properties used for looking up and filtering Stack resources.

property capabilities

capabilities?: pulumi.Input<pulumi.Input<string>[]>;

A list of capabilities. Valid values: CAPABILITY_IAM or CAPABILITY_NAMED_IAM

property disableRollback

disableRollback?: pulumi.Input<boolean>;

Set to true to disable rollback of the stack if stack creation failed. Conflicts with on_failure.

property iamRoleArn

iamRoleArn?: pulumi.Input<string>;

The ARN of an IAM role that AWS CloudFormation assumes to create the stack. If you don’t specify a value, AWS CloudFormation uses the role that was previously associated with the stack. If no role is available, AWS CloudFormation uses a temporary session that is generated from your user credentials.

property name

name?: pulumi.Input<string>;

Stack name.

property notificationArns

notificationArns?: pulumi.Input<pulumi.Input<string>[]>;

A list of SNS topic ARNs to publish stack related events.

property onFailure

onFailure?: pulumi.Input<string>;

Action to be taken if stack creation fails. This must be one of: DO_NOTHING, ROLLBACK, or DELETE. Conflicts with disable_rollback.

property outputs

outputs?: pulumi.Input<{ ... }>;

A map of outputs from the stack.

property parameters

parameters?: pulumi.Input<{ ... }>;

A map of Parameter structures that specify input parameters for the stack.

property policyBody

policyBody?: pulumi.Input<string>;

Structure containing the stack policy body. Conflicts w/ policy_url.

property policyUrl

policyUrl?: pulumi.Input<string>;

Location of a file containing the stack policy. Conflicts w/ policy_body.

property tags

tags?: pulumi.Input<Tags>;

A list of tags to associate with this stack.

property templateBody

templateBody?: pulumi.Input<string>;

Structure containing the template body (max size: 51,200 bytes).

property templateUrl

templateUrl?: pulumi.Input<string>;

Location of a file containing the template body (max size: 460,800 bytes).

property timeoutInMinutes

timeoutInMinutes?: pulumi.Input<number>;

The amount of time that can pass before the stack status becomes CREATE_FAILED.