Class ReplicationGroupState

Inheritance

System.Object

InputArgs

ResourceArgs

ReplicationGroupState

Inherited Members

ResourceArgs.Empty

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()

Namespace: Pulumi.Aws.ElastiCache

Assembly: Pulumi.Aws.dll

Syntax

public sealed class ReplicationGroupState : ResourceArgs

Constructors

ReplicationGroupState()

Declaration

public ReplicationGroupState()

Properties

ApplyImmediately

Specifies whether any modifications are applied immediately, or during the next maintenance window. Default is false.

Declaration

public Input<bool> ApplyImmediately { get; set; }

Property Value

Type	Description
Input<System.Boolean>

AtRestEncryptionEnabled

Whether to enable encryption at rest.

Declaration

public Input<bool> AtRestEncryptionEnabled { get; set; }

Property Value

Type	Description
Input<System.Boolean>

AuthToken

The password used to access a password protected server. Can be specified only if transit_encryption_enabled = true.

Declaration

public Input<string> AuthToken { get; set; }

Property Value

Type	Description
Input<System.String>

AutomaticFailoverEnabled

Specifies whether a read-only replica will be automatically promoted to read/write primary if the existing primary fails. If true, Multi-AZ is enabled for this replication group. If false, Multi-AZ is disabled for this replication group. Must be enabled for Redis (cluster mode enabled) replication groups. Defaults to false.

Declaration

public Input<bool> AutomaticFailoverEnabled { get; set; }

Property Value

Type	Description
Input<System.Boolean>

AutoMinorVersionUpgrade

Specifies whether a minor engine upgrades will be applied automatically to the underlying Cache Cluster instances during the maintenance window. Defaults to true.

Declaration

public Input<bool> AutoMinorVersionUpgrade { get; set; }

Property Value

Type	Description
Input<System.Boolean>

AvailabilityZones

A list of EC2 availability zones in which the replication group's cache clusters will be created. The order of the availability zones in the list is not important.

Declaration

public InputList<string> AvailabilityZones { get; set; }

Property Value

Type	Description
InputList<System.String>

ClusterMode

Create a native redis cluster. automatic_failover_enabled must be set to true. Cluster Mode documented below. Only 1 cluster_mode block is allowed.

Declaration

public Input<ReplicationGroupClusterModeGetArgs> ClusterMode { get; set; }

Property Value

Type	Description
Input<ReplicationGroupClusterModeGetArgs>

ConfigurationEndpointAddress

The address of the replication group configuration endpoint when cluster mode is enabled.

Declaration

public Input<string> ConfigurationEndpointAddress { get; set; }

Property Value

Type	Description
Input<System.String>

Engine

The name of the cache engine to be used for the clusters in this replication group. e.g. redis

Declaration

public Input<string> Engine { get; set; }

Property Value

Type	Description
Input<System.String>

EngineVersion

The version number of the cache engine to be used for the cache clusters in this replication group.

Declaration

public Input<string> EngineVersion { get; set; }

Property Value

Type	Description
Input<System.String>

KmsKeyId

The ARN of the key that you wish to use if encrypting at rest. If not supplied, uses service managed encryption. Can be specified only if at_rest_encryption_enabled = true.

Declaration

public Input<string> KmsKeyId { get; set; }

Property Value

Type	Description
Input<System.String>

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>

MemberClusters

The identifiers of all the nodes that are part of this replication group.

Declaration

public InputList<string> MemberClusters { get; set; }

Property Value

Type	Description
InputList<System.String>

NodeType

The compute and memory capacity of the nodes in the node group.

Declaration

public Input<string> NodeType { get; set; }

Property Value

Type	Description
Input<System.String>

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>

NumberCacheClusters

The number of cache clusters (primary and replicas) this replication group will have. If Multi-AZ is enabled, the value of this parameter must be at least 2. Updates will occur before other modifications.

Declaration

public Input<int> NumberCacheClusters { get; set; }

Property Value

Type	Description
Input<System.Int32>

ParameterGroupName

The name of the parameter group to associate with this replication group. If this argument is omitted, the default cache parameter group for the specified engine is used.

Declaration

public Input<string> ParameterGroupName { get; set; }

Property Value

Type	Description
Input<System.String>

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.

Declaration

public Input<int> Port { get; set; }

Property Value

Type	Description
Input<System.Int32>

PrimaryEndpointAddress

(Redis only) The address of the endpoint for the primary node in the replication group, if the cluster mode is disabled.

Declaration

public Input<string> PrimaryEndpointAddress { get; set; }

Property Value

Type	Description
Input<System.String>

ReplicationGroupDescription

A user-created description for the replication group.

Declaration

public Input<string> ReplicationGroupDescription { get; set; }

Property Value

Type	Description
Input<System.String>

ReplicationGroupId

The replication group identifier. This parameter is stored as a lowercase string.

Declaration

public Input<string> ReplicationGroupId { get; set; }

Property Value

Type	Description
Input<System.String>

SecurityGroupIds

One or more Amazon VPC security groups associated with this replication group. Use this parameter only when you are creating a replication group in an Amazon Virtual Private Cloud

Declaration

public InputList<string> SecurityGroupIds { get; set; }

Property Value

Type	Description
InputList<System.String>

SecurityGroupNames

A list of cache security group names to associate with this replication group.

Declaration

public InputList<string> SecurityGroupNames { get; set; }

Property Value

Type	Description
InputList<System.String>

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

Type	Description
InputList<System.String>

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>

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>

SnapshotWindow

The daily time range (in UTC) during which ElastiCache will begin taking a daily snapshot of your cache cluster. The minimum snapshot window is a 60 minute period. Example: 05:00-09:00

Declaration

public Input<string> SnapshotWindow { get; set; }

Property Value

Type	Description
Input<System.String>

SubnetGroupName

The name of the cache subnet group to be used for the replication group.

Declaration

public Input<string> SubnetGroupName { get; set; }

Property Value

Type	Description
Input<System.String>

Tags

A map of tags to assign to the resource

Declaration

public InputMap<object> Tags { get; set; }

Property Value

Type	Description
InputMap<System.Object>

TransitEncryptionEnabled

Whether to enable encryption in transit.

Declaration

public Input<bool> TransitEncryptionEnabled { get; set; }

Property Value

Type	Description
Input<System.Boolean>