Please wait. This can take some minutes ...
Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $
You can buy this project and download/modify it how often you want.
com.pulumi.awsnative.cloudformation.kotlin.StackArgs.kt Maven / Gradle / Ivy
@file:Suppress("NAME_SHADOWING", "DEPRECATION")
package com.pulumi.awsnative.cloudformation.kotlin
import com.pulumi.awsnative.cloudformation.StackArgs.builder
import com.pulumi.awsnative.cloudformation.kotlin.enums.StackCapabilitiesItem
import com.pulumi.awsnative.kotlin.inputs.TagArgs
import com.pulumi.awsnative.kotlin.inputs.TagArgsBuilder
import com.pulumi.core.Output
import com.pulumi.core.Output.of
import com.pulumi.kotlin.ConvertibleToJava
import com.pulumi.kotlin.PulumiTagMarker
import com.pulumi.kotlin.applySuspend
import kotlin.Any
import kotlin.Boolean
import kotlin.Int
import kotlin.Pair
import kotlin.String
import kotlin.Suppress
import kotlin.Unit
import kotlin.collections.List
import kotlin.collections.Map
import kotlin.jvm.JvmName
/**
* The AWS::CloudFormation::Stack resource nests a stack as a resource in a top-level template.
* @property capabilities In some cases, you must explicitly acknowledge that your stack template contains certain capabilities in order for AWS CloudFormation to create the stack.
* - `CAPABILITY_IAM` and `CAPABILITY_NAMED_IAM`
* Some stack templates might include resources that can affect permissions in your AWS account ; for example, by creating new AWS Identity and Access Management (IAM) users. For those stacks, you must explicitly acknowledge this by specifying one of these capabilities.
* The following IAM resources require you to specify either the `CAPABILITY_IAM` or `CAPABILITY_NAMED_IAM` capability.
* - If you have IAM resources, you can specify either capability.
* - If you have IAM resources with custom names, you *must* specify `CAPABILITY_NAMED_IAM` .
* - If you don't specify either of these capabilities, AWS CloudFormation returns an `InsufficientCapabilities` error.
* If your stack template contains these resources, we recommend that you review all permissions associated with them and edit their permissions if necessary.
* - [`AWS::IAM::AccessKey`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-accesskey.html)
* - [`AWS::IAM::Group`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-group.html)
* - [`AWS::IAM::InstanceProfile`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-instanceprofile.html)
* - [`AWS::IAM::Policy`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-policy.html)
* - [`AWS::IAM::Role`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-role.html)
* - [`AWS::IAM::User`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-user.html)
* - [`AWS::IAM::UserToGroupAddition`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-addusertogroup.html)
* For more information, see [Acknowledging IAM Resources in AWS CloudFormation Templates](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#capabilities) .
* - `CAPABILITY_AUTO_EXPAND`
* Some template contain macros. Macros perform custom processing on templates; this can include simple actions like find-and-replace operations, all the way to extensive transformations of entire templates. Because of this, users typically create a change set from the processed template, so that they can review the changes resulting from the macros before actually creating the stack. If your stack template contains one or more macros, and you choose to create a stack directly from the processed template, without first reviewing the resulting changes in a change set, you must acknowledge this capability. This includes the [AWS::Include](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/create-reusable-transform-function-snippets-and-add-to-your-template-with-aws-include-transform.html) and [AWS::Serverless](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/transform-aws-serverless.html) transforms, which are macros hosted by AWS CloudFormation .
* If you want to create a stack from a stack template that contains macros *and* nested stacks, you must create the stack directly from the template using this capability.
* > You should only create stacks directly from a stack template that contains macros if you know what processing the macro performs.
* >
* > Each macro relies on an underlying Lambda service function for processing stack templates. Be aware that the Lambda function owner can update the function operation without AWS CloudFormation being notified.
* For more information, see [Using AWS CloudFormation macros to perform custom processing on templates](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-macros.html) .
* @property description A user-defined description associated with the stack.
* @property disableRollback Set to `true` to disable rollback of the stack if stack creation failed. You can specify either `DisableRollback` or `OnFailure` , but not both.
* Default: `false`
* @property enableTerminationProtection Whether to enable termination protection on the specified stack. If a user attempts to delete a stack with termination protection enabled, the operation fails and the stack remains unchanged. For more information, see [Protecting a Stack From Being Deleted](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-protect-stacks.html) in the *AWS CloudFormation User Guide* . Termination protection is deactivated on stacks by default.
* For [nested stacks](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-nested-stacks.html) , termination protection is set on the root stack and can't be changed directly on the nested stack.
* @property notificationArns The Amazon SNS topic ARNs to publish stack related events. You can find your Amazon SNS topic ARNs using the Amazon SNS console or your Command Line Interface (CLI).
* @property parameters The set value pairs that represent the parameters passed to CloudFormation when this nested stack is created. Each parameter has a name corresponding to a parameter defined in the embedded template and a value representing the value that you want to set for the parameter.
* > If you use the `Ref` function to pass a parameter value to a nested stack, comma-delimited list parameters must be of type `String` . In other words, you can't pass values that are of type `CommaDelimitedList` to nested stacks.
* Conditional. Required if the nested stack requires input parameters.
* Whether an update causes interruptions depends on the resources that are being updated. An update never causes a nested stack to be replaced.
* @property roleArn The Amazon Resource Name (ARN) of an AWS Identity and Access Management (IAM) role that AWS CloudFormation assumes to create the stack. AWS CloudFormation uses the role's credentials to make calls on your behalf. AWS CloudFormation always uses this role for all future operations on the stack. Provided that users have permission to operate on the stack, AWS CloudFormation uses this role even if the users don't have permission to pass it. Ensure that the role grants least privilege.
* 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's generated from your user credentials.
* @property stackName The name that's associated with the stack. The name must be unique in the Region in which you are creating the stack.
* > A stack name can contain only alphanumeric characters (case sensitive) and hyphens. It must start with an alphabetical character and can't be longer than 128 characters.
* @property stackPolicyBody Structure containing the stack policy body. For more information, go to [Prevent Updates to Stack Resources](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/protect-stack-resources.html) in the *AWS CloudFormation User Guide* . You can specify either the `StackPolicyBody` or the `StackPolicyURL` parameter, but not both.
* Search the [CloudFormation User Guide](https://docs.aws.amazon.com/cloudformation/) for `AWS::CloudFormation::Stack` for more information about the expected schema for this property.
* @property stackPolicyUrl Location of a file containing the stack policy. The URL must point to a policy (maximum size: 16 KB) located in an S3 bucket in the same Region as the stack. You can specify either the `StackPolicyBody` or the `StackPolicyURL` parameter, but not both.
* @property stackStatusReason Success/failure message associated with the stack status.
* @property tags Key-value pairs to associate with this stack. CloudFormation also propagates these tags to the resources created in the stack. A maximum number of 50 tags can be specified.
* @property templateBody Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes. For more information, go to [Template anatomy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html) in the AWS CloudFormation User Guide.
* Conditional: You must specify either the `TemplateBody` or the `TemplateURL` parameter, but not both.
* Search the [CloudFormation User Guide](https://docs.aws.amazon.com/cloudformation/) for `AWS::CloudFormation::Stack` for more information about the expected schema for this property.
* @property templateUrl Location of file containing the template body. The URL must point to a template (max size: 460,800 bytes) that's located in an Amazon S3 bucket. For more information, see [Template anatomy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html) .
* Whether an update causes interruptions depends on the resources that are being updated. An update never causes a nested stack to be replaced.
* @property timeoutInMinutes The length of time, in minutes, that CloudFormation waits for the nested stack to reach the `CREATE_COMPLETE` state. The default is no timeout. When CloudFormation detects that the nested stack has reached the `CREATE_COMPLETE` state, it marks the nested stack resource as `CREATE_COMPLETE` in the parent stack and resumes creating the parent stack. If the timeout period expires before the nested stack reaches `CREATE_COMPLETE` , CloudFormation marks the nested stack as failed and rolls back both the nested stack and parent stack.
* Updates aren't supported.
*/
public data class StackArgs(
public val capabilities: Output>? = null,
public val description: Output? = null,
public val disableRollback: Output? = null,
public val enableTerminationProtection: Output? = null,
public val notificationArns: Output>? = null,
public val parameters: Output>? = null,
public val roleArn: Output? = null,
public val stackName: Output? = null,
public val stackPolicyBody: Output? = null,
public val stackPolicyUrl: Output? = null,
public val stackStatusReason: Output? = null,
public val tags: Output>? = null,
public val templateBody: Output? = null,
public val templateUrl: Output? = null,
public val timeoutInMinutes: Output? = null,
) : ConvertibleToJava {
override fun toJava(): com.pulumi.awsnative.cloudformation.StackArgs =
com.pulumi.awsnative.cloudformation.StackArgs.builder()
.capabilities(
capabilities?.applyValue({ args0 ->
args0.map({ args0 ->
args0.let({ args0 ->
args0.toJava()
})
})
}),
)
.description(description?.applyValue({ args0 -> args0 }))
.disableRollback(disableRollback?.applyValue({ args0 -> args0 }))
.enableTerminationProtection(enableTerminationProtection?.applyValue({ args0 -> args0 }))
.notificationArns(notificationArns?.applyValue({ args0 -> args0.map({ args0 -> args0 }) }))
.parameters(
parameters?.applyValue({ args0 ->
args0.map({ args0 ->
args0.key.to(args0.value)
}).toMap()
}),
)
.roleArn(roleArn?.applyValue({ args0 -> args0 }))
.stackName(stackName?.applyValue({ args0 -> args0 }))
.stackPolicyBody(stackPolicyBody?.applyValue({ args0 -> args0 }))
.stackPolicyUrl(stackPolicyUrl?.applyValue({ args0 -> args0 }))
.stackStatusReason(stackStatusReason?.applyValue({ args0 -> args0 }))
.tags(tags?.applyValue({ args0 -> args0.map({ args0 -> args0.let({ args0 -> args0.toJava() }) }) }))
.templateBody(templateBody?.applyValue({ args0 -> args0 }))
.templateUrl(templateUrl?.applyValue({ args0 -> args0 }))
.timeoutInMinutes(timeoutInMinutes?.applyValue({ args0 -> args0 })).build()
}
/**
* Builder for [StackArgs].
*/
@PulumiTagMarker
public class StackArgsBuilder internal constructor() {
private var capabilities: Output>? = null
private var description: Output? = null
private var disableRollback: Output? = null
private var enableTerminationProtection: Output? = null
private var notificationArns: Output>? = null
private var parameters: Output>? = null
private var roleArn: Output? = null
private var stackName: Output? = null
private var stackPolicyBody: Output? = null
private var stackPolicyUrl: Output? = null
private var stackStatusReason: Output? = null
private var tags: Output>? = null
private var templateBody: Output? = null
private var templateUrl: Output? = null
private var timeoutInMinutes: Output? = null
/**
* @param value In some cases, you must explicitly acknowledge that your stack template contains certain capabilities in order for AWS CloudFormation to create the stack.
* - `CAPABILITY_IAM` and `CAPABILITY_NAMED_IAM`
* Some stack templates might include resources that can affect permissions in your AWS account ; for example, by creating new AWS Identity and Access Management (IAM) users. For those stacks, you must explicitly acknowledge this by specifying one of these capabilities.
* The following IAM resources require you to specify either the `CAPABILITY_IAM` or `CAPABILITY_NAMED_IAM` capability.
* - If you have IAM resources, you can specify either capability.
* - If you have IAM resources with custom names, you *must* specify `CAPABILITY_NAMED_IAM` .
* - If you don't specify either of these capabilities, AWS CloudFormation returns an `InsufficientCapabilities` error.
* If your stack template contains these resources, we recommend that you review all permissions associated with them and edit their permissions if necessary.
* - [`AWS::IAM::AccessKey`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-accesskey.html)
* - [`AWS::IAM::Group`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-group.html)
* - [`AWS::IAM::InstanceProfile`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-instanceprofile.html)
* - [`AWS::IAM::Policy`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-policy.html)
* - [`AWS::IAM::Role`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-role.html)
* - [`AWS::IAM::User`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-user.html)
* - [`AWS::IAM::UserToGroupAddition`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-addusertogroup.html)
* For more information, see [Acknowledging IAM Resources in AWS CloudFormation Templates](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#capabilities) .
* - `CAPABILITY_AUTO_EXPAND`
* Some template contain macros. Macros perform custom processing on templates; this can include simple actions like find-and-replace operations, all the way to extensive transformations of entire templates. Because of this, users typically create a change set from the processed template, so that they can review the changes resulting from the macros before actually creating the stack. If your stack template contains one or more macros, and you choose to create a stack directly from the processed template, without first reviewing the resulting changes in a change set, you must acknowledge this capability. This includes the [AWS::Include](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/create-reusable-transform-function-snippets-and-add-to-your-template-with-aws-include-transform.html) and [AWS::Serverless](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/transform-aws-serverless.html) transforms, which are macros hosted by AWS CloudFormation .
* If you want to create a stack from a stack template that contains macros *and* nested stacks, you must create the stack directly from the template using this capability.
* > You should only create stacks directly from a stack template that contains macros if you know what processing the macro performs.
* >
* > Each macro relies on an underlying Lambda service function for processing stack templates. Be aware that the Lambda function owner can update the function operation without AWS CloudFormation being notified.
* For more information, see [Using AWS CloudFormation macros to perform custom processing on templates](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-macros.html) .
*/
@JvmName("iaspffwqhrdircjo")
public suspend fun capabilities(`value`: Output>) {
this.capabilities = value
}
@JvmName("ncxfnseeujefnuvn")
public suspend fun capabilities(vararg values: Output) {
this.capabilities = Output.all(values.asList())
}
/**
* @param values In some cases, you must explicitly acknowledge that your stack template contains certain capabilities in order for AWS CloudFormation to create the stack.
* - `CAPABILITY_IAM` and `CAPABILITY_NAMED_IAM`
* Some stack templates might include resources that can affect permissions in your AWS account ; for example, by creating new AWS Identity and Access Management (IAM) users. For those stacks, you must explicitly acknowledge this by specifying one of these capabilities.
* The following IAM resources require you to specify either the `CAPABILITY_IAM` or `CAPABILITY_NAMED_IAM` capability.
* - If you have IAM resources, you can specify either capability.
* - If you have IAM resources with custom names, you *must* specify `CAPABILITY_NAMED_IAM` .
* - If you don't specify either of these capabilities, AWS CloudFormation returns an `InsufficientCapabilities` error.
* If your stack template contains these resources, we recommend that you review all permissions associated with them and edit their permissions if necessary.
* - [`AWS::IAM::AccessKey`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-accesskey.html)
* - [`AWS::IAM::Group`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-group.html)
* - [`AWS::IAM::InstanceProfile`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-instanceprofile.html)
* - [`AWS::IAM::Policy`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-policy.html)
* - [`AWS::IAM::Role`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-role.html)
* - [`AWS::IAM::User`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-user.html)
* - [`AWS::IAM::UserToGroupAddition`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-addusertogroup.html)
* For more information, see [Acknowledging IAM Resources in AWS CloudFormation Templates](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#capabilities) .
* - `CAPABILITY_AUTO_EXPAND`
* Some template contain macros. Macros perform custom processing on templates; this can include simple actions like find-and-replace operations, all the way to extensive transformations of entire templates. Because of this, users typically create a change set from the processed template, so that they can review the changes resulting from the macros before actually creating the stack. If your stack template contains one or more macros, and you choose to create a stack directly from the processed template, without first reviewing the resulting changes in a change set, you must acknowledge this capability. This includes the [AWS::Include](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/create-reusable-transform-function-snippets-and-add-to-your-template-with-aws-include-transform.html) and [AWS::Serverless](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/transform-aws-serverless.html) transforms, which are macros hosted by AWS CloudFormation .
* If you want to create a stack from a stack template that contains macros *and* nested stacks, you must create the stack directly from the template using this capability.
* > You should only create stacks directly from a stack template that contains macros if you know what processing the macro performs.
* >
* > Each macro relies on an underlying Lambda service function for processing stack templates. Be aware that the Lambda function owner can update the function operation without AWS CloudFormation being notified.
* For more information, see [Using AWS CloudFormation macros to perform custom processing on templates](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-macros.html) .
*/
@JvmName("hvojknxhxiogcorn")
public suspend fun capabilities(values: List>) {
this.capabilities = Output.all(values)
}
/**
* @param value A user-defined description associated with the stack.
*/
@JvmName("xopdpvqbgdllmluo")
public suspend fun description(`value`: Output) {
this.description = value
}
/**
* @param value Set to `true` to disable rollback of the stack if stack creation failed. You can specify either `DisableRollback` or `OnFailure` , but not both.
* Default: `false`
*/
@JvmName("qhoiynbyucffwjfg")
public suspend fun disableRollback(`value`: Output) {
this.disableRollback = value
}
/**
* @param value Whether to enable termination protection on the specified stack. If a user attempts to delete a stack with termination protection enabled, the operation fails and the stack remains unchanged. For more information, see [Protecting a Stack From Being Deleted](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-protect-stacks.html) in the *AWS CloudFormation User Guide* . Termination protection is deactivated on stacks by default.
* For [nested stacks](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-nested-stacks.html) , termination protection is set on the root stack and can't be changed directly on the nested stack.
*/
@JvmName("igrqvlueyjxjafmm")
public suspend fun enableTerminationProtection(`value`: Output) {
this.enableTerminationProtection = value
}
/**
* @param value The Amazon SNS topic ARNs to publish stack related events. You can find your Amazon SNS topic ARNs using the Amazon SNS console or your Command Line Interface (CLI).
*/
@JvmName("sdhrwkjwskmaudtu")
public suspend fun notificationArns(`value`: Output>) {
this.notificationArns = value
}
@JvmName("mmugiadcioqbpjnn")
public suspend fun notificationArns(vararg values: Output) {
this.notificationArns = Output.all(values.asList())
}
/**
* @param values The Amazon SNS topic ARNs to publish stack related events. You can find your Amazon SNS topic ARNs using the Amazon SNS console or your Command Line Interface (CLI).
*/
@JvmName("opgsscvhdjcylupp")
public suspend fun notificationArns(values: List>) {
this.notificationArns = Output.all(values)
}
/**
* @param value The set value pairs that represent the parameters passed to CloudFormation when this nested stack is created. Each parameter has a name corresponding to a parameter defined in the embedded template and a value representing the value that you want to set for the parameter.
* > If you use the `Ref` function to pass a parameter value to a nested stack, comma-delimited list parameters must be of type `String` . In other words, you can't pass values that are of type `CommaDelimitedList` to nested stacks.
* Conditional. Required if the nested stack requires input parameters.
* Whether an update causes interruptions depends on the resources that are being updated. An update never causes a nested stack to be replaced.
*/
@JvmName("cpvdkkqxkjucxdcj")
public suspend fun parameters(`value`: Output>) {
this.parameters = value
}
/**
* @param value The Amazon Resource Name (ARN) of an AWS Identity and Access Management (IAM) role that AWS CloudFormation assumes to create the stack. AWS CloudFormation uses the role's credentials to make calls on your behalf. AWS CloudFormation always uses this role for all future operations on the stack. Provided that users have permission to operate on the stack, AWS CloudFormation uses this role even if the users don't have permission to pass it. Ensure that the role grants least privilege.
* 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's generated from your user credentials.
*/
@JvmName("ncrwoqyihffybymi")
public suspend fun roleArn(`value`: Output) {
this.roleArn = value
}
/**
* @param value The name that's associated with the stack. The name must be unique in the Region in which you are creating the stack.
* > A stack name can contain only alphanumeric characters (case sensitive) and hyphens. It must start with an alphabetical character and can't be longer than 128 characters.
*/
@JvmName("wniojpuepsmdqcay")
public suspend fun stackName(`value`: Output) {
this.stackName = value
}
/**
* @param value Structure containing the stack policy body. For more information, go to [Prevent Updates to Stack Resources](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/protect-stack-resources.html) in the *AWS CloudFormation User Guide* . You can specify either the `StackPolicyBody` or the `StackPolicyURL` parameter, but not both.
* Search the [CloudFormation User Guide](https://docs.aws.amazon.com/cloudformation/) for `AWS::CloudFormation::Stack` for more information about the expected schema for this property.
*/
@JvmName("jmrigmgyynpjovpk")
public suspend fun stackPolicyBody(`value`: Output) {
this.stackPolicyBody = value
}
/**
* @param value Location of a file containing the stack policy. The URL must point to a policy (maximum size: 16 KB) located in an S3 bucket in the same Region as the stack. You can specify either the `StackPolicyBody` or the `StackPolicyURL` parameter, but not both.
*/
@JvmName("fbnluuyavpwrxfbv")
public suspend fun stackPolicyUrl(`value`: Output) {
this.stackPolicyUrl = value
}
/**
* @param value Success/failure message associated with the stack status.
*/
@JvmName("imgipvgowmmrrfdo")
public suspend fun stackStatusReason(`value`: Output) {
this.stackStatusReason = value
}
/**
* @param value Key-value pairs to associate with this stack. CloudFormation also propagates these tags to the resources created in the stack. A maximum number of 50 tags can be specified.
*/
@JvmName("elhsigrmcmsrjjxh")
public suspend fun tags(`value`: Output>) {
this.tags = value
}
@JvmName("gbslsmuhrjjywxrj")
public suspend fun tags(vararg values: Output) {
this.tags = Output.all(values.asList())
}
/**
* @param values Key-value pairs to associate with this stack. CloudFormation also propagates these tags to the resources created in the stack. A maximum number of 50 tags can be specified.
*/
@JvmName("qcqmnkhjvxdouhih")
public suspend fun tags(values: List>) {
this.tags = Output.all(values)
}
/**
* @param value Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes. For more information, go to [Template anatomy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html) in the AWS CloudFormation User Guide.
* Conditional: You must specify either the `TemplateBody` or the `TemplateURL` parameter, but not both.
* Search the [CloudFormation User Guide](https://docs.aws.amazon.com/cloudformation/) for `AWS::CloudFormation::Stack` for more information about the expected schema for this property.
*/
@JvmName("qrlrjelrjwmeevya")
public suspend fun templateBody(`value`: Output) {
this.templateBody = value
}
/**
* @param value Location of file containing the template body. The URL must point to a template (max size: 460,800 bytes) that's located in an Amazon S3 bucket. For more information, see [Template anatomy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html) .
* Whether an update causes interruptions depends on the resources that are being updated. An update never causes a nested stack to be replaced.
*/
@JvmName("orajamnlvhgtnhhv")
public suspend fun templateUrl(`value`: Output) {
this.templateUrl = value
}
/**
* @param value The length of time, in minutes, that CloudFormation waits for the nested stack to reach the `CREATE_COMPLETE` state. The default is no timeout. When CloudFormation detects that the nested stack has reached the `CREATE_COMPLETE` state, it marks the nested stack resource as `CREATE_COMPLETE` in the parent stack and resumes creating the parent stack. If the timeout period expires before the nested stack reaches `CREATE_COMPLETE` , CloudFormation marks the nested stack as failed and rolls back both the nested stack and parent stack.
* Updates aren't supported.
*/
@JvmName("dhwxmubiftspbcpb")
public suspend fun timeoutInMinutes(`value`: Output) {
this.timeoutInMinutes = value
}
/**
* @param value In some cases, you must explicitly acknowledge that your stack template contains certain capabilities in order for AWS CloudFormation to create the stack.
* - `CAPABILITY_IAM` and `CAPABILITY_NAMED_IAM`
* Some stack templates might include resources that can affect permissions in your AWS account ; for example, by creating new AWS Identity and Access Management (IAM) users. For those stacks, you must explicitly acknowledge this by specifying one of these capabilities.
* The following IAM resources require you to specify either the `CAPABILITY_IAM` or `CAPABILITY_NAMED_IAM` capability.
* - If you have IAM resources, you can specify either capability.
* - If you have IAM resources with custom names, you *must* specify `CAPABILITY_NAMED_IAM` .
* - If you don't specify either of these capabilities, AWS CloudFormation returns an `InsufficientCapabilities` error.
* If your stack template contains these resources, we recommend that you review all permissions associated with them and edit their permissions if necessary.
* - [`AWS::IAM::AccessKey`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-accesskey.html)
* - [`AWS::IAM::Group`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-group.html)
* - [`AWS::IAM::InstanceProfile`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-instanceprofile.html)
* - [`AWS::IAM::Policy`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-policy.html)
* - [`AWS::IAM::Role`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-role.html)
* - [`AWS::IAM::User`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-user.html)
* - [`AWS::IAM::UserToGroupAddition`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-addusertogroup.html)
* For more information, see [Acknowledging IAM Resources in AWS CloudFormation Templates](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#capabilities) .
* - `CAPABILITY_AUTO_EXPAND`
* Some template contain macros. Macros perform custom processing on templates; this can include simple actions like find-and-replace operations, all the way to extensive transformations of entire templates. Because of this, users typically create a change set from the processed template, so that they can review the changes resulting from the macros before actually creating the stack. If your stack template contains one or more macros, and you choose to create a stack directly from the processed template, without first reviewing the resulting changes in a change set, you must acknowledge this capability. This includes the [AWS::Include](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/create-reusable-transform-function-snippets-and-add-to-your-template-with-aws-include-transform.html) and [AWS::Serverless](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/transform-aws-serverless.html) transforms, which are macros hosted by AWS CloudFormation .
* If you want to create a stack from a stack template that contains macros *and* nested stacks, you must create the stack directly from the template using this capability.
* > You should only create stacks directly from a stack template that contains macros if you know what processing the macro performs.
* >
* > Each macro relies on an underlying Lambda service function for processing stack templates. Be aware that the Lambda function owner can update the function operation without AWS CloudFormation being notified.
* For more information, see [Using AWS CloudFormation macros to perform custom processing on templates](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-macros.html) .
*/
@JvmName("iolevqxrbmnsheve")
public suspend fun capabilities(`value`: List?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.capabilities = mapped
}
/**
* @param values In some cases, you must explicitly acknowledge that your stack template contains certain capabilities in order for AWS CloudFormation to create the stack.
* - `CAPABILITY_IAM` and `CAPABILITY_NAMED_IAM`
* Some stack templates might include resources that can affect permissions in your AWS account ; for example, by creating new AWS Identity and Access Management (IAM) users. For those stacks, you must explicitly acknowledge this by specifying one of these capabilities.
* The following IAM resources require you to specify either the `CAPABILITY_IAM` or `CAPABILITY_NAMED_IAM` capability.
* - If you have IAM resources, you can specify either capability.
* - If you have IAM resources with custom names, you *must* specify `CAPABILITY_NAMED_IAM` .
* - If you don't specify either of these capabilities, AWS CloudFormation returns an `InsufficientCapabilities` error.
* If your stack template contains these resources, we recommend that you review all permissions associated with them and edit their permissions if necessary.
* - [`AWS::IAM::AccessKey`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-accesskey.html)
* - [`AWS::IAM::Group`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-group.html)
* - [`AWS::IAM::InstanceProfile`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-instanceprofile.html)
* - [`AWS::IAM::Policy`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-policy.html)
* - [`AWS::IAM::Role`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-role.html)
* - [`AWS::IAM::User`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-user.html)
* - [`AWS::IAM::UserToGroupAddition`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-addusertogroup.html)
* For more information, see [Acknowledging IAM Resources in AWS CloudFormation Templates](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#capabilities) .
* - `CAPABILITY_AUTO_EXPAND`
* Some template contain macros. Macros perform custom processing on templates; this can include simple actions like find-and-replace operations, all the way to extensive transformations of entire templates. Because of this, users typically create a change set from the processed template, so that they can review the changes resulting from the macros before actually creating the stack. If your stack template contains one or more macros, and you choose to create a stack directly from the processed template, without first reviewing the resulting changes in a change set, you must acknowledge this capability. This includes the [AWS::Include](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/create-reusable-transform-function-snippets-and-add-to-your-template-with-aws-include-transform.html) and [AWS::Serverless](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/transform-aws-serverless.html) transforms, which are macros hosted by AWS CloudFormation .
* If you want to create a stack from a stack template that contains macros *and* nested stacks, you must create the stack directly from the template using this capability.
* > You should only create stacks directly from a stack template that contains macros if you know what processing the macro performs.
* >
* > Each macro relies on an underlying Lambda service function for processing stack templates. Be aware that the Lambda function owner can update the function operation without AWS CloudFormation being notified.
* For more information, see [Using AWS CloudFormation macros to perform custom processing on templates](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-macros.html) .
*/
@JvmName("ndgqimunjowcnvwo")
public suspend fun capabilities(vararg values: StackCapabilitiesItem) {
val toBeMapped = values.toList()
val mapped = toBeMapped.let({ args0 -> of(args0) })
this.capabilities = mapped
}
/**
* @param value A user-defined description associated with the stack.
*/
@JvmName("rlolxtrpvjsortdl")
public suspend fun description(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.description = mapped
}
/**
* @param value Set to `true` to disable rollback of the stack if stack creation failed. You can specify either `DisableRollback` or `OnFailure` , but not both.
* Default: `false`
*/
@JvmName("xshnfnxsehrxpthg")
public suspend fun disableRollback(`value`: Boolean?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.disableRollback = mapped
}
/**
* @param value Whether to enable termination protection on the specified stack. If a user attempts to delete a stack with termination protection enabled, the operation fails and the stack remains unchanged. For more information, see [Protecting a Stack From Being Deleted](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-protect-stacks.html) in the *AWS CloudFormation User Guide* . Termination protection is deactivated on stacks by default.
* For [nested stacks](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-nested-stacks.html) , termination protection is set on the root stack and can't be changed directly on the nested stack.
*/
@JvmName("fxpedcqrknhwtfby")
public suspend fun enableTerminationProtection(`value`: Boolean?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.enableTerminationProtection = mapped
}
/**
* @param value The Amazon SNS topic ARNs to publish stack related events. You can find your Amazon SNS topic ARNs using the Amazon SNS console or your Command Line Interface (CLI).
*/
@JvmName("xfwpugtgwgajgutk")
public suspend fun notificationArns(`value`: List?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.notificationArns = mapped
}
/**
* @param values The Amazon SNS topic ARNs to publish stack related events. You can find your Amazon SNS topic ARNs using the Amazon SNS console or your Command Line Interface (CLI).
*/
@JvmName("lstpudtqvihxqyfp")
public suspend fun notificationArns(vararg values: String) {
val toBeMapped = values.toList()
val mapped = toBeMapped.let({ args0 -> of(args0) })
this.notificationArns = mapped
}
/**
* @param value The set value pairs that represent the parameters passed to CloudFormation when this nested stack is created. Each parameter has a name corresponding to a parameter defined in the embedded template and a value representing the value that you want to set for the parameter.
* > If you use the `Ref` function to pass a parameter value to a nested stack, comma-delimited list parameters must be of type `String` . In other words, you can't pass values that are of type `CommaDelimitedList` to nested stacks.
* Conditional. Required if the nested stack requires input parameters.
* Whether an update causes interruptions depends on the resources that are being updated. An update never causes a nested stack to be replaced.
*/
@JvmName("agidjcslguoagfpv")
public suspend fun parameters(`value`: Map?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.parameters = mapped
}
/**
* @param values The set value pairs that represent the parameters passed to CloudFormation when this nested stack is created. Each parameter has a name corresponding to a parameter defined in the embedded template and a value representing the value that you want to set for the parameter.
* > If you use the `Ref` function to pass a parameter value to a nested stack, comma-delimited list parameters must be of type `String` . In other words, you can't pass values that are of type `CommaDelimitedList` to nested stacks.
* Conditional. Required if the nested stack requires input parameters.
* Whether an update causes interruptions depends on the resources that are being updated. An update never causes a nested stack to be replaced.
*/
@JvmName("ulmqdasriahqufmv")
public fun parameters(vararg values: Pair) {
val toBeMapped = values.toMap()
val mapped = toBeMapped.let({ args0 -> of(args0) })
this.parameters = mapped
}
/**
* @param value The Amazon Resource Name (ARN) of an AWS Identity and Access Management (IAM) role that AWS CloudFormation assumes to create the stack. AWS CloudFormation uses the role's credentials to make calls on your behalf. AWS CloudFormation always uses this role for all future operations on the stack. Provided that users have permission to operate on the stack, AWS CloudFormation uses this role even if the users don't have permission to pass it. Ensure that the role grants least privilege.
* 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's generated from your user credentials.
*/
@JvmName("krwitjpjwkhvmbqk")
public suspend fun roleArn(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.roleArn = mapped
}
/**
* @param value The name that's associated with the stack. The name must be unique in the Region in which you are creating the stack.
* > A stack name can contain only alphanumeric characters (case sensitive) and hyphens. It must start with an alphabetical character and can't be longer than 128 characters.
*/
@JvmName("pymwpaxgufnjheuh")
public suspend fun stackName(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.stackName = mapped
}
/**
* @param value Structure containing the stack policy body. For more information, go to [Prevent Updates to Stack Resources](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/protect-stack-resources.html) in the *AWS CloudFormation User Guide* . You can specify either the `StackPolicyBody` or the `StackPolicyURL` parameter, but not both.
* Search the [CloudFormation User Guide](https://docs.aws.amazon.com/cloudformation/) for `AWS::CloudFormation::Stack` for more information about the expected schema for this property.
*/
@JvmName("gwaqfdcevnbxriyo")
public suspend fun stackPolicyBody(`value`: Any?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.stackPolicyBody = mapped
}
/**
* @param value Location of a file containing the stack policy. The URL must point to a policy (maximum size: 16 KB) located in an S3 bucket in the same Region as the stack. You can specify either the `StackPolicyBody` or the `StackPolicyURL` parameter, but not both.
*/
@JvmName("hcnmkcjahejcqjth")
public suspend fun stackPolicyUrl(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.stackPolicyUrl = mapped
}
/**
* @param value Success/failure message associated with the stack status.
*/
@JvmName("gxrjpkdpdctyypwu")
public suspend fun stackStatusReason(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.stackStatusReason = mapped
}
/**
* @param value Key-value pairs to associate with this stack. CloudFormation also propagates these tags to the resources created in the stack. A maximum number of 50 tags can be specified.
*/
@JvmName("korwdtfhaloduuol")
public suspend fun tags(`value`: List?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.tags = mapped
}
/**
* @param argument Key-value pairs to associate with this stack. CloudFormation also propagates these tags to the resources created in the stack. A maximum number of 50 tags can be specified.
*/
@JvmName("qxyihjukxelawrwt")
public suspend fun tags(argument: List Unit>) {
val toBeMapped = argument.toList().map { TagArgsBuilder().applySuspend { it() }.build() }
val mapped = of(toBeMapped)
this.tags = mapped
}
/**
* @param argument Key-value pairs to associate with this stack. CloudFormation also propagates these tags to the resources created in the stack. A maximum number of 50 tags can be specified.
*/
@JvmName("dnuaymmclfcanhbv")
public suspend fun tags(vararg argument: suspend TagArgsBuilder.() -> Unit) {
val toBeMapped = argument.toList().map { TagArgsBuilder().applySuspend { it() }.build() }
val mapped = of(toBeMapped)
this.tags = mapped
}
/**
* @param argument Key-value pairs to associate with this stack. CloudFormation also propagates these tags to the resources created in the stack. A maximum number of 50 tags can be specified.
*/
@JvmName("hckjummvevhgxphh")
public suspend fun tags(argument: suspend TagArgsBuilder.() -> Unit) {
val toBeMapped = listOf(TagArgsBuilder().applySuspend { argument() }.build())
val mapped = of(toBeMapped)
this.tags = mapped
}
/**
* @param values Key-value pairs to associate with this stack. CloudFormation also propagates these tags to the resources created in the stack. A maximum number of 50 tags can be specified.
*/
@JvmName("vcvpglpdbaemwucl")
public suspend fun tags(vararg values: TagArgs) {
val toBeMapped = values.toList()
val mapped = toBeMapped.let({ args0 -> of(args0) })
this.tags = mapped
}
/**
* @param value Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes. For more information, go to [Template anatomy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html) in the AWS CloudFormation User Guide.
* Conditional: You must specify either the `TemplateBody` or the `TemplateURL` parameter, but not both.
* Search the [CloudFormation User Guide](https://docs.aws.amazon.com/cloudformation/) for `AWS::CloudFormation::Stack` for more information about the expected schema for this property.
*/
@JvmName("xvlydxmuwnviktwt")
public suspend fun templateBody(`value`: Any?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.templateBody = mapped
}
/**
* @param value Location of file containing the template body. The URL must point to a template (max size: 460,800 bytes) that's located in an Amazon S3 bucket. For more information, see [Template anatomy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html) .
* Whether an update causes interruptions depends on the resources that are being updated. An update never causes a nested stack to be replaced.
*/
@JvmName("aqgyvnrmdqgvtsmj")
public suspend fun templateUrl(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.templateUrl = mapped
}
/**
* @param value The length of time, in minutes, that CloudFormation waits for the nested stack to reach the `CREATE_COMPLETE` state. The default is no timeout. When CloudFormation detects that the nested stack has reached the `CREATE_COMPLETE` state, it marks the nested stack resource as `CREATE_COMPLETE` in the parent stack and resumes creating the parent stack. If the timeout period expires before the nested stack reaches `CREATE_COMPLETE` , CloudFormation marks the nested stack as failed and rolls back both the nested stack and parent stack.
* Updates aren't supported.
*/
@JvmName("oogelhitahwbnmld")
public suspend fun timeoutInMinutes(`value`: Int?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.timeoutInMinutes = mapped
}
internal fun build(): StackArgs = StackArgs(
capabilities = capabilities,
description = description,
disableRollback = disableRollback,
enableTerminationProtection = enableTerminationProtection,
notificationArns = notificationArns,
parameters = parameters,
roleArn = roleArn,
stackName = stackName,
stackPolicyBody = stackPolicyBody,
stackPolicyUrl = stackPolicyUrl,
stackStatusReason = stackStatusReason,
tags = tags,
templateBody = templateBody,
templateUrl = templateUrl,
timeoutInMinutes = timeoutInMinutes,
)
}