io.cloudshiftdev.awscdk.services.cloudformation.CfnModuleDefaultVersion.kt Maven / Gradle / Ivy
The newest version!
@file:Suppress("RedundantVisibilityModifier","RedundantUnitReturnType","RemoveRedundantQualifierName","unused","UnusedImport","ClassName","REDUNDANT_PROJECTION","DEPRECATION")
package io.cloudshiftdev.awscdk.services.cloudformation
import io.cloudshiftdev.awscdk.CfnResource
import io.cloudshiftdev.awscdk.IInspectable
import io.cloudshiftdev.awscdk.TreeInspector
import io.cloudshiftdev.awscdk.common.CdkDslMarker
import kotlin.String
import kotlin.Unit
import io.cloudshiftdev.constructs.Construct as CloudshiftdevConstructsConstruct
import software.constructs.Construct as SoftwareConstructsConstruct
/**
* Specifies the default version of a module.
*
* The default version of the module will be used in CloudFormation operations for this account and
* Region.
*
* To register a module version, use the
* `[`AWS::CloudFormation::ModuleVersion`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-moduleversion.html)`
* resource.
*
* For more information using modules, see [Using modules to encapsulate and reuse resource
* configurations](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/modules.html) and
* [Registering
* extensions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry.html#registry-register)
* in the *AWS CloudFormation User Guide* . For information on developing modules, see [Developing
* modules](https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/modules.html) in the *AWS
* CloudFormation CLI User Guide* .
*
* Example:
*
* ```
* // The code below shows an example of how to instantiate this type.
* // The values are placeholders you should change.
* import io.cloudshiftdev.awscdk.services.cloudformation.*;
* CfnModuleDefaultVersion cfnModuleDefaultVersion = CfnModuleDefaultVersion.Builder.create(this,
* "MyCfnModuleDefaultVersion")
* .arn("arn")
* .moduleName("moduleName")
* .versionId("versionId")
* .build();
* ```
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-moduledefaultversion.html)
*/
public open class CfnModuleDefaultVersion(
cdkObject: software.amazon.awscdk.services.cloudformation.CfnModuleDefaultVersion,
) : CfnResource(cdkObject),
IInspectable {
public constructor(scope: CloudshiftdevConstructsConstruct, id: String) :
this(software.amazon.awscdk.services.cloudformation.CfnModuleDefaultVersion(scope.let(CloudshiftdevConstructsConstruct.Companion::unwrap),
id)
)
public constructor(
scope: CloudshiftdevConstructsConstruct,
id: String,
props: CfnModuleDefaultVersionProps,
) :
this(software.amazon.awscdk.services.cloudformation.CfnModuleDefaultVersion(scope.let(CloudshiftdevConstructsConstruct.Companion::unwrap),
id, props.let(CfnModuleDefaultVersionProps.Companion::unwrap))
)
public constructor(
scope: CloudshiftdevConstructsConstruct,
id: String,
props: CfnModuleDefaultVersionProps.Builder.() -> Unit,
) : this(scope, id, CfnModuleDefaultVersionProps(props)
)
/**
* The Amazon Resource Name (ARN) of the module version to set as the default version.
*/
public open fun arn(): String? = unwrap(this).getArn()
/**
* The Amazon Resource Name (ARN) of the module version to set as the default version.
*/
public open fun arn(`value`: String) {
unwrap(this).setArn(`value`)
}
/**
* Examines the CloudFormation resource and discloses attributes.
*
* @param inspector tree inspector to collect and process attributes.
*/
public override fun inspect(inspector: TreeInspector) {
unwrap(this).inspect(inspector.let(TreeInspector.Companion::unwrap))
}
/**
* The name of the module.
*/
public open fun moduleName(): String? = unwrap(this).getModuleName()
/**
* The name of the module.
*/
public open fun moduleName(`value`: String) {
unwrap(this).setModuleName(`value`)
}
/**
* The ID for the specific version of the module.
*/
public open fun versionId(): String? = unwrap(this).getVersionId()
/**
* The ID for the specific version of the module.
*/
public open fun versionId(`value`: String) {
unwrap(this).setVersionId(`value`)
}
/**
* A fluent builder for [io.cloudshiftdev.awscdk.services.cloudformation.CfnModuleDefaultVersion].
*/
@CdkDslMarker
public interface Builder {
/**
* The Amazon Resource Name (ARN) of the module version to set as the default version.
*
* Conditional: You must specify either `Arn` , or `ModuleName` and `VersionId` .
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-moduledefaultversion.html#cfn-cloudformation-moduledefaultversion-arn)
* @param arn The Amazon Resource Name (ARN) of the module version to set as the default
* version.
*/
public fun arn(arn: String)
/**
* The name of the module.
*
* Conditional: You must specify either `Arn` , or `ModuleName` and `VersionId` .
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-moduledefaultversion.html#cfn-cloudformation-moduledefaultversion-modulename)
* @param moduleName The name of the module.
*/
public fun moduleName(moduleName: String)
/**
* The ID for the specific version of the module.
*
* Conditional: You must specify either `Arn` , or `ModuleName` and `VersionId` .
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-moduledefaultversion.html#cfn-cloudformation-moduledefaultversion-versionid)
* @param versionId The ID for the specific version of the module.
*/
public fun versionId(versionId: String)
}
private class BuilderImpl(
scope: SoftwareConstructsConstruct,
id: String,
) : Builder {
private val cdkBuilder:
software.amazon.awscdk.services.cloudformation.CfnModuleDefaultVersion.Builder =
software.amazon.awscdk.services.cloudformation.CfnModuleDefaultVersion.Builder.create(scope,
id)
/**
* The Amazon Resource Name (ARN) of the module version to set as the default version.
*
* Conditional: You must specify either `Arn` , or `ModuleName` and `VersionId` .
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-moduledefaultversion.html#cfn-cloudformation-moduledefaultversion-arn)
* @param arn The Amazon Resource Name (ARN) of the module version to set as the default
* version.
*/
override fun arn(arn: String) {
cdkBuilder.arn(arn)
}
/**
* The name of the module.
*
* Conditional: You must specify either `Arn` , or `ModuleName` and `VersionId` .
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-moduledefaultversion.html#cfn-cloudformation-moduledefaultversion-modulename)
* @param moduleName The name of the module.
*/
override fun moduleName(moduleName: String) {
cdkBuilder.moduleName(moduleName)
}
/**
* The ID for the specific version of the module.
*
* Conditional: You must specify either `Arn` , or `ModuleName` and `VersionId` .
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-moduledefaultversion.html#cfn-cloudformation-moduledefaultversion-versionid)
* @param versionId The ID for the specific version of the module.
*/
override fun versionId(versionId: String) {
cdkBuilder.versionId(versionId)
}
public fun build(): software.amazon.awscdk.services.cloudformation.CfnModuleDefaultVersion =
cdkBuilder.build()
}
public companion object {
public val CFN_RESOURCE_TYPE_NAME: String =
software.amazon.awscdk.services.cloudformation.CfnModuleDefaultVersion.CFN_RESOURCE_TYPE_NAME
public operator fun invoke(
scope: CloudshiftdevConstructsConstruct,
id: String,
block: Builder.() -> Unit = {},
): CfnModuleDefaultVersion {
val builderImpl = BuilderImpl(CloudshiftdevConstructsConstruct.unwrap(scope), id)
return CfnModuleDefaultVersion(builderImpl.apply(block).build())
}
internal
fun wrap(cdkObject: software.amazon.awscdk.services.cloudformation.CfnModuleDefaultVersion):
CfnModuleDefaultVersion = CfnModuleDefaultVersion(cdkObject)
internal fun unwrap(wrapped: CfnModuleDefaultVersion):
software.amazon.awscdk.services.cloudformation.CfnModuleDefaultVersion = wrapped.cdkObject
as software.amazon.awscdk.services.cloudformation.CfnModuleDefaultVersion
}
}