cloudshift.awscdk.dsl.services.cloudformation.CfnStackPropsDsl.kt Maven / Gradle / Ivy
@file:Suppress("RedundantVisibilityModifier","RedundantUnitReturnType","RemoveRedundantQualifierName","unused","UnusedImport","ClassName","REDUNDANT_PROJECTION","DEPRECATION")
package cloudshift.awscdk.dsl.services.cloudformation
import cloudshift.awscdk.common.CdkDslMarker
import cloudshift.awscdk.dsl.CfnTagDsl
import kotlin.Number
import kotlin.String
import kotlin.Unit
import kotlin.collections.Collection
import kotlin.collections.Map
import kotlin.collections.MutableList
import software.amazon.awscdk.CfnTag
import software.amazon.awscdk.IResolvable
import software.amazon.awscdk.services.cloudformation.CfnStackProps
/**
* Properties for defining a `CfnStack`.
*
* Example:
*
* ```
* // The code below shows an example of how to instantiate this type.
* // The values are placeholders you should change.
* import software.amazon.awscdk.services.cloudformation.*;
* CfnStackProps cfnStackProps = CfnStackProps.builder()
* .templateUrl("templateUrl")
* // the properties below are optional
* .notificationArns(List.of("notificationArns"))
* .parameters(Map.of(
* "parametersKey", "parameters"))
* .tags(List.of(CfnTag.builder()
* .key("key")
* .value("value")
* .build()))
* .timeoutInMinutes(123)
* .build();
* ```
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-stack.html)
*/
@CdkDslMarker
public class CfnStackPropsDsl {
private val cdkBuilder: CfnStackProps.Builder = CfnStackProps.builder()
private val _notificationArns: MutableList = mutableListOf()
private val _tags: MutableList = mutableListOf()
/**
* @param notificationArns The Amazon Simple Notification Service (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).
*/
public fun notificationArns(vararg notificationArns: String) {
_notificationArns.addAll(listOf(*notificationArns))
}
/**
* @param notificationArns The Amazon Simple Notification Service (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).
*/
public fun notificationArns(notificationArns: Collection) {
_notificationArns.addAll(notificationArns)
}
/**
* @param 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.
*/
public fun parameters(parameters: Map) {
cdkBuilder.parameters(parameters)
}
/**
* @param 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.
*/
public fun parameters(parameters: IResolvable) {
cdkBuilder.parameters(parameters)
}
/**
* @param tags Key-value pairs to associate with this stack.
* AWS CloudFormation also propagates these tags to the resources created in the stack. A maximum
* number of 50 tags can be specified.
*/
public fun tags(tags: CfnTagDsl.() -> Unit) {
_tags.add(CfnTagDsl().apply(tags).build())
}
/**
* @param tags Key-value pairs to associate with this stack.
* AWS CloudFormation also propagates these tags to the resources created in the stack. A maximum
* number of 50 tags can be specified.
*/
public fun tags(tags: Collection) {
_tags.addAll(tags)
}
/**
* @param 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.
*/
public fun templateUrl(templateUrl: String) {
cdkBuilder.templateUrl(templateUrl)
}
/**
* @param 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 fun timeoutInMinutes(timeoutInMinutes: Number) {
cdkBuilder.timeoutInMinutes(timeoutInMinutes)
}
public fun build(): CfnStackProps {
if(_notificationArns.isNotEmpty()) cdkBuilder.notificationArns(_notificationArns)
if(_tags.isNotEmpty()) cdkBuilder.tags(_tags)
return cdkBuilder.build()
}
}