@pulumi/aws
Version:
A Pulumi package for creating and managing Amazon Web Services (AWS) cloud resources.
145 lines (144 loc) • 3.96 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* The CloudFormation Stack data source allows access to stack
* outputs and other useful data including the template body.
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as aws from "@pulumi/aws";
*
* const network = aws.cloudformation.getStack({
* name: "my-network-stack",
* });
* const web = new aws.ec2.Instance("web", {
* ami: "ami-abb07bcb",
* instanceType: aws.ec2.InstanceType.T2_Micro,
* subnetId: network.then(network => network.outputs?.SubnetId),
* tags: {
* Name: "HelloWorld",
* },
* });
* ```
*/
export declare function getStack(args: GetStackArgs, opts?: pulumi.InvokeOptions): Promise<GetStackResult>;
/**
* A collection of arguments for invoking getStack.
*/
export interface GetStackArgs {
/**
* Name of the stack
*/
name: string;
/**
* Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.
*/
region?: string;
/**
* Map of tags associated with this stack.
*/
tags?: {
[key: string]: string;
};
}
/**
* A collection of values returned by getStack.
*/
export interface GetStackResult {
/**
* List of capabilities
*/
readonly capabilities: string[];
/**
* Description of the stack
*/
readonly description: string;
/**
* Whether the rollback of the stack is disabled when stack creation fails
*/
readonly disableRollback: boolean;
/**
* ARN of the IAM role used to create the stack.
*/
readonly iamRoleArn: string;
/**
* The provider-assigned unique ID for this managed resource.
*/
readonly id: string;
readonly name: string;
/**
* List of SNS topic ARNs to publish stack related events
*/
readonly notificationArns: string[];
/**
* Map of outputs from the stack.
*/
readonly outputs: {
[key: string]: string;
};
/**
* Map of parameters that specify input parameters for the stack.
*/
readonly parameters: {
[key: string]: string;
};
readonly region: string;
/**
* Map of tags associated with this stack.
*/
readonly tags: {
[key: string]: string;
};
/**
* Structure containing the template body.
*/
readonly templateBody: string;
/**
* Amount of time that can pass before the stack status becomes `CREATE_FAILED`
*/
readonly timeoutInMinutes: number;
}
/**
* The CloudFormation Stack data source allows access to stack
* outputs and other useful data including the template body.
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as aws from "@pulumi/aws";
*
* const network = aws.cloudformation.getStack({
* name: "my-network-stack",
* });
* const web = new aws.ec2.Instance("web", {
* ami: "ami-abb07bcb",
* instanceType: aws.ec2.InstanceType.T2_Micro,
* subnetId: network.then(network => network.outputs?.SubnetId),
* tags: {
* Name: "HelloWorld",
* },
* });
* ```
*/
export declare function getStackOutput(args: GetStackOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetStackResult>;
/**
* A collection of arguments for invoking getStack.
*/
export interface GetStackOutputArgs {
/**
* Name of the stack
*/
name: pulumi.Input<string>;
/**
* Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.
*/
region?: pulumi.Input<string>;
/**
* Map of tags associated with this stack.
*/
tags?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
}