![JAR search and dependency download from the Maven repository](/logo.png)
io.cloudshiftdev.awscdk.cloud_assembly_schema.BootstrapRole.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.Number
import kotlin.String
import kotlin.Unit
import kotlin.collections.Map
/**
* Information needed to access an IAM role created as part of the bootstrap process.
*
* 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;
* BootstrapRole bootstrapRole = BootstrapRole.builder()
* .arn("arn")
* // the properties below are optional
* .assumeRoleAdditionalOptions(Map.of(
* "assumeRoleAdditionalOptionsKey", assumeRoleAdditionalOptions))
* .assumeRoleExternalId("assumeRoleExternalId")
* .bootstrapStackVersionSsmParameter("bootstrapStackVersionSsmParameter")
* .requiresBootstrapStackVersion(123)
* .build();
* ```
*/
public interface BootstrapRole {
/**
* The ARN of the IAM role created as part of bootrapping e.g. lookupRoleArn.
*/
public fun arn(): String
/**
* Additional options to pass to STS when assuming the role.
*
* * `RoleArn` should not be used. Use the dedicated `arn` 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()
/**
* External ID to use when assuming the bootstrap role.
*
* Default: - No external ID
*/
public fun assumeRoleExternalId(): String? = unwrap(this).getAssumeRoleExternalId()
/**
* Name of SSM parameter with bootstrap stack version.
*
* Default: - Discover SSM parameter by reading stack
*/
public fun bootstrapStackVersionSsmParameter(): String? =
unwrap(this).getBootstrapStackVersionSsmParameter()
/**
* Version of bootstrap stack required to use this role.
*
* Default: - No bootstrap stack required
*/
public fun requiresBootstrapStackVersion(): Number? =
unwrap(this).getRequiresBootstrapStackVersion()
/**
* A builder for [BootstrapRole]
*/
@CdkDslMarker
public interface Builder {
/**
* @param arn The ARN of the IAM role created as part of bootrapping e.g. lookupRoleArn.
*/
public fun arn(arn: String)
/**
* @param assumeRoleAdditionalOptions Additional options to pass to STS when assuming the role.
* * `RoleArn` should not be used. Use the dedicated `arn` property instead.
* * `ExternalId` should not be used. Use the dedicated `assumeRoleExternalId` instead.
*/
public fun assumeRoleAdditionalOptions(assumeRoleAdditionalOptions: Map)
/**
* @param assumeRoleExternalId External ID to use when assuming the bootstrap role.
*/
public fun assumeRoleExternalId(assumeRoleExternalId: String)
/**
* @param bootstrapStackVersionSsmParameter Name of SSM parameter with bootstrap stack version.
*/
public fun bootstrapStackVersionSsmParameter(bootstrapStackVersionSsmParameter: String)
/**
* @param requiresBootstrapStackVersion Version of bootstrap stack required to use this role.
*/
public fun requiresBootstrapStackVersion(requiresBootstrapStackVersion: Number)
}
private class BuilderImpl : Builder {
private val cdkBuilder: software.amazon.awscdk.cloud_assembly_schema.BootstrapRole.Builder =
software.amazon.awscdk.cloud_assembly_schema.BootstrapRole.builder()
/**
* @param arn The ARN of the IAM role created as part of bootrapping e.g. lookupRoleArn.
*/
override fun arn(arn: String) {
cdkBuilder.arn(arn)
}
/**
* @param assumeRoleAdditionalOptions Additional options to pass to STS when assuming the role.
* * `RoleArn` should not be used. Use the dedicated `arn` 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 assumeRoleExternalId External ID to use when assuming the bootstrap role.
*/
override fun assumeRoleExternalId(assumeRoleExternalId: String) {
cdkBuilder.assumeRoleExternalId(assumeRoleExternalId)
}
/**
* @param bootstrapStackVersionSsmParameter Name of SSM parameter with bootstrap stack version.
*/
override fun bootstrapStackVersionSsmParameter(bootstrapStackVersionSsmParameter: String) {
cdkBuilder.bootstrapStackVersionSsmParameter(bootstrapStackVersionSsmParameter)
}
/**
* @param requiresBootstrapStackVersion Version of bootstrap stack required to use this role.
*/
override fun requiresBootstrapStackVersion(requiresBootstrapStackVersion: Number) {
cdkBuilder.requiresBootstrapStackVersion(requiresBootstrapStackVersion)
}
public fun build(): software.amazon.awscdk.cloud_assembly_schema.BootstrapRole =
cdkBuilder.build()
}
private class Wrapper(
cdkObject: software.amazon.awscdk.cloud_assembly_schema.BootstrapRole,
) : CdkObject(cdkObject),
BootstrapRole {
/**
* The ARN of the IAM role created as part of bootrapping e.g. lookupRoleArn.
*/
override fun arn(): String = unwrap(this).getArn()
/**
* Additional options to pass to STS when assuming the role.
*
* * `RoleArn` should not be used. Use the dedicated `arn` 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()
/**
* External ID to use when assuming the bootstrap role.
*
* Default: - No external ID
*/
override fun assumeRoleExternalId(): String? = unwrap(this).getAssumeRoleExternalId()
/**
* Name of SSM parameter with bootstrap stack version.
*
* Default: - Discover SSM parameter by reading stack
*/
override fun bootstrapStackVersionSsmParameter(): String? =
unwrap(this).getBootstrapStackVersionSsmParameter()
/**
* Version of bootstrap stack required to use this role.
*
* Default: - No bootstrap stack required
*/
override fun requiresBootstrapStackVersion(): Number? =
unwrap(this).getRequiresBootstrapStackVersion()
}
public companion object {
public operator fun invoke(block: Builder.() -> Unit = {}): BootstrapRole {
val builderImpl = BuilderImpl()
return Wrapper(builderImpl.apply(block).build())
}
internal fun wrap(cdkObject: software.amazon.awscdk.cloud_assembly_schema.BootstrapRole):
BootstrapRole = CdkObjectWrappers.wrap(cdkObject) as? BootstrapRole ?: Wrapper(cdkObject)
internal fun unwrap(wrapped: BootstrapRole):
software.amazon.awscdk.cloud_assembly_schema.BootstrapRole = (wrapped as
CdkObject).cdkObject as software.amazon.awscdk.cloud_assembly_schema.BootstrapRole
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy