io.cloudshiftdev.awscdk.cloud_assembly_schema.AwsCloudFormationStackProperties.kt Maven / Gradle / Ivy
@file:Suppress("RedundantVisibilityModifier","RedundantUnitReturnType","RemoveRedundantQualifierName","unused","UnusedImport","ClassName","REDUNDANT_PROJECTION","DEPRECATION")
package io.cloudshiftdev.awscdk.cloud_assembly_schema
import io.cloudshiftdev.awscdk.common.CdkDslMarker
import io.cloudshiftdev.awscdk.common.CdkObject
import io.cloudshiftdev.awscdk.common.CdkObjectWrappers
import kotlin.Any
import kotlin.Boolean
import kotlin.Number
import kotlin.String
import kotlin.Unit
import kotlin.collections.List
import kotlin.collections.Map
import kotlin.jvm.JvmName
/**
* Artifact properties for CloudFormation stacks.
*
* Example:
*
* ```
* // The code below shows an example of how to instantiate this type.
* // The values are placeholders you should change.
* import io.cloudshiftdev.awscdk.cloud_assembly_schema.*;
* Object assumeRoleAdditionalOptions;
* AwsCloudFormationStackProperties awsCloudFormationStackProperties =
* AwsCloudFormationStackProperties.builder()
* .templateFile("templateFile")
* // the properties below are optional
* .assumeRoleAdditionalOptions(Map.of(
* "assumeRoleAdditionalOptionsKey", assumeRoleAdditionalOptions))
* .assumeRoleArn("assumeRoleArn")
* .assumeRoleExternalId("assumeRoleExternalId")
* .bootstrapStackVersionSsmParameter("bootstrapStackVersionSsmParameter")
* .cloudFormationExecutionRoleArn("cloudFormationExecutionRoleArn")
* .lookupRole(BootstrapRole.builder()
* .arn("arn")
* // the properties below are optional
* .assumeRoleAdditionalOptions(Map.of(
* "assumeRoleAdditionalOptionsKey", assumeRoleAdditionalOptions))
* .assumeRoleExternalId("assumeRoleExternalId")
* .bootstrapStackVersionSsmParameter("bootstrapStackVersionSsmParameter")
* .requiresBootstrapStackVersion(123)
* .build())
* .notificationArns(List.of("notificationArns"))
* .parameters(Map.of(
* "parametersKey", "parameters"))
* .requiresBootstrapStackVersion(123)
* .stackName("stackName")
* .stackTemplateAssetObjectUrl("stackTemplateAssetObjectUrl")
* .tags(Map.of(
* "tagsKey", "tags"))
* .terminationProtection(false)
* .validateOnSynth(false)
* .build();
* ```
*/
public interface AwsCloudFormationStackProperties {
/**
* Additional options to pass to STS when assuming the role.
*
* * `RoleArn` should not be used. Use the dedicated `assumeRoleArn` property instead.
* * `ExternalId` should not be used. Use the dedicated `assumeRoleExternalId` instead.
*
* Default: - No additional options.
*
* [Documentation](https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/STS.html#assumeRole-property)
*/
public fun assumeRoleAdditionalOptions(): Map =
unwrap(this).getAssumeRoleAdditionalOptions() ?: emptyMap()
/**
* The role that needs to be assumed to deploy the stack.
*
* Default: - No role is assumed (current credentials are used)
*/
public fun assumeRoleArn(): String? = unwrap(this).getAssumeRoleArn()
/**
* External ID to use when assuming role for cloudformation deployments.
*
* Default: - No external ID
*/
public fun assumeRoleExternalId(): String? = unwrap(this).getAssumeRoleExternalId()
/**
* SSM parameter where the bootstrap stack version number can be found.
*
* Only used if `requiresBootstrapStackVersion` is set.
*
* * If this value is not set, the bootstrap stack name must be known at
* deployment time so the stack version can be looked up from the stack
* outputs.
* * If this value is set, the bootstrap stack can have any name because
* we won't need to look it up.
*
* Default: - Bootstrap stack version number looked up
*/
public fun bootstrapStackVersionSsmParameter(): String? =
unwrap(this).getBootstrapStackVersionSsmParameter()
/**
* The role that is passed to CloudFormation to execute the change set.
*
* Default: - No role is passed (currently assumed role/credentials are used)
*/
public fun cloudFormationExecutionRoleArn(): String? =
unwrap(this).getCloudFormationExecutionRoleArn()
/**
* The role to use to look up values from the target AWS account.
*
* Default: - No role is assumed (current credentials are used)
*/
public fun lookupRole(): BootstrapRole? = unwrap(this).getLookupRole()?.let(BootstrapRole::wrap)
/**
* SNS Notification ARNs that should receive CloudFormation Stack Events.
*
* Default: - No notification arns
*/
public fun notificationArns(): List = unwrap(this).getNotificationArns() ?: emptyList()
/**
* Values for CloudFormation stack parameters that should be passed when the stack is deployed.
*
* Default: - No parameters
*/
public fun parameters(): Map = unwrap(this).getParameters() ?: emptyMap()
/**
* Version of bootstrap stack required to deploy this stack.
*
* Default: - No bootstrap stack required
*/
public fun requiresBootstrapStackVersion(): Number? =
unwrap(this).getRequiresBootstrapStackVersion()
/**
* The name to use for the CloudFormation stack.
*
* Default: - name derived from artifact ID
*/
public fun stackName(): String? = unwrap(this).getStackName()
/**
* If the stack template has already been included in the asset manifest, its asset URL.
*
* Default: - Not uploaded yet, upload just before deploying
*/
public fun stackTemplateAssetObjectUrl(): String? = unwrap(this).getStackTemplateAssetObjectUrl()
/**
* Values for CloudFormation stack tags that should be passed when the stack is deployed.
*
* Default: - No tags
*/
public fun tags(): Map = unwrap(this).getTags() ?: emptyMap()
/**
* A file relative to the assembly root which contains the CloudFormation template for this stack.
*/
public fun templateFile(): String
/**
* Whether to enable termination protection for this stack.
*
* Default: false
*/
public fun terminationProtection(): Boolean? = unwrap(this).getTerminationProtection()
/**
* Whether this stack should be validated by the CLI after synthesis.
*
* Default: - false
*/
public fun validateOnSynth(): Boolean? = unwrap(this).getValidateOnSynth()
/**
* A builder for [AwsCloudFormationStackProperties]
*/
@CdkDslMarker
public interface Builder {
/**
* @param assumeRoleAdditionalOptions Additional options to pass to STS when assuming the role.
* * `RoleArn` should not be used. Use the dedicated `assumeRoleArn` property instead.
* * `ExternalId` should not be used. Use the dedicated `assumeRoleExternalId` instead.
*/
public fun assumeRoleAdditionalOptions(assumeRoleAdditionalOptions: Map)
/**
* @param assumeRoleArn The role that needs to be assumed to deploy the stack.
*/
public fun assumeRoleArn(assumeRoleArn: String)
/**
* @param assumeRoleExternalId External ID to use when assuming role for cloudformation
* deployments.
*/
public fun assumeRoleExternalId(assumeRoleExternalId: String)
/**
* @param bootstrapStackVersionSsmParameter SSM parameter where the bootstrap stack version
* number can be found.
* Only used if `requiresBootstrapStackVersion` is set.
*
* * If this value is not set, the bootstrap stack name must be known at
* deployment time so the stack version can be looked up from the stack
* outputs.
* * If this value is set, the bootstrap stack can have any name because
* we won't need to look it up.
*/
public fun bootstrapStackVersionSsmParameter(bootstrapStackVersionSsmParameter: String)
/**
* @param cloudFormationExecutionRoleArn The role that is passed to CloudFormation to execute
* the change set.
*/
public fun cloudFormationExecutionRoleArn(cloudFormationExecutionRoleArn: String)
/**
* @param lookupRole The role to use to look up values from the target AWS account.
*/
public fun lookupRole(lookupRole: BootstrapRole)
/**
* @param lookupRole The role to use to look up values from the target AWS account.
*/
@kotlin.Suppress("INAPPLICABLE_JVM_NAME")
@JvmName("076474af8edd3e233f2751f68690ce0e842b393acc8318964bd017282cd44242")
public fun lookupRole(lookupRole: BootstrapRole.Builder.() -> Unit)
/**
* @param notificationArns SNS Notification ARNs that should receive CloudFormation Stack
* Events.
*/
public fun notificationArns(notificationArns: List)
/**
* @param notificationArns SNS Notification ARNs that should receive CloudFormation Stack
* Events.
*/
public fun notificationArns(vararg notificationArns: String)
/**
* @param parameters Values for CloudFormation stack parameters that should be passed when the
* stack is deployed.
*/
public fun parameters(parameters: Map)
/**
* @param requiresBootstrapStackVersion Version of bootstrap stack required to deploy this
* stack.
*/
public fun requiresBootstrapStackVersion(requiresBootstrapStackVersion: Number)
/**
* @param stackName The name to use for the CloudFormation stack.
*/
public fun stackName(stackName: String)
/**
* @param stackTemplateAssetObjectUrl If the stack template has already been included in the
* asset manifest, its asset URL.
*/
public fun stackTemplateAssetObjectUrl(stackTemplateAssetObjectUrl: String)
/**
* @param tags Values for CloudFormation stack tags that should be passed when the stack is
* deployed.
*/
public fun tags(tags: Map)
/**
* @param templateFile A file relative to the assembly root which contains the CloudFormation
* template for this stack.
*/
public fun templateFile(templateFile: String)
/**
* @param terminationProtection Whether to enable termination protection for this stack.
*/
public fun terminationProtection(terminationProtection: Boolean)
/**
* @param validateOnSynth Whether this stack should be validated by the CLI after synthesis.
*/
public fun validateOnSynth(validateOnSynth: Boolean)
}
private class BuilderImpl : Builder {
private val cdkBuilder:
software.amazon.awscdk.cloud_assembly_schema.AwsCloudFormationStackProperties.Builder =
software.amazon.awscdk.cloud_assembly_schema.AwsCloudFormationStackProperties.builder()
/**
* @param assumeRoleAdditionalOptions Additional options to pass to STS when assuming the role.
* * `RoleArn` should not be used. Use the dedicated `assumeRoleArn` property instead.
* * `ExternalId` should not be used. Use the dedicated `assumeRoleExternalId` instead.
*/
override fun assumeRoleAdditionalOptions(assumeRoleAdditionalOptions: Map) {
cdkBuilder.assumeRoleAdditionalOptions(assumeRoleAdditionalOptions.mapValues{CdkObjectWrappers.unwrap(it.value)})
}
/**
* @param assumeRoleArn The role that needs to be assumed to deploy the stack.
*/
override fun assumeRoleArn(assumeRoleArn: String) {
cdkBuilder.assumeRoleArn(assumeRoleArn)
}
/**
* @param assumeRoleExternalId External ID to use when assuming role for cloudformation
* deployments.
*/
override fun assumeRoleExternalId(assumeRoleExternalId: String) {
cdkBuilder.assumeRoleExternalId(assumeRoleExternalId)
}
/**
* @param bootstrapStackVersionSsmParameter SSM parameter where the bootstrap stack version
* number can be found.
* Only used if `requiresBootstrapStackVersion` is set.
*
* * If this value is not set, the bootstrap stack name must be known at
* deployment time so the stack version can be looked up from the stack
* outputs.
* * If this value is set, the bootstrap stack can have any name because
* we won't need to look it up.
*/
override fun bootstrapStackVersionSsmParameter(bootstrapStackVersionSsmParameter: String) {
cdkBuilder.bootstrapStackVersionSsmParameter(bootstrapStackVersionSsmParameter)
}
/**
* @param cloudFormationExecutionRoleArn The role that is passed to CloudFormation to execute
* the change set.
*/
override fun cloudFormationExecutionRoleArn(cloudFormationExecutionRoleArn: String) {
cdkBuilder.cloudFormationExecutionRoleArn(cloudFormationExecutionRoleArn)
}
/**
* @param lookupRole The role to use to look up values from the target AWS account.
*/
override fun lookupRole(lookupRole: BootstrapRole) {
cdkBuilder.lookupRole(lookupRole.let(BootstrapRole.Companion::unwrap))
}
/**
* @param lookupRole The role to use to look up values from the target AWS account.
*/
@kotlin.Suppress("INAPPLICABLE_JVM_NAME")
@JvmName("076474af8edd3e233f2751f68690ce0e842b393acc8318964bd017282cd44242")
override fun lookupRole(lookupRole: BootstrapRole.Builder.() -> Unit): Unit =
lookupRole(BootstrapRole(lookupRole))
/**
* @param notificationArns SNS Notification ARNs that should receive CloudFormation Stack
* Events.
*/
override fun notificationArns(notificationArns: List) {
cdkBuilder.notificationArns(notificationArns)
}
/**
* @param notificationArns SNS Notification ARNs that should receive CloudFormation Stack
* Events.
*/
override fun notificationArns(vararg notificationArns: String): Unit =
notificationArns(notificationArns.toList())
/**
* @param parameters Values for CloudFormation stack parameters that should be passed when the
* stack is deployed.
*/
override fun parameters(parameters: Map) {
cdkBuilder.parameters(parameters)
}
/**
* @param requiresBootstrapStackVersion Version of bootstrap stack required to deploy this
* stack.
*/
override fun requiresBootstrapStackVersion(requiresBootstrapStackVersion: Number) {
cdkBuilder.requiresBootstrapStackVersion(requiresBootstrapStackVersion)
}
/**
* @param stackName The name to use for the CloudFormation stack.
*/
override fun stackName(stackName: String) {
cdkBuilder.stackName(stackName)
}
/**
* @param stackTemplateAssetObjectUrl If the stack template has already been included in the
* asset manifest, its asset URL.
*/
override fun stackTemplateAssetObjectUrl(stackTemplateAssetObjectUrl: String) {
cdkBuilder.stackTemplateAssetObjectUrl(stackTemplateAssetObjectUrl)
}
/**
* @param tags Values for CloudFormation stack tags that should be passed when the stack is
* deployed.
*/
override fun tags(tags: Map) {
cdkBuilder.tags(tags)
}
/**
* @param templateFile A file relative to the assembly root which contains the CloudFormation
* template for this stack.
*/
override fun templateFile(templateFile: String) {
cdkBuilder.templateFile(templateFile)
}
/**
* @param terminationProtection Whether to enable termination protection for this stack.
*/
override fun terminationProtection(terminationProtection: Boolean) {
cdkBuilder.terminationProtection(terminationProtection)
}
/**
* @param validateOnSynth Whether this stack should be validated by the CLI after synthesis.
*/
override fun validateOnSynth(validateOnSynth: Boolean) {
cdkBuilder.validateOnSynth(validateOnSynth)
}
public fun build():
software.amazon.awscdk.cloud_assembly_schema.AwsCloudFormationStackProperties =
cdkBuilder.build()
}
private class Wrapper(
cdkObject: software.amazon.awscdk.cloud_assembly_schema.AwsCloudFormationStackProperties,
) : CdkObject(cdkObject),
AwsCloudFormationStackProperties {
/**
* Additional options to pass to STS when assuming the role.
*
* * `RoleArn` should not be used. Use the dedicated `assumeRoleArn` property instead.
* * `ExternalId` should not be used. Use the dedicated `assumeRoleExternalId` instead.
*
* Default: - No additional options.
*
* [Documentation](https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/STS.html#assumeRole-property)
*/
override fun assumeRoleAdditionalOptions(): Map =
unwrap(this).getAssumeRoleAdditionalOptions() ?: emptyMap()
/**
* The role that needs to be assumed to deploy the stack.
*
* Default: - No role is assumed (current credentials are used)
*/
override fun assumeRoleArn(): String? = unwrap(this).getAssumeRoleArn()
/**
* External ID to use when assuming role for cloudformation deployments.
*
* Default: - No external ID
*/
override fun assumeRoleExternalId(): String? = unwrap(this).getAssumeRoleExternalId()
/**
* SSM parameter where the bootstrap stack version number can be found.
*
* Only used if `requiresBootstrapStackVersion` is set.
*
* * If this value is not set, the bootstrap stack name must be known at
* deployment time so the stack version can be looked up from the stack
* outputs.
* * If this value is set, the bootstrap stack can have any name because
* we won't need to look it up.
*
* Default: - Bootstrap stack version number looked up
*/
override fun bootstrapStackVersionSsmParameter(): String? =
unwrap(this).getBootstrapStackVersionSsmParameter()
/**
* The role that is passed to CloudFormation to execute the change set.
*
* Default: - No role is passed (currently assumed role/credentials are used)
*/
override fun cloudFormationExecutionRoleArn(): String? =
unwrap(this).getCloudFormationExecutionRoleArn()
/**
* The role to use to look up values from the target AWS account.
*
* Default: - No role is assumed (current credentials are used)
*/
override fun lookupRole(): BootstrapRole? =
unwrap(this).getLookupRole()?.let(BootstrapRole::wrap)
/**
* SNS Notification ARNs that should receive CloudFormation Stack Events.
*
* Default: - No notification arns
*/
override fun notificationArns(): List = unwrap(this).getNotificationArns() ?:
emptyList()
/**
* Values for CloudFormation stack parameters that should be passed when the stack is deployed.
*
* Default: - No parameters
*/
override fun parameters(): Map = unwrap(this).getParameters() ?: emptyMap()
/**
* Version of bootstrap stack required to deploy this stack.
*
* Default: - No bootstrap stack required
*/
override fun requiresBootstrapStackVersion(): Number? =
unwrap(this).getRequiresBootstrapStackVersion()
/**
* The name to use for the CloudFormation stack.
*
* Default: - name derived from artifact ID
*/
override fun stackName(): String? = unwrap(this).getStackName()
/**
* If the stack template has already been included in the asset manifest, its asset URL.
*
* Default: - Not uploaded yet, upload just before deploying
*/
override fun stackTemplateAssetObjectUrl(): String? =
unwrap(this).getStackTemplateAssetObjectUrl()
/**
* Values for CloudFormation stack tags that should be passed when the stack is deployed.
*
* Default: - No tags
*/
override fun tags(): Map = unwrap(this).getTags() ?: emptyMap()
/**
* A file relative to the assembly root which contains the CloudFormation template for this
* stack.
*/
override fun templateFile(): String = unwrap(this).getTemplateFile()
/**
* Whether to enable termination protection for this stack.
*
* Default: false
*/
override fun terminationProtection(): Boolean? = unwrap(this).getTerminationProtection()
/**
* Whether this stack should be validated by the CLI after synthesis.
*
* Default: - false
*/
override fun validateOnSynth(): Boolean? = unwrap(this).getValidateOnSynth()
}
public companion object {
public operator fun invoke(block: Builder.() -> Unit = {}): AwsCloudFormationStackProperties {
val builderImpl = BuilderImpl()
return Wrapper(builderImpl.apply(block).build())
}
internal
fun wrap(cdkObject: software.amazon.awscdk.cloud_assembly_schema.AwsCloudFormationStackProperties):
AwsCloudFormationStackProperties = CdkObjectWrappers.wrap(cdkObject) as?
AwsCloudFormationStackProperties ?: Wrapper(cdkObject)
internal fun unwrap(wrapped: AwsCloudFormationStackProperties):
software.amazon.awscdk.cloud_assembly_schema.AwsCloudFormationStackProperties = (wrapped as
CdkObject).cdkObject as
software.amazon.awscdk.cloud_assembly_schema.AwsCloudFormationStackProperties
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy