ClusterArgs class
The set of arguments for Cluster. The set of arguments for Cluster.
Constructors
-
ClusterArgs({required Input<
String> aclName, Input<bool?> ? autoMinorVersionUpgrade, Input<bool?> ? dataTiering, Input<String?> ? description, Input<String?> ? engine, 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, required Input<String> nodeType, Input<int?> ? numReplicasPerShard, Input<int?> ? numShards, Input<String?> ? parameterGroupName, Input<int?> ? port, Input<String?> ? region, Input<List< ? securityGroupIds, Input<String> ?>List< ? snapshotArns, Input<String> ?>String?> ? snapshotName, Input<int?> ? snapshotRetentionLimit, Input<String?> ? snapshotWindow, Input<String?> ? snsTopicArn, Input<String?> ? subnetGroupName, Input<Map< ? tags, Input<String, String> ?>bool?> ? tlsEnabled}) -
Creates a new ClusterArgs.
aclNameThe name of the Access Control List to associate with the cluster.autoMinorVersionUpgradeWhen set totrue, the cluster will automatically receive minor engine version upgrades after launch. Defaults totrue.dataTieringEnables data tiering. This option is not supported by all instance types. For more information, see Data tiering.descriptionDescription for the cluster. Defaults to"Managed by Pulumi".engineThe engine that will run on your nodes. Supported values areredisandvalkey.engineVersionVersion number of the engine to be used for the cluster. Downgrades are not supported.finalSnapshotNameName of the final cluster snapshot to be created when this resource is deleted. If omitted, no final snapshot will be made.ipDiscoveryMechanism that the cluster uses to discover IP addresses. Valid values areipv4andipv6. Defaults toipv4. To specifyipv6,networkTypemust beipv6ordualStack.kmsKeyArnARN of the KMS key used to encrypt the cluster at rest.maintenanceWindowSpecifies the weekly time range during which maintenance on the cluster is performed. Specify as a range in the formatddd:hh24:mi-ddd:hh24:mi(24H Clock UTC). The minimum maintenance window is a 60 minute period. Example:sun:23:00-mon:01:30.multiRegionClusterNameThe multi region cluster identifier specified onaws.memorydb.MultiRegionCluster.nameName of the cluster. If omitted, the provider will assign a random, unique name. Conflicts withnamePrefix.namePrefixCreates a unique name beginning with the specified prefix. Conflicts withname.networkTypeIP address type for the cluster. Valid values areipv4,ipv6anddualStack. Defaults toipv4.nodeTypeThe compute and memory capacity of the nodes in the cluster. See AWS documentation on supported node types as well as vertical scaling.numReplicasPerShardThe number of replicas to apply to each shard, up to a maximum of 5. Defaults to1(i.e. 2 nodes per shard).numShardsThe number of shards in the cluster. Defaults to1.parameterGroupNameThe name of the parameter group associated with the cluster.portThe port number on which each of the nodes accepts connections. Defaults to6379.regionRegion where this resource will be managed. Defaults to the Region set in the provider configuration.securityGroupIdsSet of VPC Security Group ID-s to associate with this cluster.snapshotArnsList 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.snapshotNameThe name of a snapshot from which to restore data into the new cluster.snapshotRetentionLimitThe number of days for which MemoryDB retains automatic snapshots before deleting them. When set to0, automatic backups are disabled. Defaults to0.snapshotWindowThe daily time range (in UTC) during which MemoryDB begins taking a daily snapshot of your shard. Example:05:00-09:00.snsTopicArnARN of the SNS topic to which cluster notifications are sent.subnetGroupNameThe name of the subnet group to be used for the cluster. Defaults to a subnet group consisting of default VPC subnets.tagsA map of tags to assign to the resource. If configured with a providerdefaultTagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.tlsEnabledA flag to enable in-transit encryption on the cluster. When set tofalse, theaclNamemust beopen-access. Defaults totrue.const -
ClusterArgs.fromMap(Map<
String, dynamic> map) -
factory
Properties
-
aclName
→ Input<
String> -
The name of the Access Control List to associate with the cluster.
final
-
autoMinorVersionUpgrade
→ Input<
bool?> ? -
When set to
true, the cluster will automatically receive minor engine version upgrades after launch. Defaults totrue.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
redisandvalkey.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
ipv4andipv6. Defaults toipv4. To specifyipv6,networkTypemust beipv6ordualStack.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,ipv6anddualStack. Defaults toipv4.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
-
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 to0.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
-
A map of tags to assign to the resource. If configured with a provider
defaultTagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.final -
tlsEnabled
→ Input<
bool?> ? -
A flag to enable in-transit encryption on the cluster. When set to
false, theaclNamemust beopen-access. Defaults totrue.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