Class ClusterState
Inheritance
System.Object
ClusterState
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Assembly: Pulumi.Aws.dll
Syntax
public sealed class ClusterState : ResourceArgs
Constructors
View Source
ClusterState()
Declaration
Properties
View Source
Declaration
public Input<bool> ApplyImmediately { get; set; }
Property Value
| Type |
Description |
| Input<System.Boolean> |
|
View Source
Arn
Declaration
public Input<string> Arn { get; set; }
Property Value
| Type |
Description |
| Input<System.String> |
|
View Source
AvailabilityZone
The Availability Zone for the cache cluster. If you want to create cache nodes in multi-az, use preferred_availability_zones instead. Default: System chosen Availability Zone.
Declaration
public Input<string> AvailabilityZone { get; set; }
Property Value
| Type |
Description |
| Input<System.String> |
|
View Source
AzMode
Specifies whether the nodes in this Memcached node group are created in a single Availability Zone or created across multiple Availability Zones in the cluster's region. Valid values for this parameter are single-az or cross-az, default is single-az. If you want to choose cross-az, num_cache_nodes must be greater than 1
Declaration
public Input<string> AzMode { get; set; }
Property Value
| Type |
Description |
| Input<System.String> |
|
View Source
CacheNodes
List of node objects including id, address, port and availability_zone.
Referenceable e.g. as ${aws_elasticache_cluster.bar.cache_nodes.0.address}
Declaration
public InputList<ClusterCacheNodeGetArgs> CacheNodes { get; set; }
Property Value
View Source
ClusterAddress
(Memcached only) The DNS name of the cache cluster without the port appended.
Declaration
public Input<string> ClusterAddress { get; set; }
Property Value
| Type |
Description |
| Input<System.String> |
|
View Source
ClusterId
Group identifier. ElastiCache converts
this name to lowercase
Declaration
public Input<string> ClusterId { get; set; }
Property Value
| Type |
Description |
| Input<System.String> |
|
View Source
ConfigurationEndpoint
(Memcached only) The configuration endpoint to allow host discovery.
Declaration
public Input<string> ConfigurationEndpoint { get; set; }
Property Value
| Type |
Description |
| Input<System.String> |
|
View Source
Engine
Name of the cache engine to be used for this cache cluster.
Valid values for this parameter are memcached or redis
Declaration
public Input<string> Engine { get; set; }
Property Value
| Type |
Description |
| Input<System.String> |
|
View Source
EngineVersion
Declaration
public Input<string> EngineVersion { get; set; }
Property Value
| Type |
Description |
| Input<System.String> |
|
View Source
MaintenanceWindow
Specifies the weekly time range for when maintenance
on the cache cluster is performed. The format is ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC).
The minimum maintenance window is a 60 minute period. Example: sun:05:00-sun:09:00
Declaration
public Input<string> MaintenanceWindow { get; set; }
Property Value
| Type |
Description |
| Input<System.String> |
|
View Source
NodeType
Declaration
public Input<string> NodeType { get; set; }
Property Value
| Type |
Description |
| Input<System.String> |
|
View Source
NotificationTopicArn
An Amazon Resource Name (ARN) of an
SNS topic to send ElastiCache notifications to. Example:
arn:aws:sns:us-east-1:012345678999:my_sns_topic
Declaration
public Input<string> NotificationTopicArn { get; set; }
Property Value
| Type |
Description |
| Input<System.String> |
|
View Source
NumCacheNodes
The initial number of cache nodes that the
cache cluster will have. For Redis, this value must be 1. For Memcache, this
value must be between 1 and 20. If this number is reduced on subsequent runs,
the highest numbered nodes will be removed.
Declaration
public Input<int> NumCacheNodes { get; set; }
Property Value
| Type |
Description |
| Input<System.Int32> |
|
View Source
ParameterGroupName
Name of the parameter group to associate
with this cache cluster
Declaration
public Input<string> ParameterGroupName { get; set; }
Property Value
| Type |
Description |
| Input<System.String> |
|
View Source
Port
The port number on which each of the cache nodes will accept connections. For Memcache the default is 11211, and for Redis the default port is 6379. Cannot be provided with replication_group_id.
Declaration
public Input<int> Port { get; set; }
Property Value
| Type |
Description |
| Input<System.Int32> |
|
View Source
PreferredAvailabilityZones
A list of the Availability Zones in which cache nodes are created. If you are creating your cluster in an Amazon VPC you can only locate nodes in Availability Zones that are associated with the subnets in the selected subnet group. The number of Availability Zones listed must equal the value of num_cache_nodes. If you want all the nodes in the same Availability Zone, use availability_zone instead, or repeat the Availability Zone multiple times in the list. Default: System chosen Availability Zones. Detecting drift of existing node availability zone is not currently supported. Updating this argument by itself to migrate existing node availability zones is not currently supported and will show a perpetual difference.
Declaration
public InputList<string> PreferredAvailabilityZones { get; set; }
Property Value
View Source
ReplicationGroupId
The ID of the replication group to which this cluster should belong. If this parameter is specified, the cluster is added to the specified replication group as a read replica; otherwise, the cluster is a standalone primary that is not part of any replication group.
Declaration
public Input<string> ReplicationGroupId { get; set; }
Property Value
| Type |
Description |
| Input<System.String> |
|
View Source
SecurityGroupIds
One or more VPC security groups associated
with the cache cluster
Declaration
public InputList<string> SecurityGroupIds { get; set; }
Property Value
View Source
SecurityGroupNames
List of security group
names to associate with this cache cluster
Declaration
public InputList<string> SecurityGroupNames { get; set; }
Property Value
View Source
SnapshotArns
A single-element string list containing an
Amazon Resource Name (ARN) of a Redis RDB snapshot file stored in Amazon S3.
Example: arn:aws:s3:::my_bucket/snapshot1.rdb
Declaration
public InputList<string> SnapshotArns { get; set; }
Property Value
View Source
SnapshotName
The name of a snapshot from which to restore data into the new node group. Changing the snapshot_name forces a new resource.
Declaration
public Input<string> SnapshotName { get; set; }
Property Value
| Type |
Description |
| Input<System.String> |
|
View Source
SnapshotRetentionLimit
The number of days for which ElastiCache will
retain automatic cache cluster snapshots before deleting them. For example, if you set
SnapshotRetentionLimit to 5, then a snapshot that was taken today will be retained for 5 days
before being deleted. If the value of SnapshotRetentionLimit is set to zero (0), backups are turned off.
Please note that setting a snapshot_retention_limit is not supported on cache.t1.micro or cache.t2.* cache nodes
Declaration
public Input<int> SnapshotRetentionLimit { get; set; }
Property Value
| Type |
Description |
| Input<System.Int32> |
|
View Source
SnapshotWindow
The daily time range (in UTC) during which ElastiCache will
begin taking a daily snapshot of your cache cluster. Example: 05:00-09:00
Declaration
public Input<string> SnapshotWindow { get; set; }
Property Value
| Type |
Description |
| Input<System.String> |
|
View Source
SubnetGroupName
Name of the subnet group to be used
for the cache cluster.
Declaration
public Input<string> SubnetGroupName { get; set; }
Property Value
| Type |
Description |
| Input<System.String> |
|
View Source
A map of tags to assign to the resource
Declaration
public InputMap<object> Tags { get; set; }
Property Value
| Type |
Description |
| InputMap<System.Object> |
|