Package-level declarations

Types

Link copied to clipboard
class Cluster : KotlinCustomResource

Provides an ElastiCache Cluster resource, which manages either a Memcached cluster, a single-node Redis instance, or a read replica in a Redis (Cluster Mode Enabled) replication group. For working with Redis (Cluster Mode Enabled) replication groups, see the aws.elasticache.ReplicationGroup resource.

Link copied to clipboard
data class ClusterArgs(val applyImmediately: Output<Boolean>? = null, val autoMinorVersionUpgrade: Output<String>? = null, val availabilityZone: Output<String>? = null, val azMode: Output<String>? = null, val clusterId: Output<String>? = null, val engine: Output<String>? = null, val engineVersion: Output<String>? = null, val finalSnapshotIdentifier: Output<String>? = null, val ipDiscovery: Output<String>? = null, val logDeliveryConfigurations: Output<List<ClusterLogDeliveryConfigurationArgs>>? = null, val maintenanceWindow: Output<String>? = null, val networkType: Output<String>? = null, val nodeType: Output<String>? = null, val notificationTopicArn: Output<String>? = null, val numCacheNodes: Output<Int>? = null, val outpostMode: Output<String>? = null, val parameterGroupName: Output<String>? = null, val port: Output<Int>? = null, val preferredAvailabilityZones: Output<List<String>>? = null, val preferredOutpostArn: Output<String>? = null, val replicationGroupId: Output<String>? = null, val securityGroupIds: Output<List<String>>? = null, val securityGroupNames: Output<List<String>>? = null, val snapshotArns: Output<String>? = null, val snapshotName: Output<String>? = null, val snapshotRetentionLimit: Output<Int>? = null, val snapshotWindow: Output<String>? = null, val subnetGroupName: Output<String>? = null, val tags: Output<Map<String, String>>? = null) : ConvertibleToJava<ClusterArgs>

Provides an ElastiCache Cluster resource, which manages either a Memcached cluster, a single-node Redis instance, or a read replica in a Redis (Cluster Mode Enabled) replication group. For working with Redis (Cluster Mode Enabled) replication groups, see the aws.elasticache.ReplicationGroup resource.

Link copied to clipboard
Link copied to clipboard
object ClusterMapper : ResourceMapper<Cluster>
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
class GlobalReplicationGroup : KotlinCustomResource

Provides an ElastiCache Global Replication Group resource, which manages replication between two or more Replication Groups in different regions. For more information, see the ElastiCache User Guide.

Link copied to clipboard
data class GlobalReplicationGroupArgs(val automaticFailoverEnabled: Output<Boolean>? = null, val cacheNodeType: Output<String>? = null, val engineVersion: Output<String>? = null, val globalReplicationGroupDescription: Output<String>? = null, val globalReplicationGroupIdSuffix: Output<String>? = null, val numNodeGroups: Output<Int>? = null, val parameterGroupName: Output<String>? = null, val primaryReplicationGroupId: Output<String>? = null) : ConvertibleToJava<GlobalReplicationGroupArgs>

Provides an ElastiCache Global Replication Group resource, which manages replication between two or more Replication Groups in different regions. For more information, see the ElastiCache User Guide.

Link copied to clipboard
Link copied to clipboard
class ParameterGroup : KotlinCustomResource

Provides an ElastiCache parameter group resource.

Link copied to clipboard
data class ParameterGroupArgs(val description: Output<String>? = null, val family: Output<String>? = null, val name: Output<String>? = null, val parameters: Output<List<ParameterGroupParameterArgs>>? = null, val tags: Output<Map<String, String>>? = null) : ConvertibleToJava<ParameterGroupArgs>

Provides an ElastiCache parameter group resource.

Link copied to clipboard
Link copied to clipboard
object ParameterGroupMapper : ResourceMapper<ParameterGroup>
Link copied to clipboard
class ReplicationGroup : KotlinCustomResource

Provides an ElastiCache Replication Group resource. For working with a Memcached cluster or a single-node Redis instance (Cluster Mode Disabled), see the aws.elasticache.Cluster resource.

Link copied to clipboard
data class ReplicationGroupArgs(val applyImmediately: Output<Boolean>? = null, val atRestEncryptionEnabled: Output<Boolean>? = null, val authToken: Output<String>? = null, val autoMinorVersionUpgrade: Output<Boolean>? = null, val automaticFailoverEnabled: Output<Boolean>? = null, val availabilityZones: Output<List<String>>? = null, val clusterMode: Output<ReplicationGroupClusterModeArgs>? = null, val dataTieringEnabled: Output<Boolean>? = null, val description: Output<String>? = null, val engine: Output<String>? = null, val engineVersion: Output<String>? = null, val finalSnapshotIdentifier: Output<String>? = null, val globalReplicationGroupId: Output<String>? = null, val kmsKeyId: Output<String>? = null, val logDeliveryConfigurations: Output<List<ReplicationGroupLogDeliveryConfigurationArgs>>? = null, val maintenanceWindow: Output<String>? = null, val multiAzEnabled: Output<Boolean>? = null, val nodeType: Output<String>? = null, val notificationTopicArn: Output<String>? = null, val numCacheClusters: Output<Int>? = null, val numNodeGroups: Output<Int>? = null, val numberCacheClusters: Output<Int>? = null, val parameterGroupName: Output<String>? = null, val port: Output<Int>? = null, val preferredCacheClusterAzs: Output<List<String>>? = null, val replicasPerNodeGroup: Output<Int>? = null, val replicationGroupDescription: Output<String>? = null, val replicationGroupId: Output<String>? = null, val securityGroupIds: Output<List<String>>? = null, val securityGroupNames: Output<List<String>>? = null, val snapshotArns: Output<List<String>>? = null, val snapshotName: Output<String>? = null, val snapshotRetentionLimit: Output<Int>? = null, val snapshotWindow: Output<String>? = null, val subnetGroupName: Output<String>? = null, val tags: Output<Map<String, String>>? = null, val transitEncryptionEnabled: Output<Boolean>? = null, val userGroupIds: Output<List<String>>? = null) : ConvertibleToJava<ReplicationGroupArgs>

Provides an ElastiCache Replication Group resource. For working with a Memcached cluster or a single-node Redis instance (Cluster Mode Disabled), see the aws.elasticache.Cluster resource.

Link copied to clipboard
object ReplicationGroupMapper : ResourceMapper<ReplicationGroup>
Link copied to clipboard
class SecurityGroup : KotlinCustomResource

Provides an ElastiCache Security Group to control access to one or more cache clusters.

Link copied to clipboard
data class SecurityGroupArgs(val description: Output<String>? = null, val name: Output<String>? = null, val securityGroupNames: Output<List<String>>? = null) : ConvertibleToJava<SecurityGroupArgs>

Provides an ElastiCache Security Group to control access to one or more cache clusters.

Link copied to clipboard
Link copied to clipboard
object SecurityGroupMapper : ResourceMapper<SecurityGroup>
Link copied to clipboard
Link copied to clipboard
class SubnetGroup : KotlinCustomResource

Provides an ElastiCache Subnet Group resource.

Link copied to clipboard
data class SubnetGroupArgs(val description: Output<String>? = null, val name: Output<String>? = null, val subnetIds: Output<List<String>>? = null, val tags: Output<Map<String, String>>? = null) : ConvertibleToJava<SubnetGroupArgs>

Provides an ElastiCache Subnet Group resource.

Link copied to clipboard
Link copied to clipboard
object SubnetGroupMapper : ResourceMapper<SubnetGroup>
Link copied to clipboard
Link copied to clipboard
class User : KotlinCustomResource

Provides an ElastiCache user resource.

Link copied to clipboard
data class UserArgs(val accessString: Output<String>? = null, val authenticationMode: Output<UserAuthenticationModeArgs>? = null, val engine: Output<String>? = null, val noPasswordRequired: Output<Boolean>? = null, val passwords: Output<List<String>>? = null, val tags: Output<Map<String, String>>? = null, val userId: Output<String>? = null, val userName: Output<String>? = null) : ConvertibleToJava<UserArgs>

Provides an ElastiCache user resource.

Link copied to clipboard

Builder for UserArgs.

Link copied to clipboard
class UserGroup : KotlinCustomResource

Provides an ElastiCache user group resource.

Link copied to clipboard
data class UserGroupArgs(val engine: Output<String>? = null, val tags: Output<Map<String, String>>? = null, val userGroupId: Output<String>? = null, val userIds: Output<List<String>>? = null) : ConvertibleToJava<UserGroupArgs>

Provides an ElastiCache user group resource.

Link copied to clipboard
Link copied to clipboard
class UserGroupAssociation : KotlinCustomResource

Associate an existing ElastiCache user and an existing user group.

Link copied to clipboard
data class UserGroupAssociationArgs(val userGroupId: Output<String>? = null, val userId: Output<String>? = null) : ConvertibleToJava<UserGroupAssociationArgs>

Associate an existing ElastiCache user and an existing user group.

Link copied to clipboard
Link copied to clipboard
object UserGroupMapper : ResourceMapper<UserGroup>
Link copied to clipboard
Link copied to clipboard
object UserMapper : ResourceMapper<User>
Link copied to clipboard

Builder for User.

Functions

Link copied to clipboard
fun cluster(name: String): Cluster
suspend fun cluster(name: String, block: suspend ClusterResourceBuilder.() -> Unit): Cluster
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
suspend fun subnetGroup(name: String, block: suspend SubnetGroupResourceBuilder.() -> Unit): SubnetGroup
Link copied to clipboard
fun user(name: String): User
suspend fun user(name: String, block: suspend UserResourceBuilder.() -> Unit): User
Link copied to clipboard
suspend fun userGroup(name: String, block: suspend UserGroupResourceBuilder.() -> Unit): UserGroup