ClusterState class

Input properties used for looking up and filtering Cluster resources.

Constructors

ClusterState({Input<String?>? aclName, Input<String?>? arn, Input<bool?>? autoMinorVersionUpgrade, Input<List<ClusterClusterEndpoint>?>? clusterEndpoints, Input<bool?>? dataTiering, Input<String?>? description, Input<String?>? engine, Input<String?>? enginePatchVersion, Input<String?>? engineVersion, Input<String?>? finalSnapshotName, Input<String?>? ipDiscovery, Input<String?>? kmsKeyArn, Input<String?>? maintenanceWindow, Input<String?>? multiRegionClusterName, Input<String?>? name, Input<String?>? namePrefix, Input<String?>? networkType, Input<String?>? nodeType, Input<int?>? numReplicasPerShard, Input<int?>? numShards, Input<String?>? parameterGroupName, Input<int?>? port, Input<String?>? region, Input<List<String>?>? securityGroupIds, Input<List<ClusterShard>?>? shards, Input<List<String>?>? snapshotArns, Input<String?>? snapshotName, Input<int?>? snapshotRetentionLimit, Input<String?>? snapshotWindow, Input<String?>? snsTopicArn, Input<String?>? subnetGroupName, Input<Map<String, String>?>? tags, Input<Map<String, String>?>? tagsAll, Input<bool?>? tlsEnabled})
Creates a new ClusterState. aclName The name of the Access Control List to associate with the cluster. arn The ARN of the cluster. autoMinorVersionUpgrade When set to true, the cluster will automatically receive minor engine version upgrades after launch. Defaults to true. clusterEndpoints Optional. dataTiering Enables data tiering. This option is not supported by all instance types. For more information, see Data tiering. description Description for the cluster. Defaults to "Managed by Pulumi". engine The engine that will run on your nodes. Supported values are redis and valkey. enginePatchVersion Patch version number of the engine used by the cluster. engineVersion Version number of the engine to be used for the cluster. Downgrades are not supported. finalSnapshotName Name of the final cluster snapshot to be created when this resource is deleted. If omitted, no final snapshot will be made. ipDiscovery Mechanism that the cluster uses to discover IP addresses. Valid values are ipv4 and ipv6. Defaults to ipv4. To specify ipv6, networkType must be ipv6 or dualStack. kmsKeyArn ARN of the KMS key used to encrypt the cluster at rest. maintenanceWindow Specifies the weekly time range during which maintenance on the cluster is performed. Specify as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window is a 60 minute period. Example: sun:23:00-mon:01:30. multiRegionClusterName The multi region cluster identifier specified on aws.memorydb.MultiRegionCluster. name Name of the cluster. If omitted, the provider will assign a random, unique name. Conflicts with namePrefix. namePrefix Creates a unique name beginning with the specified prefix. Conflicts with name. networkType IP address type for the cluster. Valid values are ipv4, ipv6 and dualStack. Defaults to ipv4. nodeType The compute and memory capacity of the nodes in the cluster. See AWS documentation on supported node types as well as vertical scaling. numReplicasPerShard The number of replicas to apply to each shard, up to a maximum of 5. Defaults to 1 (i.e. 2 nodes per shard). numShards The number of shards in the cluster. Defaults to 1. parameterGroupName The name of the parameter group associated with the cluster. port The port number on which each of the nodes accepts connections. Defaults to 6379. region Region where this resource will be managed. Defaults to the Region set in the provider configuration. securityGroupIds Set of VPC Security Group ID-s to associate with this cluster. shards Set of shards in this cluster. snapshotArns List of ARN-s that uniquely identify RDB snapshot files stored in S3. The snapshot files will be used to populate the new cluster. Object names in the ARN-s cannot contain any commas. snapshotName The name of a snapshot from which to restore data into the new cluster. snapshotRetentionLimit The number of days for which MemoryDB retains automatic snapshots before deleting them. When set to 0, automatic backups are disabled. Defaults to 0. snapshotWindow The daily time range (in UTC) during which MemoryDB begins taking a daily snapshot of your shard. Example: 05:00-09:00. snsTopicArn ARN of the SNS topic to which cluster notifications are sent. subnetGroupName The name of the subnet group to be used for the cluster. Defaults to a subnet group consisting of default VPC subnets. tags A map of tags to assign to the resource. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level. tagsAll A map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block. tlsEnabled A flag to enable in-transit encryption on the cluster. When set to false, the aclName must be open-access. Defaults to true.
const
ClusterState.fromMap(Map<String, dynamic> map)
factory

Properties

aclName → Input<String?>?
The name of the Access Control List to associate with the cluster.
final
arn → Input<String?>?
The ARN of the cluster.
final
autoMinorVersionUpgrade → Input<bool?>?
When set to true, the cluster will automatically receive minor engine version upgrades after launch. Defaults to true.
final
clusterEndpoints → Input<List<ClusterClusterEndpoint>?>?
final
dataTiering → Input<bool?>?
Enables data tiering. This option is not supported by all instance types. For more information, see Data tiering.
final
description → Input<String?>?
Description for the cluster. Defaults to "Managed by Pulumi".
final
engine → Input<String?>?
The engine that will run on your nodes. Supported values are redis and valkey.
final
enginePatchVersion → Input<String?>?
Patch version number of the engine used by the cluster.
final
engineVersion → Input<String?>?
Version number of the engine to be used for the cluster. Downgrades are not supported.
final
finalSnapshotName → Input<String?>?
Name of the final cluster snapshot to be created when this resource is deleted. If omitted, no final snapshot will be made.
final
hashCode → int
The hash code for this object.
no setterinherited
ipDiscovery → Input<String?>?
Mechanism that the cluster uses to discover IP addresses. Valid values are ipv4 and ipv6. Defaults to ipv4. To specify ipv6, networkType must be ipv6 or dualStack.
final
kmsKeyArn → Input<String?>?
ARN of the KMS key used to encrypt the cluster at rest.
final
maintenanceWindow → Input<String?>?
Specifies the weekly time range during which maintenance on the cluster is performed. Specify as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window is a 60 minute period. Example: sun:23:00-mon:01:30.
final
multiRegionClusterName → Input<String?>?
The multi region cluster identifier specified on aws.memorydb.MultiRegionCluster.
final
name → Input<String?>?
Name of the cluster. If omitted, the provider will assign a random, unique name. Conflicts with namePrefix.
final
namePrefix → Input<String?>?
Creates a unique name beginning with the specified prefix. Conflicts with name.
final
networkType → Input<String?>?
IP address type for the cluster. Valid values are ipv4, ipv6 and dualStack. Defaults to ipv4.
final
nodeType → Input<String?>?
The compute and memory capacity of the nodes in the cluster. See AWS documentation on supported node types as well as vertical scaling.
final
numReplicasPerShard → Input<int?>?
The number of replicas to apply to each shard, up to a maximum of 5. Defaults to 1 (i.e. 2 nodes per shard).
final
numShards → Input<int?>?
The number of shards in the cluster. Defaults to 1.
final
parameterGroupName → Input<String?>?
The name of the parameter group associated with the cluster.
final
port → Input<int?>?
The port number on which each of the nodes accepts connections. Defaults to 6379.
final
region → Input<String?>?
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
securityGroupIds → Input<List<String>?>?
Set of VPC Security Group ID-s to associate with this cluster.
final
shards → Input<List<ClusterShard>?>?
Set of shards in this cluster.
final
snapshotArns → Input<List<String>?>?
List of ARN-s that uniquely identify RDB snapshot files stored in S3. The snapshot files will be used to populate the new cluster. Object names in the ARN-s cannot contain any commas.
final
snapshotName → Input<String?>?
The name of a snapshot from which to restore data into the new cluster.
final
snapshotRetentionLimit → Input<int?>?
The number of days for which MemoryDB retains automatic snapshots before deleting them. When set to 0, automatic backups are disabled. Defaults to 0.
final
snapshotWindow → Input<String?>?
The daily time range (in UTC) during which MemoryDB begins taking a daily snapshot of your shard. Example: 05:00-09:00.
final
snsTopicArn → Input<String?>?
ARN of the SNS topic to which cluster notifications are sent.
final
subnetGroupName → Input<String?>?
The name of the subnet group to be used for the cluster. Defaults to a subnet group consisting of default VPC subnets.
final
tags → Input<Map<String, String>?>?
A map of tags to assign to the resource. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
final
tagsAll → Input<Map<String, String>?>?
A map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.
final
tlsEnabled → Input<bool?>?
A flag to enable in-transit encryption on the cluster. When set to false, the aclName must be open-access. Defaults to true.
final

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toMap() → Map<String, dynamic>
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited