이 페이지는 아직 한국어로 제공되지 않으며 번역 작업 중입니다. 번역에 관한 질문이나 의견이 있으시면 언제든지 저희에게 연락해 주십시오.

aws_elasticache_replication_group

account_id

Type: STRING

arn

Type: STRING
Provider name: ARN
Description: The ARN (Amazon Resource Name) of the replication group.

at_rest_encryption_enabled

Type: BOOLEAN
Provider name: AtRestEncryptionEnabled
Description: A flag that enables encryption at-rest when set to true. You cannot modify the value of AtRestEncryptionEnabled after the cluster is created. To enable encryption at-rest on a cluster you must set AtRestEncryptionEnabled to true when you create a cluster. Required: Only available when creating a replication group in an Amazon VPC using redis version 3.2.6, 4.x or later.
Default: false

auth_token_enabled

Type: BOOLEAN
Provider name: AuthTokenEnabled
Description: A flag that enables using an AuthToken (password) when issuing Redis commands.
Default: false

auth_token_last_modified_date

Type: TIMESTAMP
Provider name: AuthTokenLastModifiedDate
Description: The date the auth token was last modified

auto_minor_version_upgrade

Type: BOOLEAN
Provider name: AutoMinorVersionUpgrade
Description: If you are running Redis engine version 6.0 or later, set this parameter to yes if you want to opt-in to the next auto minor version upgrade campaign. This parameter is disabled for previous versions.

automatic_failover

Type: STRING
Provider name: AutomaticFailover
Description: Indicates the status of automatic failover for this Redis replication group.

cache_node_type

Type: STRING
Provider name: CacheNodeType
Description: The name of the compute and memory capacity node type for each node in the replication group.

cluster_enabled

Type: BOOLEAN
Provider name: ClusterEnabled
Description: A flag indicating whether or not this replication group is cluster enabled; i.e., whether its data can be partitioned across multiple shards (API/CLI: node groups). Valid values: true | false

cluster_mode

Type: STRING
Provider name: ClusterMode
Description: Enabled or Disabled. To modify cluster mode from Disabled to Enabled, you must first set the cluster mode to Compatible. Compatible mode allows your Redis clients to connect using both cluster mode enabled and cluster mode disabled. After you migrate all Redis clients to use cluster mode enabled, you can then complete cluster mode configuration and set the cluster mode to Enabled.

configuration_endpoint

Type: STRUCT
Provider name: ConfigurationEndpoint
Description: The configuration endpoint for this replication group. Use the configuration endpoint to connect to this replication group.

  • address
    Type: STRING
    Provider name: Address
    Description: The DNS hostname of the cache node.
  • port
    Type: INT32
    Provider name: Port
    Description: The port number that the cache engine is listening on.

data_tiering

Type: STRING
Provider name: DataTiering
Description: 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. For more information, see Data tiering.

description

Type: STRING
Provider name: Description
Description: The user supplied description of the replication group.

global_replication_group_info

Type: STRUCT
Provider name: GlobalReplicationGroupInfo
Description: The name of the Global datastore and role of this replication group in the Global datastore.

  • global_replication_group_id
    Type: STRING
    Provider name: GlobalReplicationGroupId
    Description: The name of the Global datastore
  • global_replication_group_member_role
    Type: STRING
    Provider name: GlobalReplicationGroupMemberRole
    Description: The role of the replication group in a Global datastore. Can be primary or secondary.

ip_discovery

Type: STRING
Provider name: IpDiscovery
Description: The network type you choose when modifying a cluster, either ipv4 | ipv6. IPv6 is supported for workloads using Redis engine version 6.2 onward or Memcached engine version 1.6.6 on all instances built on the Nitro system.

kms_key_id

Type: STRING
Provider name: KmsKeyId
Description: The ID of the KMS key used to encrypt the disk in the cluster.

log_delivery_configurations

Type: UNORDERED_LIST_STRUCT
Provider name: LogDeliveryConfigurations
Description: Returns the destination, format and type of the logs.

  • destination_details
    Type: STRUCT
    Provider name: DestinationDetails
    Description: Configuration details of either a CloudWatch Logs destination or Kinesis Data Firehose destination.
    • cloud_watch_logs_details
      Type: STRUCT
      Provider name: CloudWatchLogsDetails
      Description: The configuration details of the CloudWatch Logs destination.
      • log_group
        Type: STRING
        Provider name: LogGroup
        Description: The name of the CloudWatch Logs log group.
    • kinesis_firehose_details
      Type: STRUCT
      Provider name: KinesisFirehoseDetails
      Description: The configuration details of the Kinesis Data Firehose destination.
      • delivery_stream
        Type: STRING
        Provider name: DeliveryStream
        Description: The name of the Kinesis Data Firehose delivery stream.
  • destination_type
    Type: STRING
    Provider name: DestinationType
    Description: Returns the destination type, either cloudwatch-logs or kinesis-firehose.
  • log_format
    Type: STRING
    Provider name: LogFormat
    Description: Returns the log format, either JSON or TEXT.
  • log_type
    Type: STRING
    Provider name: LogType
    Description: Refers to slow-log or engine-log.
  • message
    Type: STRING
    Provider name: Message
    Description: Returns an error message for the log delivery configuration.
  • status
    Type: STRING
    Provider name: Status
    Description: Returns the log delivery configuration status. Values are one of enabling | disabling | modifying | active | error

member_clusters

Type: UNORDERED_LIST_STRING
Provider name: MemberClusters
Description: The names of all the cache clusters that are part of this replication group.

member_clusters_outpost_arns

Type: UNORDERED_LIST_STRING
Provider name: MemberClustersOutpostArns
Description: The outpost ARNs of the replication group’s member clusters.

multi_az

Type: STRING
Provider name: MultiAZ
Description: A flag indicating if you have Multi-AZ enabled to enhance fault tolerance. For more information, see Minimizing Downtime: Multi-AZ

network_type

Type: STRING
Provider name: NetworkType
Description: Must be either ipv4 | ipv6 | dual_stack. IPv6 is supported for workloads using Redis engine version 6.2 onward or Memcached engine version 1.6.6 on all instances built on the Nitro system.

node_groups

Type: UNORDERED_LIST_STRUCT
Provider name: NodeGroups
Description: A list of node groups in this replication group. For Redis (cluster mode disabled) replication groups, this is a single-element list. For Redis (cluster mode enabled) replication groups, the list contains an entry for each node group (shard).

  • node_group_id
    Type: STRING
    Provider name: NodeGroupId
    Description: The identifier for the node group (shard). A Redis (cluster mode disabled) replication group contains only 1 node group; therefore, the node group ID is 0001. A Redis (cluster mode enabled) replication group contains 1 to 90 node groups numbered 0001 to 0090. Optionally, the user can provide the id for a node group.
  • node_group_members
    Type: UNORDERED_LIST_STRUCT
    Provider name: NodeGroupMembers
    Description: A list containing information about individual nodes within the node group (shard).
    • cache_cluster_id
      Type: STRING
      Provider name: CacheClusterId
      Description: The ID of the cluster to which the node belongs.
    • cache_node_id
      Type: STRING
      Provider name: CacheNodeId
      Description: The ID of the node within its cluster. A node ID is a numeric identifier (0001, 0002, etc.).
    • current_role
      Type: STRING
      Provider name: CurrentRole
      Description: The role that is currently assigned to the node - primary or replica. This member is only applicable for Redis (cluster mode disabled) replication groups.
    • preferred_availability_zone
      Type: STRING
      Provider name: PreferredAvailabilityZone
      Description: The name of the Availability Zone in which the node is located.
    • preferred_outpost_arn
      Type: STRING
      Provider name: PreferredOutpostArn
      Description: The outpost ARN of the node group member.
    • read_endpoint
      Type: STRUCT
      Provider name: ReadEndpoint
      Description: The information required for client programs to connect to a node for read operations. The read endpoint is only applicable on Redis (cluster mode disabled) clusters.
      • address
        Type: STRING
        Provider name: Address
        Description: The DNS hostname of the cache node.
      • port
        Type: INT32
        Provider name: Port
        Description: The port number that the cache engine is listening on.
  • primary_endpoint
    Type: STRUCT
    Provider name: PrimaryEndpoint
    Description: The endpoint of the primary node in this node group (shard).
    • address
      Type: STRING
      Provider name: Address
      Description: The DNS hostname of the cache node.
    • port
      Type: INT32
      Provider name: Port
      Description: The port number that the cache engine is listening on.
  • reader_endpoint
    Type: STRUCT
    Provider name: ReaderEndpoint
    Description: The endpoint of the replica nodes in this node group (shard).
    • address
      Type: STRING
      Provider name: Address
      Description: The DNS hostname of the cache node.
    • port
      Type: INT32
      Provider name: Port
      Description: The port number that the cache engine is listening on.
  • slots
    Type: STRING
    Provider name: Slots
    Description: The keyspace for this node group (shard).
  • status
    Type: STRING
    Provider name: Status
    Description: The current state of this replication group - creating, available, modifying, deleting.

pending_modified_values

Type: STRUCT
Provider name: PendingModifiedValues
Description: A group of settings to be applied to the replication group, either immediately or during the next maintenance window.

  • auth_token_status
    Type: STRING
    Provider name: AuthTokenStatus
    Description: The auth token status
  • automatic_failover_status
    Type: STRING
    Provider name: AutomaticFailoverStatus
    Description: Indicates the status of automatic failover for this Redis replication group.
  • cluster_mode
    Type: STRING
    Provider name: ClusterMode
    Description: Enabled or Disabled. To modify cluster mode from Disabled to Enabled, you must first set the cluster mode to Compatible. Compatible mode allows your Redis clients to connect using both cluster mode enabled and cluster mode disabled. After you migrate all Redis clients to use cluster mode enabled, you can then complete cluster mode configuration and set the cluster mode to Enabled.
  • log_delivery_configurations
    Type: UNORDERED_LIST_STRUCT
    Provider name: LogDeliveryConfigurations
    Description: The log delivery configurations being modified
    • destination_details
      Type: STRUCT
      Provider name: DestinationDetails
      Description: Configuration details of either a CloudWatch Logs destination or Kinesis Data Firehose destination.
      • cloud_watch_logs_details
        Type: STRUCT
        Provider name: CloudWatchLogsDetails
        Description: The configuration details of the CloudWatch Logs destination.
        • log_group
          Type: STRING
          Provider name: LogGroup
          Description: The name of the CloudWatch Logs log group.
      • kinesis_firehose_details
        Type: STRUCT
        Provider name: KinesisFirehoseDetails
        Description: The configuration details of the Kinesis Data Firehose destination.
        • delivery_stream
          Type: STRING
          Provider name: DeliveryStream
          Description: The name of the Kinesis Data Firehose delivery stream.
    • destination_type
      Type: STRING
      Provider name: DestinationType
      Description: Returns the destination type, either CloudWatch Logs or Kinesis Data Firehose.
    • log_format
      Type: STRING
      Provider name: LogFormat
      Description: Returns the log format, either JSON or TEXT
    • log_type
      Type: STRING
      Provider name: LogType
      Description: Refers to slow-log or engine-log..
  • primary_cluster_id
    Type: STRING
    Provider name: PrimaryClusterId
    Description: The primary cluster ID that is applied immediately (if –apply-immediately was specified), or during the next maintenance window.
  • resharding
    Type: STRUCT
    Provider name: Resharding
    Description: The status of an online resharding operation.
    • slot_migration
      Type: STRUCT
      Provider name: SlotMigration
      Description: Represents the progress of an online resharding operation.
      • progress_percentage
        Type: DOUBLE
        Provider name: ProgressPercentage
        Description: The percentage of the slot migration that is complete.
  • transit_encryption_enabled
    Type: BOOLEAN
    Provider name: TransitEncryptionEnabled
    Description: A flag that enables in-transit encryption when set to true.
  • transit_encryption_mode
    Type: STRING
    Provider name: TransitEncryptionMode
    Description: A setting that allows you to migrate your clients to use in-transit encryption, with no downtime.
  • user_groups
    Type: STRUCT
    Provider name: UserGroups
    Description: The user group being modified.
    • user_group_ids_to_add
      Type: UNORDERED_LIST_STRING
      Provider name: UserGroupIdsToAdd
      Description: The ID of the user group to add.
    • user_group_ids_to_remove
      Type: UNORDERED_LIST_STRING
      Provider name: UserGroupIdsToRemove
      Description: The ID of the user group to remove.

replication_group_create_time

Type: TIMESTAMP
Provider name: ReplicationGroupCreateTime
Description: The date and time when the cluster was created.

replication_group_id

Type: STRING
Provider name: ReplicationGroupId
Description: The identifier for the replication group.

snapshot_retention_limit

Type: INT32
Provider name: SnapshotRetentionLimit
Description: The number of days for which ElastiCache retains automatic cluster snapshots before deleting them. For example, if you set SnapshotRetentionLimit to 5, a snapshot that was taken today is retained for 5 days before being deleted. If the value of SnapshotRetentionLimit is set to zero (0), backups are turned off.

snapshot_window

Type: STRING
Provider name: SnapshotWindow
Description: The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of your node group (shard). Example: 05:00-09:00 If you do not specify this parameter, ElastiCache automatically chooses an appropriate time range. This parameter is only valid if the Engine parameter is redis.

snapshotting_cluster_id

Type: STRING
Provider name: SnapshottingClusterId
Description: The cluster ID that is used as the daily snapshot source for the replication group.

status

Type: STRING
Provider name: Status
Description: The current state of this replication group - creating, available, modifying, deleting, create-failed, snapshotting.

tags

Type: UNORDERED_LIST_STRING

transit_encryption_enabled

Type: BOOLEAN
Provider name: TransitEncryptionEnabled
Description: A flag that enables in-transit encryption when set to true. Required: Only available when creating a replication group in an Amazon VPC using redis version 3.2.6, 4.x or later.
Default: false

transit_encryption_mode

Type: STRING
Provider name: TransitEncryptionMode
Description: A setting that allows you to migrate your clients to use in-transit encryption, with no downtime.

user_group_ids

Type: UNORDERED_LIST_STRING
Provider name: UserGroupIds
Description: The ID of the user group associated to the replication group.