io.cloudshiftdev.awscdk.services.elasticache.CfnUserGroup.kt Maven / Gradle / Ivy
The newest version!
@file:Suppress("RedundantVisibilityModifier","RedundantUnitReturnType","RemoveRedundantQualifierName","unused","UnusedImport","ClassName","REDUNDANT_PROJECTION","DEPRECATION")
package io.cloudshiftdev.awscdk.services.elasticache
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
/**
* For Redis OSS engine version 6.0 onwards: Creates a Redis user group. For more information, see
* [Using Role Based Access Control
* (RBAC)](https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/Clusters.RBAC.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.elasticache.*;
* CfnUserGroup cfnUserGroup = CfnUserGroup.Builder.create(this, "MyCfnUserGroup")
* .engine("engine")
* .userGroupId("userGroupId")
* .userIds(List.of("userIds"))
* // the properties below are optional
* .tags(List.of(CfnTag.builder()
* .key("key")
* .value("value")
* .build()))
* .build();
* ```
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-usergroup.html)
*/
public open class CfnUserGroup(
cdkObject: software.amazon.awscdk.services.elasticache.CfnUserGroup,
) : CfnResource(cdkObject),
IInspectable,
ITaggable {
public constructor(
scope: CloudshiftdevConstructsConstruct,
id: String,
props: CfnUserGroupProps,
) :
this(software.amazon.awscdk.services.elasticache.CfnUserGroup(scope.let(CloudshiftdevConstructsConstruct.Companion::unwrap),
id, props.let(CfnUserGroupProps.Companion::unwrap))
)
public constructor(
scope: CloudshiftdevConstructsConstruct,
id: String,
props: CfnUserGroupProps.Builder.() -> Unit,
) : this(scope, id, CfnUserGroupProps(props)
)
/**
* The Amazon Resource Name (ARN) of the user group.
*/
public open fun attrArn(): String = unwrap(this).getAttrArn()
/**
* Indicates user group status.
*
* Can be "creating", "active", "modifying", "deleting".
*/
public open fun attrStatus(): String = unwrap(this).getAttrStatus()
/**
* The current supported value is redis.
*/
public open fun engine(): String = unwrap(this).getEngine()
/**
* The current supported value is redis.
*/
public open fun engine(`value`: String) {
unwrap(this).setEngine(`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))
}
/**
* Tag Manager which manages the tags for this resource.
*/
public override fun tags(): TagManager = unwrap(this).getTags().let(TagManager::wrap)
/**
* The list of tags.
*/
public open fun tagsRaw(): List = unwrap(this).getTagsRaw()?.map(CfnTag::wrap) ?:
emptyList()
/**
* The list of tags.
*/
public open fun tagsRaw(`value`: List) {
unwrap(this).setTagsRaw(`value`.map(CfnTag.Companion::unwrap))
}
/**
* The list of tags.
*/
public open fun tagsRaw(vararg `value`: CfnTag): Unit = tagsRaw(`value`.toList())
/**
* The ID of the user group.
*/
public open fun userGroupId(): String = unwrap(this).getUserGroupId()
/**
* The ID of the user group.
*/
public open fun userGroupId(`value`: String) {
unwrap(this).setUserGroupId(`value`)
}
/**
* The list of user IDs that belong to the user group.
*/
public open fun userIds(): List = unwrap(this).getUserIds()
/**
* The list of user IDs that belong to the user group.
*/
public open fun userIds(`value`: List) {
unwrap(this).setUserIds(`value`)
}
/**
* The list of user IDs that belong to the user group.
*/
public open fun userIds(vararg `value`: String): Unit = userIds(`value`.toList())
/**
* A fluent builder for [io.cloudshiftdev.awscdk.services.elasticache.CfnUserGroup].
*/
@CdkDslMarker
public interface Builder {
/**
* The current supported value is redis.
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-usergroup.html#cfn-elasticache-usergroup-engine)
* @param engine The current supported value is redis.
*/
public fun engine(engine: String)
/**
* The list of tags.
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-usergroup.html#cfn-elasticache-usergroup-tags)
* @param tags The list of tags.
*/
public fun tags(tags: List)
/**
* The list of tags.
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-usergroup.html#cfn-elasticache-usergroup-tags)
* @param tags The list of tags.
*/
public fun tags(vararg tags: CfnTag)
/**
* The ID of the user group.
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-usergroup.html#cfn-elasticache-usergroup-usergroupid)
* @param userGroupId The ID of the user group.
*/
public fun userGroupId(userGroupId: String)
/**
* The list of user IDs that belong to the user group.
*
* A user named `default` must be included.
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-usergroup.html#cfn-elasticache-usergroup-userids)
* @param userIds The list of user IDs that belong to the user group.
*/
public fun userIds(userIds: List)
/**
* The list of user IDs that belong to the user group.
*
* A user named `default` must be included.
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-usergroup.html#cfn-elasticache-usergroup-userids)
* @param userIds The list of user IDs that belong to the user group.
*/
public fun userIds(vararg userIds: String)
}
private class BuilderImpl(
scope: SoftwareConstructsConstruct,
id: String,
) : Builder {
private val cdkBuilder: software.amazon.awscdk.services.elasticache.CfnUserGroup.Builder =
software.amazon.awscdk.services.elasticache.CfnUserGroup.Builder.create(scope, id)
/**
* The current supported value is redis.
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-usergroup.html#cfn-elasticache-usergroup-engine)
* @param engine The current supported value is redis.
*/
override fun engine(engine: String) {
cdkBuilder.engine(engine)
}
/**
* The list of tags.
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-usergroup.html#cfn-elasticache-usergroup-tags)
* @param tags The list of tags.
*/
override fun tags(tags: List) {
cdkBuilder.tags(tags.map(CfnTag.Companion::unwrap))
}
/**
* The list of tags.
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-usergroup.html#cfn-elasticache-usergroup-tags)
* @param tags The list of tags.
*/
override fun tags(vararg tags: CfnTag): Unit = tags(tags.toList())
/**
* The ID of the user group.
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-usergroup.html#cfn-elasticache-usergroup-usergroupid)
* @param userGroupId The ID of the user group.
*/
override fun userGroupId(userGroupId: String) {
cdkBuilder.userGroupId(userGroupId)
}
/**
* The list of user IDs that belong to the user group.
*
* A user named `default` must be included.
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-usergroup.html#cfn-elasticache-usergroup-userids)
* @param userIds The list of user IDs that belong to the user group.
*/
override fun userIds(userIds: List) {
cdkBuilder.userIds(userIds)
}
/**
* The list of user IDs that belong to the user group.
*
* A user named `default` must be included.
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-usergroup.html#cfn-elasticache-usergroup-userids)
* @param userIds The list of user IDs that belong to the user group.
*/
override fun userIds(vararg userIds: String): Unit = userIds(userIds.toList())
public fun build(): software.amazon.awscdk.services.elasticache.CfnUserGroup =
cdkBuilder.build()
}
public companion object {
public val CFN_RESOURCE_TYPE_NAME: String =
software.amazon.awscdk.services.elasticache.CfnUserGroup.CFN_RESOURCE_TYPE_NAME
public operator fun invoke(
scope: CloudshiftdevConstructsConstruct,
id: String,
block: Builder.() -> Unit = {},
): CfnUserGroup {
val builderImpl = BuilderImpl(CloudshiftdevConstructsConstruct.unwrap(scope), id)
return CfnUserGroup(builderImpl.apply(block).build())
}
internal fun wrap(cdkObject: software.amazon.awscdk.services.elasticache.CfnUserGroup):
CfnUserGroup = CfnUserGroup(cdkObject)
internal fun unwrap(wrapped: CfnUserGroup):
software.amazon.awscdk.services.elasticache.CfnUserGroup = wrapped.cdkObject as
software.amazon.awscdk.services.elasticache.CfnUserGroup
}
}