io.cloudshiftdev.awscdk.services.servicecatalogappregistry.CfnApplication.kt Maven / Gradle / Ivy
The newest version!
@file:Suppress("RedundantVisibilityModifier","RedundantUnitReturnType","RemoveRedundantQualifierName","unused","UnusedImport","ClassName","REDUNDANT_PROJECTION","DEPRECATION")
package io.cloudshiftdev.awscdk.services.servicecatalogappregistry
import io.cloudshiftdev.awscdk.CfnResource
import io.cloudshiftdev.awscdk.IInspectable
import io.cloudshiftdev.awscdk.ITaggable
import io.cloudshiftdev.awscdk.TagManager
import io.cloudshiftdev.awscdk.TreeInspector
import io.cloudshiftdev.awscdk.common.CdkDslMarker
import kotlin.String
import kotlin.Unit
import kotlin.collections.Map
import io.cloudshiftdev.constructs.Construct as CloudshiftdevConstructsConstruct
import software.constructs.Construct as SoftwareConstructsConstruct
/**
* Represents a AWS Service Catalog AppRegistry application that is the top-level node in a
* hierarchy of related cloud resource abstractions.
*
* 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.servicecatalogappregistry.*;
* CfnApplication cfnApplication = CfnApplication.Builder.create(this, "MyCfnApplication")
* .name("name")
* // the properties below are optional
* .description("description")
* .tags(Map.of(
* "tagsKey", "tags"))
* .build();
* ```
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicecatalogappregistry-application.html)
*/
public open class CfnApplication(
cdkObject: software.amazon.awscdk.services.servicecatalogappregistry.CfnApplication,
) : CfnResource(cdkObject),
IInspectable,
ITaggable {
public constructor(
scope: CloudshiftdevConstructsConstruct,
id: String,
props: CfnApplicationProps,
) :
this(software.amazon.awscdk.services.servicecatalogappregistry.CfnApplication(scope.let(CloudshiftdevConstructsConstruct.Companion::unwrap),
id, props.let(CfnApplicationProps.Companion::unwrap))
)
public constructor(
scope: CloudshiftdevConstructsConstruct,
id: String,
props: CfnApplicationProps.Builder.() -> Unit,
) : this(scope, id, CfnApplicationProps(props)
)
/**
* The name of the application.
*
* The name must be unique in the region in which you are creating the application.
*/
public open fun attrApplicationName(): String = unwrap(this).getAttrApplicationName()
/**
* The key of the AWS application tag, which is `awsApplication` .
*
* Applications created before 11/13/2023 or applications without the `AppTag` linked resource
* group return no value.
*/
public open fun attrApplicationTagKey(): String = unwrap(this).getAttrApplicationTagKey()
/**
* The value of the AWS application tag, which is the identifier of an associated resource.
*
* Applications created before 11/13/2023 or applications without the `AppTag` linked resource
* group return no value.
*/
public open fun attrApplicationTagValue(): String = unwrap(this).getAttrApplicationTagValue()
/**
* The Amazon resource name (ARN) that specifies the application across services.
*/
public open fun attrArn(): String = unwrap(this).getAttrArn()
/**
* The identifier of the application.
*/
public open fun attrId(): String = unwrap(this).getAttrId()
/**
* The description of the application.
*/
public open fun description(): String? = unwrap(this).getDescription()
/**
* The description of the application.
*/
public open fun description(`value`: String) {
unwrap(this).setDescription(`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 application.
*/
public open fun name(): String = unwrap(this).getName()
/**
* The name of the application.
*/
public open fun name(`value`: String) {
unwrap(this).setName(`value`)
}
/**
* Tag Manager which manages the tags for this resource.
*/
public override fun tags(): TagManager = unwrap(this).getTags().let(TagManager::wrap)
/**
* Key-value pairs you can use to associate with the application.
*/
public open fun tagsRaw(): Map = unwrap(this).getTagsRaw() ?: emptyMap()
/**
* Key-value pairs you can use to associate with the application.
*/
public open fun tagsRaw(`value`: Map) {
unwrap(this).setTagsRaw(`value`)
}
/**
* A fluent builder for
* [io.cloudshiftdev.awscdk.services.servicecatalogappregistry.CfnApplication].
*/
@CdkDslMarker
public interface Builder {
/**
* The description of the application.
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicecatalogappregistry-application.html#cfn-servicecatalogappregistry-application-description)
* @param description The description of the application.
*/
public fun description(description: String)
/**
* The name of the application.
*
* The name must be unique in the region in which you are creating the application.
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicecatalogappregistry-application.html#cfn-servicecatalogappregistry-application-name)
* @param name The name of the application.
*/
public fun name(name: String)
/**
* Key-value pairs you can use to associate with the application.
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicecatalogappregistry-application.html#cfn-servicecatalogappregistry-application-tags)
* @param tags Key-value pairs you can use to associate with the application.
*/
public fun tags(tags: Map)
}
private class BuilderImpl(
scope: SoftwareConstructsConstruct,
id: String,
) : Builder {
private val cdkBuilder:
software.amazon.awscdk.services.servicecatalogappregistry.CfnApplication.Builder =
software.amazon.awscdk.services.servicecatalogappregistry.CfnApplication.Builder.create(scope,
id)
/**
* The description of the application.
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicecatalogappregistry-application.html#cfn-servicecatalogappregistry-application-description)
* @param description The description of the application.
*/
override fun description(description: String) {
cdkBuilder.description(description)
}
/**
* The name of the application.
*
* The name must be unique in the region in which you are creating the application.
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicecatalogappregistry-application.html#cfn-servicecatalogappregistry-application-name)
* @param name The name of the application.
*/
override fun name(name: String) {
cdkBuilder.name(name)
}
/**
* Key-value pairs you can use to associate with the application.
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicecatalogappregistry-application.html#cfn-servicecatalogappregistry-application-tags)
* @param tags Key-value pairs you can use to associate with the application.
*/
override fun tags(tags: Map) {
cdkBuilder.tags(tags)
}
public fun build(): software.amazon.awscdk.services.servicecatalogappregistry.CfnApplication =
cdkBuilder.build()
}
public companion object {
public val CFN_RESOURCE_TYPE_NAME: String =
software.amazon.awscdk.services.servicecatalogappregistry.CfnApplication.CFN_RESOURCE_TYPE_NAME
public operator fun invoke(
scope: CloudshiftdevConstructsConstruct,
id: String,
block: Builder.() -> Unit = {},
): CfnApplication {
val builderImpl = BuilderImpl(CloudshiftdevConstructsConstruct.unwrap(scope), id)
return CfnApplication(builderImpl.apply(block).build())
}
internal
fun wrap(cdkObject: software.amazon.awscdk.services.servicecatalogappregistry.CfnApplication):
CfnApplication = CfnApplication(cdkObject)
internal fun unwrap(wrapped: CfnApplication):
software.amazon.awscdk.services.servicecatalogappregistry.CfnApplication = wrapped.cdkObject
as software.amazon.awscdk.services.servicecatalogappregistry.CfnApplication
}
}