ReplicationGroupArgs constructor

const ReplicationGroupArgs({
  1. Input<bool?>? applyImmediately,
  2. Input<bool?>? atRestEncryptionEnabled,
  3. Input<String?>? authToken,
  4. Input<String?>? authTokenUpdateStrategy,
  5. Input<String?>? authTokenWo,
  6. Input<int?>? authTokenWoVersion,
  7. Input<bool?>? autoMinorVersionUpgrade,
  8. Input<bool?>? automaticFailoverEnabled,
  9. Input<String?>? clusterMode,
  10. Input<bool?>? dataTieringEnabled,
  11. required Input<String> description,
  12. Input<String?>? durability,
  13. Input<String?>? engine,
  14. Input<String?>? engineVersion,
  15. Input<String?>? finalSnapshotIdentifier,
  16. Input<String?>? globalReplicationGroupId,
  17. Input<String?>? ipDiscovery,
  18. Input<String?>? kmsKeyId,
  19. Input<List<ReplicationGroupLogDeliveryConfiguration>?>? logDeliveryConfigurations,
  20. Input<String?>? maintenanceWindow,
  21. Input<bool?>? multiAzEnabled,
  22. Input<String?>? networkType,
  23. Input<List<ReplicationGroupNodeGroupConfiguration>?>? nodeGroupConfigurations,
  24. Input<String?>? nodeType,
  25. Input<String?>? notificationTopicArn,
  26. Input<int?>? numCacheClusters,
  27. Input<int?>? numNodeGroups,
  28. Input<String?>? parameterGroupName,
  29. Input<int?>? port,
  30. Input<List<String>?>? preferredCacheClusterAzs,
  31. Input<String?>? region,
  32. Input<int?>? replicasPerNodeGroup,
  33. Input<String?>? replicationGroupId,
  34. Input<List<String>?>? securityGroupIds,
  35. Input<List<String>?>? securityGroupNames,
  36. Input<List<String>?>? snapshotArns,
  37. Input<String?>? snapshotName,
  38. Input<int?>? snapshotRetentionLimit,
  39. Input<String?>? snapshotWindow,
  40. Input<String?>? subnetGroupName,
  41. Input<Map<String, String>?>? tags,
  42. Input<bool?>? transitEncryptionEnabled,
  43. Input<String?>? transitEncryptionMode,
  44. Input<List<String>?>? userGroupIds,
})

Creates a new ReplicationGroupArgs. applyImmediately Specifies whether any modifications are applied immediately, or during the next maintenance window. Default is false. atRestEncryptionEnabled Whether to enable encryption at rest. authToken Password used to access a password protected server. Can be specified only if transitEncryptionEnabled = true. authTokenUpdateStrategy Strategy used when modifying authToken or authTokenWo on an existing replication group. Not used during initial create. Valid values are SET, ROTATE, and DELETE. If omitted during an auth token change, AWS defaults to ROTATE. If value is DELETE then authToken and authTokenWo must be omitted. authTokenWo NOTE: This field is write-only and its value will not be updated in state as part of read operations. authTokenWoVersion Integer that, when changed, triggers a re-send of authTokenWo to the replication group. Requires authTokenWo. autoMinorVersionUpgrade Specifies whether minor version engine upgrades will be applied automatically to the underlying Cache Cluster instances during the maintenance window. automaticFailoverEnabled Specifies whether a read-only replica will be automatically promoted to read/write primary if the existing primary fails. If enabled, numCacheClusters must be greater than 1. Must be enabled for Redis (cluster mode enabled) replication groups. Defaults to false. clusterMode Specifies whether cluster mode is enabled or disabled. Valid values are enabled or disabled or compatible dataTieringEnabled Enables data tiering. Data tiering is only supported for replication groups using the r6gd node type. This parameter must be set to true when using r6gd nodes. description User-created description for the replication group. Must not be empty. durability Specifies the durability mode for the replication group. Valid values are default, async, sync, or disabled. Requires cluster mode enabled and Valkey 9.0 or higher. engine Name of the cache engine to be used for the clusters in this replication group. engineVersion Version number of the cache engine to be used for the cache clusters in this replication group. finalSnapshotIdentifier The name of your final node group (shard) snapshot. ElastiCache creates the snapshot from the primary node in the cluster. If omitted, no final snapshot will be made. globalReplicationGroupId The ID of the global replication group to which this replication group should belong. If this parameter is specified, the replication group is added to the specified global replication group as a secondary replication group; otherwise, the replication group is not part of any global replication group. If globalReplicationGroupId is set, the numNodeGroups parameter cannot be set. ipDiscovery The IP version to advertise in the discovery protocol. Valid values are ipv4 or ipv6. 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 atRestEncryptionEnabled = true. logDeliveryConfigurations Specifies the destination and format of Redis OSS/Valkey SLOWLOG or Redis OSS/Valkey Engine Log. See the documentation on Amazon ElastiCache. See Log Delivery Configuration below for more details. 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 multiAzEnabled Specifies whether to enable Multi-AZ Support for the replication group. networkType The IP versions for cache cluster connections. Valid values are ipv4, ipv6 or dualStack. nodeGroupConfigurations Configuration block for node groups (shards). Can be specified only if numNodeGroups is set. Conflicts with preferredCacheClusterAzs. See Node Group Configuration below for more details. nodeType Instance class to be used. notificationTopicArn ARN of an SNS topic to send ElastiCache notifications to. Example: arn:aws:sns:us-east-1:012345678999:my_sns_topic numCacheClusters Number of cache clusters (primary and replicas) this replication group will have. numNodeGroups Number of node groups (shards) for this Redis replication group. parameterGroupName 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. To enable "cluster mode", i.e., data sharding, use a parameter group that has the parameter cluster-enabled set to true. port 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. preferredCacheClusterAzs 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 considered. The first item in the list will be the primary node. Ignored when updating. region Region where this resource will be managed. Defaults to the Region set in the provider configuration. replicasPerNodeGroup Number of replica nodes in each node group. replicationGroupId Replication group identifier. This parameter is stored as a lowercase string. securityGroupIds IDs of one or more Amazon VPC security groups associated with this replication group. Use this parameter only when you are creating a replication group in a VPC. securityGroupNames Names of one or more Amazon VPC security groups associated with this replication group. Use this parameter only when you are creating a replication group in a VPC. snapshotArns List of ARNs that identify Redis RDB snapshot files stored in Amazon S3. The names object names cannot contain any commas. snapshotName Name of a snapshot from which to restore data into the new node group. Changing the snapshotName forces a new resource. snapshotRetentionLimit 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 snapshotRetentionLimit is not supported on cache.t1.micro cache nodes snapshotWindow 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 subnetGroupName Name of the cache subnet group to be used for the replication group. tags Map of tags to assign to the resource. Adding tags to this resource will add or overwrite any existing tags on the clusters in the replication group and not to the group itself. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level. transitEncryptionEnabled Whether to enable encryption in transit. transitEncryptionMode A setting that enables clients to migrate to in-transit encryption with no downtime. userGroupIds User Group ID to associate with the replication group. Only a maximum of one (1) user group ID is valid. NOTE: This argument is a set because the AWS specification allows for multiple IDs. However, in practice, AWS only allows a maximum size of one.

Implementation

const ReplicationGroupArgs({
  this.applyImmediately,
  this.atRestEncryptionEnabled,
  this.authToken,
  this.authTokenUpdateStrategy,
  this.authTokenWo,
  this.authTokenWoVersion,
  this.autoMinorVersionUpgrade,
  this.automaticFailoverEnabled,
  this.clusterMode,
  this.dataTieringEnabled,
  required this.description,
  this.durability,
  this.engine,
  this.engineVersion,
  this.finalSnapshotIdentifier,
  this.globalReplicationGroupId,
  this.ipDiscovery,
  this.kmsKeyId,
  this.logDeliveryConfigurations,
  this.maintenanceWindow,
  this.multiAzEnabled,
  this.networkType,
  this.nodeGroupConfigurations,
  this.nodeType,
  this.notificationTopicArn,
  this.numCacheClusters,
  this.numNodeGroups,
  this.parameterGroupName,
  this.port,
  this.preferredCacheClusterAzs,
  this.region,
  this.replicasPerNodeGroup,
  this.replicationGroupId,
  this.securityGroupIds,
  this.securityGroupNames,
  this.snapshotArns,
  this.snapshotName,
  this.snapshotRetentionLimit,
  this.snapshotWindow,
  this.subnetGroupName,
  this.tags,
  this.transitEncryptionEnabled,
  this.transitEncryptionMode,
  this.userGroupIds,
});