Documentation ¶
Index ¶
- type CloudFormationType
- type CloudFormationTypeArgs
- type CloudFormationTypeArray
- type CloudFormationTypeArrayInput
- type CloudFormationTypeArrayOutput
- func (CloudFormationTypeArrayOutput) ElementType() reflect.Type
- func (o CloudFormationTypeArrayOutput) Index(i pulumi.IntInput) CloudFormationTypeOutput
- func (o CloudFormationTypeArrayOutput) ToCloudFormationTypeArrayOutput() CloudFormationTypeArrayOutput
- func (o CloudFormationTypeArrayOutput) ToCloudFormationTypeArrayOutputWithContext(ctx context.Context) CloudFormationTypeArrayOutput
- type CloudFormationTypeInput
- type CloudFormationTypeLoggingConfig
- type CloudFormationTypeLoggingConfigArgs
- func (CloudFormationTypeLoggingConfigArgs) ElementType() reflect.Type
- func (i CloudFormationTypeLoggingConfigArgs) ToCloudFormationTypeLoggingConfigOutput() CloudFormationTypeLoggingConfigOutput
- func (i CloudFormationTypeLoggingConfigArgs) ToCloudFormationTypeLoggingConfigOutputWithContext(ctx context.Context) CloudFormationTypeLoggingConfigOutput
- func (i CloudFormationTypeLoggingConfigArgs) ToCloudFormationTypeLoggingConfigPtrOutput() CloudFormationTypeLoggingConfigPtrOutput
- func (i CloudFormationTypeLoggingConfigArgs) ToCloudFormationTypeLoggingConfigPtrOutputWithContext(ctx context.Context) CloudFormationTypeLoggingConfigPtrOutput
- type CloudFormationTypeLoggingConfigInput
- type CloudFormationTypeLoggingConfigOutput
- func (CloudFormationTypeLoggingConfigOutput) ElementType() reflect.Type
- func (o CloudFormationTypeLoggingConfigOutput) LogGroupName() pulumi.StringOutput
- func (o CloudFormationTypeLoggingConfigOutput) LogRoleArn() pulumi.StringOutput
- func (o CloudFormationTypeLoggingConfigOutput) ToCloudFormationTypeLoggingConfigOutput() CloudFormationTypeLoggingConfigOutput
- func (o CloudFormationTypeLoggingConfigOutput) ToCloudFormationTypeLoggingConfigOutputWithContext(ctx context.Context) CloudFormationTypeLoggingConfigOutput
- func (o CloudFormationTypeLoggingConfigOutput) ToCloudFormationTypeLoggingConfigPtrOutput() CloudFormationTypeLoggingConfigPtrOutput
- func (o CloudFormationTypeLoggingConfigOutput) ToCloudFormationTypeLoggingConfigPtrOutputWithContext(ctx context.Context) CloudFormationTypeLoggingConfigPtrOutput
- type CloudFormationTypeLoggingConfigPtrInput
- type CloudFormationTypeLoggingConfigPtrOutput
- func (o CloudFormationTypeLoggingConfigPtrOutput) Elem() CloudFormationTypeLoggingConfigOutput
- func (CloudFormationTypeLoggingConfigPtrOutput) ElementType() reflect.Type
- func (o CloudFormationTypeLoggingConfigPtrOutput) LogGroupName() pulumi.StringPtrOutput
- func (o CloudFormationTypeLoggingConfigPtrOutput) LogRoleArn() pulumi.StringPtrOutput
- func (o CloudFormationTypeLoggingConfigPtrOutput) ToCloudFormationTypeLoggingConfigPtrOutput() CloudFormationTypeLoggingConfigPtrOutput
- func (o CloudFormationTypeLoggingConfigPtrOutput) ToCloudFormationTypeLoggingConfigPtrOutputWithContext(ctx context.Context) CloudFormationTypeLoggingConfigPtrOutput
- type CloudFormationTypeMap
- type CloudFormationTypeMapInput
- type CloudFormationTypeMapOutput
- func (CloudFormationTypeMapOutput) ElementType() reflect.Type
- func (o CloudFormationTypeMapOutput) MapIndex(k pulumi.StringInput) CloudFormationTypeOutput
- func (o CloudFormationTypeMapOutput) ToCloudFormationTypeMapOutput() CloudFormationTypeMapOutput
- func (o CloudFormationTypeMapOutput) ToCloudFormationTypeMapOutputWithContext(ctx context.Context) CloudFormationTypeMapOutput
- type CloudFormationTypeOutput
- type CloudFormationTypeState
- type GetCloudFormationTypeLoggingConfig
- type GetCloudFormationTypeLoggingConfigArgs
- func (GetCloudFormationTypeLoggingConfigArgs) ElementType() reflect.Type
- func (i GetCloudFormationTypeLoggingConfigArgs) ToGetCloudFormationTypeLoggingConfigOutput() GetCloudFormationTypeLoggingConfigOutput
- func (i GetCloudFormationTypeLoggingConfigArgs) ToGetCloudFormationTypeLoggingConfigOutputWithContext(ctx context.Context) GetCloudFormationTypeLoggingConfigOutput
- type GetCloudFormationTypeLoggingConfigArray
- func (GetCloudFormationTypeLoggingConfigArray) ElementType() reflect.Type
- func (i GetCloudFormationTypeLoggingConfigArray) ToGetCloudFormationTypeLoggingConfigArrayOutput() GetCloudFormationTypeLoggingConfigArrayOutput
- func (i GetCloudFormationTypeLoggingConfigArray) ToGetCloudFormationTypeLoggingConfigArrayOutputWithContext(ctx context.Context) GetCloudFormationTypeLoggingConfigArrayOutput
- type GetCloudFormationTypeLoggingConfigArrayInput
- type GetCloudFormationTypeLoggingConfigArrayOutput
- func (GetCloudFormationTypeLoggingConfigArrayOutput) ElementType() reflect.Type
- func (o GetCloudFormationTypeLoggingConfigArrayOutput) Index(i pulumi.IntInput) GetCloudFormationTypeLoggingConfigOutput
- func (o GetCloudFormationTypeLoggingConfigArrayOutput) ToGetCloudFormationTypeLoggingConfigArrayOutput() GetCloudFormationTypeLoggingConfigArrayOutput
- func (o GetCloudFormationTypeLoggingConfigArrayOutput) ToGetCloudFormationTypeLoggingConfigArrayOutputWithContext(ctx context.Context) GetCloudFormationTypeLoggingConfigArrayOutput
- type GetCloudFormationTypeLoggingConfigInput
- type GetCloudFormationTypeLoggingConfigOutput
- func (GetCloudFormationTypeLoggingConfigOutput) ElementType() reflect.Type
- func (o GetCloudFormationTypeLoggingConfigOutput) LogGroupName() pulumi.StringOutput
- func (o GetCloudFormationTypeLoggingConfigOutput) LogRoleArn() pulumi.StringOutput
- func (o GetCloudFormationTypeLoggingConfigOutput) ToGetCloudFormationTypeLoggingConfigOutput() GetCloudFormationTypeLoggingConfigOutput
- func (o GetCloudFormationTypeLoggingConfigOutput) ToGetCloudFormationTypeLoggingConfigOutputWithContext(ctx context.Context) GetCloudFormationTypeLoggingConfigOutput
- type GetExportArgs
- type GetExportOutputArgs
- type GetExportResult
- type GetExportResultOutput
- func (GetExportResultOutput) ElementType() reflect.Type
- func (o GetExportResultOutput) ExportingStackId() pulumi.StringOutput
- func (o GetExportResultOutput) Id() pulumi.StringOutput
- func (o GetExportResultOutput) Name() pulumi.StringOutput
- func (o GetExportResultOutput) ToGetExportResultOutput() GetExportResultOutput
- func (o GetExportResultOutput) ToGetExportResultOutputWithContext(ctx context.Context) GetExportResultOutput
- func (o GetExportResultOutput) Value() pulumi.StringOutput
- type LookupCloudFormationTypeArgs
- type LookupCloudFormationTypeOutputArgs
- type LookupCloudFormationTypeResult
- type LookupCloudFormationTypeResultOutput
- func (o LookupCloudFormationTypeResultOutput) Arn() pulumi.StringOutput
- func (o LookupCloudFormationTypeResultOutput) DefaultVersionId() pulumi.StringOutput
- func (o LookupCloudFormationTypeResultOutput) DeprecatedStatus() pulumi.StringOutput
- func (o LookupCloudFormationTypeResultOutput) Description() pulumi.StringOutput
- func (o LookupCloudFormationTypeResultOutput) DocumentationUrl() pulumi.StringOutput
- func (LookupCloudFormationTypeResultOutput) ElementType() reflect.Type
- func (o LookupCloudFormationTypeResultOutput) ExecutionRoleArn() pulumi.StringOutput
- func (o LookupCloudFormationTypeResultOutput) Id() pulumi.StringOutput
- func (o LookupCloudFormationTypeResultOutput) IsDefaultVersion() pulumi.BoolOutput
- func (o LookupCloudFormationTypeResultOutput) LoggingConfigs() GetCloudFormationTypeLoggingConfigArrayOutput
- func (o LookupCloudFormationTypeResultOutput) ProvisioningType() pulumi.StringOutput
- func (o LookupCloudFormationTypeResultOutput) Schema() pulumi.StringOutput
- func (o LookupCloudFormationTypeResultOutput) SourceUrl() pulumi.StringOutput
- func (o LookupCloudFormationTypeResultOutput) ToLookupCloudFormationTypeResultOutput() LookupCloudFormationTypeResultOutput
- func (o LookupCloudFormationTypeResultOutput) ToLookupCloudFormationTypeResultOutputWithContext(ctx context.Context) LookupCloudFormationTypeResultOutput
- func (o LookupCloudFormationTypeResultOutput) Type() pulumi.StringOutput
- func (o LookupCloudFormationTypeResultOutput) TypeArn() pulumi.StringOutput
- func (o LookupCloudFormationTypeResultOutput) TypeName() pulumi.StringOutput
- func (o LookupCloudFormationTypeResultOutput) VersionId() pulumi.StringPtrOutput
- func (o LookupCloudFormationTypeResultOutput) Visibility() pulumi.StringOutput
- type LookupStackArgs
- type LookupStackOutputArgs
- type LookupStackResult
- type LookupStackResultOutput
- func (o LookupStackResultOutput) Capabilities() pulumi.StringArrayOutput
- func (o LookupStackResultOutput) Description() pulumi.StringOutput
- func (o LookupStackResultOutput) DisableRollback() pulumi.BoolOutput
- func (LookupStackResultOutput) ElementType() reflect.Type
- func (o LookupStackResultOutput) IamRoleArn() pulumi.StringOutput
- func (o LookupStackResultOutput) Id() pulumi.StringOutput
- func (o LookupStackResultOutput) Name() pulumi.StringOutput
- func (o LookupStackResultOutput) NotificationArns() pulumi.StringArrayOutput
- func (o LookupStackResultOutput) Outputs() pulumi.StringMapOutput
- func (o LookupStackResultOutput) Parameters() pulumi.StringMapOutput
- func (o LookupStackResultOutput) Tags() pulumi.StringMapOutput
- func (o LookupStackResultOutput) TemplateBody() pulumi.StringOutput
- func (o LookupStackResultOutput) TimeoutInMinutes() pulumi.IntOutput
- func (o LookupStackResultOutput) ToLookupStackResultOutput() LookupStackResultOutput
- func (o LookupStackResultOutput) ToLookupStackResultOutputWithContext(ctx context.Context) LookupStackResultOutput
- type Stack
- type StackArgs
- type StackArray
- type StackArrayInput
- type StackArrayOutput
- type StackInput
- type StackMap
- type StackMapInput
- type StackMapOutput
- type StackOutput
- type StackSet
- type StackSetArgs
- type StackSetArray
- type StackSetArrayInput
- type StackSetArrayOutput
- type StackSetAutoDeployment
- type StackSetAutoDeploymentArgs
- func (StackSetAutoDeploymentArgs) ElementType() reflect.Type
- func (i StackSetAutoDeploymentArgs) ToStackSetAutoDeploymentOutput() StackSetAutoDeploymentOutput
- func (i StackSetAutoDeploymentArgs) ToStackSetAutoDeploymentOutputWithContext(ctx context.Context) StackSetAutoDeploymentOutput
- func (i StackSetAutoDeploymentArgs) ToStackSetAutoDeploymentPtrOutput() StackSetAutoDeploymentPtrOutput
- func (i StackSetAutoDeploymentArgs) ToStackSetAutoDeploymentPtrOutputWithContext(ctx context.Context) StackSetAutoDeploymentPtrOutput
- type StackSetAutoDeploymentInput
- type StackSetAutoDeploymentOutput
- func (StackSetAutoDeploymentOutput) ElementType() reflect.Type
- func (o StackSetAutoDeploymentOutput) Enabled() pulumi.BoolPtrOutput
- func (o StackSetAutoDeploymentOutput) RetainStacksOnAccountRemoval() pulumi.BoolPtrOutput
- func (o StackSetAutoDeploymentOutput) ToStackSetAutoDeploymentOutput() StackSetAutoDeploymentOutput
- func (o StackSetAutoDeploymentOutput) ToStackSetAutoDeploymentOutputWithContext(ctx context.Context) StackSetAutoDeploymentOutput
- func (o StackSetAutoDeploymentOutput) ToStackSetAutoDeploymentPtrOutput() StackSetAutoDeploymentPtrOutput
- func (o StackSetAutoDeploymentOutput) ToStackSetAutoDeploymentPtrOutputWithContext(ctx context.Context) StackSetAutoDeploymentPtrOutput
- type StackSetAutoDeploymentPtrInput
- type StackSetAutoDeploymentPtrOutput
- func (o StackSetAutoDeploymentPtrOutput) Elem() StackSetAutoDeploymentOutput
- func (StackSetAutoDeploymentPtrOutput) ElementType() reflect.Type
- func (o StackSetAutoDeploymentPtrOutput) Enabled() pulumi.BoolPtrOutput
- func (o StackSetAutoDeploymentPtrOutput) RetainStacksOnAccountRemoval() pulumi.BoolPtrOutput
- func (o StackSetAutoDeploymentPtrOutput) ToStackSetAutoDeploymentPtrOutput() StackSetAutoDeploymentPtrOutput
- func (o StackSetAutoDeploymentPtrOutput) ToStackSetAutoDeploymentPtrOutputWithContext(ctx context.Context) StackSetAutoDeploymentPtrOutput
- type StackSetInput
- type StackSetInstance
- type StackSetInstanceArgs
- type StackSetInstanceArray
- type StackSetInstanceArrayInput
- type StackSetInstanceArrayOutput
- func (StackSetInstanceArrayOutput) ElementType() reflect.Type
- func (o StackSetInstanceArrayOutput) Index(i pulumi.IntInput) StackSetInstanceOutput
- func (o StackSetInstanceArrayOutput) ToStackSetInstanceArrayOutput() StackSetInstanceArrayOutput
- func (o StackSetInstanceArrayOutput) ToStackSetInstanceArrayOutputWithContext(ctx context.Context) StackSetInstanceArrayOutput
- type StackSetInstanceDeploymentTargets
- type StackSetInstanceDeploymentTargetsArgs
- func (StackSetInstanceDeploymentTargetsArgs) ElementType() reflect.Type
- func (i StackSetInstanceDeploymentTargetsArgs) ToStackSetInstanceDeploymentTargetsOutput() StackSetInstanceDeploymentTargetsOutput
- func (i StackSetInstanceDeploymentTargetsArgs) ToStackSetInstanceDeploymentTargetsOutputWithContext(ctx context.Context) StackSetInstanceDeploymentTargetsOutput
- func (i StackSetInstanceDeploymentTargetsArgs) ToStackSetInstanceDeploymentTargetsPtrOutput() StackSetInstanceDeploymentTargetsPtrOutput
- func (i StackSetInstanceDeploymentTargetsArgs) ToStackSetInstanceDeploymentTargetsPtrOutputWithContext(ctx context.Context) StackSetInstanceDeploymentTargetsPtrOutput
- type StackSetInstanceDeploymentTargetsInput
- type StackSetInstanceDeploymentTargetsOutput
- func (StackSetInstanceDeploymentTargetsOutput) ElementType() reflect.Type
- func (o StackSetInstanceDeploymentTargetsOutput) OrganizationalUnitIds() pulumi.StringArrayOutput
- func (o StackSetInstanceDeploymentTargetsOutput) ToStackSetInstanceDeploymentTargetsOutput() StackSetInstanceDeploymentTargetsOutput
- func (o StackSetInstanceDeploymentTargetsOutput) ToStackSetInstanceDeploymentTargetsOutputWithContext(ctx context.Context) StackSetInstanceDeploymentTargetsOutput
- func (o StackSetInstanceDeploymentTargetsOutput) ToStackSetInstanceDeploymentTargetsPtrOutput() StackSetInstanceDeploymentTargetsPtrOutput
- func (o StackSetInstanceDeploymentTargetsOutput) ToStackSetInstanceDeploymentTargetsPtrOutputWithContext(ctx context.Context) StackSetInstanceDeploymentTargetsPtrOutput
- type StackSetInstanceDeploymentTargetsPtrInput
- type StackSetInstanceDeploymentTargetsPtrOutput
- func (o StackSetInstanceDeploymentTargetsPtrOutput) Elem() StackSetInstanceDeploymentTargetsOutput
- func (StackSetInstanceDeploymentTargetsPtrOutput) ElementType() reflect.Type
- func (o StackSetInstanceDeploymentTargetsPtrOutput) OrganizationalUnitIds() pulumi.StringArrayOutput
- func (o StackSetInstanceDeploymentTargetsPtrOutput) ToStackSetInstanceDeploymentTargetsPtrOutput() StackSetInstanceDeploymentTargetsPtrOutput
- func (o StackSetInstanceDeploymentTargetsPtrOutput) ToStackSetInstanceDeploymentTargetsPtrOutputWithContext(ctx context.Context) StackSetInstanceDeploymentTargetsPtrOutput
- type StackSetInstanceInput
- type StackSetInstanceMap
- type StackSetInstanceMapInput
- type StackSetInstanceMapOutput
- func (StackSetInstanceMapOutput) ElementType() reflect.Type
- func (o StackSetInstanceMapOutput) MapIndex(k pulumi.StringInput) StackSetInstanceOutput
- func (o StackSetInstanceMapOutput) ToStackSetInstanceMapOutput() StackSetInstanceMapOutput
- func (o StackSetInstanceMapOutput) ToStackSetInstanceMapOutputWithContext(ctx context.Context) StackSetInstanceMapOutput
- type StackSetInstanceOutput
- type StackSetInstanceState
- type StackSetMap
- type StackSetMapInput
- type StackSetMapOutput
- type StackSetOutput
- type StackSetState
- type StackState
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type CloudFormationType ¶ added in v4.2.0
type CloudFormationType struct { pulumi.CustomResourceState // (Optional) Amazon Resource Name (ARN) of the CloudFormation Type version. See also `typeArn`. Arn pulumi.StringOutput `pulumi:"arn"` // Identifier of the CloudFormation Type default version. DefaultVersionId pulumi.StringOutput `pulumi:"defaultVersionId"` // Deprecation status of the version. DeprecatedStatus pulumi.StringOutput `pulumi:"deprecatedStatus"` // Description of the version. Description pulumi.StringOutput `pulumi:"description"` // URL of the documentation for the CloudFormation Type. DocumentationUrl pulumi.StringOutput `pulumi:"documentationUrl"` // Amazon Resource Name (ARN) of the IAM Role for CloudFormation to assume when invoking the extension. If your extension calls AWS APIs in any of its handlers, you must create an IAM execution role that includes the necessary permissions to call those AWS APIs, and provision that execution role in your account. When CloudFormation needs to invoke the extension handler, CloudFormation assumes this execution role to create a temporary session token, which it then passes to the extension handler, thereby supplying your extension with the appropriate credentials. ExecutionRoleArn pulumi.StringPtrOutput `pulumi:"executionRoleArn"` // Whether the CloudFormation Type version is the default version. IsDefaultVersion pulumi.BoolOutput `pulumi:"isDefaultVersion"` // Configuration block containing logging configuration. LoggingConfig CloudFormationTypeLoggingConfigPtrOutput `pulumi:"loggingConfig"` // Provisioning behavior of the CloudFormation Type. ProvisioningType pulumi.StringOutput `pulumi:"provisioningType"` // JSON document of the CloudFormation Type schema. Schema pulumi.StringOutput `pulumi:"schema"` // URL to the S3 bucket containing the extension project package that contains the necessary files for the extension you want to register. Must begin with `s3://` or `https://`. For example, `s3://example-bucket/example-object`. SchemaHandlerPackage pulumi.StringOutput `pulumi:"schemaHandlerPackage"` // URL of the source code for the CloudFormation Type. SourceUrl pulumi.StringOutput `pulumi:"sourceUrl"` // CloudFormation Registry Type. For example, `RESOURCE` or `MODULE`. Type pulumi.StringOutput `pulumi:"type"` // (Optional) Amazon Resource Name (ARN) of the CloudFormation Type. See also `arn`. TypeArn pulumi.StringOutput `pulumi:"typeArn"` // CloudFormation Type name. For example, `ExampleCompany::ExampleService::ExampleResource`. TypeName pulumi.StringOutput `pulumi:"typeName"` // (Optional) Identifier of the CloudFormation Type version. VersionId pulumi.StringOutput `pulumi:"versionId"` // Scope of the CloudFormation Type. Visibility pulumi.StringOutput `pulumi:"visibility"` }
## Example Usage
```go package main
import (
"fmt" "github.com/pulumi/pulumi-aws/sdk/v4/go/aws/cloudformation" "github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() { pulumi.Run(func(ctx *pulumi.Context) error { _, err := cloudformation.NewCloudFormationType(ctx, "example", &cloudformation.CloudFormationTypeArgs{ SchemaHandlerPackage: pulumi.String(fmt.Sprintf("%v%v%v%v", "s3://", aws_s3_bucket_object.Example.Bucket, "/", aws_s3_bucket_object.Example.Key)), Type: pulumi.String("RESOURCE"), TypeName: pulumi.String("ExampleCompany::ExampleService::ExampleResource"), LoggingConfig: &cloudformation.CloudFormationTypeLoggingConfigArgs{ LogGroupName: pulumi.Any(aws_cloudwatch_log_group.Example.Name), LogRoleArn: pulumi.Any(aws_iam_role.Example.Arn), }, }) if err != nil { return err } return nil }) }
```
## Import
`aws_cloudformation_type` can be imported with their type version Amazon Resource Name (ARN), e.g.,
```sh
$ pulumi import aws:cloudformation/cloudFormationType:CloudFormationType example arn:aws:cloudformation:us-east-1:123456789012:type/resource/ExampleCompany-ExampleService-ExampleType/1
```
func GetCloudFormationType ¶ added in v4.2.0
func GetCloudFormationType(ctx *pulumi.Context, name string, id pulumi.IDInput, state *CloudFormationTypeState, opts ...pulumi.ResourceOption) (*CloudFormationType, error)
GetCloudFormationType gets an existing CloudFormationType resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).
func NewCloudFormationType ¶ added in v4.2.0
func NewCloudFormationType(ctx *pulumi.Context, name string, args *CloudFormationTypeArgs, opts ...pulumi.ResourceOption) (*CloudFormationType, error)
NewCloudFormationType registers a new resource with the given unique name, arguments, and options.
func (*CloudFormationType) ElementType ¶ added in v4.2.0
func (*CloudFormationType) ElementType() reflect.Type
func (*CloudFormationType) ToCloudFormationTypeOutput ¶ added in v4.2.0
func (i *CloudFormationType) ToCloudFormationTypeOutput() CloudFormationTypeOutput
func (*CloudFormationType) ToCloudFormationTypeOutputWithContext ¶ added in v4.2.0
func (i *CloudFormationType) ToCloudFormationTypeOutputWithContext(ctx context.Context) CloudFormationTypeOutput
type CloudFormationTypeArgs ¶ added in v4.2.0
type CloudFormationTypeArgs struct { // Amazon Resource Name (ARN) of the IAM Role for CloudFormation to assume when invoking the extension. If your extension calls AWS APIs in any of its handlers, you must create an IAM execution role that includes the necessary permissions to call those AWS APIs, and provision that execution role in your account. When CloudFormation needs to invoke the extension handler, CloudFormation assumes this execution role to create a temporary session token, which it then passes to the extension handler, thereby supplying your extension with the appropriate credentials. ExecutionRoleArn pulumi.StringPtrInput // Configuration block containing logging configuration. LoggingConfig CloudFormationTypeLoggingConfigPtrInput // URL to the S3 bucket containing the extension project package that contains the necessary files for the extension you want to register. Must begin with `s3://` or `https://`. For example, `s3://example-bucket/example-object`. SchemaHandlerPackage pulumi.StringInput // CloudFormation Registry Type. For example, `RESOURCE` or `MODULE`. Type pulumi.StringPtrInput // CloudFormation Type name. For example, `ExampleCompany::ExampleService::ExampleResource`. TypeName pulumi.StringInput }
The set of arguments for constructing a CloudFormationType resource.
func (CloudFormationTypeArgs) ElementType ¶ added in v4.2.0
func (CloudFormationTypeArgs) ElementType() reflect.Type
type CloudFormationTypeArray ¶ added in v4.2.0
type CloudFormationTypeArray []CloudFormationTypeInput
func (CloudFormationTypeArray) ElementType ¶ added in v4.2.0
func (CloudFormationTypeArray) ElementType() reflect.Type
func (CloudFormationTypeArray) ToCloudFormationTypeArrayOutput ¶ added in v4.2.0
func (i CloudFormationTypeArray) ToCloudFormationTypeArrayOutput() CloudFormationTypeArrayOutput
func (CloudFormationTypeArray) ToCloudFormationTypeArrayOutputWithContext ¶ added in v4.2.0
func (i CloudFormationTypeArray) ToCloudFormationTypeArrayOutputWithContext(ctx context.Context) CloudFormationTypeArrayOutput
type CloudFormationTypeArrayInput ¶ added in v4.2.0
type CloudFormationTypeArrayInput interface { pulumi.Input ToCloudFormationTypeArrayOutput() CloudFormationTypeArrayOutput ToCloudFormationTypeArrayOutputWithContext(context.Context) CloudFormationTypeArrayOutput }
CloudFormationTypeArrayInput is an input type that accepts CloudFormationTypeArray and CloudFormationTypeArrayOutput values. You can construct a concrete instance of `CloudFormationTypeArrayInput` via:
CloudFormationTypeArray{ CloudFormationTypeArgs{...} }
type CloudFormationTypeArrayOutput ¶ added in v4.2.0
type CloudFormationTypeArrayOutput struct{ *pulumi.OutputState }
func (CloudFormationTypeArrayOutput) ElementType ¶ added in v4.2.0
func (CloudFormationTypeArrayOutput) ElementType() reflect.Type
func (CloudFormationTypeArrayOutput) Index ¶ added in v4.2.0
func (o CloudFormationTypeArrayOutput) Index(i pulumi.IntInput) CloudFormationTypeOutput
func (CloudFormationTypeArrayOutput) ToCloudFormationTypeArrayOutput ¶ added in v4.2.0
func (o CloudFormationTypeArrayOutput) ToCloudFormationTypeArrayOutput() CloudFormationTypeArrayOutput
func (CloudFormationTypeArrayOutput) ToCloudFormationTypeArrayOutputWithContext ¶ added in v4.2.0
func (o CloudFormationTypeArrayOutput) ToCloudFormationTypeArrayOutputWithContext(ctx context.Context) CloudFormationTypeArrayOutput
type CloudFormationTypeInput ¶ added in v4.2.0
type CloudFormationTypeInput interface { pulumi.Input ToCloudFormationTypeOutput() CloudFormationTypeOutput ToCloudFormationTypeOutputWithContext(ctx context.Context) CloudFormationTypeOutput }
type CloudFormationTypeLoggingConfig ¶ added in v4.2.0
type CloudFormationTypeLoggingConfig struct { // Name of the CloudWatch Log Group where CloudFormation sends error logging information when invoking the type's handlers. LogGroupName string `pulumi:"logGroupName"` // Amazon Resource Name (ARN) of the IAM Role CloudFormation assumes when sending error logging information to CloudWatch Logs. LogRoleArn string `pulumi:"logRoleArn"` }
type CloudFormationTypeLoggingConfigArgs ¶ added in v4.2.0
type CloudFormationTypeLoggingConfigArgs struct { // Name of the CloudWatch Log Group where CloudFormation sends error logging information when invoking the type's handlers. LogGroupName pulumi.StringInput `pulumi:"logGroupName"` // Amazon Resource Name (ARN) of the IAM Role CloudFormation assumes when sending error logging information to CloudWatch Logs. LogRoleArn pulumi.StringInput `pulumi:"logRoleArn"` }
func (CloudFormationTypeLoggingConfigArgs) ElementType ¶ added in v4.2.0
func (CloudFormationTypeLoggingConfigArgs) ElementType() reflect.Type
func (CloudFormationTypeLoggingConfigArgs) ToCloudFormationTypeLoggingConfigOutput ¶ added in v4.2.0
func (i CloudFormationTypeLoggingConfigArgs) ToCloudFormationTypeLoggingConfigOutput() CloudFormationTypeLoggingConfigOutput
func (CloudFormationTypeLoggingConfigArgs) ToCloudFormationTypeLoggingConfigOutputWithContext ¶ added in v4.2.0
func (i CloudFormationTypeLoggingConfigArgs) ToCloudFormationTypeLoggingConfigOutputWithContext(ctx context.Context) CloudFormationTypeLoggingConfigOutput
func (CloudFormationTypeLoggingConfigArgs) ToCloudFormationTypeLoggingConfigPtrOutput ¶ added in v4.2.0
func (i CloudFormationTypeLoggingConfigArgs) ToCloudFormationTypeLoggingConfigPtrOutput() CloudFormationTypeLoggingConfigPtrOutput
func (CloudFormationTypeLoggingConfigArgs) ToCloudFormationTypeLoggingConfigPtrOutputWithContext ¶ added in v4.2.0
func (i CloudFormationTypeLoggingConfigArgs) ToCloudFormationTypeLoggingConfigPtrOutputWithContext(ctx context.Context) CloudFormationTypeLoggingConfigPtrOutput
type CloudFormationTypeLoggingConfigInput ¶ added in v4.2.0
type CloudFormationTypeLoggingConfigInput interface { pulumi.Input ToCloudFormationTypeLoggingConfigOutput() CloudFormationTypeLoggingConfigOutput ToCloudFormationTypeLoggingConfigOutputWithContext(context.Context) CloudFormationTypeLoggingConfigOutput }
CloudFormationTypeLoggingConfigInput is an input type that accepts CloudFormationTypeLoggingConfigArgs and CloudFormationTypeLoggingConfigOutput values. You can construct a concrete instance of `CloudFormationTypeLoggingConfigInput` via:
CloudFormationTypeLoggingConfigArgs{...}
type CloudFormationTypeLoggingConfigOutput ¶ added in v4.2.0
type CloudFormationTypeLoggingConfigOutput struct{ *pulumi.OutputState }
func (CloudFormationTypeLoggingConfigOutput) ElementType ¶ added in v4.2.0
func (CloudFormationTypeLoggingConfigOutput) ElementType() reflect.Type
func (CloudFormationTypeLoggingConfigOutput) LogGroupName ¶ added in v4.2.0
func (o CloudFormationTypeLoggingConfigOutput) LogGroupName() pulumi.StringOutput
Name of the CloudWatch Log Group where CloudFormation sends error logging information when invoking the type's handlers.
func (CloudFormationTypeLoggingConfigOutput) LogRoleArn ¶ added in v4.2.0
func (o CloudFormationTypeLoggingConfigOutput) LogRoleArn() pulumi.StringOutput
Amazon Resource Name (ARN) of the IAM Role CloudFormation assumes when sending error logging information to CloudWatch Logs.
func (CloudFormationTypeLoggingConfigOutput) ToCloudFormationTypeLoggingConfigOutput ¶ added in v4.2.0
func (o CloudFormationTypeLoggingConfigOutput) ToCloudFormationTypeLoggingConfigOutput() CloudFormationTypeLoggingConfigOutput
func (CloudFormationTypeLoggingConfigOutput) ToCloudFormationTypeLoggingConfigOutputWithContext ¶ added in v4.2.0
func (o CloudFormationTypeLoggingConfigOutput) ToCloudFormationTypeLoggingConfigOutputWithContext(ctx context.Context) CloudFormationTypeLoggingConfigOutput
func (CloudFormationTypeLoggingConfigOutput) ToCloudFormationTypeLoggingConfigPtrOutput ¶ added in v4.2.0
func (o CloudFormationTypeLoggingConfigOutput) ToCloudFormationTypeLoggingConfigPtrOutput() CloudFormationTypeLoggingConfigPtrOutput
func (CloudFormationTypeLoggingConfigOutput) ToCloudFormationTypeLoggingConfigPtrOutputWithContext ¶ added in v4.2.0
func (o CloudFormationTypeLoggingConfigOutput) ToCloudFormationTypeLoggingConfigPtrOutputWithContext(ctx context.Context) CloudFormationTypeLoggingConfigPtrOutput
type CloudFormationTypeLoggingConfigPtrInput ¶ added in v4.2.0
type CloudFormationTypeLoggingConfigPtrInput interface { pulumi.Input ToCloudFormationTypeLoggingConfigPtrOutput() CloudFormationTypeLoggingConfigPtrOutput ToCloudFormationTypeLoggingConfigPtrOutputWithContext(context.Context) CloudFormationTypeLoggingConfigPtrOutput }
CloudFormationTypeLoggingConfigPtrInput is an input type that accepts CloudFormationTypeLoggingConfigArgs, CloudFormationTypeLoggingConfigPtr and CloudFormationTypeLoggingConfigPtrOutput values. You can construct a concrete instance of `CloudFormationTypeLoggingConfigPtrInput` via:
CloudFormationTypeLoggingConfigArgs{...} or: nil
func CloudFormationTypeLoggingConfigPtr ¶ added in v4.2.0
func CloudFormationTypeLoggingConfigPtr(v *CloudFormationTypeLoggingConfigArgs) CloudFormationTypeLoggingConfigPtrInput
type CloudFormationTypeLoggingConfigPtrOutput ¶ added in v4.2.0
type CloudFormationTypeLoggingConfigPtrOutput struct{ *pulumi.OutputState }
func (CloudFormationTypeLoggingConfigPtrOutput) ElementType ¶ added in v4.2.0
func (CloudFormationTypeLoggingConfigPtrOutput) ElementType() reflect.Type
func (CloudFormationTypeLoggingConfigPtrOutput) LogGroupName ¶ added in v4.2.0
func (o CloudFormationTypeLoggingConfigPtrOutput) LogGroupName() pulumi.StringPtrOutput
Name of the CloudWatch Log Group where CloudFormation sends error logging information when invoking the type's handlers.
func (CloudFormationTypeLoggingConfigPtrOutput) LogRoleArn ¶ added in v4.2.0
func (o CloudFormationTypeLoggingConfigPtrOutput) LogRoleArn() pulumi.StringPtrOutput
Amazon Resource Name (ARN) of the IAM Role CloudFormation assumes when sending error logging information to CloudWatch Logs.
func (CloudFormationTypeLoggingConfigPtrOutput) ToCloudFormationTypeLoggingConfigPtrOutput ¶ added in v4.2.0
func (o CloudFormationTypeLoggingConfigPtrOutput) ToCloudFormationTypeLoggingConfigPtrOutput() CloudFormationTypeLoggingConfigPtrOutput
func (CloudFormationTypeLoggingConfigPtrOutput) ToCloudFormationTypeLoggingConfigPtrOutputWithContext ¶ added in v4.2.0
func (o CloudFormationTypeLoggingConfigPtrOutput) ToCloudFormationTypeLoggingConfigPtrOutputWithContext(ctx context.Context) CloudFormationTypeLoggingConfigPtrOutput
type CloudFormationTypeMap ¶ added in v4.2.0
type CloudFormationTypeMap map[string]CloudFormationTypeInput
func (CloudFormationTypeMap) ElementType ¶ added in v4.2.0
func (CloudFormationTypeMap) ElementType() reflect.Type
func (CloudFormationTypeMap) ToCloudFormationTypeMapOutput ¶ added in v4.2.0
func (i CloudFormationTypeMap) ToCloudFormationTypeMapOutput() CloudFormationTypeMapOutput
func (CloudFormationTypeMap) ToCloudFormationTypeMapOutputWithContext ¶ added in v4.2.0
func (i CloudFormationTypeMap) ToCloudFormationTypeMapOutputWithContext(ctx context.Context) CloudFormationTypeMapOutput
type CloudFormationTypeMapInput ¶ added in v4.2.0
type CloudFormationTypeMapInput interface { pulumi.Input ToCloudFormationTypeMapOutput() CloudFormationTypeMapOutput ToCloudFormationTypeMapOutputWithContext(context.Context) CloudFormationTypeMapOutput }
CloudFormationTypeMapInput is an input type that accepts CloudFormationTypeMap and CloudFormationTypeMapOutput values. You can construct a concrete instance of `CloudFormationTypeMapInput` via:
CloudFormationTypeMap{ "key": CloudFormationTypeArgs{...} }
type CloudFormationTypeMapOutput ¶ added in v4.2.0
type CloudFormationTypeMapOutput struct{ *pulumi.OutputState }
func (CloudFormationTypeMapOutput) ElementType ¶ added in v4.2.0
func (CloudFormationTypeMapOutput) ElementType() reflect.Type
func (CloudFormationTypeMapOutput) MapIndex ¶ added in v4.2.0
func (o CloudFormationTypeMapOutput) MapIndex(k pulumi.StringInput) CloudFormationTypeOutput
func (CloudFormationTypeMapOutput) ToCloudFormationTypeMapOutput ¶ added in v4.2.0
func (o CloudFormationTypeMapOutput) ToCloudFormationTypeMapOutput() CloudFormationTypeMapOutput
func (CloudFormationTypeMapOutput) ToCloudFormationTypeMapOutputWithContext ¶ added in v4.2.0
func (o CloudFormationTypeMapOutput) ToCloudFormationTypeMapOutputWithContext(ctx context.Context) CloudFormationTypeMapOutput
type CloudFormationTypeOutput ¶ added in v4.2.0
type CloudFormationTypeOutput struct{ *pulumi.OutputState }
func (CloudFormationTypeOutput) ElementType ¶ added in v4.2.0
func (CloudFormationTypeOutput) ElementType() reflect.Type
func (CloudFormationTypeOutput) ToCloudFormationTypeOutput ¶ added in v4.2.0
func (o CloudFormationTypeOutput) ToCloudFormationTypeOutput() CloudFormationTypeOutput
func (CloudFormationTypeOutput) ToCloudFormationTypeOutputWithContext ¶ added in v4.2.0
func (o CloudFormationTypeOutput) ToCloudFormationTypeOutputWithContext(ctx context.Context) CloudFormationTypeOutput
type CloudFormationTypeState ¶ added in v4.2.0
type CloudFormationTypeState struct { // (Optional) Amazon Resource Name (ARN) of the CloudFormation Type version. See also `typeArn`. Arn pulumi.StringPtrInput // Identifier of the CloudFormation Type default version. DefaultVersionId pulumi.StringPtrInput // Deprecation status of the version. DeprecatedStatus pulumi.StringPtrInput // Description of the version. Description pulumi.StringPtrInput // URL of the documentation for the CloudFormation Type. DocumentationUrl pulumi.StringPtrInput // Amazon Resource Name (ARN) of the IAM Role for CloudFormation to assume when invoking the extension. If your extension calls AWS APIs in any of its handlers, you must create an IAM execution role that includes the necessary permissions to call those AWS APIs, and provision that execution role in your account. When CloudFormation needs to invoke the extension handler, CloudFormation assumes this execution role to create a temporary session token, which it then passes to the extension handler, thereby supplying your extension with the appropriate credentials. ExecutionRoleArn pulumi.StringPtrInput // Whether the CloudFormation Type version is the default version. IsDefaultVersion pulumi.BoolPtrInput // Configuration block containing logging configuration. LoggingConfig CloudFormationTypeLoggingConfigPtrInput // Provisioning behavior of the CloudFormation Type. ProvisioningType pulumi.StringPtrInput // JSON document of the CloudFormation Type schema. Schema pulumi.StringPtrInput // URL to the S3 bucket containing the extension project package that contains the necessary files for the extension you want to register. Must begin with `s3://` or `https://`. For example, `s3://example-bucket/example-object`. SchemaHandlerPackage pulumi.StringPtrInput // URL of the source code for the CloudFormation Type. SourceUrl pulumi.StringPtrInput // CloudFormation Registry Type. For example, `RESOURCE` or `MODULE`. Type pulumi.StringPtrInput // (Optional) Amazon Resource Name (ARN) of the CloudFormation Type. See also `arn`. TypeArn pulumi.StringPtrInput // CloudFormation Type name. For example, `ExampleCompany::ExampleService::ExampleResource`. TypeName pulumi.StringPtrInput // (Optional) Identifier of the CloudFormation Type version. VersionId pulumi.StringPtrInput // Scope of the CloudFormation Type. Visibility pulumi.StringPtrInput }
func (CloudFormationTypeState) ElementType ¶ added in v4.2.0
func (CloudFormationTypeState) ElementType() reflect.Type
type GetCloudFormationTypeLoggingConfig ¶ added in v4.2.0
type GetCloudFormationTypeLoggingConfig struct { // Name of the CloudWatch Log Group where CloudFormation sends error logging information when invoking the type's handlers. LogGroupName string `pulumi:"logGroupName"` // Amazon Resource Name (ARN) of the IAM Role CloudFormation assumes when sending error logging information to CloudWatch Logs. LogRoleArn string `pulumi:"logRoleArn"` }
type GetCloudFormationTypeLoggingConfigArgs ¶ added in v4.2.0
type GetCloudFormationTypeLoggingConfigArgs struct { // Name of the CloudWatch Log Group where CloudFormation sends error logging information when invoking the type's handlers. LogGroupName pulumi.StringInput `pulumi:"logGroupName"` // Amazon Resource Name (ARN) of the IAM Role CloudFormation assumes when sending error logging information to CloudWatch Logs. LogRoleArn pulumi.StringInput `pulumi:"logRoleArn"` }
func (GetCloudFormationTypeLoggingConfigArgs) ElementType ¶ added in v4.2.0
func (GetCloudFormationTypeLoggingConfigArgs) ElementType() reflect.Type
func (GetCloudFormationTypeLoggingConfigArgs) ToGetCloudFormationTypeLoggingConfigOutput ¶ added in v4.2.0
func (i GetCloudFormationTypeLoggingConfigArgs) ToGetCloudFormationTypeLoggingConfigOutput() GetCloudFormationTypeLoggingConfigOutput
func (GetCloudFormationTypeLoggingConfigArgs) ToGetCloudFormationTypeLoggingConfigOutputWithContext ¶ added in v4.2.0
func (i GetCloudFormationTypeLoggingConfigArgs) ToGetCloudFormationTypeLoggingConfigOutputWithContext(ctx context.Context) GetCloudFormationTypeLoggingConfigOutput
type GetCloudFormationTypeLoggingConfigArray ¶ added in v4.2.0
type GetCloudFormationTypeLoggingConfigArray []GetCloudFormationTypeLoggingConfigInput
func (GetCloudFormationTypeLoggingConfigArray) ElementType ¶ added in v4.2.0
func (GetCloudFormationTypeLoggingConfigArray) ElementType() reflect.Type
func (GetCloudFormationTypeLoggingConfigArray) ToGetCloudFormationTypeLoggingConfigArrayOutput ¶ added in v4.2.0
func (i GetCloudFormationTypeLoggingConfigArray) ToGetCloudFormationTypeLoggingConfigArrayOutput() GetCloudFormationTypeLoggingConfigArrayOutput
func (GetCloudFormationTypeLoggingConfigArray) ToGetCloudFormationTypeLoggingConfigArrayOutputWithContext ¶ added in v4.2.0
func (i GetCloudFormationTypeLoggingConfigArray) ToGetCloudFormationTypeLoggingConfigArrayOutputWithContext(ctx context.Context) GetCloudFormationTypeLoggingConfigArrayOutput
type GetCloudFormationTypeLoggingConfigArrayInput ¶ added in v4.2.0
type GetCloudFormationTypeLoggingConfigArrayInput interface { pulumi.Input ToGetCloudFormationTypeLoggingConfigArrayOutput() GetCloudFormationTypeLoggingConfigArrayOutput ToGetCloudFormationTypeLoggingConfigArrayOutputWithContext(context.Context) GetCloudFormationTypeLoggingConfigArrayOutput }
GetCloudFormationTypeLoggingConfigArrayInput is an input type that accepts GetCloudFormationTypeLoggingConfigArray and GetCloudFormationTypeLoggingConfigArrayOutput values. You can construct a concrete instance of `GetCloudFormationTypeLoggingConfigArrayInput` via:
GetCloudFormationTypeLoggingConfigArray{ GetCloudFormationTypeLoggingConfigArgs{...} }
type GetCloudFormationTypeLoggingConfigArrayOutput ¶ added in v4.2.0
type GetCloudFormationTypeLoggingConfigArrayOutput struct{ *pulumi.OutputState }
func (GetCloudFormationTypeLoggingConfigArrayOutput) ElementType ¶ added in v4.2.0
func (GetCloudFormationTypeLoggingConfigArrayOutput) ElementType() reflect.Type
func (GetCloudFormationTypeLoggingConfigArrayOutput) ToGetCloudFormationTypeLoggingConfigArrayOutput ¶ added in v4.2.0
func (o GetCloudFormationTypeLoggingConfigArrayOutput) ToGetCloudFormationTypeLoggingConfigArrayOutput() GetCloudFormationTypeLoggingConfigArrayOutput
func (GetCloudFormationTypeLoggingConfigArrayOutput) ToGetCloudFormationTypeLoggingConfigArrayOutputWithContext ¶ added in v4.2.0
func (o GetCloudFormationTypeLoggingConfigArrayOutput) ToGetCloudFormationTypeLoggingConfigArrayOutputWithContext(ctx context.Context) GetCloudFormationTypeLoggingConfigArrayOutput
type GetCloudFormationTypeLoggingConfigInput ¶ added in v4.2.0
type GetCloudFormationTypeLoggingConfigInput interface { pulumi.Input ToGetCloudFormationTypeLoggingConfigOutput() GetCloudFormationTypeLoggingConfigOutput ToGetCloudFormationTypeLoggingConfigOutputWithContext(context.Context) GetCloudFormationTypeLoggingConfigOutput }
GetCloudFormationTypeLoggingConfigInput is an input type that accepts GetCloudFormationTypeLoggingConfigArgs and GetCloudFormationTypeLoggingConfigOutput values. You can construct a concrete instance of `GetCloudFormationTypeLoggingConfigInput` via:
GetCloudFormationTypeLoggingConfigArgs{...}
type GetCloudFormationTypeLoggingConfigOutput ¶ added in v4.2.0
type GetCloudFormationTypeLoggingConfigOutput struct{ *pulumi.OutputState }
func (GetCloudFormationTypeLoggingConfigOutput) ElementType ¶ added in v4.2.0
func (GetCloudFormationTypeLoggingConfigOutput) ElementType() reflect.Type
func (GetCloudFormationTypeLoggingConfigOutput) LogGroupName ¶ added in v4.2.0
func (o GetCloudFormationTypeLoggingConfigOutput) LogGroupName() pulumi.StringOutput
Name of the CloudWatch Log Group where CloudFormation sends error logging information when invoking the type's handlers.
func (GetCloudFormationTypeLoggingConfigOutput) LogRoleArn ¶ added in v4.2.0
func (o GetCloudFormationTypeLoggingConfigOutput) LogRoleArn() pulumi.StringOutput
Amazon Resource Name (ARN) of the IAM Role CloudFormation assumes when sending error logging information to CloudWatch Logs.
func (GetCloudFormationTypeLoggingConfigOutput) ToGetCloudFormationTypeLoggingConfigOutput ¶ added in v4.2.0
func (o GetCloudFormationTypeLoggingConfigOutput) ToGetCloudFormationTypeLoggingConfigOutput() GetCloudFormationTypeLoggingConfigOutput
func (GetCloudFormationTypeLoggingConfigOutput) ToGetCloudFormationTypeLoggingConfigOutputWithContext ¶ added in v4.2.0
func (o GetCloudFormationTypeLoggingConfigOutput) ToGetCloudFormationTypeLoggingConfigOutputWithContext(ctx context.Context) GetCloudFormationTypeLoggingConfigOutput
type GetExportArgs ¶
type GetExportArgs struct { // The name of the export as it appears in the console or from [list-exports](http://docs.aws.amazon.com/cli/latest/reference/cloudformation/list-exports.html) Name string `pulumi:"name"` }
A collection of arguments for invoking getExport.
type GetExportOutputArgs ¶ added in v4.21.0
type GetExportOutputArgs struct { // The name of the export as it appears in the console or from [list-exports](http://docs.aws.amazon.com/cli/latest/reference/cloudformation/list-exports.html) Name pulumi.StringInput `pulumi:"name"` }
A collection of arguments for invoking getExport.
func (GetExportOutputArgs) ElementType ¶ added in v4.21.0
func (GetExportOutputArgs) ElementType() reflect.Type
type GetExportResult ¶
type GetExportResult struct { // The exportingStackId (AWS ARNs) equivalent `ExportingStackId` from [list-exports](http://docs.aws.amazon.com/cli/latest/reference/cloudformation/list-exports.html) ExportingStackId string `pulumi:"exportingStackId"` // The provider-assigned unique ID for this managed resource. Id string `pulumi:"id"` Name string `pulumi:"name"` // The value from Cloudformation export identified by the export name found from [list-exports](http://docs.aws.amazon.com/cli/latest/reference/cloudformation/list-exports.html) Value string `pulumi:"value"` }
A collection of values returned by getExport.
func GetExport ¶
func GetExport(ctx *pulumi.Context, args *GetExportArgs, opts ...pulumi.InvokeOption) (*GetExportResult, error)
The CloudFormation Export data source allows access to stack exports specified in the [Output](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/outputs-section-structure.html) 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 deployment please use normal interpolation or Cloudformation Outputs.
## Example Usage
```go package main
import (
"github.com/pulumi/pulumi-aws/sdk/v4/go/aws/cloudformation" "github.com/pulumi/pulumi-aws/sdk/v4/go/aws/ec2" "github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() { pulumi.Run(func(ctx *pulumi.Context) error { subnetId, err := cloudformation.GetExport(ctx, &cloudformation.GetExportArgs{ Name: "mySubnetIdExportName", }, nil) if err != nil { return err } _, err = ec2.NewInstance(ctx, "web", &ec2.InstanceArgs{ Ami: pulumi.String("ami-abb07bcb"), InstanceType: pulumi.String("t2.micro"), SubnetId: pulumi.String(subnetId.Value), }) if err != nil { return err } return nil }) }
```
type GetExportResultOutput ¶ added in v4.21.0
type GetExportResultOutput struct{ *pulumi.OutputState }
A collection of values returned by getExport.
func GetExportOutput ¶ added in v4.21.0
func GetExportOutput(ctx *pulumi.Context, args GetExportOutputArgs, opts ...pulumi.InvokeOption) GetExportResultOutput
func (GetExportResultOutput) ElementType ¶ added in v4.21.0
func (GetExportResultOutput) ElementType() reflect.Type
func (GetExportResultOutput) ExportingStackId ¶ added in v4.21.0
func (o GetExportResultOutput) ExportingStackId() pulumi.StringOutput
The exportingStackId (AWS ARNs) equivalent `ExportingStackId` from [list-exports](http://docs.aws.amazon.com/cli/latest/reference/cloudformation/list-exports.html)
func (GetExportResultOutput) Id ¶ added in v4.21.0
func (o GetExportResultOutput) Id() pulumi.StringOutput
The provider-assigned unique ID for this managed resource.
func (GetExportResultOutput) Name ¶ added in v4.21.0
func (o GetExportResultOutput) Name() pulumi.StringOutput
func (GetExportResultOutput) ToGetExportResultOutput ¶ added in v4.21.0
func (o GetExportResultOutput) ToGetExportResultOutput() GetExportResultOutput
func (GetExportResultOutput) ToGetExportResultOutputWithContext ¶ added in v4.21.0
func (o GetExportResultOutput) ToGetExportResultOutputWithContext(ctx context.Context) GetExportResultOutput
func (GetExportResultOutput) Value ¶ added in v4.21.0
func (o GetExportResultOutput) Value() pulumi.StringOutput
The value from Cloudformation export identified by the export name found from [list-exports](http://docs.aws.amazon.com/cli/latest/reference/cloudformation/list-exports.html)
type LookupCloudFormationTypeArgs ¶ added in v4.2.0
type LookupCloudFormationTypeArgs struct { // Amazon Resource Name (ARN) of the CloudFormation Type. For example, `arn:aws:cloudformation:us-west-2::type/resource/AWS-EC2-VPC`. Arn *string `pulumi:"arn"` // CloudFormation Registry Type. For example, `RESOURCE`. Type *string `pulumi:"type"` // CloudFormation Type name. For example, `AWS::EC2::VPC`. TypeName *string `pulumi:"typeName"` // Identifier of the CloudFormation Type version. VersionId *string `pulumi:"versionId"` }
A collection of arguments for invoking getCloudFormationType.
type LookupCloudFormationTypeOutputArgs ¶ added in v4.21.0
type LookupCloudFormationTypeOutputArgs struct { // Amazon Resource Name (ARN) of the CloudFormation Type. For example, `arn:aws:cloudformation:us-west-2::type/resource/AWS-EC2-VPC`. Arn pulumi.StringPtrInput `pulumi:"arn"` // CloudFormation Registry Type. For example, `RESOURCE`. Type pulumi.StringPtrInput `pulumi:"type"` // CloudFormation Type name. For example, `AWS::EC2::VPC`. TypeName pulumi.StringPtrInput `pulumi:"typeName"` // Identifier of the CloudFormation Type version. VersionId pulumi.StringPtrInput `pulumi:"versionId"` }
A collection of arguments for invoking getCloudFormationType.
func (LookupCloudFormationTypeOutputArgs) ElementType ¶ added in v4.21.0
func (LookupCloudFormationTypeOutputArgs) ElementType() reflect.Type
type LookupCloudFormationTypeResult ¶ added in v4.2.0
type LookupCloudFormationTypeResult struct { Arn string `pulumi:"arn"` // Identifier of the CloudFormation Type default version. DefaultVersionId string `pulumi:"defaultVersionId"` // Deprecation status of the CloudFormation Type. DeprecatedStatus string `pulumi:"deprecatedStatus"` // Description of the CloudFormation Type. Description string `pulumi:"description"` // URL of the documentation for the CloudFormation Type. DocumentationUrl string `pulumi:"documentationUrl"` // Amazon Resource Name (ARN) of the IAM Role used to register the CloudFormation Type. ExecutionRoleArn string `pulumi:"executionRoleArn"` // The provider-assigned unique ID for this managed resource. Id string `pulumi:"id"` // Whether the CloudFormation Type version is the default version. IsDefaultVersion bool `pulumi:"isDefaultVersion"` // List of objects containing logging configuration. LoggingConfigs []GetCloudFormationTypeLoggingConfig `pulumi:"loggingConfigs"` // Provisioning behavior of the CloudFormation Type. ProvisioningType string `pulumi:"provisioningType"` // JSON document of the CloudFormation Type schema. Schema string `pulumi:"schema"` // URL of the source code for the CloudFormation Type. SourceUrl string `pulumi:"sourceUrl"` Type string `pulumi:"type"` TypeArn string `pulumi:"typeArn"` TypeName string `pulumi:"typeName"` VersionId *string `pulumi:"versionId"` // Scope of the CloudFormation Type. Visibility string `pulumi:"visibility"` }
A collection of values returned by getCloudFormationType.
func LookupCloudFormationType ¶ added in v4.2.0
func LookupCloudFormationType(ctx *pulumi.Context, args *LookupCloudFormationTypeArgs, opts ...pulumi.InvokeOption) (*LookupCloudFormationTypeResult, error)
Provides details about a CloudFormation Type.
## Example Usage
```go package main
import (
"github.com/pulumi/pulumi-aws/sdk/v4/go/aws/cloudformation" "github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() { pulumi.Run(func(ctx *pulumi.Context) error { _, err := cloudformation.LookupCloudFormationType(ctx, &cloudformation.LookupCloudFormationTypeArgs{ Type: pulumi.StringRef("RESOURCE"), TypeName: pulumi.StringRef("AWS::Athena::WorkGroup"), }, nil) if err != nil { return err } return nil }) }
```
type LookupCloudFormationTypeResultOutput ¶ added in v4.21.0
type LookupCloudFormationTypeResultOutput struct{ *pulumi.OutputState }
A collection of values returned by getCloudFormationType.
func LookupCloudFormationTypeOutput ¶ added in v4.21.0
func LookupCloudFormationTypeOutput(ctx *pulumi.Context, args LookupCloudFormationTypeOutputArgs, opts ...pulumi.InvokeOption) LookupCloudFormationTypeResultOutput
func (LookupCloudFormationTypeResultOutput) Arn ¶ added in v4.21.0
func (o LookupCloudFormationTypeResultOutput) Arn() pulumi.StringOutput
func (LookupCloudFormationTypeResultOutput) DefaultVersionId ¶ added in v4.21.0
func (o LookupCloudFormationTypeResultOutput) DefaultVersionId() pulumi.StringOutput
Identifier of the CloudFormation Type default version.
func (LookupCloudFormationTypeResultOutput) DeprecatedStatus ¶ added in v4.21.0
func (o LookupCloudFormationTypeResultOutput) DeprecatedStatus() pulumi.StringOutput
Deprecation status of the CloudFormation Type.
func (LookupCloudFormationTypeResultOutput) Description ¶ added in v4.21.0
func (o LookupCloudFormationTypeResultOutput) Description() pulumi.StringOutput
Description of the CloudFormation Type.
func (LookupCloudFormationTypeResultOutput) DocumentationUrl ¶ added in v4.21.0
func (o LookupCloudFormationTypeResultOutput) DocumentationUrl() pulumi.StringOutput
URL of the documentation for the CloudFormation Type.
func (LookupCloudFormationTypeResultOutput) ElementType ¶ added in v4.21.0
func (LookupCloudFormationTypeResultOutput) ElementType() reflect.Type
func (LookupCloudFormationTypeResultOutput) ExecutionRoleArn ¶ added in v4.21.0
func (o LookupCloudFormationTypeResultOutput) ExecutionRoleArn() pulumi.StringOutput
Amazon Resource Name (ARN) of the IAM Role used to register the CloudFormation Type.
func (LookupCloudFormationTypeResultOutput) Id ¶ added in v4.21.0
func (o LookupCloudFormationTypeResultOutput) Id() pulumi.StringOutput
The provider-assigned unique ID for this managed resource.
func (LookupCloudFormationTypeResultOutput) IsDefaultVersion ¶ added in v4.21.0
func (o LookupCloudFormationTypeResultOutput) IsDefaultVersion() pulumi.BoolOutput
Whether the CloudFormation Type version is the default version.
func (LookupCloudFormationTypeResultOutput) LoggingConfigs ¶ added in v4.21.0
func (o LookupCloudFormationTypeResultOutput) LoggingConfigs() GetCloudFormationTypeLoggingConfigArrayOutput
List of objects containing logging configuration.
func (LookupCloudFormationTypeResultOutput) ProvisioningType ¶ added in v4.21.0
func (o LookupCloudFormationTypeResultOutput) ProvisioningType() pulumi.StringOutput
Provisioning behavior of the CloudFormation Type.
func (LookupCloudFormationTypeResultOutput) Schema ¶ added in v4.21.0
func (o LookupCloudFormationTypeResultOutput) Schema() pulumi.StringOutput
JSON document of the CloudFormation Type schema.
func (LookupCloudFormationTypeResultOutput) SourceUrl ¶ added in v4.21.0
func (o LookupCloudFormationTypeResultOutput) SourceUrl() pulumi.StringOutput
URL of the source code for the CloudFormation Type.
func (LookupCloudFormationTypeResultOutput) ToLookupCloudFormationTypeResultOutput ¶ added in v4.21.0
func (o LookupCloudFormationTypeResultOutput) ToLookupCloudFormationTypeResultOutput() LookupCloudFormationTypeResultOutput
func (LookupCloudFormationTypeResultOutput) ToLookupCloudFormationTypeResultOutputWithContext ¶ added in v4.21.0
func (o LookupCloudFormationTypeResultOutput) ToLookupCloudFormationTypeResultOutputWithContext(ctx context.Context) LookupCloudFormationTypeResultOutput
func (LookupCloudFormationTypeResultOutput) Type ¶ added in v4.21.0
func (o LookupCloudFormationTypeResultOutput) Type() pulumi.StringOutput
func (LookupCloudFormationTypeResultOutput) TypeArn ¶ added in v4.21.0
func (o LookupCloudFormationTypeResultOutput) TypeArn() pulumi.StringOutput
func (LookupCloudFormationTypeResultOutput) TypeName ¶ added in v4.21.0
func (o LookupCloudFormationTypeResultOutput) TypeName() pulumi.StringOutput
func (LookupCloudFormationTypeResultOutput) VersionId ¶ added in v4.21.0
func (o LookupCloudFormationTypeResultOutput) VersionId() pulumi.StringPtrOutput
func (LookupCloudFormationTypeResultOutput) Visibility ¶ added in v4.21.0
func (o LookupCloudFormationTypeResultOutput) Visibility() pulumi.StringOutput
Scope of the CloudFormation Type.
type LookupStackArgs ¶
type LookupStackArgs struct { // The name of the stack Name string `pulumi:"name"` // A map of tags associated with this stack. Tags map[string]string `pulumi:"tags"` }
A collection of arguments for invoking getStack.
type LookupStackOutputArgs ¶ added in v4.21.0
type LookupStackOutputArgs struct { // The name of the stack Name pulumi.StringInput `pulumi:"name"` // A map of tags associated with this stack. Tags pulumi.StringMapInput `pulumi:"tags"` }
A collection of arguments for invoking getStack.
func (LookupStackOutputArgs) ElementType ¶ added in v4.21.0
func (LookupStackOutputArgs) ElementType() reflect.Type
type LookupStackResult ¶
type LookupStackResult struct { // A list of capabilities Capabilities []string `pulumi:"capabilities"` // Description of the stack Description string `pulumi:"description"` // Whether the rollback of the stack is disabled when stack creation fails DisableRollback bool `pulumi:"disableRollback"` // The ARN of the IAM role used to create the stack. IamRoleArn string `pulumi:"iamRoleArn"` // The provider-assigned unique ID for this managed resource. Id string `pulumi:"id"` Name string `pulumi:"name"` // A list of SNS topic ARNs to publish stack related events NotificationArns []string `pulumi:"notificationArns"` // A map of outputs from the stack. Outputs map[string]string `pulumi:"outputs"` // A map of parameters that specify input parameters for the stack. Parameters map[string]string `pulumi:"parameters"` // A map of tags associated with this stack. Tags map[string]string `pulumi:"tags"` // Structure containing the template body. TemplateBody string `pulumi:"templateBody"` // The amount of time that can pass before the stack status becomes `CREATE_FAILED` TimeoutInMinutes int `pulumi:"timeoutInMinutes"` }
A collection of values returned by getStack.
func LookupStack ¶
func LookupStack(ctx *pulumi.Context, args *LookupStackArgs, opts ...pulumi.InvokeOption) (*LookupStackResult, error)
The CloudFormation Stack data source allows access to stack outputs and other useful data including the template body.
## Example Usage
```go package main
import (
"github.com/pulumi/pulumi-aws/sdk/v4/go/aws/cloudformation" "github.com/pulumi/pulumi-aws/sdk/v4/go/aws/ec2" "github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() { pulumi.Run(func(ctx *pulumi.Context) error { network, err := cloudformation.LookupStack(ctx, &cloudformation.LookupStackArgs{ Name: "my-network-stack", }, nil) if err != nil { return err } _, err = ec2.NewInstance(ctx, "web", &ec2.InstanceArgs{ Ami: pulumi.String("ami-abb07bcb"), InstanceType: pulumi.String("t2.micro"), SubnetId: pulumi.String(network.Outputs.SubnetId), Tags: pulumi.StringMap{ "Name": pulumi.String("HelloWorld"), }, }) if err != nil { return err } return nil }) }
```
type LookupStackResultOutput ¶ added in v4.21.0
type LookupStackResultOutput struct{ *pulumi.OutputState }
A collection of values returned by getStack.
func LookupStackOutput ¶ added in v4.21.0
func LookupStackOutput(ctx *pulumi.Context, args LookupStackOutputArgs, opts ...pulumi.InvokeOption) LookupStackResultOutput
func (LookupStackResultOutput) Capabilities ¶ added in v4.21.0
func (o LookupStackResultOutput) Capabilities() pulumi.StringArrayOutput
A list of capabilities
func (LookupStackResultOutput) Description ¶ added in v4.21.0
func (o LookupStackResultOutput) Description() pulumi.StringOutput
Description of the stack
func (LookupStackResultOutput) DisableRollback ¶ added in v4.21.0
func (o LookupStackResultOutput) DisableRollback() pulumi.BoolOutput
Whether the rollback of the stack is disabled when stack creation fails
func (LookupStackResultOutput) ElementType ¶ added in v4.21.0
func (LookupStackResultOutput) ElementType() reflect.Type
func (LookupStackResultOutput) IamRoleArn ¶ added in v4.21.0
func (o LookupStackResultOutput) IamRoleArn() pulumi.StringOutput
The ARN of the IAM role used to create the stack.
func (LookupStackResultOutput) Id ¶ added in v4.21.0
func (o LookupStackResultOutput) Id() pulumi.StringOutput
The provider-assigned unique ID for this managed resource.
func (LookupStackResultOutput) Name ¶ added in v4.21.0
func (o LookupStackResultOutput) Name() pulumi.StringOutput
func (LookupStackResultOutput) NotificationArns ¶ added in v4.21.0
func (o LookupStackResultOutput) NotificationArns() pulumi.StringArrayOutput
A list of SNS topic ARNs to publish stack related events
func (LookupStackResultOutput) Outputs ¶ added in v4.21.0
func (o LookupStackResultOutput) Outputs() pulumi.StringMapOutput
A map of outputs from the stack.
func (LookupStackResultOutput) Parameters ¶ added in v4.21.0
func (o LookupStackResultOutput) Parameters() pulumi.StringMapOutput
A map of parameters that specify input parameters for the stack.
func (LookupStackResultOutput) Tags ¶ added in v4.21.0
func (o LookupStackResultOutput) Tags() pulumi.StringMapOutput
A map of tags associated with this stack.
func (LookupStackResultOutput) TemplateBody ¶ added in v4.21.0
func (o LookupStackResultOutput) TemplateBody() pulumi.StringOutput
Structure containing the template body.
func (LookupStackResultOutput) TimeoutInMinutes ¶ added in v4.21.0
func (o LookupStackResultOutput) TimeoutInMinutes() pulumi.IntOutput
The amount of time that can pass before the stack status becomes `CREATE_FAILED`
func (LookupStackResultOutput) ToLookupStackResultOutput ¶ added in v4.21.0
func (o LookupStackResultOutput) ToLookupStackResultOutput() LookupStackResultOutput
func (LookupStackResultOutput) ToLookupStackResultOutputWithContext ¶ added in v4.21.0
func (o LookupStackResultOutput) ToLookupStackResultOutputWithContext(ctx context.Context) LookupStackResultOutput
type Stack ¶
type Stack struct { pulumi.CustomResourceState // A list of capabilities. // Valid values: `CAPABILITY_IAM`, `CAPABILITY_NAMED_IAM`, or `CAPABILITY_AUTO_EXPAND` Capabilities pulumi.StringArrayOutput `pulumi:"capabilities"` // Set to true to disable rollback of the stack if stack creation failed. // Conflicts with `onFailure`. DisableRollback pulumi.BoolPtrOutput `pulumi:"disableRollback"` // 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. IamRoleArn pulumi.StringPtrOutput `pulumi:"iamRoleArn"` // Stack name. Name pulumi.StringOutput `pulumi:"name"` // A list of SNS topic ARNs to publish stack related events. NotificationArns pulumi.StringArrayOutput `pulumi:"notificationArns"` // Action to be taken if stack creation fails. This must be // one of: `DO_NOTHING`, `ROLLBACK`, or `DELETE`. Conflicts with `disableRollback`. OnFailure pulumi.StringPtrOutput `pulumi:"onFailure"` // A map of outputs from the stack. Outputs pulumi.StringMapOutput `pulumi:"outputs"` // A map of Parameter structures that specify input parameters for the stack. Parameters pulumi.StringMapOutput `pulumi:"parameters"` // Structure containing the stack policy body. // Conflicts w/ `policyUrl`. PolicyBody pulumi.StringOutput `pulumi:"policyBody"` // Location of a file containing the stack policy. // Conflicts w/ `policyBody`. PolicyUrl pulumi.StringPtrOutput `pulumi:"policyUrl"` // Map of resource tags to associate with this stack. .If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level. Tags pulumi.StringMapOutput `pulumi:"tags"` // A map of tags assigned to the resource, including those inherited from the provider . TagsAll pulumi.StringMapOutput `pulumi:"tagsAll"` // Structure containing the template body (max size: 51,200 bytes). TemplateBody pulumi.StringOutput `pulumi:"templateBody"` // Location of a file containing the template body (max size: 460,800 bytes). TemplateUrl pulumi.StringPtrOutput `pulumi:"templateUrl"` // The amount of time that can pass before the stack status becomes `CREATE_FAILED`. TimeoutInMinutes pulumi.IntPtrOutput `pulumi:"timeoutInMinutes"` }
Provides a CloudFormation Stack resource.
## Example Usage
```go package main
import (
"fmt" "github.com/pulumi/pulumi-aws/sdk/v4/go/aws/cloudformation" "github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() { pulumi.Run(func(ctx *pulumi.Context) error { _, err := cloudformation.NewStack(ctx, "network", &cloudformation.StackArgs{ Parameters: pulumi.StringMap{ "VPCCidr": pulumi.String("10.0.0.0/16"), }, TemplateBody: pulumi.String(fmt.Sprintf("%v%v%v%v%v%v%v%v%v%v%v%v%v%v%v%v%v%v%v%v%v", "{\n", " \"Parameters\" : {\n", " \"VPCCidr\" : {\n", " \"Type\" : \"String\",\n", " \"Default\" : \"10.0.0.0/16\",\n", " \"Description\" : \"Enter the CIDR block for the VPC. Default is 10.0.0.0/16.\"\n", " }\n", " },\n", " \"Resources\" : {\n", " \"myVpc\": {\n", " \"Type\" : \"AWS::EC2::VPC\",\n", " \"Properties\" : {\n", " \"CidrBlock\" : { \"Ref\" : \"VPCCidr\" },\n", " \"Tags\" : [\n", " {\"Key\": \"Name\", \"Value\": \"Primary_CF_VPC\"}\n", " ]\n", " }\n", " }\n", " }\n", "}\n", "\n")), }) if err != nil { return err } return nil }) }
```
## Import
Cloudformation Stacks can be imported using the `name`, e.g.,
```sh
$ pulumi import aws:cloudformation/stack:Stack stack networking-stack
```
func GetStack ¶
func GetStack(ctx *pulumi.Context, name string, id pulumi.IDInput, state *StackState, opts ...pulumi.ResourceOption) (*Stack, error)
GetStack gets an existing Stack resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).
func NewStack ¶
func NewStack(ctx *pulumi.Context, name string, args *StackArgs, opts ...pulumi.ResourceOption) (*Stack, error)
NewStack registers a new resource with the given unique name, arguments, and options.
func (*Stack) ElementType ¶
func (*Stack) ToStackOutput ¶
func (i *Stack) ToStackOutput() StackOutput
func (*Stack) ToStackOutputWithContext ¶
func (i *Stack) ToStackOutputWithContext(ctx context.Context) StackOutput
type StackArgs ¶
type StackArgs struct { // A list of capabilities. // Valid values: `CAPABILITY_IAM`, `CAPABILITY_NAMED_IAM`, or `CAPABILITY_AUTO_EXPAND` Capabilities pulumi.StringArrayInput // Set to true to disable rollback of the stack if stack creation failed. // Conflicts with `onFailure`. DisableRollback pulumi.BoolPtrInput // 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. IamRoleArn pulumi.StringPtrInput // Stack name. Name pulumi.StringPtrInput // A list of SNS topic ARNs to publish stack related events. NotificationArns pulumi.StringArrayInput // Action to be taken if stack creation fails. This must be // one of: `DO_NOTHING`, `ROLLBACK`, or `DELETE`. Conflicts with `disableRollback`. OnFailure pulumi.StringPtrInput // A map of Parameter structures that specify input parameters for the stack. Parameters pulumi.StringMapInput // Structure containing the stack policy body. // Conflicts w/ `policyUrl`. PolicyBody pulumi.StringPtrInput // Location of a file containing the stack policy. // Conflicts w/ `policyBody`. PolicyUrl pulumi.StringPtrInput // Map of resource tags to associate with this stack. .If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level. Tags pulumi.StringMapInput // Structure containing the template body (max size: 51,200 bytes). TemplateBody pulumi.StringPtrInput // Location of a file containing the template body (max size: 460,800 bytes). TemplateUrl pulumi.StringPtrInput // The amount of time that can pass before the stack status becomes `CREATE_FAILED`. TimeoutInMinutes pulumi.IntPtrInput }
The set of arguments for constructing a Stack resource.
func (StackArgs) ElementType ¶
type StackArray ¶
type StackArray []StackInput
func (StackArray) ElementType ¶
func (StackArray) ElementType() reflect.Type
func (StackArray) ToStackArrayOutput ¶
func (i StackArray) ToStackArrayOutput() StackArrayOutput
func (StackArray) ToStackArrayOutputWithContext ¶
func (i StackArray) ToStackArrayOutputWithContext(ctx context.Context) StackArrayOutput
type StackArrayInput ¶
type StackArrayInput interface { pulumi.Input ToStackArrayOutput() StackArrayOutput ToStackArrayOutputWithContext(context.Context) StackArrayOutput }
StackArrayInput is an input type that accepts StackArray and StackArrayOutput values. You can construct a concrete instance of `StackArrayInput` via:
StackArray{ StackArgs{...} }
type StackArrayOutput ¶
type StackArrayOutput struct{ *pulumi.OutputState }
func (StackArrayOutput) ElementType ¶
func (StackArrayOutput) ElementType() reflect.Type
func (StackArrayOutput) Index ¶
func (o StackArrayOutput) Index(i pulumi.IntInput) StackOutput
func (StackArrayOutput) ToStackArrayOutput ¶
func (o StackArrayOutput) ToStackArrayOutput() StackArrayOutput
func (StackArrayOutput) ToStackArrayOutputWithContext ¶
func (o StackArrayOutput) ToStackArrayOutputWithContext(ctx context.Context) StackArrayOutput
type StackInput ¶
type StackInput interface { pulumi.Input ToStackOutput() StackOutput ToStackOutputWithContext(ctx context.Context) StackOutput }
type StackMap ¶
type StackMap map[string]StackInput
func (StackMap) ElementType ¶
func (StackMap) ToStackMapOutput ¶
func (i StackMap) ToStackMapOutput() StackMapOutput
func (StackMap) ToStackMapOutputWithContext ¶
func (i StackMap) ToStackMapOutputWithContext(ctx context.Context) StackMapOutput
type StackMapInput ¶
type StackMapInput interface { pulumi.Input ToStackMapOutput() StackMapOutput ToStackMapOutputWithContext(context.Context) StackMapOutput }
StackMapInput is an input type that accepts StackMap and StackMapOutput values. You can construct a concrete instance of `StackMapInput` via:
StackMap{ "key": StackArgs{...} }
type StackMapOutput ¶
type StackMapOutput struct{ *pulumi.OutputState }
func (StackMapOutput) ElementType ¶
func (StackMapOutput) ElementType() reflect.Type
func (StackMapOutput) MapIndex ¶
func (o StackMapOutput) MapIndex(k pulumi.StringInput) StackOutput
func (StackMapOutput) ToStackMapOutput ¶
func (o StackMapOutput) ToStackMapOutput() StackMapOutput
func (StackMapOutput) ToStackMapOutputWithContext ¶
func (o StackMapOutput) ToStackMapOutputWithContext(ctx context.Context) StackMapOutput
type StackOutput ¶
type StackOutput struct{ *pulumi.OutputState }
func (StackOutput) ElementType ¶
func (StackOutput) ElementType() reflect.Type
func (StackOutput) ToStackOutput ¶
func (o StackOutput) ToStackOutput() StackOutput
func (StackOutput) ToStackOutputWithContext ¶
func (o StackOutput) ToStackOutputWithContext(ctx context.Context) StackOutput
type StackSet ¶
type StackSet struct { pulumi.CustomResourceState // Amazon Resource Number (ARN) of the IAM Role in the administrator account. This must be defined when using the `SELF_MANAGED` permission model. AdministrationRoleArn pulumi.StringPtrOutput `pulumi:"administrationRoleArn"` // Amazon Resource Name (ARN) of the StackSet. Arn pulumi.StringOutput `pulumi:"arn"` // Configuration block containing the auto-deployment model for your StackSet. This can only be defined when using the `SERVICE_MANAGED` permission model. AutoDeployment StackSetAutoDeploymentPtrOutput `pulumi:"autoDeployment"` // A list of capabilities. Valid values: `CAPABILITY_IAM`, `CAPABILITY_NAMED_IAM`, `CAPABILITY_AUTO_EXPAND`. Capabilities pulumi.StringArrayOutput `pulumi:"capabilities"` // Description of the StackSet. Description pulumi.StringPtrOutput `pulumi:"description"` // Name of the IAM Role in all target accounts for StackSet operations. Defaults to `AWSCloudFormationStackSetExecutionRole` when using the `SELF_MANAGED` permission model. This should not be defined when using the `SERVICE_MANAGED` permission model. ExecutionRoleName pulumi.StringOutput `pulumi:"executionRoleName"` // Name of the StackSet. The name must be unique in the region where you create your StackSet. The name can contain only alphanumeric characters (case-sensitive) and hyphens. It must start with an alphabetic character and cannot be longer than 128 characters. Name pulumi.StringOutput `pulumi:"name"` // Key-value map of input parameters for the StackSet template. All template parameters, including those with a `Default`, must be configured or ignored with `lifecycle` configuration block `ignoreChanges` argument. All `NoEcho` template parameters must be ignored with the `lifecycle` configuration block `ignoreChanges` argument. Parameters pulumi.StringMapOutput `pulumi:"parameters"` // Describes how the IAM roles required for your StackSet are created. Valid values: `SELF_MANAGED` (default), `SERVICE_MANAGED`. PermissionModel pulumi.StringPtrOutput `pulumi:"permissionModel"` // Unique identifier of the StackSet. StackSetId pulumi.StringOutput `pulumi:"stackSetId"` // Key-value map of tags to associate with this StackSet and the Stacks created from it. AWS CloudFormation also propagates these tags to supported resources that are created in the Stacks. A maximum number of 50 tags can be specified. .If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level. Tags pulumi.StringMapOutput `pulumi:"tags"` // A map of tags assigned to the resource, including those inherited from the provider . TagsAll pulumi.StringMapOutput `pulumi:"tagsAll"` // String containing the CloudFormation template body. Maximum size: 51,200 bytes. Conflicts with `templateUrl`. TemplateBody pulumi.StringOutput `pulumi:"templateBody"` // String containing the location of a file containing the CloudFormation template body. The URL must point to a template that is located in an Amazon S3 bucket. Maximum location file size: 460,800 bytes. Conflicts with `templateBody`. TemplateUrl pulumi.StringPtrOutput `pulumi:"templateUrl"` }
Manages a CloudFormation StackSet. StackSets allow CloudFormation templates to be easily deployed across multiple accounts and regions via StackSet Instances (`cloudformation.StackSetInstance` resource). Additional information about StackSets can be found in the [AWS CloudFormation User Guide](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/what-is-cfnstacksets.html).
> **NOTE:** All template parameters, including those with a `Default`, must be configured or ignored with the `lifecycle` configuration block `ignoreChanges` argument.
> **NOTE:** All `NoEcho` template parameters must be ignored with the `lifecycle` configuration block `ignoreChanges` argument.
## Example Usage
```go package main
import (
"fmt" "github.com/pulumi/pulumi-aws/sdk/v4/go/aws/cloudformation" "github.com/pulumi/pulumi-aws/sdk/v4/go/aws/iam" "github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() { pulumi.Run(func(ctx *pulumi.Context) error { aWSCloudFormationStackSetAdministrationRoleAssumeRolePolicy, err := iam.GetPolicyDocument(ctx, &iam.GetPolicyDocumentArgs{ Statements: []iam.GetPolicyDocumentStatement{ iam.GetPolicyDocumentStatement{ Actions: []string{ "sts:AssumeRole", }, Effect: pulumi.StringRef("Allow"), Principals: []iam.GetPolicyDocumentStatementPrincipal{ iam.GetPolicyDocumentStatementPrincipal{ Identifiers: []string{ "cloudformation.amazonaws.com", }, Type: "Service", }, }, }, }, }, nil) if err != nil { return err } aWSCloudFormationStackSetAdministrationRole, err := iam.NewRole(ctx, "aWSCloudFormationStackSetAdministrationRole", &iam.RoleArgs{ AssumeRolePolicy: pulumi.String(aWSCloudFormationStackSetAdministrationRoleAssumeRolePolicy.Json), }) if err != nil { return err } example, err := cloudformation.NewStackSet(ctx, "example", &cloudformation.StackSetArgs{ AdministrationRoleArn: aWSCloudFormationStackSetAdministrationRole.Arn, Parameters: pulumi.StringMap{ "VPCCidr": pulumi.String("10.0.0.0/16"), }, TemplateBody: pulumi.String(fmt.Sprintf("%v%v%v%v%v%v%v%v%v%v%v%v%v%v%v%v%v%v%v%v", "{\n", " \"Parameters\" : {\n", " \"VPCCidr\" : {\n", " \"Type\" : \"String\",\n", " \"Default\" : \"10.0.0.0/16\",\n", " \"Description\" : \"Enter the CIDR block for the VPC. Default is 10.0.0.0/16.\"\n", " }\n", " },\n", " \"Resources\" : {\n", " \"myVpc\": {\n", " \"Type\" : \"AWS::EC2::VPC\",\n", " \"Properties\" : {\n", " \"CidrBlock\" : { \"Ref\" : \"VPCCidr\" },\n", " \"Tags\" : [\n", " {\"Key\": \"Name\", \"Value\": \"Primary_CF_VPC\"}\n", " ]\n", " }\n", " }\n", " }\n", "}\n")), }) if err != nil { return err } aWSCloudFormationStackSetAdministrationRoleExecutionPolicyPolicyDocument := iam.GetPolicyDocumentOutput(ctx, iam.GetPolicyDocumentOutputArgs{ Statements: iam.GetPolicyDocumentStatementArray{ &iam.GetPolicyDocumentStatementArgs{ Actions: pulumi.StringArray{ pulumi.String("sts:AssumeRole"), }, Effect: pulumi.String("Allow"), Resources: pulumi.StringArray{ example.ExecutionRoleName.ApplyT(func(executionRoleName string) (string, error) { return fmt.Sprintf("%v%v", "arn:aws:iam::*:role/", executionRoleName), nil }).(pulumi.StringOutput), }, }, }, }, nil) _, err = iam.NewRolePolicy(ctx, "aWSCloudFormationStackSetAdministrationRoleExecutionPolicyRolePolicy", &iam.RolePolicyArgs{ Policy: aWSCloudFormationStackSetAdministrationRoleExecutionPolicyPolicyDocument.ApplyT(func(aWSCloudFormationStackSetAdministrationRoleExecutionPolicyPolicyDocument iam.GetPolicyDocumentResult) (string, error) { return aWSCloudFormationStackSetAdministrationRoleExecutionPolicyPolicyDocument.Json, nil }).(pulumi.StringOutput), Role: aWSCloudFormationStackSetAdministrationRole.Name, }) if err != nil { return err } return nil }) }
```
## Import
CloudFormation StackSets can be imported using the `name`, e.g.,
```sh
$ pulumi import aws:cloudformation/stackSet:StackSet example example
```
func GetStackSet ¶
func GetStackSet(ctx *pulumi.Context, name string, id pulumi.IDInput, state *StackSetState, opts ...pulumi.ResourceOption) (*StackSet, error)
GetStackSet gets an existing StackSet resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).
func NewStackSet ¶
func NewStackSet(ctx *pulumi.Context, name string, args *StackSetArgs, opts ...pulumi.ResourceOption) (*StackSet, error)
NewStackSet registers a new resource with the given unique name, arguments, and options.
func (*StackSet) ElementType ¶
func (*StackSet) ToStackSetOutput ¶
func (i *StackSet) ToStackSetOutput() StackSetOutput
func (*StackSet) ToStackSetOutputWithContext ¶
func (i *StackSet) ToStackSetOutputWithContext(ctx context.Context) StackSetOutput
type StackSetArgs ¶
type StackSetArgs struct { // Amazon Resource Number (ARN) of the IAM Role in the administrator account. This must be defined when using the `SELF_MANAGED` permission model. AdministrationRoleArn pulumi.StringPtrInput // Configuration block containing the auto-deployment model for your StackSet. This can only be defined when using the `SERVICE_MANAGED` permission model. AutoDeployment StackSetAutoDeploymentPtrInput // A list of capabilities. Valid values: `CAPABILITY_IAM`, `CAPABILITY_NAMED_IAM`, `CAPABILITY_AUTO_EXPAND`. Capabilities pulumi.StringArrayInput // Description of the StackSet. Description pulumi.StringPtrInput // Name of the IAM Role in all target accounts for StackSet operations. Defaults to `AWSCloudFormationStackSetExecutionRole` when using the `SELF_MANAGED` permission model. This should not be defined when using the `SERVICE_MANAGED` permission model. ExecutionRoleName pulumi.StringPtrInput // Name of the StackSet. The name must be unique in the region where you create your StackSet. The name can contain only alphanumeric characters (case-sensitive) and hyphens. It must start with an alphabetic character and cannot be longer than 128 characters. Name pulumi.StringPtrInput // Key-value map of input parameters for the StackSet template. All template parameters, including those with a `Default`, must be configured or ignored with `lifecycle` configuration block `ignoreChanges` argument. All `NoEcho` template parameters must be ignored with the `lifecycle` configuration block `ignoreChanges` argument. Parameters pulumi.StringMapInput // Describes how the IAM roles required for your StackSet are created. Valid values: `SELF_MANAGED` (default), `SERVICE_MANAGED`. PermissionModel pulumi.StringPtrInput // Key-value map of tags to associate with this StackSet and the Stacks created from it. AWS CloudFormation also propagates these tags to supported resources that are created in the Stacks. A maximum number of 50 tags can be specified. .If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level. Tags pulumi.StringMapInput // String containing the CloudFormation template body. Maximum size: 51,200 bytes. Conflicts with `templateUrl`. TemplateBody pulumi.StringPtrInput // String containing the location of a file containing the CloudFormation template body. The URL must point to a template that is located in an Amazon S3 bucket. Maximum location file size: 460,800 bytes. Conflicts with `templateBody`. TemplateUrl pulumi.StringPtrInput }
The set of arguments for constructing a StackSet resource.
func (StackSetArgs) ElementType ¶
func (StackSetArgs) ElementType() reflect.Type
type StackSetArray ¶
type StackSetArray []StackSetInput
func (StackSetArray) ElementType ¶
func (StackSetArray) ElementType() reflect.Type
func (StackSetArray) ToStackSetArrayOutput ¶
func (i StackSetArray) ToStackSetArrayOutput() StackSetArrayOutput
func (StackSetArray) ToStackSetArrayOutputWithContext ¶
func (i StackSetArray) ToStackSetArrayOutputWithContext(ctx context.Context) StackSetArrayOutput
type StackSetArrayInput ¶
type StackSetArrayInput interface { pulumi.Input ToStackSetArrayOutput() StackSetArrayOutput ToStackSetArrayOutputWithContext(context.Context) StackSetArrayOutput }
StackSetArrayInput is an input type that accepts StackSetArray and StackSetArrayOutput values. You can construct a concrete instance of `StackSetArrayInput` via:
StackSetArray{ StackSetArgs{...} }
type StackSetArrayOutput ¶
type StackSetArrayOutput struct{ *pulumi.OutputState }
func (StackSetArrayOutput) ElementType ¶
func (StackSetArrayOutput) ElementType() reflect.Type
func (StackSetArrayOutput) Index ¶
func (o StackSetArrayOutput) Index(i pulumi.IntInput) StackSetOutput
func (StackSetArrayOutput) ToStackSetArrayOutput ¶
func (o StackSetArrayOutput) ToStackSetArrayOutput() StackSetArrayOutput
func (StackSetArrayOutput) ToStackSetArrayOutputWithContext ¶
func (o StackSetArrayOutput) ToStackSetArrayOutputWithContext(ctx context.Context) StackSetArrayOutput
type StackSetAutoDeployment ¶
type StackSetAutoDeploymentArgs ¶
type StackSetAutoDeploymentArgs struct { // Whether or not auto-deployment is enabled. Enabled pulumi.BoolPtrInput `pulumi:"enabled"` // Whether or not to retain stacks when the account is removed. RetainStacksOnAccountRemoval pulumi.BoolPtrInput `pulumi:"retainStacksOnAccountRemoval"` }
func (StackSetAutoDeploymentArgs) ElementType ¶
func (StackSetAutoDeploymentArgs) ElementType() reflect.Type
func (StackSetAutoDeploymentArgs) ToStackSetAutoDeploymentOutput ¶
func (i StackSetAutoDeploymentArgs) ToStackSetAutoDeploymentOutput() StackSetAutoDeploymentOutput
func (StackSetAutoDeploymentArgs) ToStackSetAutoDeploymentOutputWithContext ¶
func (i StackSetAutoDeploymentArgs) ToStackSetAutoDeploymentOutputWithContext(ctx context.Context) StackSetAutoDeploymentOutput
func (StackSetAutoDeploymentArgs) ToStackSetAutoDeploymentPtrOutput ¶
func (i StackSetAutoDeploymentArgs) ToStackSetAutoDeploymentPtrOutput() StackSetAutoDeploymentPtrOutput
func (StackSetAutoDeploymentArgs) ToStackSetAutoDeploymentPtrOutputWithContext ¶
func (i StackSetAutoDeploymentArgs) ToStackSetAutoDeploymentPtrOutputWithContext(ctx context.Context) StackSetAutoDeploymentPtrOutput
type StackSetAutoDeploymentInput ¶
type StackSetAutoDeploymentInput interface { pulumi.Input ToStackSetAutoDeploymentOutput() StackSetAutoDeploymentOutput ToStackSetAutoDeploymentOutputWithContext(context.Context) StackSetAutoDeploymentOutput }
StackSetAutoDeploymentInput is an input type that accepts StackSetAutoDeploymentArgs and StackSetAutoDeploymentOutput values. You can construct a concrete instance of `StackSetAutoDeploymentInput` via:
StackSetAutoDeploymentArgs{...}
type StackSetAutoDeploymentOutput ¶
type StackSetAutoDeploymentOutput struct{ *pulumi.OutputState }
func (StackSetAutoDeploymentOutput) ElementType ¶
func (StackSetAutoDeploymentOutput) ElementType() reflect.Type
func (StackSetAutoDeploymentOutput) Enabled ¶
func (o StackSetAutoDeploymentOutput) Enabled() pulumi.BoolPtrOutput
Whether or not auto-deployment is enabled.
func (StackSetAutoDeploymentOutput) RetainStacksOnAccountRemoval ¶
func (o StackSetAutoDeploymentOutput) RetainStacksOnAccountRemoval() pulumi.BoolPtrOutput
Whether or not to retain stacks when the account is removed.
func (StackSetAutoDeploymentOutput) ToStackSetAutoDeploymentOutput ¶
func (o StackSetAutoDeploymentOutput) ToStackSetAutoDeploymentOutput() StackSetAutoDeploymentOutput
func (StackSetAutoDeploymentOutput) ToStackSetAutoDeploymentOutputWithContext ¶
func (o StackSetAutoDeploymentOutput) ToStackSetAutoDeploymentOutputWithContext(ctx context.Context) StackSetAutoDeploymentOutput
func (StackSetAutoDeploymentOutput) ToStackSetAutoDeploymentPtrOutput ¶
func (o StackSetAutoDeploymentOutput) ToStackSetAutoDeploymentPtrOutput() StackSetAutoDeploymentPtrOutput
func (StackSetAutoDeploymentOutput) ToStackSetAutoDeploymentPtrOutputWithContext ¶
func (o StackSetAutoDeploymentOutput) ToStackSetAutoDeploymentPtrOutputWithContext(ctx context.Context) StackSetAutoDeploymentPtrOutput
type StackSetAutoDeploymentPtrInput ¶
type StackSetAutoDeploymentPtrInput interface { pulumi.Input ToStackSetAutoDeploymentPtrOutput() StackSetAutoDeploymentPtrOutput ToStackSetAutoDeploymentPtrOutputWithContext(context.Context) StackSetAutoDeploymentPtrOutput }
StackSetAutoDeploymentPtrInput is an input type that accepts StackSetAutoDeploymentArgs, StackSetAutoDeploymentPtr and StackSetAutoDeploymentPtrOutput values. You can construct a concrete instance of `StackSetAutoDeploymentPtrInput` via:
StackSetAutoDeploymentArgs{...} or: nil
func StackSetAutoDeploymentPtr ¶
func StackSetAutoDeploymentPtr(v *StackSetAutoDeploymentArgs) StackSetAutoDeploymentPtrInput
type StackSetAutoDeploymentPtrOutput ¶
type StackSetAutoDeploymentPtrOutput struct{ *pulumi.OutputState }
func (StackSetAutoDeploymentPtrOutput) Elem ¶
func (o StackSetAutoDeploymentPtrOutput) Elem() StackSetAutoDeploymentOutput
func (StackSetAutoDeploymentPtrOutput) ElementType ¶
func (StackSetAutoDeploymentPtrOutput) ElementType() reflect.Type
func (StackSetAutoDeploymentPtrOutput) Enabled ¶
func (o StackSetAutoDeploymentPtrOutput) Enabled() pulumi.BoolPtrOutput
Whether or not auto-deployment is enabled.
func (StackSetAutoDeploymentPtrOutput) RetainStacksOnAccountRemoval ¶
func (o StackSetAutoDeploymentPtrOutput) RetainStacksOnAccountRemoval() pulumi.BoolPtrOutput
Whether or not to retain stacks when the account is removed.
func (StackSetAutoDeploymentPtrOutput) ToStackSetAutoDeploymentPtrOutput ¶
func (o StackSetAutoDeploymentPtrOutput) ToStackSetAutoDeploymentPtrOutput() StackSetAutoDeploymentPtrOutput
func (StackSetAutoDeploymentPtrOutput) ToStackSetAutoDeploymentPtrOutputWithContext ¶
func (o StackSetAutoDeploymentPtrOutput) ToStackSetAutoDeploymentPtrOutputWithContext(ctx context.Context) StackSetAutoDeploymentPtrOutput
type StackSetInput ¶
type StackSetInput interface { pulumi.Input ToStackSetOutput() StackSetOutput ToStackSetOutputWithContext(ctx context.Context) StackSetOutput }
type StackSetInstance ¶
type StackSetInstance struct { pulumi.CustomResourceState // Target AWS Account ID to create a Stack based on the StackSet. Defaults to current account. AccountId pulumi.StringOutput `pulumi:"accountId"` // The AWS Organizations accounts to which StackSets deploys. StackSets doesn't deploy stack instances to the organization management account, even if the organization management account is in your organization or in an OU in your organization. Drift detection is not possible for this argument. See deploymentTargets below. DeploymentTargets StackSetInstanceDeploymentTargetsPtrOutput `pulumi:"deploymentTargets"` // The organization root ID or organizational unit (OU) IDs specified for `deploymentTargets`. OrganizationalUnitId pulumi.StringOutput `pulumi:"organizationalUnitId"` // Key-value map of input parameters to override from the StackSet for this Instance. ParameterOverrides pulumi.StringMapOutput `pulumi:"parameterOverrides"` // Target AWS Region to create a Stack based on the StackSet. Defaults to current region. Region pulumi.StringOutput `pulumi:"region"` // During resource destroy, remove Instance from StackSet while keeping the Stack and its associated resources. Must be enabled in the state _before_ destroy operation to take effect. You cannot reassociate a retained Stack or add an existing, saved Stack to a new StackSet. Defaults to `false`. RetainStack pulumi.BoolPtrOutput `pulumi:"retainStack"` // Stack identifier StackId pulumi.StringOutput `pulumi:"stackId"` // Name of the StackSet. StackSetName pulumi.StringOutput `pulumi:"stackSetName"` }
Manages a CloudFormation StackSet Instance. Instances are managed in the account and region of the StackSet after the target account permissions have been configured. Additional information about StackSets can be found in the [AWS CloudFormation User Guide](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/what-is-cfnstacksets.html).
> **NOTE:** All target accounts must have an IAM Role created that matches the name of the execution role configured in the StackSet (the `executionRoleName` argument in the `cloudformation.StackSet` resource) in a trust relationship with the administrative account or administration IAM Role. The execution role must have appropriate permissions to manage resources defined in the template along with those required for StackSets to operate. See the [AWS CloudFormation User Guide](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-prereqs.html) for more details.
> **NOTE:** To retain the Stack during resource destroy, ensure `retainStack` has been set to `true` in the state first. This must be completed _before_ a deployment that would destroy the resource.
## Example Usage
```go package main
import (
"github.com/pulumi/pulumi-aws/sdk/v4/go/aws/cloudformation" "github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() { pulumi.Run(func(ctx *pulumi.Context) error { _, err := cloudformation.NewStackSetInstance(ctx, "example", &cloudformation.StackSetInstanceArgs{ AccountId: pulumi.String("123456789012"), Region: pulumi.String("us-east-1"), StackSetName: pulumi.Any(aws_cloudformation_stack_set.Example.Name), }) if err != nil { return err } return nil }) }
``` ### Example Deployment across Organizations account
```go package main
import (
"github.com/pulumi/pulumi-aws/sdk/v4/go/aws/cloudformation" "github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() { pulumi.Run(func(ctx *pulumi.Context) error { _, err := cloudformation.NewStackSetInstance(ctx, "example", &cloudformation.StackSetInstanceArgs{ DeploymentTargets: &cloudformation.StackSetInstanceDeploymentTargetsArgs{ OrganizationalUnitIds: pulumi.StringArray{ pulumi.Any(aws_organizations_organization.Example.Roots[0].Id), }, }, Region: pulumi.String("us-east-1"), StackSetName: pulumi.Any(aws_cloudformation_stack_set.Example.Name), }) if err != nil { return err } return nil }) }
```
## Import
CloudFormation StackSet Instances can be imported using the StackSet name, target AWS account ID, and target AWS region separated by commas (`,`) e.g.,
```sh
$ pulumi import aws:cloudformation/stackSetInstance:StackSetInstance example example,123456789012,us-east-1
```
func GetStackSetInstance ¶
func GetStackSetInstance(ctx *pulumi.Context, name string, id pulumi.IDInput, state *StackSetInstanceState, opts ...pulumi.ResourceOption) (*StackSetInstance, error)
GetStackSetInstance gets an existing StackSetInstance resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).
func NewStackSetInstance ¶
func NewStackSetInstance(ctx *pulumi.Context, name string, args *StackSetInstanceArgs, opts ...pulumi.ResourceOption) (*StackSetInstance, error)
NewStackSetInstance registers a new resource with the given unique name, arguments, and options.
func (*StackSetInstance) ElementType ¶
func (*StackSetInstance) ElementType() reflect.Type
func (*StackSetInstance) ToStackSetInstanceOutput ¶
func (i *StackSetInstance) ToStackSetInstanceOutput() StackSetInstanceOutput
func (*StackSetInstance) ToStackSetInstanceOutputWithContext ¶
func (i *StackSetInstance) ToStackSetInstanceOutputWithContext(ctx context.Context) StackSetInstanceOutput
type StackSetInstanceArgs ¶
type StackSetInstanceArgs struct { // Target AWS Account ID to create a Stack based on the StackSet. Defaults to current account. AccountId pulumi.StringPtrInput // The AWS Organizations accounts to which StackSets deploys. StackSets doesn't deploy stack instances to the organization management account, even if the organization management account is in your organization or in an OU in your organization. Drift detection is not possible for this argument. See deploymentTargets below. DeploymentTargets StackSetInstanceDeploymentTargetsPtrInput // Key-value map of input parameters to override from the StackSet for this Instance. ParameterOverrides pulumi.StringMapInput // Target AWS Region to create a Stack based on the StackSet. Defaults to current region. Region pulumi.StringPtrInput // During resource destroy, remove Instance from StackSet while keeping the Stack and its associated resources. Must be enabled in the state _before_ destroy operation to take effect. You cannot reassociate a retained Stack or add an existing, saved Stack to a new StackSet. Defaults to `false`. RetainStack pulumi.BoolPtrInput // Name of the StackSet. StackSetName pulumi.StringInput }
The set of arguments for constructing a StackSetInstance resource.
func (StackSetInstanceArgs) ElementType ¶
func (StackSetInstanceArgs) ElementType() reflect.Type
type StackSetInstanceArray ¶
type StackSetInstanceArray []StackSetInstanceInput
func (StackSetInstanceArray) ElementType ¶
func (StackSetInstanceArray) ElementType() reflect.Type
func (StackSetInstanceArray) ToStackSetInstanceArrayOutput ¶
func (i StackSetInstanceArray) ToStackSetInstanceArrayOutput() StackSetInstanceArrayOutput
func (StackSetInstanceArray) ToStackSetInstanceArrayOutputWithContext ¶
func (i StackSetInstanceArray) ToStackSetInstanceArrayOutputWithContext(ctx context.Context) StackSetInstanceArrayOutput
type StackSetInstanceArrayInput ¶
type StackSetInstanceArrayInput interface { pulumi.Input ToStackSetInstanceArrayOutput() StackSetInstanceArrayOutput ToStackSetInstanceArrayOutputWithContext(context.Context) StackSetInstanceArrayOutput }
StackSetInstanceArrayInput is an input type that accepts StackSetInstanceArray and StackSetInstanceArrayOutput values. You can construct a concrete instance of `StackSetInstanceArrayInput` via:
StackSetInstanceArray{ StackSetInstanceArgs{...} }
type StackSetInstanceArrayOutput ¶
type StackSetInstanceArrayOutput struct{ *pulumi.OutputState }
func (StackSetInstanceArrayOutput) ElementType ¶
func (StackSetInstanceArrayOutput) ElementType() reflect.Type
func (StackSetInstanceArrayOutput) Index ¶
func (o StackSetInstanceArrayOutput) Index(i pulumi.IntInput) StackSetInstanceOutput
func (StackSetInstanceArrayOutput) ToStackSetInstanceArrayOutput ¶
func (o StackSetInstanceArrayOutput) ToStackSetInstanceArrayOutput() StackSetInstanceArrayOutput
func (StackSetInstanceArrayOutput) ToStackSetInstanceArrayOutputWithContext ¶
func (o StackSetInstanceArrayOutput) ToStackSetInstanceArrayOutputWithContext(ctx context.Context) StackSetInstanceArrayOutput
type StackSetInstanceDeploymentTargets ¶ added in v4.24.0
type StackSetInstanceDeploymentTargets struct {
OrganizationalUnitIds []string `pulumi:"organizationalUnitIds"`
}
type StackSetInstanceDeploymentTargetsArgs ¶ added in v4.24.0
type StackSetInstanceDeploymentTargetsArgs struct {
OrganizationalUnitIds pulumi.StringArrayInput `pulumi:"organizationalUnitIds"`
}
func (StackSetInstanceDeploymentTargetsArgs) ElementType ¶ added in v4.24.0
func (StackSetInstanceDeploymentTargetsArgs) ElementType() reflect.Type
func (StackSetInstanceDeploymentTargetsArgs) ToStackSetInstanceDeploymentTargetsOutput ¶ added in v4.24.0
func (i StackSetInstanceDeploymentTargetsArgs) ToStackSetInstanceDeploymentTargetsOutput() StackSetInstanceDeploymentTargetsOutput
func (StackSetInstanceDeploymentTargetsArgs) ToStackSetInstanceDeploymentTargetsOutputWithContext ¶ added in v4.24.0
func (i StackSetInstanceDeploymentTargetsArgs) ToStackSetInstanceDeploymentTargetsOutputWithContext(ctx context.Context) StackSetInstanceDeploymentTargetsOutput
func (StackSetInstanceDeploymentTargetsArgs) ToStackSetInstanceDeploymentTargetsPtrOutput ¶ added in v4.24.0
func (i StackSetInstanceDeploymentTargetsArgs) ToStackSetInstanceDeploymentTargetsPtrOutput() StackSetInstanceDeploymentTargetsPtrOutput
func (StackSetInstanceDeploymentTargetsArgs) ToStackSetInstanceDeploymentTargetsPtrOutputWithContext ¶ added in v4.24.0
func (i StackSetInstanceDeploymentTargetsArgs) ToStackSetInstanceDeploymentTargetsPtrOutputWithContext(ctx context.Context) StackSetInstanceDeploymentTargetsPtrOutput
type StackSetInstanceDeploymentTargetsInput ¶ added in v4.24.0
type StackSetInstanceDeploymentTargetsInput interface { pulumi.Input ToStackSetInstanceDeploymentTargetsOutput() StackSetInstanceDeploymentTargetsOutput ToStackSetInstanceDeploymentTargetsOutputWithContext(context.Context) StackSetInstanceDeploymentTargetsOutput }
StackSetInstanceDeploymentTargetsInput is an input type that accepts StackSetInstanceDeploymentTargetsArgs and StackSetInstanceDeploymentTargetsOutput values. You can construct a concrete instance of `StackSetInstanceDeploymentTargetsInput` via:
StackSetInstanceDeploymentTargetsArgs{...}
type StackSetInstanceDeploymentTargetsOutput ¶ added in v4.24.0
type StackSetInstanceDeploymentTargetsOutput struct{ *pulumi.OutputState }
func (StackSetInstanceDeploymentTargetsOutput) ElementType ¶ added in v4.24.0
func (StackSetInstanceDeploymentTargetsOutput) ElementType() reflect.Type
func (StackSetInstanceDeploymentTargetsOutput) OrganizationalUnitIds ¶ added in v4.24.0
func (o StackSetInstanceDeploymentTargetsOutput) OrganizationalUnitIds() pulumi.StringArrayOutput
func (StackSetInstanceDeploymentTargetsOutput) ToStackSetInstanceDeploymentTargetsOutput ¶ added in v4.24.0
func (o StackSetInstanceDeploymentTargetsOutput) ToStackSetInstanceDeploymentTargetsOutput() StackSetInstanceDeploymentTargetsOutput
func (StackSetInstanceDeploymentTargetsOutput) ToStackSetInstanceDeploymentTargetsOutputWithContext ¶ added in v4.24.0
func (o StackSetInstanceDeploymentTargetsOutput) ToStackSetInstanceDeploymentTargetsOutputWithContext(ctx context.Context) StackSetInstanceDeploymentTargetsOutput
func (StackSetInstanceDeploymentTargetsOutput) ToStackSetInstanceDeploymentTargetsPtrOutput ¶ added in v4.24.0
func (o StackSetInstanceDeploymentTargetsOutput) ToStackSetInstanceDeploymentTargetsPtrOutput() StackSetInstanceDeploymentTargetsPtrOutput
func (StackSetInstanceDeploymentTargetsOutput) ToStackSetInstanceDeploymentTargetsPtrOutputWithContext ¶ added in v4.24.0
func (o StackSetInstanceDeploymentTargetsOutput) ToStackSetInstanceDeploymentTargetsPtrOutputWithContext(ctx context.Context) StackSetInstanceDeploymentTargetsPtrOutput
type StackSetInstanceDeploymentTargetsPtrInput ¶ added in v4.24.0
type StackSetInstanceDeploymentTargetsPtrInput interface { pulumi.Input ToStackSetInstanceDeploymentTargetsPtrOutput() StackSetInstanceDeploymentTargetsPtrOutput ToStackSetInstanceDeploymentTargetsPtrOutputWithContext(context.Context) StackSetInstanceDeploymentTargetsPtrOutput }
StackSetInstanceDeploymentTargetsPtrInput is an input type that accepts StackSetInstanceDeploymentTargetsArgs, StackSetInstanceDeploymentTargetsPtr and StackSetInstanceDeploymentTargetsPtrOutput values. You can construct a concrete instance of `StackSetInstanceDeploymentTargetsPtrInput` via:
StackSetInstanceDeploymentTargetsArgs{...} or: nil
func StackSetInstanceDeploymentTargetsPtr ¶ added in v4.24.0
func StackSetInstanceDeploymentTargetsPtr(v *StackSetInstanceDeploymentTargetsArgs) StackSetInstanceDeploymentTargetsPtrInput
type StackSetInstanceDeploymentTargetsPtrOutput ¶ added in v4.24.0
type StackSetInstanceDeploymentTargetsPtrOutput struct{ *pulumi.OutputState }
func (StackSetInstanceDeploymentTargetsPtrOutput) ElementType ¶ added in v4.24.0
func (StackSetInstanceDeploymentTargetsPtrOutput) ElementType() reflect.Type
func (StackSetInstanceDeploymentTargetsPtrOutput) OrganizationalUnitIds ¶ added in v4.24.0
func (o StackSetInstanceDeploymentTargetsPtrOutput) OrganizationalUnitIds() pulumi.StringArrayOutput
func (StackSetInstanceDeploymentTargetsPtrOutput) ToStackSetInstanceDeploymentTargetsPtrOutput ¶ added in v4.24.0
func (o StackSetInstanceDeploymentTargetsPtrOutput) ToStackSetInstanceDeploymentTargetsPtrOutput() StackSetInstanceDeploymentTargetsPtrOutput
func (StackSetInstanceDeploymentTargetsPtrOutput) ToStackSetInstanceDeploymentTargetsPtrOutputWithContext ¶ added in v4.24.0
func (o StackSetInstanceDeploymentTargetsPtrOutput) ToStackSetInstanceDeploymentTargetsPtrOutputWithContext(ctx context.Context) StackSetInstanceDeploymentTargetsPtrOutput
type StackSetInstanceInput ¶
type StackSetInstanceInput interface { pulumi.Input ToStackSetInstanceOutput() StackSetInstanceOutput ToStackSetInstanceOutputWithContext(ctx context.Context) StackSetInstanceOutput }
type StackSetInstanceMap ¶
type StackSetInstanceMap map[string]StackSetInstanceInput
func (StackSetInstanceMap) ElementType ¶
func (StackSetInstanceMap) ElementType() reflect.Type
func (StackSetInstanceMap) ToStackSetInstanceMapOutput ¶
func (i StackSetInstanceMap) ToStackSetInstanceMapOutput() StackSetInstanceMapOutput
func (StackSetInstanceMap) ToStackSetInstanceMapOutputWithContext ¶
func (i StackSetInstanceMap) ToStackSetInstanceMapOutputWithContext(ctx context.Context) StackSetInstanceMapOutput
type StackSetInstanceMapInput ¶
type StackSetInstanceMapInput interface { pulumi.Input ToStackSetInstanceMapOutput() StackSetInstanceMapOutput ToStackSetInstanceMapOutputWithContext(context.Context) StackSetInstanceMapOutput }
StackSetInstanceMapInput is an input type that accepts StackSetInstanceMap and StackSetInstanceMapOutput values. You can construct a concrete instance of `StackSetInstanceMapInput` via:
StackSetInstanceMap{ "key": StackSetInstanceArgs{...} }
type StackSetInstanceMapOutput ¶
type StackSetInstanceMapOutput struct{ *pulumi.OutputState }
func (StackSetInstanceMapOutput) ElementType ¶
func (StackSetInstanceMapOutput) ElementType() reflect.Type
func (StackSetInstanceMapOutput) MapIndex ¶
func (o StackSetInstanceMapOutput) MapIndex(k pulumi.StringInput) StackSetInstanceOutput
func (StackSetInstanceMapOutput) ToStackSetInstanceMapOutput ¶
func (o StackSetInstanceMapOutput) ToStackSetInstanceMapOutput() StackSetInstanceMapOutput
func (StackSetInstanceMapOutput) ToStackSetInstanceMapOutputWithContext ¶
func (o StackSetInstanceMapOutput) ToStackSetInstanceMapOutputWithContext(ctx context.Context) StackSetInstanceMapOutput
type StackSetInstanceOutput ¶
type StackSetInstanceOutput struct{ *pulumi.OutputState }
func (StackSetInstanceOutput) ElementType ¶
func (StackSetInstanceOutput) ElementType() reflect.Type
func (StackSetInstanceOutput) ToStackSetInstanceOutput ¶
func (o StackSetInstanceOutput) ToStackSetInstanceOutput() StackSetInstanceOutput
func (StackSetInstanceOutput) ToStackSetInstanceOutputWithContext ¶
func (o StackSetInstanceOutput) ToStackSetInstanceOutputWithContext(ctx context.Context) StackSetInstanceOutput
type StackSetInstanceState ¶
type StackSetInstanceState struct { // Target AWS Account ID to create a Stack based on the StackSet. Defaults to current account. AccountId pulumi.StringPtrInput // The AWS Organizations accounts to which StackSets deploys. StackSets doesn't deploy stack instances to the organization management account, even if the organization management account is in your organization or in an OU in your organization. Drift detection is not possible for this argument. See deploymentTargets below. DeploymentTargets StackSetInstanceDeploymentTargetsPtrInput // The organization root ID or organizational unit (OU) IDs specified for `deploymentTargets`. OrganizationalUnitId pulumi.StringPtrInput // Key-value map of input parameters to override from the StackSet for this Instance. ParameterOverrides pulumi.StringMapInput // Target AWS Region to create a Stack based on the StackSet. Defaults to current region. Region pulumi.StringPtrInput // During resource destroy, remove Instance from StackSet while keeping the Stack and its associated resources. Must be enabled in the state _before_ destroy operation to take effect. You cannot reassociate a retained Stack or add an existing, saved Stack to a new StackSet. Defaults to `false`. RetainStack pulumi.BoolPtrInput // Stack identifier StackId pulumi.StringPtrInput // Name of the StackSet. StackSetName pulumi.StringPtrInput }
func (StackSetInstanceState) ElementType ¶
func (StackSetInstanceState) ElementType() reflect.Type
type StackSetMap ¶
type StackSetMap map[string]StackSetInput
func (StackSetMap) ElementType ¶
func (StackSetMap) ElementType() reflect.Type
func (StackSetMap) ToStackSetMapOutput ¶
func (i StackSetMap) ToStackSetMapOutput() StackSetMapOutput
func (StackSetMap) ToStackSetMapOutputWithContext ¶
func (i StackSetMap) ToStackSetMapOutputWithContext(ctx context.Context) StackSetMapOutput
type StackSetMapInput ¶
type StackSetMapInput interface { pulumi.Input ToStackSetMapOutput() StackSetMapOutput ToStackSetMapOutputWithContext(context.Context) StackSetMapOutput }
StackSetMapInput is an input type that accepts StackSetMap and StackSetMapOutput values. You can construct a concrete instance of `StackSetMapInput` via:
StackSetMap{ "key": StackSetArgs{...} }
type StackSetMapOutput ¶
type StackSetMapOutput struct{ *pulumi.OutputState }
func (StackSetMapOutput) ElementType ¶
func (StackSetMapOutput) ElementType() reflect.Type
func (StackSetMapOutput) MapIndex ¶
func (o StackSetMapOutput) MapIndex(k pulumi.StringInput) StackSetOutput
func (StackSetMapOutput) ToStackSetMapOutput ¶
func (o StackSetMapOutput) ToStackSetMapOutput() StackSetMapOutput
func (StackSetMapOutput) ToStackSetMapOutputWithContext ¶
func (o StackSetMapOutput) ToStackSetMapOutputWithContext(ctx context.Context) StackSetMapOutput
type StackSetOutput ¶
type StackSetOutput struct{ *pulumi.OutputState }
func (StackSetOutput) ElementType ¶
func (StackSetOutput) ElementType() reflect.Type
func (StackSetOutput) ToStackSetOutput ¶
func (o StackSetOutput) ToStackSetOutput() StackSetOutput
func (StackSetOutput) ToStackSetOutputWithContext ¶
func (o StackSetOutput) ToStackSetOutputWithContext(ctx context.Context) StackSetOutput
type StackSetState ¶
type StackSetState struct { // Amazon Resource Number (ARN) of the IAM Role in the administrator account. This must be defined when using the `SELF_MANAGED` permission model. AdministrationRoleArn pulumi.StringPtrInput // Amazon Resource Name (ARN) of the StackSet. Arn pulumi.StringPtrInput // Configuration block containing the auto-deployment model for your StackSet. This can only be defined when using the `SERVICE_MANAGED` permission model. AutoDeployment StackSetAutoDeploymentPtrInput // A list of capabilities. Valid values: `CAPABILITY_IAM`, `CAPABILITY_NAMED_IAM`, `CAPABILITY_AUTO_EXPAND`. Capabilities pulumi.StringArrayInput // Description of the StackSet. Description pulumi.StringPtrInput // Name of the IAM Role in all target accounts for StackSet operations. Defaults to `AWSCloudFormationStackSetExecutionRole` when using the `SELF_MANAGED` permission model. This should not be defined when using the `SERVICE_MANAGED` permission model. ExecutionRoleName pulumi.StringPtrInput // Name of the StackSet. The name must be unique in the region where you create your StackSet. The name can contain only alphanumeric characters (case-sensitive) and hyphens. It must start with an alphabetic character and cannot be longer than 128 characters. Name pulumi.StringPtrInput // Key-value map of input parameters for the StackSet template. All template parameters, including those with a `Default`, must be configured or ignored with `lifecycle` configuration block `ignoreChanges` argument. All `NoEcho` template parameters must be ignored with the `lifecycle` configuration block `ignoreChanges` argument. Parameters pulumi.StringMapInput // Describes how the IAM roles required for your StackSet are created. Valid values: `SELF_MANAGED` (default), `SERVICE_MANAGED`. PermissionModel pulumi.StringPtrInput // Unique identifier of the StackSet. StackSetId pulumi.StringPtrInput // Key-value map of tags to associate with this StackSet and the Stacks created from it. AWS CloudFormation also propagates these tags to supported resources that are created in the Stacks. A maximum number of 50 tags can be specified. .If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level. Tags pulumi.StringMapInput // A map of tags assigned to the resource, including those inherited from the provider . TagsAll pulumi.StringMapInput // String containing the CloudFormation template body. Maximum size: 51,200 bytes. Conflicts with `templateUrl`. TemplateBody pulumi.StringPtrInput // String containing the location of a file containing the CloudFormation template body. The URL must point to a template that is located in an Amazon S3 bucket. Maximum location file size: 460,800 bytes. Conflicts with `templateBody`. TemplateUrl pulumi.StringPtrInput }
func (StackSetState) ElementType ¶
func (StackSetState) ElementType() reflect.Type
type StackState ¶
type StackState struct { // A list of capabilities. // Valid values: `CAPABILITY_IAM`, `CAPABILITY_NAMED_IAM`, or `CAPABILITY_AUTO_EXPAND` Capabilities pulumi.StringArrayInput // Set to true to disable rollback of the stack if stack creation failed. // Conflicts with `onFailure`. DisableRollback pulumi.BoolPtrInput // 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. IamRoleArn pulumi.StringPtrInput // Stack name. Name pulumi.StringPtrInput // A list of SNS topic ARNs to publish stack related events. NotificationArns pulumi.StringArrayInput // Action to be taken if stack creation fails. This must be // one of: `DO_NOTHING`, `ROLLBACK`, or `DELETE`. Conflicts with `disableRollback`. OnFailure pulumi.StringPtrInput // A map of outputs from the stack. Outputs pulumi.StringMapInput // A map of Parameter structures that specify input parameters for the stack. Parameters pulumi.StringMapInput // Structure containing the stack policy body. // Conflicts w/ `policyUrl`. PolicyBody pulumi.StringPtrInput // Location of a file containing the stack policy. // Conflicts w/ `policyBody`. PolicyUrl pulumi.StringPtrInput // Map of resource tags to associate with this stack. .If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level. Tags pulumi.StringMapInput // A map of tags assigned to the resource, including those inherited from the provider . TagsAll pulumi.StringMapInput // Structure containing the template body (max size: 51,200 bytes). TemplateBody pulumi.StringPtrInput // Location of a file containing the template body (max size: 460,800 bytes). TemplateUrl pulumi.StringPtrInput // The amount of time that can pass before the stack status becomes `CREATE_FAILED`. TimeoutInMinutes pulumi.IntPtrInput }
func (StackState) ElementType ¶
func (StackState) ElementType() reflect.Type