io.cloudshiftdev.awscdk.services.memorydb.CfnSubnetGroup.kt Maven / Gradle / Ivy
The newest version!
@file:Suppress("RedundantVisibilityModifier","RedundantUnitReturnType","RemoveRedundantQualifierName","unused","UnusedImport","ClassName","REDUNDANT_PROJECTION","DEPRECATION")
package io.cloudshiftdev.awscdk.services.memorydb
import io.cloudshiftdev.awscdk.CfnResource
import io.cloudshiftdev.awscdk.CfnTag
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.List
import io.cloudshiftdev.constructs.Construct as CloudshiftdevConstructsConstruct
import software.constructs.Construct as SoftwareConstructsConstruct
/**
* Specifies a subnet group.
*
* A subnet group is a collection of subnets (typically private) that you can designate for your
* cluster s running in an Amazon Virtual Private Cloud (VPC) environment. When you create a cluster in
* an Amazon VPC , you must specify a subnet group. MemoryDB uses that subnet group to choose a subnet
* and IP addresses within that subnet to associate with your nodes. For more information, see [Subnets
* and subnet groups](https://docs.aws.amazon.com/memorydb/latest/devguide/subnetgroups.html) .
*
* 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.memorydb.*;
* CfnSubnetGroup cfnSubnetGroup = CfnSubnetGroup.Builder.create(this, "MyCfnSubnetGroup")
* .subnetGroupName("subnetGroupName")
* .subnetIds(List.of("subnetIds"))
* // the properties below are optional
* .description("description")
* .tags(List.of(CfnTag.builder()
* .key("key")
* .value("value")
* .build()))
* .build();
* ```
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-memorydb-subnetgroup.html)
*/
public open class CfnSubnetGroup(
cdkObject: software.amazon.awscdk.services.memorydb.CfnSubnetGroup,
) : CfnResource(cdkObject),
IInspectable,
ITaggable {
public constructor(
scope: CloudshiftdevConstructsConstruct,
id: String,
props: CfnSubnetGroupProps,
) :
this(software.amazon.awscdk.services.memorydb.CfnSubnetGroup(scope.let(CloudshiftdevConstructsConstruct.Companion::unwrap),
id, props.let(CfnSubnetGroupProps.Companion::unwrap))
)
public constructor(
scope: CloudshiftdevConstructsConstruct,
id: String,
props: CfnSubnetGroupProps.Builder.() -> Unit,
) : this(scope, id, CfnSubnetGroupProps(props)
)
/**
* When you pass the logical ID of this resource to the intrinsic `Ref` function, Ref returns the
* ARN of the subnet group, such as
* `arn:aws:memorydb:us-east-1:123456789012:subnetgroup/my-subnet-group`.
*/
public open fun attrArn(): String = unwrap(this).getAttrArn()
/**
* A description of the subnet group.
*/
public open fun description(): String? = unwrap(this).getDescription()
/**
* A description of the subnet group.
*/
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 subnet group to be used for the cluster .
*/
public open fun subnetGroupName(): String = unwrap(this).getSubnetGroupName()
/**
* The name of the subnet group to be used for the cluster .
*/
public open fun subnetGroupName(`value`: String) {
unwrap(this).setSubnetGroupName(`value`)
}
/**
* A list of Amazon VPC subnet IDs for the subnet group.
*/
public open fun subnetIds(): List = unwrap(this).getSubnetIds()
/**
* A list of Amazon VPC subnet IDs for the subnet group.
*/
public open fun subnetIds(`value`: List) {
unwrap(this).setSubnetIds(`value`)
}
/**
* A list of Amazon VPC subnet IDs for the subnet group.
*/
public open fun subnetIds(vararg `value`: String): Unit = subnetIds(`value`.toList())
/**
* Tag Manager which manages the tags for this resource.
*/
public override fun tags(): TagManager = unwrap(this).getTags().let(TagManager::wrap)
/**
* An array of key-value pairs to apply to this resource.
*/
public open fun tagsRaw(): List = unwrap(this).getTagsRaw()?.map(CfnTag::wrap) ?:
emptyList()
/**
* An array of key-value pairs to apply to this resource.
*/
public open fun tagsRaw(`value`: List) {
unwrap(this).setTagsRaw(`value`.map(CfnTag.Companion::unwrap))
}
/**
* An array of key-value pairs to apply to this resource.
*/
public open fun tagsRaw(vararg `value`: CfnTag): Unit = tagsRaw(`value`.toList())
/**
* A fluent builder for [io.cloudshiftdev.awscdk.services.memorydb.CfnSubnetGroup].
*/
@CdkDslMarker
public interface Builder {
/**
* A description of the subnet group.
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-memorydb-subnetgroup.html#cfn-memorydb-subnetgroup-description)
* @param description A description of the subnet group.
*/
public fun description(description: String)
/**
* The name of the subnet group to be used for the cluster .
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-memorydb-subnetgroup.html#cfn-memorydb-subnetgroup-subnetgroupname)
* @param subnetGroupName The name of the subnet group to be used for the cluster .
*/
public fun subnetGroupName(subnetGroupName: String)
/**
* A list of Amazon VPC subnet IDs for the subnet group.
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-memorydb-subnetgroup.html#cfn-memorydb-subnetgroup-subnetids)
* @param subnetIds A list of Amazon VPC subnet IDs for the subnet group.
*/
public fun subnetIds(subnetIds: List)
/**
* A list of Amazon VPC subnet IDs for the subnet group.
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-memorydb-subnetgroup.html#cfn-memorydb-subnetgroup-subnetids)
* @param subnetIds A list of Amazon VPC subnet IDs for the subnet group.
*/
public fun subnetIds(vararg subnetIds: String)
/**
* An array of key-value pairs to apply to this resource.
*
* For more information, see
* [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html)
* .
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-memorydb-subnetgroup.html#cfn-memorydb-subnetgroup-tags)
* @param tags An array of key-value pairs to apply to this resource.
*/
public fun tags(tags: List)
/**
* An array of key-value pairs to apply to this resource.
*
* For more information, see
* [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html)
* .
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-memorydb-subnetgroup.html#cfn-memorydb-subnetgroup-tags)
* @param tags An array of key-value pairs to apply to this resource.
*/
public fun tags(vararg tags: CfnTag)
}
private class BuilderImpl(
scope: SoftwareConstructsConstruct,
id: String,
) : Builder {
private val cdkBuilder: software.amazon.awscdk.services.memorydb.CfnSubnetGroup.Builder =
software.amazon.awscdk.services.memorydb.CfnSubnetGroup.Builder.create(scope, id)
/**
* A description of the subnet group.
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-memorydb-subnetgroup.html#cfn-memorydb-subnetgroup-description)
* @param description A description of the subnet group.
*/
override fun description(description: String) {
cdkBuilder.description(description)
}
/**
* The name of the subnet group to be used for the cluster .
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-memorydb-subnetgroup.html#cfn-memorydb-subnetgroup-subnetgroupname)
* @param subnetGroupName The name of the subnet group to be used for the cluster .
*/
override fun subnetGroupName(subnetGroupName: String) {
cdkBuilder.subnetGroupName(subnetGroupName)
}
/**
* A list of Amazon VPC subnet IDs for the subnet group.
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-memorydb-subnetgroup.html#cfn-memorydb-subnetgroup-subnetids)
* @param subnetIds A list of Amazon VPC subnet IDs for the subnet group.
*/
override fun subnetIds(subnetIds: List) {
cdkBuilder.subnetIds(subnetIds)
}
/**
* A list of Amazon VPC subnet IDs for the subnet group.
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-memorydb-subnetgroup.html#cfn-memorydb-subnetgroup-subnetids)
* @param subnetIds A list of Amazon VPC subnet IDs for the subnet group.
*/
override fun subnetIds(vararg subnetIds: String): Unit = subnetIds(subnetIds.toList())
/**
* An array of key-value pairs to apply to this resource.
*
* For more information, see
* [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html)
* .
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-memorydb-subnetgroup.html#cfn-memorydb-subnetgroup-tags)
* @param tags An array of key-value pairs to apply to this resource.
*/
override fun tags(tags: List) {
cdkBuilder.tags(tags.map(CfnTag.Companion::unwrap))
}
/**
* An array of key-value pairs to apply to this resource.
*
* For more information, see
* [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html)
* .
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-memorydb-subnetgroup.html#cfn-memorydb-subnetgroup-tags)
* @param tags An array of key-value pairs to apply to this resource.
*/
override fun tags(vararg tags: CfnTag): Unit = tags(tags.toList())
public fun build(): software.amazon.awscdk.services.memorydb.CfnSubnetGroup = cdkBuilder.build()
}
public companion object {
public val CFN_RESOURCE_TYPE_NAME: String =
software.amazon.awscdk.services.memorydb.CfnSubnetGroup.CFN_RESOURCE_TYPE_NAME
public operator fun invoke(
scope: CloudshiftdevConstructsConstruct,
id: String,
block: Builder.() -> Unit = {},
): CfnSubnetGroup {
val builderImpl = BuilderImpl(CloudshiftdevConstructsConstruct.unwrap(scope), id)
return CfnSubnetGroup(builderImpl.apply(block).build())
}
internal fun wrap(cdkObject: software.amazon.awscdk.services.memorydb.CfnSubnetGroup):
CfnSubnetGroup = CfnSubnetGroup(cdkObject)
internal fun unwrap(wrapped: CfnSubnetGroup):
software.amazon.awscdk.services.memorydb.CfnSubnetGroup = wrapped.cdkObject as
software.amazon.awscdk.services.memorydb.CfnSubnetGroup
}
}