{ "smithy": "2.0", "metadata": { "suppressions": [ { "id": "HttpMethodSemantics", "namespace": "*" }, { "id": "HttpResponseCodeSemantics", "namespace": "*" }, { "id": "PaginatedTrait", "namespace": "*" }, { "id": "HttpHeaderTrait", "namespace": "*" }, { "id": "HttpUriConflict", "namespace": "*" }, { "id": "Service", "namespace": "*" } ] }, "shapes": { "com.amazonaws.elasticache#APICallRateForCustomerExceededFault": { "type": "structure", "members": { "message": { "target": "com.amazonaws.elasticache#ExceptionMessage" } }, "traits": { "aws.protocols#awsQueryError": { "code": "APICallRateForCustomerExceeded", "httpResponseCode": 400 }, "smithy.api#documentation": "
The customer has exceeded the allowed rate of API calls.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.elasticache#AZMode": { "type": "enum", "members": { "SINGLE_AZ": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "single-az" } }, "CROSS_AZ": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "cross-az" } } } }, "com.amazonaws.elasticache#AccessString": { "type": "string", "traits": { "smithy.api#pattern": "\\S" } }, "com.amazonaws.elasticache#AddTagsToResource": { "type": "operation", "input": { "target": "com.amazonaws.elasticache#AddTagsToResourceMessage" }, "output": { "target": "com.amazonaws.elasticache#TagListMessage" }, "errors": [ { "target": "com.amazonaws.elasticache#CacheClusterNotFoundFault" }, { "target": "com.amazonaws.elasticache#CacheParameterGroupNotFoundFault" }, { "target": "com.amazonaws.elasticache#CacheSecurityGroupNotFoundFault" }, { "target": "com.amazonaws.elasticache#CacheSubnetGroupNotFoundFault" }, { "target": "com.amazonaws.elasticache#GlobalReplicationGroupNotFoundFault" }, { "target": "com.amazonaws.elasticache#InvalidARNFault" }, { "target": "com.amazonaws.elasticache#InvalidParameterValueException" }, { "target": "com.amazonaws.elasticache#InvalidReplicationGroupStateFault" }, { "target": "com.amazonaws.elasticache#InvalidServerlessCacheSnapshotStateFault" }, { "target": "com.amazonaws.elasticache#InvalidServerlessCacheStateFault" }, { "target": "com.amazonaws.elasticache#ReplicationGroupNotFoundFault" }, { "target": "com.amazonaws.elasticache#ReservedCacheNodeNotFoundFault" }, { "target": "com.amazonaws.elasticache#ServerlessCacheNotFoundFault" }, { "target": "com.amazonaws.elasticache#ServerlessCacheSnapshotNotFoundFault" }, { "target": "com.amazonaws.elasticache#SnapshotNotFoundFault" }, { "target": "com.amazonaws.elasticache#TagQuotaPerResourceExceeded" }, { "target": "com.amazonaws.elasticache#UserGroupNotFoundFault" }, { "target": "com.amazonaws.elasticache#UserNotFoundFault" } ], "traits": { "smithy.api#documentation": "A tag is a key-value pair where the key and value are case-sensitive. You can use tags\n to categorize and track all your ElastiCache resources.\n When you add or remove tags on replication groups, those actions will\n be replicated to all nodes in the replication group. For more information, see Resource-level permissions.
\nFor example, you can use cost-allocation tags to your ElastiCache resources, Amazon\n generates a cost allocation report as a comma-separated value (CSV) file with your usage\n and costs aggregated by your tags. You can apply tags that represent business categories\n (such as cost centers, application names, or owners) to organize your costs across\n multiple services.
\nFor more information, see Using Cost Allocation Tags in\n Amazon ElastiCache in the ElastiCache User\n Guide.
", "smithy.api#examples": [ { "title": "AddTagsToResource", "documentation": "Adds up to 10 tags, key/value pairs, to a cluster or snapshot resource.", "input": { "ResourceName": "arn:aws:elasticache:us-east-1:1234567890:cluster:my-mem-cluster", "Tags": [ { "Value": "20150202", "Key": "APIVersion" }, { "Value": "ElastiCache", "Key": "Service" } ] }, "output": { "TagList": [ { "Value": "20150202", "Key": "APIVersion" }, { "Value": "ElastiCache", "Key": "Service" } ] } } ] } }, "com.amazonaws.elasticache#AddTagsToResourceMessage": { "type": "structure", "members": { "ResourceName": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The Amazon Resource Name (ARN) of the resource to which the tags are to be added, for\n example arn:aws:elasticache:us-west-2:0123456789:cluster:myCluster or\n arn:aws:elasticache:us-west-2:0123456789:snapshot:mySnapshot.\n ElastiCache resources are cluster and\n snapshot.
For more information about ARNs, see Amazon Resource Names (ARNs)\n and Amazon Service Namespaces.
", "smithy.api#required": {} } }, "Tags": { "target": "com.amazonaws.elasticache#TagList", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "A list of tags to be added to this resource. A tag is a key-value pair. A tag key must\n be accompanied by a tag value, although null is accepted.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Represents the input of an AddTagsToResource operation.
", "smithy.api#input": {} } }, "com.amazonaws.elasticache#AllowedNodeGroupId": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 4 }, "smithy.api#pattern": "^\\d+$" } }, "com.amazonaws.elasticache#AllowedNodeTypeModificationsMessage": { "type": "structure", "members": { "ScaleUpModifications": { "target": "com.amazonaws.elasticache#NodeTypeList", "traits": { "smithy.api#documentation": "A string list, each element of which specifies a cache node type which you can use to\n scale your cluster or replication group.
\nWhen scaling up a Valkey or Redis OSS cluster or replication group using\n ModifyCacheCluster or ModifyReplicationGroup, use a value\n from this list for the CacheNodeType parameter.
A string list, each element of which specifies a cache node type which you can use to\n scale your cluster or replication group. When scaling down a Valkey or Redis OSS cluster or\n replication group using ModifyCacheCluster or ModifyReplicationGroup, use a value from\n this list for the CacheNodeType parameter.
" } } }, "traits": { "smithy.api#documentation": "Represents the allowed node types you can use to modify your cluster or replication\n group.
", "smithy.api#output": {} } }, "com.amazonaws.elasticache#AmazonElastiCacheV9": { "type": "service", "version": "2015-02-02", "operations": [ { "target": "com.amazonaws.elasticache#AddTagsToResource" }, { "target": "com.amazonaws.elasticache#AuthorizeCacheSecurityGroupIngress" }, { "target": "com.amazonaws.elasticache#BatchApplyUpdateAction" }, { "target": "com.amazonaws.elasticache#BatchStopUpdateAction" }, { "target": "com.amazonaws.elasticache#CompleteMigration" }, { "target": "com.amazonaws.elasticache#CopyServerlessCacheSnapshot" }, { "target": "com.amazonaws.elasticache#CopySnapshot" }, { "target": "com.amazonaws.elasticache#CreateCacheCluster" }, { "target": "com.amazonaws.elasticache#CreateCacheParameterGroup" }, { "target": "com.amazonaws.elasticache#CreateCacheSecurityGroup" }, { "target": "com.amazonaws.elasticache#CreateCacheSubnetGroup" }, { "target": "com.amazonaws.elasticache#CreateGlobalReplicationGroup" }, { "target": "com.amazonaws.elasticache#CreateReplicationGroup" }, { "target": "com.amazonaws.elasticache#CreateServerlessCache" }, { "target": "com.amazonaws.elasticache#CreateServerlessCacheSnapshot" }, { "target": "com.amazonaws.elasticache#CreateSnapshot" }, { "target": "com.amazonaws.elasticache#CreateUser" }, { "target": "com.amazonaws.elasticache#CreateUserGroup" }, { "target": "com.amazonaws.elasticache#DecreaseNodeGroupsInGlobalReplicationGroup" }, { "target": "com.amazonaws.elasticache#DecreaseReplicaCount" }, { "target": "com.amazonaws.elasticache#DeleteCacheCluster" }, { "target": "com.amazonaws.elasticache#DeleteCacheParameterGroup" }, { "target": "com.amazonaws.elasticache#DeleteCacheSecurityGroup" }, { "target": "com.amazonaws.elasticache#DeleteCacheSubnetGroup" }, { "target": "com.amazonaws.elasticache#DeleteGlobalReplicationGroup" }, { "target": "com.amazonaws.elasticache#DeleteReplicationGroup" }, { "target": "com.amazonaws.elasticache#DeleteServerlessCache" }, { "target": "com.amazonaws.elasticache#DeleteServerlessCacheSnapshot" }, { "target": "com.amazonaws.elasticache#DeleteSnapshot" }, { "target": "com.amazonaws.elasticache#DeleteUser" }, { "target": "com.amazonaws.elasticache#DeleteUserGroup" }, { "target": "com.amazonaws.elasticache#DescribeCacheClusters" }, { "target": "com.amazonaws.elasticache#DescribeCacheEngineVersions" }, { "target": "com.amazonaws.elasticache#DescribeCacheParameterGroups" }, { "target": "com.amazonaws.elasticache#DescribeCacheParameters" }, { "target": "com.amazonaws.elasticache#DescribeCacheSecurityGroups" }, { "target": "com.amazonaws.elasticache#DescribeCacheSubnetGroups" }, { "target": "com.amazonaws.elasticache#DescribeEngineDefaultParameters" }, { "target": "com.amazonaws.elasticache#DescribeEvents" }, { "target": "com.amazonaws.elasticache#DescribeGlobalReplicationGroups" }, { "target": "com.amazonaws.elasticache#DescribeReplicationGroups" }, { "target": "com.amazonaws.elasticache#DescribeReservedCacheNodes" }, { "target": "com.amazonaws.elasticache#DescribeReservedCacheNodesOfferings" }, { "target": "com.amazonaws.elasticache#DescribeServerlessCaches" }, { "target": "com.amazonaws.elasticache#DescribeServerlessCacheSnapshots" }, { "target": "com.amazonaws.elasticache#DescribeServiceUpdates" }, { "target": "com.amazonaws.elasticache#DescribeSnapshots" }, { "target": "com.amazonaws.elasticache#DescribeUpdateActions" }, { "target": "com.amazonaws.elasticache#DescribeUserGroups" }, { "target": "com.amazonaws.elasticache#DescribeUsers" }, { "target": "com.amazonaws.elasticache#DisassociateGlobalReplicationGroup" }, { "target": "com.amazonaws.elasticache#ExportServerlessCacheSnapshot" }, { "target": "com.amazonaws.elasticache#FailoverGlobalReplicationGroup" }, { "target": "com.amazonaws.elasticache#IncreaseNodeGroupsInGlobalReplicationGroup" }, { "target": "com.amazonaws.elasticache#IncreaseReplicaCount" }, { "target": "com.amazonaws.elasticache#ListAllowedNodeTypeModifications" }, { "target": "com.amazonaws.elasticache#ListTagsForResource" }, { "target": "com.amazonaws.elasticache#ModifyCacheCluster" }, { "target": "com.amazonaws.elasticache#ModifyCacheParameterGroup" }, { "target": "com.amazonaws.elasticache#ModifyCacheSubnetGroup" }, { "target": "com.amazonaws.elasticache#ModifyGlobalReplicationGroup" }, { "target": "com.amazonaws.elasticache#ModifyReplicationGroup" }, { "target": "com.amazonaws.elasticache#ModifyReplicationGroupShardConfiguration" }, { "target": "com.amazonaws.elasticache#ModifyServerlessCache" }, { "target": "com.amazonaws.elasticache#ModifyUser" }, { "target": "com.amazonaws.elasticache#ModifyUserGroup" }, { "target": "com.amazonaws.elasticache#PrepareMigration" }, { "target": "com.amazonaws.elasticache#PurchaseReservedCacheNodesOffering" }, { "target": "com.amazonaws.elasticache#RebalanceSlotsInGlobalReplicationGroup" }, { "target": "com.amazonaws.elasticache#RebootCacheCluster" }, { "target": "com.amazonaws.elasticache#RemoveTagsFromResource" }, { "target": "com.amazonaws.elasticache#ResetCacheParameterGroup" }, { "target": "com.amazonaws.elasticache#RevokeCacheSecurityGroupIngress" }, { "target": "com.amazonaws.elasticache#StartMigration" }, { "target": "com.amazonaws.elasticache#StopMigration" }, { "target": "com.amazonaws.elasticache#TestFailover" }, { "target": "com.amazonaws.elasticache#TestMigration" } ], "traits": { "aws.api#service": { "sdkId": "ElastiCache", "arnNamespace": "elasticache", "cloudFormationName": "ElastiCache", "cloudTrailEventSource": "elasticache.amazonaws.com", "endpointPrefix": "elasticache" }, "aws.auth#sigv4": { "name": "elasticache" }, "aws.protocols#awsQuery": {}, "smithy.api#documentation": "Amazon ElastiCache is a web service that makes it easier to set up, operate, and scale\n a distributed cache in the cloud.
\nWith ElastiCache, customers get all of the benefits of a high-performance, in-memory\n cache with less of the administrative burden involved in launching and managing a\n distributed cache. The service makes setup, scaling, and cluster failure handling much\n simpler than in a self-managed cache deployment.
\nIn addition, through integration with Amazon CloudWatch, customers get enhanced\n visibility into the key performance statistics associated with their cache and can\n receive alarms if a part of their cache runs hot.
", "smithy.api#title": "Amazon ElastiCache", "smithy.api#xmlNamespace": { "uri": "http://elasticache.amazonaws.com/doc/2015-02-02/" }, "smithy.rules#endpointBdd": { "version": "1.1", "parameters": { "Region": { "builtIn": "AWS::Region", "required": false, "documentation": "The AWS region used to dispatch the request.", "type": "string" }, "UseDualStack": { "builtIn": "AWS::UseDualStack", "required": true, "default": false, "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", "type": "boolean" }, "UseFIPS": { "builtIn": "AWS::UseFIPS", "required": true, "default": false, "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", "type": "boolean" }, "Endpoint": { "builtIn": "SDK::Endpoint", "required": false, "documentation": "Override the endpoint used to send this request", "type": "string" } }, "conditions": [ { "fn": "isSet", "argv": [ { "ref": "Endpoint" } ] }, { "fn": "isSet", "argv": [ { "ref": "Region" } ] }, { "fn": "aws.partition", "argv": [ { "ref": "Region" } ], "assign": "PartitionResult" }, { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] }, { "fn": "booleanEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsDualStack" ] }, true ] }, { "fn": "booleanEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsFIPS" ] }, true ] }, { "fn": "stringEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "name" ] }, "aws-us-gov" ] } ], "results": [ { "conditions": [], "error": "Invalid Configuration: FIPS and custom endpoint are not supported", "type": "error" }, { "conditions": [], "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", "type": "error" }, { "conditions": [], "endpoint": { "url": { "ref": "Endpoint" }, "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "endpoint": { "url": "https://elasticache-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "FIPS and DualStack are enabled, but this partition does not support one or both", "type": "error" }, { "conditions": [], "endpoint": { "url": "https://elasticache.{Region}.amazonaws.com", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "endpoint": { "url": "https://elasticache-fips.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "FIPS is enabled but this partition does not support FIPS", "type": "error" }, { "conditions": [], "endpoint": { "url": "https://elasticache.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "DualStack is enabled but this partition does not support DualStack", "type": "error" }, { "conditions": [], "endpoint": { "url": "https://elasticache.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "Invalid Configuration: Missing Region", "type": "error" } ], "root": 2, "nodeCount": 14, "nodes": "/////wAAAAH/////AAAAAAAAAA0AAAADAAAAAQAAAAQF9eEMAAAAAgAAAAUF9eEMAAAAAwAAAAgAAAAGAAAABAAAAAcF9eELAAAABQX14QkF9eEKAAAABAAAAAsAAAAJAAAABgAAAAoF9eEIAAAABwX14QYF9eEHAAAABQAAAAwF9eEFAAAABgX14QQF9eEFAAAAAwX14QEAAAAOAAAABAX14QIF9eED" }, "smithy.rules#endpointRuleSet": { "version": "1.0", "parameters": { "Region": { "builtIn": "AWS::Region", "required": false, "documentation": "The AWS region used to dispatch the request.", "type": "string" }, "UseDualStack": { "builtIn": "AWS::UseDualStack", "required": true, "default": false, "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", "type": "boolean" }, "UseFIPS": { "builtIn": "AWS::UseFIPS", "required": true, "default": false, "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", "type": "boolean" }, "Endpoint": { "builtIn": "SDK::Endpoint", "required": false, "documentation": "Override the endpoint used to send this request", "type": "string" } }, "rules": [ { "conditions": [ { "fn": "isSet", "argv": [ { "ref": "Endpoint" } ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] } ], "error": "Invalid Configuration: FIPS and custom endpoint are not supported", "type": "error" }, { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] } ], "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", "type": "error" }, { "conditions": [], "endpoint": { "url": { "ref": "Endpoint" }, "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" }, { "conditions": [ { "fn": "isSet", "argv": [ { "ref": "Region" } ] } ], "rules": [ { "conditions": [ { "fn": "aws.partition", "argv": [ { "ref": "Region" } ], "assign": "PartitionResult" } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ true, { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsFIPS" ] } ] }, { "fn": "booleanEquals", "argv": [ true, { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsDualStack" ] } ] } ], "rules": [ { "conditions": [], "endpoint": { "url": "https://elasticache-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" }, { "conditions": [], "error": "FIPS and DualStack are enabled, but this partition does not support one or both", "type": "error" } ], "type": "tree" }, { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsFIPS" ] }, true ] } ], "rules": [ { "conditions": [ { "fn": "stringEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "name" ] }, "aws-us-gov" ] } ], "endpoint": { "url": "https://elasticache.{Region}.amazonaws.com", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "endpoint": { "url": "https://elasticache-fips.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" }, { "conditions": [], "error": "FIPS is enabled but this partition does not support FIPS", "type": "error" } ], "type": "tree" }, { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ true, { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsDualStack" ] } ] } ], "rules": [ { "conditions": [], "endpoint": { "url": "https://elasticache.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" }, { "conditions": [], "error": "DualStack is enabled but this partition does not support DualStack", "type": "error" } ], "type": "tree" }, { "conditions": [], "endpoint": { "url": "https://elasticache.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" } ], "type": "tree" }, { "conditions": [], "error": "Invalid Configuration: Missing Region", "type": "error" } ] }, "smithy.rules#endpointTests": { "testCases": [ { "documentation": "For region af-south-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://elasticache.af-south-1.amazonaws.com" } }, "params": { "Region": "af-south-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region ap-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://elasticache.ap-east-1.amazonaws.com" } }, "params": { "Region": "ap-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region ap-northeast-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://elasticache.ap-northeast-1.amazonaws.com" } }, "params": { "Region": "ap-northeast-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region ap-northeast-2 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://elasticache.ap-northeast-2.amazonaws.com" } }, "params": { "Region": "ap-northeast-2", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region ap-northeast-3 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://elasticache.ap-northeast-3.amazonaws.com" } }, "params": { "Region": "ap-northeast-3", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region ap-south-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://elasticache.ap-south-1.amazonaws.com" } }, "params": { "Region": "ap-south-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region ap-southeast-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://elasticache.ap-southeast-1.amazonaws.com" } }, "params": { "Region": "ap-southeast-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region ap-southeast-2 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://elasticache.ap-southeast-2.amazonaws.com" } }, "params": { "Region": "ap-southeast-2", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region ap-southeast-3 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://elasticache.ap-southeast-3.amazonaws.com" } }, "params": { "Region": "ap-southeast-3", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region ca-central-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://elasticache.ca-central-1.amazonaws.com" } }, "params": { "Region": "ca-central-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region eu-central-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://elasticache.eu-central-1.amazonaws.com" } }, "params": { "Region": "eu-central-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region eu-north-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://elasticache.eu-north-1.amazonaws.com" } }, "params": { "Region": "eu-north-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region eu-south-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://elasticache.eu-south-1.amazonaws.com" } }, "params": { "Region": "eu-south-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region eu-west-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://elasticache.eu-west-1.amazonaws.com" } }, "params": { "Region": "eu-west-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region eu-west-2 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://elasticache.eu-west-2.amazonaws.com" } }, "params": { "Region": "eu-west-2", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region eu-west-3 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://elasticache.eu-west-3.amazonaws.com" } }, "params": { "Region": "eu-west-3", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region me-south-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://elasticache.me-south-1.amazonaws.com" } }, "params": { "Region": "me-south-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region sa-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://elasticache.sa-east-1.amazonaws.com" } }, "params": { "Region": "sa-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://elasticache.us-east-1.amazonaws.com" } }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://elasticache-fips.us-east-1.amazonaws.com" } }, "params": { "Region": "us-east-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-east-2 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://elasticache.us-east-2.amazonaws.com" } }, "params": { "Region": "us-east-2", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-east-2 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://elasticache-fips.us-east-2.amazonaws.com" } }, "params": { "Region": "us-east-2", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-west-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://elasticache.us-west-1.amazonaws.com" } }, "params": { "Region": "us-west-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-west-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://elasticache-fips.us-west-1.amazonaws.com" } }, "params": { "Region": "us-west-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-west-2 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://elasticache.us-west-2.amazonaws.com" } }, "params": { "Region": "us-west-2", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-west-2 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://elasticache-fips.us-west-2.amazonaws.com" } }, "params": { "Region": "us-west-2", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { "url": "https://elasticache-fips.us-east-1.api.aws" } }, "params": { "Region": "us-east-1", "UseFIPS": true, "UseDualStack": true } }, { "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { "url": "https://elasticache.us-east-1.api.aws" } }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": true } }, { "documentation": "For region cn-north-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://elasticache.cn-north-1.amazonaws.com.cn" } }, "params": { "Region": "cn-north-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region cn-northwest-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://elasticache.cn-northwest-1.amazonaws.com.cn" } }, "params": { "Region": "cn-northwest-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region cn-north-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { "url": "https://elasticache-fips.cn-north-1.api.amazonwebservices.com.cn" } }, "params": { "Region": "cn-north-1", "UseFIPS": true, "UseDualStack": true } }, { "documentation": "For region cn-north-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://elasticache-fips.cn-north-1.amazonaws.com.cn" } }, "params": { "Region": "cn-north-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region cn-north-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { "url": "https://elasticache.cn-north-1.api.amazonwebservices.com.cn" } }, "params": { "Region": "cn-north-1", "UseFIPS": false, "UseDualStack": true } }, { "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://elasticache.us-gov-east-1.amazonaws.com" } }, "params": { "Region": "us-gov-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-gov-west-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://elasticache.us-gov-west-1.amazonaws.com" } }, "params": { "Region": "us-gov-west-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-gov-west-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://elasticache.us-gov-west-1.amazonaws.com" } }, "params": { "Region": "us-gov-west-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { "url": "https://elasticache-fips.us-gov-east-1.api.aws" } }, "params": { "Region": "us-gov-east-1", "UseFIPS": true, "UseDualStack": true } }, { "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://elasticache.us-gov-east-1.amazonaws.com" } }, "params": { "Region": "us-gov-east-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { "url": "https://elasticache.us-gov-east-1.api.aws" } }, "params": { "Region": "us-gov-east-1", "UseFIPS": false, "UseDualStack": true } }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://elasticache.us-iso-east-1.c2s.ic.gov" } }, "params": { "Region": "us-iso-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-iso-west-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://elasticache.us-iso-west-1.c2s.ic.gov" } }, "params": { "Region": "us-iso-west-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://elasticache-fips.us-iso-east-1.c2s.ic.gov" } }, "params": { "Region": "us-iso-east-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://elasticache.us-isob-east-1.sc2s.sgov.gov" } }, "params": { "Region": "us-isob-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://elasticache-fips.us-isob-east-1.sc2s.sgov.gov" } }, "params": { "Region": "us-isob-east-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For custom endpoint with region set and fips disabled and dualstack disabled", "expect": { "endpoint": { "url": "https://example.com" } }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": false, "Endpoint": "https://example.com" } }, { "documentation": "For custom endpoint with region not set and fips disabled and dualstack disabled", "expect": { "endpoint": { "url": "https://example.com" } }, "params": { "UseFIPS": false, "UseDualStack": false, "Endpoint": "https://example.com" } }, { "documentation": "For custom endpoint with fips enabled and dualstack disabled", "expect": { "error": "Invalid Configuration: FIPS and custom endpoint are not supported" }, "params": { "Region": "us-east-1", "UseFIPS": true, "UseDualStack": false, "Endpoint": "https://example.com" } }, { "documentation": "For custom endpoint with fips disabled and dualstack enabled", "expect": { "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": true, "Endpoint": "https://example.com" } }, { "documentation": "Missing region", "expect": { "error": "Invalid Configuration: Missing Region" } } ], "version": "1.0" } } }, "com.amazonaws.elasticache#AuthTokenUpdateStatus": { "type": "enum", "members": { "SETTING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SETTING" } }, "ROTATING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ROTATING" } } } }, "com.amazonaws.elasticache#AuthTokenUpdateStrategyType": { "type": "enum", "members": { "SET": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SET" } }, "ROTATE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ROTATE" } }, "DELETE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DELETE" } } } }, "com.amazonaws.elasticache#Authentication": { "type": "structure", "members": { "Type": { "target": "com.amazonaws.elasticache#AuthenticationType", "traits": { "smithy.api#documentation": "Indicates whether the user requires a password to authenticate.
" } }, "PasswordCount": { "target": "com.amazonaws.elasticache#IntegerOptional", "traits": { "smithy.api#documentation": "The number of passwords belonging to the user. The maximum is two.
" } } }, "traits": { "smithy.api#documentation": "Indicates whether the user requires a password to authenticate.
" } }, "com.amazonaws.elasticache#AuthenticationMode": { "type": "structure", "members": { "Type": { "target": "com.amazonaws.elasticache#InputAuthenticationType", "traits": { "smithy.api#documentation": "Specifies the authentication type. Possible options are IAM authentication, password\n and no password.
" } }, "Passwords": { "target": "com.amazonaws.elasticache#PasswordListInput", "traits": { "smithy.api#documentation": "Specifies the passwords to use for authentication if Type is set to\n password.
Specifies the authentication mode to use.
" } }, "com.amazonaws.elasticache#AuthenticationType": { "type": "enum", "members": { "PASSWORD": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "password" } }, "NO_PASSWORD": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "no-password" } }, "IAM": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "iam" } } } }, "com.amazonaws.elasticache#AuthorizationAlreadyExistsFault": { "type": "structure", "members": { "message": { "target": "com.amazonaws.elasticache#ExceptionMessage" } }, "traits": { "aws.protocols#awsQueryError": { "code": "AuthorizationAlreadyExists", "httpResponseCode": 400 }, "smithy.api#documentation": "The specified Amazon EC2 security group is already authorized for the specified cache\n security group.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.elasticache#AuthorizationNotFoundFault": { "type": "structure", "members": { "message": { "target": "com.amazonaws.elasticache#ExceptionMessage" } }, "traits": { "aws.protocols#awsQueryError": { "code": "AuthorizationNotFound", "httpResponseCode": 404 }, "smithy.api#documentation": "The specified Amazon EC2 security group is not authorized for the specified cache\n security group.
", "smithy.api#error": "client", "smithy.api#httpError": 404 } }, "com.amazonaws.elasticache#AuthorizeCacheSecurityGroupIngress": { "type": "operation", "input": { "target": "com.amazonaws.elasticache#AuthorizeCacheSecurityGroupIngressMessage" }, "output": { "target": "com.amazonaws.elasticache#AuthorizeCacheSecurityGroupIngressResult" }, "errors": [ { "target": "com.amazonaws.elasticache#AuthorizationAlreadyExistsFault" }, { "target": "com.amazonaws.elasticache#CacheSecurityGroupNotFoundFault" }, { "target": "com.amazonaws.elasticache#InvalidCacheSecurityGroupStateFault" }, { "target": "com.amazonaws.elasticache#InvalidParameterCombinationException" }, { "target": "com.amazonaws.elasticache#InvalidParameterValueException" } ], "traits": { "smithy.api#documentation": "Allows network ingress to a cache security group. Applications using ElastiCache must\n be running on Amazon EC2, and Amazon EC2 security groups are used as the authorization\n mechanism.
\nYou cannot authorize ingress from an Amazon EC2 security group in one region to an\n ElastiCache cluster in another region.
\nThe cache security group that allows network ingress.
", "smithy.api#required": {} } }, "EC2SecurityGroupName": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The Amazon EC2 security group to be authorized for ingress to the cache security\n group.
", "smithy.api#required": {} } }, "EC2SecurityGroupOwnerId": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The Amazon account number of the Amazon EC2 security group owner. Note that this is\n not the same thing as an Amazon access key ID - you must provide a valid Amazon account\n number for this parameter.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Represents the input of an AuthorizeCacheSecurityGroupIngress operation.
", "smithy.api#input": {} } }, "com.amazonaws.elasticache#AuthorizeCacheSecurityGroupIngressResult": { "type": "structure", "members": { "CacheSecurityGroup": { "target": "com.amazonaws.elasticache#CacheSecurityGroup" } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.elasticache#AutomaticFailoverStatus": { "type": "enum", "members": { "ENABLED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "enabled" } }, "DISABLED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "disabled" } }, "ENABLING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "enabling" } }, "DISABLING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "disabling" } } } }, "com.amazonaws.elasticache#AvailabilityZone": { "type": "structure", "members": { "Name": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "The name of the Availability Zone.
" } } }, "traits": { "smithy.api#documentation": "Describes an Availability Zone in which the cluster is launched.
" } }, "com.amazonaws.elasticache#AvailabilityZonesList": { "type": "list", "member": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#xmlName": "AvailabilityZone" } } }, "com.amazonaws.elasticache#AwsQueryErrorMessage": { "type": "string" }, "com.amazonaws.elasticache#BatchApplyUpdateAction": { "type": "operation", "input": { "target": "com.amazonaws.elasticache#BatchApplyUpdateActionMessage" }, "output": { "target": "com.amazonaws.elasticache#UpdateActionResultsMessage" }, "errors": [ { "target": "com.amazonaws.elasticache#InvalidParameterValueException" }, { "target": "com.amazonaws.elasticache#ServiceUpdateNotFoundFault" } ], "traits": { "smithy.api#documentation": "Apply the service update. For more information on service updates and applying them,\n see Applying Service\n Updates.
" } }, "com.amazonaws.elasticache#BatchApplyUpdateActionMessage": { "type": "structure", "members": { "ReplicationGroupIds": { "target": "com.amazonaws.elasticache#ReplicationGroupIdList", "traits": { "smithy.api#documentation": "The replication group IDs
" } }, "CacheClusterIds": { "target": "com.amazonaws.elasticache#CacheClusterIdList", "traits": { "smithy.api#documentation": "The cache cluster IDs
" } }, "ServiceUpdateName": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The unique ID of the service update
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.elasticache#BatchStopUpdateAction": { "type": "operation", "input": { "target": "com.amazonaws.elasticache#BatchStopUpdateActionMessage" }, "output": { "target": "com.amazonaws.elasticache#UpdateActionResultsMessage" }, "errors": [ { "target": "com.amazonaws.elasticache#InvalidParameterValueException" }, { "target": "com.amazonaws.elasticache#ServiceUpdateNotFoundFault" } ], "traits": { "smithy.api#documentation": "Stop the service update. For more information on service updates and stopping them,\n see Stopping\n Service Updates.
" } }, "com.amazonaws.elasticache#BatchStopUpdateActionMessage": { "type": "structure", "members": { "ReplicationGroupIds": { "target": "com.amazonaws.elasticache#ReplicationGroupIdList", "traits": { "smithy.api#documentation": "The replication group IDs
" } }, "CacheClusterIds": { "target": "com.amazonaws.elasticache#CacheClusterIdList", "traits": { "smithy.api#documentation": "The cache cluster IDs
" } }, "ServiceUpdateName": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The unique ID of the service update
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.elasticache#Boolean": { "type": "boolean" }, "com.amazonaws.elasticache#BooleanOptional": { "type": "boolean" }, "com.amazonaws.elasticache#CacheCluster": { "type": "structure", "members": { "CacheClusterId": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "The user-supplied identifier of the cluster. This identifier is a unique key that\n identifies a cluster.
" } }, "ConfigurationEndpoint": { "target": "com.amazonaws.elasticache#Endpoint", "traits": { "smithy.api#documentation": "Represents a Memcached cluster endpoint which can be used by an application to connect\n to any node in the cluster. The configuration endpoint will always have\n .cfg in it.
Example: mem-3.9dvc4r.cfg.usw2.cache.amazonaws.com:11211\n
The URL of the web page where you can download the latest ElastiCache client\n library.
" } }, "CacheNodeType": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "The name of the compute and memory capacity node type for the cluster.
\nThe following node types are supported by ElastiCache. Generally speaking, the current\n generation types provide more memory and computational power at lower cost when compared\n to their equivalent previous generation counterparts.
\nGeneral purpose:
\nCurrent generation:
\n\n M7g node types:\n \t\t\t\t\tcache.m7g.large,\n \t\t\t\t\tcache.m7g.xlarge,\n \t\t\t\t\tcache.m7g.2xlarge,\n \t\t\t\t\tcache.m7g.4xlarge,\n \t\t\t\t\tcache.m7g.8xlarge,\n \t\t\t\t\tcache.m7g.12xlarge,\n \t\t\t\t\tcache.m7g.16xlarge\n
For region availability, see Supported Node Types\n
\n\n M6g node types (available only for Redis OSS engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward):\n\t\t\t\t\t \n\t\t\t\t\t \tcache.m6g.large,\n\t\t\t\t\t\t\tcache.m6g.xlarge,\n\t\t\t\t\t\t\tcache.m6g.2xlarge,\n\t\t\t\t\t\t\tcache.m6g.4xlarge,\n\t\t\t\t\t\t\tcache.m6g.8xlarge,\n\t\t\t\t\t\t\tcache.m6g.12xlarge,\n\t\t\t\t\t\t\tcache.m6g.16xlarge\n
\n M5 node types:\n cache.m5.large,\n \t\t\t\t\t\tcache.m5.xlarge,\n \t\t\t\t\t\tcache.m5.2xlarge,\n \t\t\t\t\t\tcache.m5.4xlarge,\n \t\t\t\t\t\tcache.m5.12xlarge,\n \t\t\t\t\t\tcache.m5.24xlarge\n
\n M4 node types:\n cache.m4.large,\n \t\t\t\t\t\tcache.m4.xlarge,\n \t\t\t\t\t\tcache.m4.2xlarge,\n \t\t\t\t\t\tcache.m4.4xlarge,\n \t\t\t\t\t\tcache.m4.10xlarge\n
\n T4g node types (available only for Redis OSS engine version 5.0.6 onward and Memcached engine version 1.5.16 onward):\n\t\t\t\t\t cache.t4g.micro,\n\t\t\t\t\t cache.t4g.small,\n\t\t\t\t\t cache.t4g.medium\n
\n T3 node types:\n cache.t3.micro, \n \t\t\t\t\t\tcache.t3.small,\n \t\t\t\t\t\tcache.t3.medium\n
\n T2 node types:\n cache.t2.micro, \n \t\t\t\t\t\tcache.t2.small,\n \t\t\t\t\t\tcache.t2.medium\n
Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)
\n\n T1 node types:\n cache.t1.micro\n
\n M1 node types:\n cache.m1.small, \n\t\t\t\t\t\t cache.m1.medium, \n\t\t\t\t\t\t cache.m1.large,\n\t\t\t\t\t\t cache.m1.xlarge\n
\n M3 node types:\n cache.m3.medium,\n \t\t\t\t\t\tcache.m3.large, \n \t\t\t\t\t\tcache.m3.xlarge,\n \t\t\t\t\t\tcache.m3.2xlarge\n
Compute optimized:
\nPrevious generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)
\n\n C1 node types:\n cache.c1.xlarge\n
Memory optimized:
\nCurrent generation:
\n\n R7g node types:\t\n\t\t\t\t\t\t\tcache.r7g.large,\n\t\t\t\t\t\t\tcache.r7g.xlarge,\n\t\t\t\t\t\t\tcache.r7g.2xlarge,\n\t\t\t\t\t\t\tcache.r7g.4xlarge,\n\t\t\t\t\t\t\tcache.r7g.8xlarge,\n\t\t\t\t\t\t\tcache.r7g.12xlarge,\n\t\t\t\t\t\t\tcache.r7g.16xlarge\n
For region availability, see Supported Node Types\n
\n\n R6g node types (available only for Redis OSS engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward):\n\t\t\t\t\t\t\tcache.r6g.large,\n\t\t\t\t\t\t\tcache.r6g.xlarge,\n\t\t\t\t\t\t\tcache.r6g.2xlarge,\n\t\t\t\t\t\t\tcache.r6g.4xlarge,\n\t\t\t\t\t\t\tcache.r6g.8xlarge,\n\t\t\t\t\t\t\tcache.r6g.12xlarge,\n\t\t\t\t\t\t\tcache.r6g.16xlarge\n
\n R5 node types:\n cache.r5.large,\n \t\t\t\t\t cache.r5.xlarge,\n \t\t\t\t\t cache.r5.2xlarge,\n \t\t\t\t\t cache.r5.4xlarge,\n \t\t\t\t\t cache.r5.12xlarge,\n \t\t\t\t\t cache.r5.24xlarge\n
\n R4 node types:\n cache.r4.large,\n \t\t\t\t\t cache.r4.xlarge,\n \t\t\t\t\t cache.r4.2xlarge,\n \t\t\t\t\t cache.r4.4xlarge,\n \t\t\t\t\t cache.r4.8xlarge,\n \t\t\t\t\t cache.r4.16xlarge\n
Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)
\n\n M2 node types:\n cache.m2.xlarge, \n \t\t\t\t\t\tcache.m2.2xlarge,\n \t\t\t\t\t\tcache.m2.4xlarge\n
\n R3 node types:\n cache.r3.large, \n \t\t\t\t\t\tcache.r3.xlarge,\n \t\t\t\t\t\tcache.r3.2xlarge, \n \t\t\t\t\t\tcache.r3.4xlarge,\n \t\t\t\t\t\tcache.r3.8xlarge\n
\n Additional node type info\n
\nAll current generation instance types are created in Amazon VPC by\n default.
\nValkey or Redis OSS append-only files (AOF) are not supported for T1 or T2 instances.
\nValkey or Redis OSS Multi-AZ with automatic failover is not supported on T1\n instances.
\nThe configuration variables appendonly and\n appendfsync are not supported on Valkey, or on Redis OSS version 2.8.22 and\n later.
The name of the cache engine (memcached or redis) to be used\n for this cluster.
The version of the cache engine that is used in this cluster.
" } }, "CacheClusterStatus": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "The current state of this cluster, one of the following values:\n available, creating, deleted,\n deleting, incompatible-network, modifying,\n rebooting cluster nodes, restore-failed, or\n snapshotting.
The number of cache nodes in the cluster.
\nFor clusters running Valkey or Redis OSS, this value must be 1. For clusters running Memcached, this\n value must be between 1 and 40.
" } }, "PreferredAvailabilityZone": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "The name of the Availability Zone in which the cluster is located or \"Multiple\" if the\n cache nodes are located in different Availability Zones.
" } }, "PreferredOutpostArn": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "The outpost ARN in which the cache cluster is created.
" } }, "CacheClusterCreateTime": { "target": "com.amazonaws.elasticache#TStamp", "traits": { "smithy.api#documentation": "The date and time when the cluster was created.
" } }, "PreferredMaintenanceWindow": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "Specifies the weekly time range during which maintenance on the cluster is performed.\n It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The\n minimum maintenance window is a 60 minute period.
\nValid values for ddd are:
\n sun\n
\n mon\n
\n tue\n
\n wed\n
\n thu\n
\n fri\n
\n sat\n
Example: sun:23:00-mon:01:30\n
Describes a notification topic and its status. Notification topics are used for\n publishing ElastiCache events to subscribers using Amazon Simple Notification Service\n (SNS).
" } }, "CacheSecurityGroups": { "target": "com.amazonaws.elasticache#CacheSecurityGroupMembershipList", "traits": { "smithy.api#documentation": "A list of cache security group elements, composed of name and status\n sub-elements.
" } }, "CacheParameterGroup": { "target": "com.amazonaws.elasticache#CacheParameterGroupStatus", "traits": { "smithy.api#documentation": "Status of the cache parameter group.
" } }, "CacheSubnetGroupName": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "The name of the cache subnet group associated with the cluster.
" } }, "CacheNodes": { "target": "com.amazonaws.elasticache#CacheNodeList", "traits": { "smithy.api#documentation": "A list of cache nodes that are members of the cluster.
" } }, "AutoMinorVersionUpgrade": { "target": "com.amazonaws.elasticache#Boolean", "traits": { "smithy.api#documentation": "\u00a0If you are running Valkey or Redis OSS engine version 6.0 or later, set this parameter to yes if\n you want to opt-in to the next auto minor version upgrade campaign. This parameter is\n disabled for previous versions.\u00a0
" } }, "SecurityGroups": { "target": "com.amazonaws.elasticache#SecurityGroupMembershipList", "traits": { "smithy.api#documentation": "A list of VPC Security Groups associated with the cluster.
" } }, "ReplicationGroupId": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "The replication group to which this cluster belongs. If this field is empty, the\n cluster is not associated with any replication group.
" } }, "SnapshotRetentionLimit": { "target": "com.amazonaws.elasticache#IntegerOptional", "traits": { "smithy.api#documentation": "The number of days for which ElastiCache retains automatic cluster snapshots before\n deleting them. For example, if you set SnapshotRetentionLimit to 5, a\n 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\n off.
\nThe daily time range (in UTC) during which ElastiCache begins taking a daily snapshot\n of your cluster.
\nExample: 05:00-09:00\n
A flag that enables using an AuthToken (password) when issuing Valkey or Redis OSS \n commands.
Default: false\n
The date the auth token was last modified
" } }, "TransitEncryptionEnabled": { "target": "com.amazonaws.elasticache#BooleanOptional", "traits": { "smithy.api#documentation": "A flag that enables in-transit encryption when set to true.
\n Required: Only available when creating a replication\n group in an Amazon VPC using Redis OSS version 3.2.6, 4.x or\n later.
Default: false\n
A flag that enables encryption at-rest when set to true.
You cannot modify the value of AtRestEncryptionEnabled after the cluster\n is created. To enable at-rest encryption on a cluster you must set\n AtRestEncryptionEnabled to true when you create a\n cluster.
\n Required: Only available when creating a replication\n group in an Amazon VPC using Redis OSS version 3.2.6, 4.x or\n later.
Default: false\n
The ARN (Amazon Resource Name) of the cache cluster.
" } }, "ReplicationGroupLogDeliveryEnabled": { "target": "com.amazonaws.elasticache#Boolean", "traits": { "smithy.api#documentation": "A boolean value indicating whether log delivery is enabled for the replication\n group.
" } }, "LogDeliveryConfigurations": { "target": "com.amazonaws.elasticache#LogDeliveryConfigurationList", "traits": { "smithy.api#documentation": "Returns the destination, format and type of the logs.
" } }, "NetworkType": { "target": "com.amazonaws.elasticache#NetworkType", "traits": { "smithy.api#documentation": "Must be either ipv4 | ipv6 | dual_stack. IPv6\n is supported for workloads using Valkey 7.2 and above, Redis OSS engine version 6.2\n 7.1 or Memcached engine version 1.6.6 and above on all instances built on the Nitro system.
The network type associated with the cluster, either ipv4 |\n ipv6. IPv6 is supported for workloads using Valkey 7.2 and above, Redis OSS engine version 6.2\n to 7.1 or Memcached engine version 1.6.6 and above on all instances built on the Nitro system.
A setting that allows you to migrate your clients to use in-transit encryption, with\n no downtime.
" } } }, "traits": { "smithy.api#documentation": "Contains all of the attributes of a specific cluster.
" } }, "com.amazonaws.elasticache#CacheClusterAlreadyExistsFault": { "type": "structure", "members": { "message": { "target": "com.amazonaws.elasticache#ExceptionMessage" } }, "traits": { "aws.protocols#awsQueryError": { "code": "CacheClusterAlreadyExists", "httpResponseCode": 400 }, "smithy.api#documentation": "You already have a cluster with the given identifier.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.elasticache#CacheClusterIdList": { "type": "list", "member": { "target": "com.amazonaws.elasticache#String" }, "traits": { "smithy.api#length": { "min": 0, "max": 20 } } }, "com.amazonaws.elasticache#CacheClusterList": { "type": "list", "member": { "target": "com.amazonaws.elasticache#CacheCluster", "traits": { "smithy.api#xmlName": "CacheCluster" } } }, "com.amazonaws.elasticache#CacheClusterMessage": { "type": "structure", "members": { "Marker": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "Provides an identifier to allow retrieval of paginated results.
" } }, "CacheClusters": { "target": "com.amazonaws.elasticache#CacheClusterList", "traits": { "smithy.api#documentation": "A list of clusters. Each item in the list contains detailed information about one\n cluster.
" } } }, "traits": { "smithy.api#documentation": "Represents the output of a DescribeCacheClusters operation.
The requested cluster ID does not refer to an existing cluster.
", "smithy.api#error": "client", "smithy.api#httpError": 404 } }, "com.amazonaws.elasticache#CacheEngineVersion": { "type": "structure", "members": { "Engine": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "The name of the cache engine.
" } }, "EngineVersion": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "The version number of the cache engine.
" } }, "CacheParameterGroupFamily": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "The name of the cache parameter group family associated with this cache engine.
\nValid values are: memcached1.4 | memcached1.5 |\n memcached1.6 | redis2.6 | redis2.8 |\n redis3.2 | redis4.0 | redis5.0 |\n redis6.x | redis7\n
The description of the cache engine.
" } }, "CacheEngineVersionDescription": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "The description of the cache engine version.
" } } }, "traits": { "smithy.api#documentation": "Provides all of the details about a particular cache engine version.
" } }, "com.amazonaws.elasticache#CacheEngineVersionList": { "type": "list", "member": { "target": "com.amazonaws.elasticache#CacheEngineVersion", "traits": { "smithy.api#xmlName": "CacheEngineVersion" } } }, "com.amazonaws.elasticache#CacheEngineVersionMessage": { "type": "structure", "members": { "Marker": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "Provides an identifier to allow retrieval of paginated results.
" } }, "CacheEngineVersions": { "target": "com.amazonaws.elasticache#CacheEngineVersionList", "traits": { "smithy.api#documentation": "A list of cache engine version details. Each element in the list contains detailed\n information about one cache engine version.
" } } }, "traits": { "smithy.api#documentation": "Represents the output of a DescribeCacheEngineVersions\n operation.
", "smithy.api#output": {} } }, "com.amazonaws.elasticache#CacheNode": { "type": "structure", "members": { "CacheNodeId": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "The cache node identifier. A node ID is a numeric identifier (0001, 0002, etc.). The\n combination of cluster ID and node ID uniquely identifies every cache node used in a\n customer's Amazon account.
" } }, "CacheNodeStatus": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "The current state of this cache node, one of the following values:\n available, creating, rebooting, or\n deleting.
The date and time when the cache node was created.
" } }, "Endpoint": { "target": "com.amazonaws.elasticache#Endpoint", "traits": { "smithy.api#documentation": "The hostname for connecting to this cache node.
" } }, "ParameterGroupStatus": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "The status of the parameter group applied to this cache node.
" } }, "SourceCacheNodeId": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "The ID of the primary node to which this read replica node is synchronized. If this\n field is empty, this node is not associated with a primary cluster.
" } }, "CustomerAvailabilityZone": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "The Availability Zone where this node was created and now resides.
" } }, "CustomerOutpostArn": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "The customer outpost ARN of the cache node.
" } } }, "traits": { "smithy.api#documentation": "Represents an individual cache node within a cluster. Each cache node runs its own\n instance of the cluster's protocol-compliant caching software - either Memcached, Valkey or Redis OSS.
\nThe following node types are supported by ElastiCache. Generally speaking, the current\n generation types provide more memory and computational power at lower cost when compared\n to their equivalent previous generation counterparts.
\nGeneral purpose:
\nCurrent generation:
\n\n M7g node types:\n \t\t\t\t\tcache.m7g.large,\n \t\t\t\t\tcache.m7g.xlarge,\n \t\t\t\t\tcache.m7g.2xlarge,\n \t\t\t\t\tcache.m7g.4xlarge,\n \t\t\t\t\tcache.m7g.8xlarge,\n \t\t\t\t\tcache.m7g.12xlarge,\n \t\t\t\t\tcache.m7g.16xlarge\n
For region availability, see Supported Node Types\n
\n\n M6g node types (available only for Redis OSS engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward):\n\t\t\t\t\t \n\t\t\t\t\t \tcache.m6g.large,\n\t\t\t\t\t\t\tcache.m6g.xlarge,\n\t\t\t\t\t\t\tcache.m6g.2xlarge,\n\t\t\t\t\t\t\tcache.m6g.4xlarge,\n\t\t\t\t\t\t\tcache.m6g.8xlarge,\n\t\t\t\t\t\t\tcache.m6g.12xlarge,\n\t\t\t\t\t\t\tcache.m6g.16xlarge\n
\n M5 node types:\n cache.m5.large,\n \t\t\t\t\t\tcache.m5.xlarge,\n \t\t\t\t\t\tcache.m5.2xlarge,\n \t\t\t\t\t\tcache.m5.4xlarge,\n \t\t\t\t\t\tcache.m5.12xlarge,\n \t\t\t\t\t\tcache.m5.24xlarge\n
\n M4 node types:\n cache.m4.large,\n \t\t\t\t\t\tcache.m4.xlarge,\n \t\t\t\t\t\tcache.m4.2xlarge,\n \t\t\t\t\t\tcache.m4.4xlarge,\n \t\t\t\t\t\tcache.m4.10xlarge\n
\n T4g node types (available only for Redis OSS engine version 5.0.6 onward and Memcached engine version 1.5.16 onward):\n\t\t\t\t\t cache.t4g.micro,\n\t\t\t\t\t cache.t4g.small,\n\t\t\t\t\t cache.t4g.medium\n
\n T3 node types:\n cache.t3.micro, \n \t\t\t\t\t\tcache.t3.small,\n \t\t\t\t\t\tcache.t3.medium\n
\n T2 node types:\n cache.t2.micro, \n \t\t\t\t\t\tcache.t2.small,\n \t\t\t\t\t\tcache.t2.medium\n
Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)
\n\n T1 node types:\n cache.t1.micro\n
\n M1 node types:\n cache.m1.small, \n\t\t\t\t\t\t cache.m1.medium, \n\t\t\t\t\t\t cache.m1.large,\n\t\t\t\t\t\t cache.m1.xlarge\n
\n M3 node types:\n cache.m3.medium,\n \t\t\t\t\t\tcache.m3.large, \n \t\t\t\t\t\tcache.m3.xlarge,\n \t\t\t\t\t\tcache.m3.2xlarge\n
Compute optimized:
\nPrevious generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)
\n\n C1 node types:\n cache.c1.xlarge\n
Memory optimized:
\nCurrent generation:
\n\n R7g node types:\t\n\t\t\t\t\t\t\tcache.r7g.large,\n\t\t\t\t\t\t\tcache.r7g.xlarge,\n\t\t\t\t\t\t\tcache.r7g.2xlarge,\n\t\t\t\t\t\t\tcache.r7g.4xlarge,\n\t\t\t\t\t\t\tcache.r7g.8xlarge,\n\t\t\t\t\t\t\tcache.r7g.12xlarge,\n\t\t\t\t\t\t\tcache.r7g.16xlarge\n
For region availability, see Supported Node Types\n
\n\n R6g node types (available only for Redis OSS engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward):\n\t\t\t\t\t\t\tcache.r6g.large,\n\t\t\t\t\t\t\tcache.r6g.xlarge,\n\t\t\t\t\t\t\tcache.r6g.2xlarge,\n\t\t\t\t\t\t\tcache.r6g.4xlarge,\n\t\t\t\t\t\t\tcache.r6g.8xlarge,\n\t\t\t\t\t\t\tcache.r6g.12xlarge,\n\t\t\t\t\t\t\tcache.r6g.16xlarge\n
\n R5 node types:\n cache.r5.large,\n \t\t\t\t\t cache.r5.xlarge,\n \t\t\t\t\t cache.r5.2xlarge,\n \t\t\t\t\t cache.r5.4xlarge,\n \t\t\t\t\t cache.r5.12xlarge,\n \t\t\t\t\t cache.r5.24xlarge\n
\n R4 node types:\n cache.r4.large,\n \t\t\t\t\t cache.r4.xlarge,\n \t\t\t\t\t cache.r4.2xlarge,\n \t\t\t\t\t cache.r4.4xlarge,\n \t\t\t\t\t cache.r4.8xlarge,\n \t\t\t\t\t cache.r4.16xlarge\n
Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)
\n\n M2 node types:\n cache.m2.xlarge, \n \t\t\t\t\t\tcache.m2.2xlarge,\n \t\t\t\t\t\tcache.m2.4xlarge\n
\n R3 node types:\n cache.r3.large, \n \t\t\t\t\t\tcache.r3.xlarge,\n \t\t\t\t\t\tcache.r3.2xlarge, \n \t\t\t\t\t\tcache.r3.4xlarge,\n \t\t\t\t\t\tcache.r3.8xlarge\n
\n Additional node type info\n
\nAll current generation instance types are created in Amazon VPC by\n default.
\nValkey or Redis OSS append-only files (AOF) are not supported for T1 or T2 instances.
\nValkey or Redis OSS Multi-AZ with automatic failover is not supported on T1\n instances.
\nThe configuration variables appendonly and\n appendfsync are not supported on Valkey, or on Redis OSS version 2.8.22 and\n later.
The name of the parameter.
" } }, "Description": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "A description of the parameter.
" } }, "Source": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "The source of the parameter value.
" } }, "DataType": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "The valid data type for the parameter.
" } }, "AllowedValues": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "The valid range of values for the parameter.
" } }, "IsModifiable": { "target": "com.amazonaws.elasticache#Boolean", "traits": { "smithy.api#documentation": "Indicates whether (true) or not (false) the parameter can be\n modified. Some parameters have security or operational implications that prevent them\n from being changed.
The earliest cache engine version to which the parameter can apply.
" } }, "CacheNodeTypeSpecificValues": { "target": "com.amazonaws.elasticache#CacheNodeTypeSpecificValueList", "traits": { "smithy.api#documentation": "A list of cache node types and their corresponding values for this parameter.
" } }, "ChangeType": { "target": "com.amazonaws.elasticache#ChangeType", "traits": { "smithy.api#documentation": "Indicates whether a change to the parameter is applied immediately or requires a\n reboot for the change to be applied. You can force a reboot or wait until the next\n maintenance window's reboot. For more information, see Rebooting a\n Cluster.
" } } }, "traits": { "smithy.api#documentation": "A parameter that has a different value for each cache node type it is applied to. For\n example, in a Valkey or Redis OSS cluster, a cache.m1.large cache node type would have a\n larger maxmemory value than a cache.m1.small type.
The cache node type for which this value applies.
" } }, "Value": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "The value for the cache node type.
" } } }, "traits": { "smithy.api#documentation": "A value that applies only to a certain cache node type.
" } }, "com.amazonaws.elasticache#CacheNodeTypeSpecificValueList": { "type": "list", "member": { "target": "com.amazonaws.elasticache#CacheNodeTypeSpecificValue", "traits": { "smithy.api#xmlName": "CacheNodeTypeSpecificValue" } } }, "com.amazonaws.elasticache#CacheNodeUpdateStatus": { "type": "structure", "members": { "CacheNodeId": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "The node ID of the cache cluster
" } }, "NodeUpdateStatus": { "target": "com.amazonaws.elasticache#NodeUpdateStatus", "traits": { "smithy.api#documentation": "The update status of the node
" } }, "NodeDeletionDate": { "target": "com.amazonaws.elasticache#TStamp", "traits": { "smithy.api#documentation": "The deletion date of the node
" } }, "NodeUpdateStartDate": { "target": "com.amazonaws.elasticache#TStamp", "traits": { "smithy.api#documentation": "The start date of the update for a node
" } }, "NodeUpdateEndDate": { "target": "com.amazonaws.elasticache#TStamp", "traits": { "smithy.api#documentation": "The end date of the update for a node
" } }, "NodeUpdateInitiatedBy": { "target": "com.amazonaws.elasticache#NodeUpdateInitiatedBy", "traits": { "smithy.api#documentation": "Reflects whether the update was initiated by the customer or automatically\n applied
" } }, "NodeUpdateInitiatedDate": { "target": "com.amazonaws.elasticache#TStamp", "traits": { "smithy.api#documentation": "The date when the update is triggered
" } }, "NodeUpdateStatusModifiedDate": { "target": "com.amazonaws.elasticache#TStamp", "traits": { "smithy.api#documentation": "The date when the NodeUpdateStatus was last modified>
" } } }, "traits": { "smithy.api#documentation": "The status of the service update on the cache node
" } }, "com.amazonaws.elasticache#CacheNodeUpdateStatusList": { "type": "list", "member": { "target": "com.amazonaws.elasticache#CacheNodeUpdateStatus", "traits": { "smithy.api#xmlName": "CacheNodeUpdateStatus" } } }, "com.amazonaws.elasticache#CacheParameterGroup": { "type": "structure", "members": { "CacheParameterGroupName": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "The name of the cache parameter group.
" } }, "CacheParameterGroupFamily": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "The name of the cache parameter group family that this cache parameter group is\n compatible with.
\nValid values are: memcached1.4 | memcached1.5 |\n memcached1.6 | redis2.6 | redis2.8 |\n redis3.2 | redis4.0 | redis5.0 |\n redis6.x | redis7\n
The description for this cache parameter group.
" } }, "IsGlobal": { "target": "com.amazonaws.elasticache#Boolean", "traits": { "smithy.api#documentation": "Indicates whether the parameter group is associated with a Global datastore
" } }, "ARN": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "The ARN (Amazon Resource Name) of the cache parameter group.
" } } }, "traits": { "smithy.api#documentation": "Represents the output of a CreateCacheParameterGroup operation.
A cache parameter group with the requested name already exists.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.elasticache#CacheParameterGroupDetails": { "type": "structure", "members": { "Marker": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "Provides an identifier to allow retrieval of paginated results.
" } }, "Parameters": { "target": "com.amazonaws.elasticache#ParametersList", "traits": { "smithy.api#documentation": "A list of Parameter instances.
" } }, "CacheNodeTypeSpecificParameters": { "target": "com.amazonaws.elasticache#CacheNodeTypeSpecificParametersList", "traits": { "smithy.api#documentation": "A list of parameters specific to a particular cache node type. Each element in the\n list contains detailed information about one parameter.
" } } }, "traits": { "smithy.api#documentation": "Represents the output of a DescribeCacheParameters operation.
The name of the cache parameter group.
" } } }, "traits": { "smithy.api#documentation": "Represents the output of one of the following operations:
\n\n ModifyCacheParameterGroup\n
\n ResetCacheParameterGroup\n
The requested cache parameter group name does not refer to an existing cache parameter\n group.
", "smithy.api#error": "client", "smithy.api#httpError": 404 } }, "com.amazonaws.elasticache#CacheParameterGroupQuotaExceededFault": { "type": "structure", "members": { "message": { "target": "com.amazonaws.elasticache#ExceptionMessage" } }, "traits": { "aws.protocols#awsQueryError": { "code": "CacheParameterGroupQuotaExceeded", "httpResponseCode": 400 }, "smithy.api#documentation": "The request cannot be processed because it would exceed the maximum number of cache\n security groups.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.elasticache#CacheParameterGroupStatus": { "type": "structure", "members": { "CacheParameterGroupName": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "The name of the cache parameter group.
" } }, "ParameterApplyStatus": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "The status of parameter updates.
" } }, "CacheNodeIdsToReboot": { "target": "com.amazonaws.elasticache#CacheNodeIdsList", "traits": { "smithy.api#documentation": "A list of the cache node IDs which need to be rebooted for parameter changes to be\n applied. A node ID is a numeric identifier (0001, 0002, etc.).
" } } }, "traits": { "smithy.api#documentation": "Status of the cache parameter group.
" } }, "com.amazonaws.elasticache#CacheParameterGroupsMessage": { "type": "structure", "members": { "Marker": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "Provides an identifier to allow retrieval of paginated results.
" } }, "CacheParameterGroups": { "target": "com.amazonaws.elasticache#CacheParameterGroupList", "traits": { "smithy.api#documentation": "A list of cache parameter groups. Each element in the list contains detailed\n information about one cache parameter group.
" } } }, "traits": { "smithy.api#documentation": "Represents the output of a DescribeCacheParameterGroups operation.
The Amazon account ID of the cache security group owner.
" } }, "CacheSecurityGroupName": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "The name of the cache security group.
" } }, "Description": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "The description of the cache security group.
" } }, "EC2SecurityGroups": { "target": "com.amazonaws.elasticache#EC2SecurityGroupList", "traits": { "smithy.api#documentation": "A list of Amazon EC2 security groups that are associated with this cache security\n group.
" } }, "ARN": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "The ARN of the cache security group,
" } } }, "traits": { "smithy.api#documentation": "Represents the output of one of the following operations:
\n\n AuthorizeCacheSecurityGroupIngress\n
\n CreateCacheSecurityGroup\n
\n RevokeCacheSecurityGroupIngress\n
A cache security group with the specified name already exists.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.elasticache#CacheSecurityGroupMembership": { "type": "structure", "members": { "CacheSecurityGroupName": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "The name of the cache security group.
" } }, "Status": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "The membership status in the cache security group. The status changes when a cache\n security group is modified, or when the cache security groups assigned to a cluster are\n modified.
" } } }, "traits": { "smithy.api#documentation": "Represents a cluster's status within a particular cache security group.
" } }, "com.amazonaws.elasticache#CacheSecurityGroupMembershipList": { "type": "list", "member": { "target": "com.amazonaws.elasticache#CacheSecurityGroupMembership", "traits": { "smithy.api#xmlName": "CacheSecurityGroup" } } }, "com.amazonaws.elasticache#CacheSecurityGroupMessage": { "type": "structure", "members": { "Marker": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "Provides an identifier to allow retrieval of paginated results.
" } }, "CacheSecurityGroups": { "target": "com.amazonaws.elasticache#CacheSecurityGroups", "traits": { "smithy.api#documentation": "A list of cache security groups. Each element in the list contains detailed\n information about one group.
" } } }, "traits": { "smithy.api#documentation": "Represents the output of a DescribeCacheSecurityGroups operation.
The requested cache security group name does not refer to an existing cache security\n group.
", "smithy.api#error": "client", "smithy.api#httpError": 404 } }, "com.amazonaws.elasticache#CacheSecurityGroupQuotaExceededFault": { "type": "structure", "members": { "message": { "target": "com.amazonaws.elasticache#ExceptionMessage" } }, "traits": { "aws.protocols#awsQueryError": { "code": "QuotaExceeded.CacheSecurityGroup", "httpResponseCode": 400 }, "smithy.api#documentation": "The request cannot be processed because it would exceed the allowed number of cache\n security groups.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.elasticache#CacheSecurityGroups": { "type": "list", "member": { "target": "com.amazonaws.elasticache#CacheSecurityGroup", "traits": { "smithy.api#xmlName": "CacheSecurityGroup" } } }, "com.amazonaws.elasticache#CacheSubnetGroup": { "type": "structure", "members": { "CacheSubnetGroupName": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "The name of the cache subnet group.
" } }, "CacheSubnetGroupDescription": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "The description of the cache subnet group.
" } }, "VpcId": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "The Amazon Virtual Private Cloud identifier (VPC ID) of the cache subnet group.
" } }, "Subnets": { "target": "com.amazonaws.elasticache#SubnetList", "traits": { "smithy.api#documentation": "A list of subnets associated with the cache subnet group.
" } }, "ARN": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "The ARN (Amazon Resource Name) of the cache subnet group.
" } }, "SupportedNetworkTypes": { "target": "com.amazonaws.elasticache#NetworkTypeList", "traits": { "smithy.api#documentation": "Either ipv4 | ipv6 | dual_stack. IPv6 is\n supported for workloads using Valkey 7.2 and above, Redis OSS engine version 6.2\n to 7.1 or Memcached engine version 1.6.6 and above on all instances built on the Nitro system.
Represents the output of one of the following operations:
\n\n CreateCacheSubnetGroup\n
\n ModifyCacheSubnetGroup\n
The requested cache subnet group name is already in use by an existing cache subnet\n group.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.elasticache#CacheSubnetGroupInUse": { "type": "structure", "members": { "message": { "target": "com.amazonaws.elasticache#ExceptionMessage" } }, "traits": { "aws.protocols#awsQueryError": { "code": "CacheSubnetGroupInUse", "httpResponseCode": 400 }, "smithy.api#documentation": "The requested cache subnet group is currently in use.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.elasticache#CacheSubnetGroupMessage": { "type": "structure", "members": { "Marker": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "Provides an identifier to allow retrieval of paginated results.
" } }, "CacheSubnetGroups": { "target": "com.amazonaws.elasticache#CacheSubnetGroups", "traits": { "smithy.api#documentation": "A list of cache subnet groups. Each element in the list contains detailed information\n about one group.
" } } }, "traits": { "smithy.api#documentation": "Represents the output of a DescribeCacheSubnetGroups operation.
The requested cache subnet group name does not refer to an existing cache subnet\n group.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.elasticache#CacheSubnetGroupQuotaExceededFault": { "type": "structure", "members": { "message": { "target": "com.amazonaws.elasticache#ExceptionMessage" } }, "traits": { "aws.protocols#awsQueryError": { "code": "CacheSubnetGroupQuotaExceeded", "httpResponseCode": 400 }, "smithy.api#documentation": "The request cannot be processed because it would exceed the allowed number of cache\n subnet groups.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.elasticache#CacheSubnetGroups": { "type": "list", "member": { "target": "com.amazonaws.elasticache#CacheSubnetGroup", "traits": { "smithy.api#xmlName": "CacheSubnetGroup" } } }, "com.amazonaws.elasticache#CacheSubnetQuotaExceededFault": { "type": "structure", "members": { "message": { "target": "com.amazonaws.elasticache#ExceptionMessage" } }, "traits": { "aws.protocols#awsQueryError": { "code": "CacheSubnetQuotaExceededFault", "httpResponseCode": 400 }, "smithy.api#documentation": "The request cannot be processed because it would exceed the allowed number of subnets\n in a cache subnet group.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.elasticache#CacheUsageLimits": { "type": "structure", "members": { "DataStorage": { "target": "com.amazonaws.elasticache#DataStorage", "traits": { "smithy.api#documentation": "\n The maximum data storage limit in the cache, expressed in Gigabytes.\n
" } }, "ECPUPerSecond": { "target": "com.amazonaws.elasticache#ECPUPerSecond" } }, "traits": { "smithy.api#documentation": "The usage limits for storage and ElastiCache Processing Units for the cache.
" } }, "com.amazonaws.elasticache#ChangeType": { "type": "enum", "members": { "immediate": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "immediate" } }, "requires_reboot": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "requires-reboot" } } } }, "com.amazonaws.elasticache#CloudWatchLogsDestinationDetails": { "type": "structure", "members": { "LogGroup": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "The name of the CloudWatch Logs log group.
" } } }, "traits": { "smithy.api#documentation": "The configuration details of the CloudWatch Logs destination.
" } }, "com.amazonaws.elasticache#ClusterIdList": { "type": "list", "member": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#xmlName": "ClusterId" } } }, "com.amazonaws.elasticache#ClusterMode": { "type": "enum", "members": { "ENABLED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "enabled" } }, "DISABLED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "disabled" } }, "COMPATIBLE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "compatible" } } } }, "com.amazonaws.elasticache#ClusterQuotaForCustomerExceededFault": { "type": "structure", "members": { "message": { "target": "com.amazonaws.elasticache#ExceptionMessage" } }, "traits": { "aws.protocols#awsQueryError": { "code": "ClusterQuotaForCustomerExceeded", "httpResponseCode": 400 }, "smithy.api#documentation": "The request cannot be processed because it would exceed the allowed number of clusters\n per customer.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.elasticache#CompleteMigration": { "type": "operation", "input": { "target": "com.amazonaws.elasticache#CompleteMigrationMessage" }, "output": { "target": "com.amazonaws.elasticache#CompleteMigrationResponse" }, "errors": [ { "target": "com.amazonaws.elasticache#InvalidCacheClusterStateFault" }, { "target": "com.amazonaws.elasticache#InvalidParameterCombinationException" }, { "target": "com.amazonaws.elasticache#InvalidParameterValueException" }, { "target": "com.amazonaws.elasticache#InvalidReplicationGroupStateFault" }, { "target": "com.amazonaws.elasticache#InvalidServerlessCacheStateFault" }, { "target": "com.amazonaws.elasticache#MigrationHealthFault" }, { "target": "com.amazonaws.elasticache#ReplicationGroupNotFoundFault" }, { "target": "com.amazonaws.elasticache#ReplicationGroupNotUnderMigrationFault" }, { "target": "com.amazonaws.elasticache#ServerlessCacheNotFoundFault" }, { "target": "com.amazonaws.elasticache#ServerlessCacheNotUnderMigrationFault" } ], "traits": { "smithy.api#documentation": "Completes the migration of data.
" } }, "com.amazonaws.elasticache#CompleteMigrationMessage": { "type": "structure", "members": { "ReplicationGroupId": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "The ID of the replication group to which data is being migrated.
" } }, "ServerlessCacheName": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "The name of the serverless cache to which data is being migrated.
" } }, "Force": { "target": "com.amazonaws.elasticache#Boolean", "traits": { "smithy.api#documentation": "Forces the migration to stop without ensuring that data is in sync. It is recommended\n to use this option only to abort the migration and not recommended when application\n wants to continue migration to ElastiCache.
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.elasticache#CompleteMigrationResponse": { "type": "structure", "members": { "ReplicationGroup": { "target": "com.amazonaws.elasticache#ReplicationGroup" }, "ServerlessCache": { "target": "com.amazonaws.elasticache#ServerlessCache", "traits": { "smithy.api#documentation": "Provides the details of the serverless cache for which the migration completed.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.elasticache#ConfigureShard": { "type": "structure", "members": { "NodeGroupId": { "target": "com.amazonaws.elasticache#AllowedNodeGroupId", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The 4-digit id for the node group you are configuring. For Valkey or Redis OSS (cluster mode\n disabled) replication groups, the node group id is always 0001. To find a Valkey or Redis OSS (cluster mode enabled)'s node group's (shard's) id, see Finding a Shard's\n Id.
", "smithy.api#required": {} } }, "NewReplicaCount": { "target": "com.amazonaws.elasticache#Integer", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The number of replicas you want in this node group at the end of this operation.\n The maximum value for NewReplicaCount is 5. The minimum value depends upon\n the type of Valkey or Redis OSS replication group you are working with.
The minimum number of replicas in a shard or replication group is:
\nValkey or Redis OSS (cluster mode disabled)
\nIf Multi-AZ: 1
\nIf Multi-AZ: 0
\nValkey or Redis OSS (cluster mode enabled): 0 (though you will not be able to failover to\n a replica if your primary node fails)
\nA list of PreferredAvailabilityZone strings that specify which\n availability zones the replication group's nodes are to be in. The nummber of\n PreferredAvailabilityZone values must equal the value of\n NewReplicaCount plus 1 to account for the primary node. If this member\n of ReplicaConfiguration is omitted, ElastiCache selects the\n availability zone for each of the replicas.
The outpost ARNs in which the cache cluster is created.
" } } }, "traits": { "smithy.api#documentation": "Node group (shard) configuration options when adding or removing replicas. Each\n node group (shard) configuration has the following members: NodeGroupId,\n NewReplicaCount, and PreferredAvailabilityZones.
" } }, "com.amazonaws.elasticache#ConnectionType": { "type": "enum", "members": { "VPC": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "vpc" } }, "PUBLIC": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "public" } } } }, "com.amazonaws.elasticache#CopyServerlessCacheSnapshot": { "type": "operation", "input": { "target": "com.amazonaws.elasticache#CopyServerlessCacheSnapshotRequest" }, "output": { "target": "com.amazonaws.elasticache#CopyServerlessCacheSnapshotResponse" }, "errors": [ { "target": "com.amazonaws.elasticache#InvalidParameterCombinationException" }, { "target": "com.amazonaws.elasticache#InvalidParameterValueException" }, { "target": "com.amazonaws.elasticache#InvalidServerlessCacheSnapshotStateFault" }, { "target": "com.amazonaws.elasticache#ServerlessCacheSnapshotAlreadyExistsFault" }, { "target": "com.amazonaws.elasticache#ServerlessCacheSnapshotNotFoundFault" }, { "target": "com.amazonaws.elasticache#ServerlessCacheSnapshotQuotaExceededFault" }, { "target": "com.amazonaws.elasticache#ServiceLinkedRoleNotFoundFault" }, { "target": "com.amazonaws.elasticache#TagQuotaPerResourceExceeded" } ], "traits": { "smithy.api#documentation": "Creates a copy of an existing serverless cache\u2019s snapshot. Available for Valkey, Redis OSS and Serverless Memcached only.
" } }, "com.amazonaws.elasticache#CopyServerlessCacheSnapshotRequest": { "type": "structure", "members": { "SourceServerlessCacheSnapshotName": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The identifier of the existing serverless cache\u2019s snapshot to be copied. Available for Valkey, Redis OSS and Serverless Memcached only.
", "smithy.api#required": {} } }, "TargetServerlessCacheSnapshotName": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The identifier for the snapshot to be created. Available for Valkey, Redis OSS and Serverless Memcached only. This value is stored as a lowercase string.
", "smithy.api#required": {} } }, "KmsKeyId": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "The identifier of the KMS key used to encrypt the target snapshot. Available for Valkey, Redis OSS and Serverless Memcached only.
" } }, "Tags": { "target": "com.amazonaws.elasticache#TagList", "traits": { "smithy.api#documentation": "A list of tags to be added to the target snapshot resource. A tag is a key-value pair. Available for Valkey, Redis OSS and Serverless Memcached only. Default: NULL
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.elasticache#CopyServerlessCacheSnapshotResponse": { "type": "structure", "members": { "ServerlessCacheSnapshot": { "target": "com.amazonaws.elasticache#ServerlessCacheSnapshot", "traits": { "smithy.api#documentation": "The response for the attempt to copy the serverless cache snapshot. Available for Valkey, Redis OSS and Serverless Memcached only.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.elasticache#CopySnapshot": { "type": "operation", "input": { "target": "com.amazonaws.elasticache#CopySnapshotMessage" }, "output": { "target": "com.amazonaws.elasticache#CopySnapshotResult" }, "errors": [ { "target": "com.amazonaws.elasticache#InvalidParameterCombinationException" }, { "target": "com.amazonaws.elasticache#InvalidParameterValueException" }, { "target": "com.amazonaws.elasticache#InvalidSnapshotStateFault" }, { "target": "com.amazonaws.elasticache#SnapshotAlreadyExistsFault" }, { "target": "com.amazonaws.elasticache#SnapshotNotFoundFault" }, { "target": "com.amazonaws.elasticache#SnapshotQuotaExceededFault" }, { "target": "com.amazonaws.elasticache#TagQuotaPerResourceExceeded" } ], "traits": { "smithy.api#documentation": "Makes a copy of an existing snapshot.
\nThis operation is valid for Valkey or Redis OSS only.
\nUsers or groups that have permissions to use the CopySnapshot\n operation can create their own Amazon S3 buckets and copy snapshots to it. To\n control access to your snapshots, use an IAM policy to control who has the ability\n to use the CopySnapshot operation. For more information about using IAM\n to control the use of ElastiCache operations, see Exporting\n Snapshots and Authentication & Access\n Control.
You could receive the following error messages.
\n\n Error Messages\n
\n\n Error Message: The S3 bucket %s is outside of\n the region.
\n\n Solution: Create an Amazon S3 bucket in the\n same region as your snapshot. For more information, see Step 1: Create an Amazon S3 Bucket in the ElastiCache User\n Guide.
\n\n Error Message: The S3 bucket %s does not\n exist.
\n\n Solution: Create an Amazon S3 bucket in the\n same region as your snapshot. For more information, see Step 1: Create an Amazon S3 Bucket in the ElastiCache User\n Guide.
\n\n Error Message: The S3 bucket %s is not owned\n by the authenticated user.
\n\n Solution: Create an Amazon S3 bucket in the\n same region as your snapshot. For more information, see Step 1: Create an Amazon S3 Bucket in the ElastiCache User\n Guide.
\n\n Error Message: The authenticated user does\n not have sufficient permissions to perform the desired activity.
\n\n Solution: Contact your system administrator\n to get the needed permissions.
\n\n Error Message: The S3 bucket %s already\n contains an object with key %s.
\n\n Solution: Give the\n TargetSnapshotName a new and unique value. If exporting a\n snapshot, you could alternatively create a new Amazon S3 bucket and use this\n same value for TargetSnapshotName.
\n Error Message: ElastiCache has not been\n granted READ permissions %s on the S3 Bucket.
\n\n Solution: Add List and Read permissions on\n the bucket. For more information, see Step 2: Grant ElastiCache Access to Your Amazon S3 Bucket in the\n ElastiCache User Guide.
\n\n Error Message: ElastiCache has not been\n granted WRITE permissions %s on the S3 Bucket.
\n\n Solution: Add Upload/Delete permissions on\n the bucket. For more information, see Step 2: Grant ElastiCache Access to Your Amazon S3 Bucket in the\n ElastiCache User Guide.
\n\n Error Message: ElastiCache has not been\n granted READ_ACP permissions %s on the S3 Bucket.
\n\n Solution: Add View Permissions on the bucket.\n For more information, see Step 2: Grant ElastiCache Access to Your Amazon S3 Bucket in the\n ElastiCache User Guide.
\nThe name of an existing snapshot from which to make a copy.
", "smithy.api#required": {} } }, "TargetSnapshotName": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "A name for the snapshot copy. ElastiCache does not permit overwriting a snapshot,\n therefore this name must be unique within its context - ElastiCache or an Amazon S3\n bucket if exporting. This value is stored as a lowercase string.
", "smithy.api#required": {} } }, "TargetBucket": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "The Amazon S3 bucket to which the snapshot is exported. This parameter is used only\n when exporting a snapshot for external access.
\nWhen using this parameter to export a snapshot, be sure Amazon ElastiCache has the\n needed permissions to this S3 bucket. For more information, see Step 2: Grant ElastiCache Access to Your Amazon S3 Bucket in the\n Amazon ElastiCache User Guide.
\nFor more information, see Exporting a\n Snapshot in the Amazon ElastiCache User Guide.
" } }, "KmsKeyId": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "The ID of the KMS key used to encrypt the target snapshot.
" } }, "Tags": { "target": "com.amazonaws.elasticache#TagList", "traits": { "smithy.api#documentation": "A list of tags to be added to this resource. A tag is a key-value pair. A tag key must\n be accompanied by a tag value, although null is accepted.
" } } }, "traits": { "smithy.api#documentation": "Represents the input of a CopySnapshotMessage operation.
Creates a cluster. All nodes in the cluster run the same protocol-compliant cache\n engine software, either Memcached, Valkey or Redis OSS.
\nThis operation is not supported for Valkey or Redis OSS (cluster mode enabled) clusters.
", "smithy.api#examples": [ { "title": "CreateCacheCluster", "documentation": "Creates a Memcached cluster with 2 nodes. ", "input": { "CacheClusterId": "my-memcached-cluster", "AZMode": "cross-az", "NumCacheNodes": 2, "CacheNodeType": "cache.r3.large", "Engine": "memcached", "EngineVersion": "1.4.24", "CacheSubnetGroupName": "default", "Port": 11211 }, "output": { "CacheCluster": { "Engine": "memcached", "CacheParameterGroup": { "CacheNodeIdsToReboot": [], "CacheParameterGroupName": "default.memcached1.4", "ParameterApplyStatus": "in-sync" }, "CacheClusterId": "my-memcached-cluster", "CacheSecurityGroups": [], "NumCacheNodes": 2, "AutoMinorVersionUpgrade": true, "CacheClusterStatus": "creating", "PreferredAvailabilityZone": "Multiple", "ClientDownloadLandingPage": "https://console.aws.amazon.com/elasticache/home#client-download:", "CacheSubnetGroupName": "default", "EngineVersion": "1.4.24", "PendingModifiedValues": {}, "PreferredMaintenanceWindow": "wed:09:00-wed:10:00", "CacheNodeType": "cache.r3.large" } } }, { "title": "CreateCacheCluster", "documentation": "Creates a Redis cluster with 1 node. ", "input": { "CacheClusterId": "my-redis", "PreferredAvailabilityZone": "us-east-1c", "NumCacheNodes": 1, "CacheNodeType": "cache.r3.larage", "Engine": "redis", "EngineVersion": "3.2.4", "CacheSubnetGroupName": "default", "Port": 6379, "SnapshotRetentionLimit": 7, "AutoMinorVersionUpgrade": true }, "output": { "CacheCluster": { "Engine": "redis", "CacheParameterGroup": { "CacheNodeIdsToReboot": [], "CacheParameterGroupName": "default.redis3.2", "ParameterApplyStatus": "in-sync" }, "SnapshotRetentionLimit": 7, "CacheClusterId": "my-redis", "CacheSecurityGroups": [], "NumCacheNodes": 1, "SnapshotWindow": "10: 00-11: 00", "AutoMinorVersionUpgrade": true, "CacheClusterStatus": "creating", "PreferredAvailabilityZone": "us-east-1c", "ClientDownloadLandingPage": "https: //console.aws.amazon.com/elasticache/home#client-download: ", "CacheSubnetGroupName": "default", "EngineVersion": "3.2.4", "PendingModifiedValues": {}, "PreferredMaintenanceWindow": "fri: 05: 30-fri: 06: 30", "CacheNodeType": "cache.m3.large" } } } ] } }, "com.amazonaws.elasticache#CreateCacheClusterMessage": { "type": "structure", "members": { "CacheClusterId": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The node group (shard) identifier. This parameter is stored as a lowercase\n string.
\n\n Constraints:\n
\nA name must contain from 1 to 50 alphanumeric characters or hyphens.
\nThe first character must be a letter.
\nA name cannot end with a hyphen or contain two consecutive hyphens.
\nThe ID of the replication group to which this cluster should belong. If this parameter\n is specified, the cluster is added to the specified replication group as a read replica;\n otherwise, the cluster is a standalone primary that is not part of any replication\n group.
\nIf the specified replication group is Multi-AZ enabled and the Availability Zone is\n not specified, the cluster is created in Availability Zones that provide the best spread\n of read replicas across Availability Zones.
\nThis parameter is only valid if the Engine parameter is\n redis.
Specifies whether the nodes in this Memcached cluster are created in a single\n Availability Zone or created across multiple Availability Zones in the cluster's\n region.
\nThis parameter is only supported for Memcached clusters.
\nIf the AZMode and PreferredAvailabilityZones are not\n specified, ElastiCache assumes single-az mode.
The EC2 Availability Zone in which the cluster is created.
\nAll nodes belonging to this cluster are placed in the preferred Availability Zone. If\n you want to create your nodes across multiple Availability Zones, use\n PreferredAvailabilityZones.
Default: System chosen Availability Zone.
" } }, "PreferredAvailabilityZones": { "target": "com.amazonaws.elasticache#PreferredAvailabilityZoneList", "traits": { "smithy.api#documentation": "A list of the Availability Zones in which cache nodes are created. The order of the\n zones in the list is not important.
\nThis option is only supported on Memcached.
\nIf you are creating your cluster in an Amazon VPC (recommended) you can only\n locate nodes in Availability Zones that are associated with the subnets in the\n selected subnet group.
\nThe number of Availability Zones listed must equal the value of\n NumCacheNodes.
If you want all the nodes in the same Availability Zone, use\n PreferredAvailabilityZone instead, or repeat the Availability Zone\n multiple times in the list.
Default: System chosen Availability Zones.
" } }, "NumCacheNodes": { "target": "com.amazonaws.elasticache#IntegerOptional", "traits": { "smithy.api#documentation": "The initial number of cache nodes that the cluster has.
\nFor clusters running Valkey or Redis OSS, this value must be 1. For clusters running Memcached, this\n value must be between 1 and 40.
\nIf you need more than 40 nodes for your Memcached cluster, please fill out the\n ElastiCache Limit Increase Request form at http://aws.amazon.com/contact-us/elasticache-node-limit-request/.
" } }, "CacheNodeType": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "The compute and memory capacity of the nodes in the node group (shard).
\nThe following node types are supported by ElastiCache. Generally speaking, the current\n generation types provide more memory and computational power at lower cost when compared\n to their equivalent previous generation counterparts.
\nGeneral purpose:
\nCurrent generation:
\n\n M7g node types:\n \t\t\t\t\tcache.m7g.large,\n \t\t\t\t\tcache.m7g.xlarge,\n \t\t\t\t\tcache.m7g.2xlarge,\n \t\t\t\t\tcache.m7g.4xlarge,\n \t\t\t\t\tcache.m7g.8xlarge,\n \t\t\t\t\tcache.m7g.12xlarge,\n \t\t\t\t\tcache.m7g.16xlarge\n
For region availability, see Supported Node Types\n
\n\n M6g node types (available only for Redis OSS engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward):\n\t\t\t\t\t \n\t\t\t\t\t \tcache.m6g.large,\n\t\t\t\t\t\t\tcache.m6g.xlarge,\n\t\t\t\t\t\t\tcache.m6g.2xlarge,\n\t\t\t\t\t\t\tcache.m6g.4xlarge,\n\t\t\t\t\t\t\tcache.m6g.8xlarge,\n\t\t\t\t\t\t\tcache.m6g.12xlarge,\n\t\t\t\t\t\t\tcache.m6g.16xlarge\n
\n M5 node types:\n cache.m5.large,\n \t\t\t\t\t\tcache.m5.xlarge,\n \t\t\t\t\t\tcache.m5.2xlarge,\n \t\t\t\t\t\tcache.m5.4xlarge,\n \t\t\t\t\t\tcache.m5.12xlarge,\n \t\t\t\t\t\tcache.m5.24xlarge\n
\n M4 node types:\n cache.m4.large,\n \t\t\t\t\t\tcache.m4.xlarge,\n \t\t\t\t\t\tcache.m4.2xlarge,\n \t\t\t\t\t\tcache.m4.4xlarge,\n \t\t\t\t\t\tcache.m4.10xlarge\n
\n T4g node types (available only for Redis OSS engine version 5.0.6 onward and Memcached engine version 1.5.16 onward):\n\t\t\t\t\t cache.t4g.micro,\n\t\t\t\t\t cache.t4g.small,\n\t\t\t\t\t cache.t4g.medium\n
\n T3 node types:\n cache.t3.micro, \n \t\t\t\t\t\tcache.t3.small,\n \t\t\t\t\t\tcache.t3.medium\n
\n T2 node types:\n cache.t2.micro, \n \t\t\t\t\t\tcache.t2.small,\n \t\t\t\t\t\tcache.t2.medium\n
Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)
\n\n T1 node types:\n cache.t1.micro\n
\n M1 node types:\n cache.m1.small, \n\t\t\t\t\t\t cache.m1.medium, \n\t\t\t\t\t\t cache.m1.large,\n\t\t\t\t\t\t cache.m1.xlarge\n
\n M3 node types:\n cache.m3.medium,\n \t\t\t\t\t\tcache.m3.large, \n \t\t\t\t\t\tcache.m3.xlarge,\n \t\t\t\t\t\tcache.m3.2xlarge\n
Compute optimized:
\nPrevious generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)
\n\n C1 node types:\n cache.c1.xlarge\n
Memory optimized:
\nCurrent generation:
\n\n R7g node types:\t\n\t\t\t\t\t\t\tcache.r7g.large,\n\t\t\t\t\t\t\tcache.r7g.xlarge,\n\t\t\t\t\t\t\tcache.r7g.2xlarge,\n\t\t\t\t\t\t\tcache.r7g.4xlarge,\n\t\t\t\t\t\t\tcache.r7g.8xlarge,\n\t\t\t\t\t\t\tcache.r7g.12xlarge,\n\t\t\t\t\t\t\tcache.r7g.16xlarge\n
For region availability, see Supported Node Types\n
\n\n R6g node types (available only for Redis OSS engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward):\n\t\t\t\t\t\t\tcache.r6g.large,\n\t\t\t\t\t\t\tcache.r6g.xlarge,\n\t\t\t\t\t\t\tcache.r6g.2xlarge,\n\t\t\t\t\t\t\tcache.r6g.4xlarge,\n\t\t\t\t\t\t\tcache.r6g.8xlarge,\n\t\t\t\t\t\t\tcache.r6g.12xlarge,\n\t\t\t\t\t\t\tcache.r6g.16xlarge\n
\n R5 node types:\n cache.r5.large,\n \t\t\t\t\t cache.r5.xlarge,\n \t\t\t\t\t cache.r5.2xlarge,\n \t\t\t\t\t cache.r5.4xlarge,\n \t\t\t\t\t cache.r5.12xlarge,\n \t\t\t\t\t cache.r5.24xlarge\n
\n R4 node types:\n cache.r4.large,\n \t\t\t\t\t cache.r4.xlarge,\n \t\t\t\t\t cache.r4.2xlarge,\n \t\t\t\t\t cache.r4.4xlarge,\n \t\t\t\t\t cache.r4.8xlarge,\n \t\t\t\t\t cache.r4.16xlarge\n
Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)
\n\n M2 node types:\n cache.m2.xlarge, \n \t\t\t\t\t\tcache.m2.2xlarge,\n \t\t\t\t\t\tcache.m2.4xlarge\n
\n R3 node types:\n cache.r3.large, \n \t\t\t\t\t\tcache.r3.xlarge,\n \t\t\t\t\t\tcache.r3.2xlarge, \n \t\t\t\t\t\tcache.r3.4xlarge,\n \t\t\t\t\t\tcache.r3.8xlarge\n
\n Additional node type info\n
\nAll current generation instance types are created in Amazon VPC by\n default.
\nValkey or Redis OSS append-only files (AOF) are not supported for T1 or T2 instances.
\nValkey or Redis OSS Multi-AZ with automatic failover is not supported on T1\n instances.
\nThe configuration variables appendonly and\n appendfsync are not supported on Valkey, or on Redis OSS version 2.8.22 and\n later.
The name of the cache engine to be used for this cluster.
\nValid values for this parameter are: memcached |\n redis\n
The version number of the cache engine to be used for this cluster. To view the\n supported cache engine versions, use the DescribeCacheEngineVersions operation.
\n\n Important: You can upgrade to a newer engine version\n (see Selecting\n a Cache Engine and Version), but you cannot downgrade to an earlier engine\n version. If you want to use an earlier engine version, you must delete the existing\n cluster or replication group and create it anew with the earlier engine version.
" } }, "CacheParameterGroupName": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "The name of the parameter group to associate with this cluster. If this argument is\n omitted, the default parameter group for the specified engine is used. You cannot use\n any parameter group which has cluster-enabled='yes' when creating a\n cluster.
The name of the subnet group to be used for the cluster.
\nUse this parameter only when you are creating a cluster in an Amazon Virtual Private\n Cloud (Amazon VPC).
\nIf you're going to launch your cluster in an Amazon VPC, you need to create a\n subnet group before you start creating a cluster. For more information, see Subnets and Subnet Groups.
\nA list of security group names to associate with this cluster.
\nUse this parameter only when you are creating a cluster outside of an Amazon Virtual\n Private Cloud (Amazon VPC).
" } }, "SecurityGroupIds": { "target": "com.amazonaws.elasticache#SecurityGroupIdsList", "traits": { "smithy.api#documentation": "One or more VPC security groups associated with the cluster.
\nUse this parameter only when you are creating a cluster in an Amazon Virtual Private\n Cloud (Amazon VPC).
" } }, "Tags": { "target": "com.amazonaws.elasticache#TagList", "traits": { "smithy.api#documentation": "A list of tags to be added to this resource.
" } }, "SnapshotArns": { "target": "com.amazonaws.elasticache#SnapshotArnsList", "traits": { "smithy.api#documentation": "A single-element string list containing an Amazon Resource Name (ARN) that uniquely\n identifies a Valkey or Redis OSS RDB snapshot file stored in Amazon S3. The snapshot file is used to\n populate the node group (shard). The Amazon S3 object name in the ARN cannot contain any\n commas.
\nThis parameter is only valid if the Engine parameter is\n redis.
Example of an Amazon S3 ARN: arn:aws:s3:::my_bucket/snapshot1.rdb\n
The name of a Valkey or Redis OSS snapshot from which to restore data into the new node group\n (shard). The snapshot status changes to restoring while the new node group\n (shard) is being created.
This parameter is only valid if the Engine parameter is\n redis.
Specifies the weekly time range during which maintenance on the cluster is performed.\n It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The\n minimum maintenance window is a 60 minute period.
" } }, "Port": { "target": "com.amazonaws.elasticache#IntegerOptional", "traits": { "smithy.api#documentation": "The port number on which each of the cache nodes accepts connections.
" } }, "NotificationTopicArn": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic\n to which notifications are sent.
\nThe Amazon SNS topic owner must be the same as the cluster owner.
\n\u00a0If you are running Valkey 7.2 and above or Redis OSS engine version 6.0 and above, set this parameter to yes \n to opt-in to the next auto minor version upgrade campaign. This parameter is\n disabled for previous versions.\u00a0
" } }, "SnapshotRetentionLimit": { "target": "com.amazonaws.elasticache#IntegerOptional", "traits": { "smithy.api#documentation": "The number of days for which ElastiCache retains automatic snapshots before deleting\n them. For example, if you set SnapshotRetentionLimit to 5, a snapshot taken\n today is retained for 5 days before being deleted.
This parameter is only valid if the Engine parameter is\n redis.
Default: 0 (i.e., automatic backups are disabled for this cache cluster).
" } }, "SnapshotWindow": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot\n of your node group (shard).
\nExample: 05:00-09:00\n
If you do not specify this parameter, ElastiCache automatically chooses an appropriate\n time range.
\nThis parameter is only valid if the Engine parameter is\n redis.
\n Reserved parameter. The password used to access a\n password protected server.
\nPassword constraints:
\nMust be only printable ASCII characters.
\nMust be at least 16 characters and no more than 128 characters in\n length.
\nThe only permitted printable special characters are !, &, #, $, ^, <,\n >, and -. Other printable special characters cannot be used in the AUTH\n token.
\nFor more information, see AUTH\n password at http://redis.io/commands/AUTH.
" } }, "OutpostMode": { "target": "com.amazonaws.elasticache#OutpostMode", "traits": { "smithy.api#documentation": "Specifies whether the nodes in the cluster are created in a single outpost or across\n multiple outposts.
" } }, "PreferredOutpostArn": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "The outpost ARN in which the cache cluster is created.
" } }, "PreferredOutpostArns": { "target": "com.amazonaws.elasticache#PreferredOutpostArnList", "traits": { "smithy.api#documentation": "The outpost ARNs in which the cache cluster is created.
" } }, "LogDeliveryConfigurations": { "target": "com.amazonaws.elasticache#LogDeliveryConfigurationRequestList", "traits": { "smithy.api#documentation": "Specifies the destination, format and type of the logs.
" } }, "TransitEncryptionEnabled": { "target": "com.amazonaws.elasticache#BooleanOptional", "traits": { "smithy.api#documentation": "A flag that enables in-transit encryption when set to true.
" } }, "NetworkType": { "target": "com.amazonaws.elasticache#NetworkType", "traits": { "smithy.api#documentation": "Must be either ipv4 | ipv6 | dual_stack. IPv6\n is supported for workloads using Valkey 7.2 and above, Redis OSS engine version 6.2 to 7.1\n and Memcached engine version 1.6.6 and above on all instances built on the Nitro system.
The network type you choose when modifying a cluster, either ipv4 |\n ipv6. IPv6 is supported for workloads using Valkey 7.2 and above, Redis OSS engine version 6.2\n to 7.1 and Memcached engine version 1.6.6 and above on all instances built on the Nitro system.
Represents the input of a CreateCacheCluster operation.
", "smithy.api#input": {} } }, "com.amazonaws.elasticache#CreateCacheClusterResult": { "type": "structure", "members": { "CacheCluster": { "target": "com.amazonaws.elasticache#CacheCluster" } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.elasticache#CreateCacheParameterGroup": { "type": "operation", "input": { "target": "com.amazonaws.elasticache#CreateCacheParameterGroupMessage" }, "output": { "target": "com.amazonaws.elasticache#CreateCacheParameterGroupResult" }, "errors": [ { "target": "com.amazonaws.elasticache#CacheParameterGroupAlreadyExistsFault" }, { "target": "com.amazonaws.elasticache#CacheParameterGroupQuotaExceededFault" }, { "target": "com.amazonaws.elasticache#InvalidCacheParameterGroupStateFault" }, { "target": "com.amazonaws.elasticache#InvalidParameterCombinationException" }, { "target": "com.amazonaws.elasticache#InvalidParameterValueException" }, { "target": "com.amazonaws.elasticache#TagQuotaPerResourceExceeded" } ], "traits": { "smithy.api#documentation": "Creates a new Amazon ElastiCache cache parameter group. An ElastiCache cache parameter\n group is a collection of parameters and their values that are applied to all of the\n nodes in any cluster or replication group using the CacheParameterGroup.
\nA newly created CacheParameterGroup is an exact duplicate of the default parameter\n group for the CacheParameterGroupFamily. To customize the newly created\n CacheParameterGroup you can change the values of specific parameters. For more\n information, see:
\n\n ModifyCacheParameterGroup in the ElastiCache API Reference.
\n\n Parameters and\n Parameter Groups in the ElastiCache User Guide.
\nA user-specified name for the cache parameter group. This value is stored as a lowercase string.
", "smithy.api#required": {} } }, "CacheParameterGroupFamily": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The name of the cache parameter group family that the cache parameter group can be\n used with.
\nValid values are: valkey8 | valkey7 | memcached1.4 | memcached1.5 | memcached1.6 | redis2.6 | redis2.8 |\nredis3.2 | redis4.0 | redis5.0 | redis6.x | redis7\n
A user-specified description for the cache parameter group.
", "smithy.api#required": {} } }, "Tags": { "target": "com.amazonaws.elasticache#TagList", "traits": { "smithy.api#documentation": "A list of tags to be added to this resource. A tag is a key-value pair. A tag key must\n be accompanied by a tag value, although null is accepted.
" } } }, "traits": { "smithy.api#documentation": "Represents the input of a CreateCacheParameterGroup operation.
Creates a new cache security group. Use a cache security group to control access to\n one or more clusters.
\nCache security groups are only used when you are creating a cluster outside of an\n Amazon Virtual Private Cloud (Amazon VPC). If you are creating a cluster inside of a\n VPC, use a cache subnet group instead. For more information, see CreateCacheSubnetGroup.
", "smithy.api#examples": [ { "title": "CreateCacheSecurityGroup", "documentation": "Creates an ElastiCache security group. ElastiCache security groups are only for clusters not running in an AWS VPC.", "input": { "CacheSecurityGroupName": "my-cache-sec-grp", "Description": "Example ElastiCache security group." } } ] } }, "com.amazonaws.elasticache#CreateCacheSecurityGroupMessage": { "type": "structure", "members": { "CacheSecurityGroupName": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "A name for the cache security group. This value is stored as a lowercase\n string.
\nConstraints: Must contain no more than 255 alphanumeric characters. Cannot be the word\n \"Default\".
\nExample: mysecuritygroup\n
A description for the cache security group.
", "smithy.api#required": {} } }, "Tags": { "target": "com.amazonaws.elasticache#TagList", "traits": { "smithy.api#documentation": "A list of tags to be added to this resource. A tag is a key-value pair. A tag key must\n be accompanied by a tag value, although null is accepted.
" } } }, "traits": { "smithy.api#documentation": "Represents the input of a CreateCacheSecurityGroup operation.
Creates a new cache subnet group.
\nUse this parameter only when you are creating a cluster in an Amazon Virtual Private\n Cloud (Amazon VPC).
", "smithy.api#examples": [ { "title": "CreateCacheSubnet", "documentation": "Creates a new cache subnet group.", "input": { "CacheSubnetGroupName": "my-sn-grp2", "CacheSubnetGroupDescription": "Sample subnet group", "SubnetIds": [ "subnet-6f28c982", "subnet-bcd382f3", "subnet-845b3e7c0" ] }, "output": { "CacheSubnetGroup": { "VpcId": "vpc-91280df6", "CacheSubnetGroupDescription": "My subnet group.", "Subnets": [ { "SubnetIdentifier": "subnet-6f28c982", "SubnetAvailabilityZone": { "Name": "us-east-1a" } }, { "SubnetIdentifier": "subnet-bcd382f3", "SubnetAvailabilityZone": { "Name": "us-east-1c" } }, { "SubnetIdentifier": "subnet-845b3e7c0", "SubnetAvailabilityZone": { "Name": "us-east-1b" } } ], "CacheSubnetGroupName": "my-sn-grp" } } } ] } }, "com.amazonaws.elasticache#CreateCacheSubnetGroupMessage": { "type": "structure", "members": { "CacheSubnetGroupName": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "A name for the cache subnet group. This value is stored as a lowercase string.
\nConstraints: Must contain no more than 255 alphanumeric characters or hyphens.
\nExample: mysubnetgroup\n
A description for the cache subnet group.
", "smithy.api#required": {} } }, "SubnetIds": { "target": "com.amazonaws.elasticache#SubnetIdentifierList", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "A list of VPC subnet IDs for the cache subnet group.
", "smithy.api#required": {} } }, "Tags": { "target": "com.amazonaws.elasticache#TagList", "traits": { "smithy.api#documentation": "A list of tags to be added to this resource. A tag is a key-value pair. A tag key must\n be accompanied by a tag value, although null is accepted.
" } } }, "traits": { "smithy.api#documentation": "Represents the input of a CreateCacheSubnetGroup operation.
Global Datastore offers fully managed, fast, reliable and secure\n cross-region replication. Using Global Datastore with Valkey or Redis OSS, you can create cross-region\n read replica clusters for ElastiCache to enable low-latency reads and disaster\n recovery across regions. For more information, see Replication\n Across Regions Using Global Datastore.
\nThe GlobalReplicationGroupIdSuffix is the\n name of the Global datastore.
\nThe PrimaryReplicationGroupId represents the\n name of the primary cluster that accepts writes and will replicate updates to\n the secondary cluster.
\nThe suffix name of a Global datastore. Amazon ElastiCache automatically applies a\n prefix to the Global datastore ID when it is created. Each Amazon Region has its own\n prefix. For instance, a Global datastore ID created in the US-West-1 region will begin\n with \"dsdfu\" along with the suffix name you provide. The suffix, combined with the\n auto-generated prefix, guarantees uniqueness of the Global datastore name across\n multiple regions.
\nFor a full list of Amazon Regions and their respective Global datastore iD prefixes,\n see Using the Amazon CLI with Global datastores .
", "smithy.api#required": {} } }, "GlobalReplicationGroupDescription": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "Provides details of the Global datastore
" } }, "PrimaryReplicationGroupId": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The name of the primary cluster that accepts writes and will replicate updates to the\n secondary cluster. This value is stored as a lowercase string.
", "smithy.api#required": {} } }, "Tags": { "target": "com.amazonaws.elasticache#TagList", "traits": { "smithy.api#documentation": "A list of tags to be added to this resource. A tag is a key-value pair. A tag key must\n be accompanied by a tag value, although null is accepted.
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.elasticache#CreateGlobalReplicationGroupResult": { "type": "structure", "members": { "GlobalReplicationGroup": { "target": "com.amazonaws.elasticache#GlobalReplicationGroup" } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.elasticache#CreateReplicationGroup": { "type": "operation", "input": { "target": "com.amazonaws.elasticache#CreateReplicationGroupMessage" }, "output": { "target": "com.amazonaws.elasticache#CreateReplicationGroupResult" }, "errors": [ { "target": "com.amazonaws.elasticache#CacheClusterNotFoundFault" }, { "target": "com.amazonaws.elasticache#CacheParameterGroupNotFoundFault" }, { "target": "com.amazonaws.elasticache#CacheSecurityGroupNotFoundFault" }, { "target": "com.amazonaws.elasticache#CacheSubnetGroupNotFoundFault" }, { "target": "com.amazonaws.elasticache#ClusterQuotaForCustomerExceededFault" }, { "target": "com.amazonaws.elasticache#GlobalReplicationGroupNotFoundFault" }, { "target": "com.amazonaws.elasticache#InsufficientCacheClusterCapacityFault" }, { "target": "com.amazonaws.elasticache#InvalidCacheClusterStateFault" }, { "target": "com.amazonaws.elasticache#InvalidGlobalReplicationGroupStateFault" }, { "target": "com.amazonaws.elasticache#InvalidParameterCombinationException" }, { "target": "com.amazonaws.elasticache#InvalidParameterValueException" }, { "target": "com.amazonaws.elasticache#InvalidUserGroupStateFault" }, { "target": "com.amazonaws.elasticache#InvalidVPCNetworkStateFault" }, { "target": "com.amazonaws.elasticache#NodeGroupsPerReplicationGroupQuotaExceededFault" }, { "target": "com.amazonaws.elasticache#NodeQuotaForClusterExceededFault" }, { "target": "com.amazonaws.elasticache#NodeQuotaForCustomerExceededFault" }, { "target": "com.amazonaws.elasticache#ReplicationGroupAlreadyExistsFault" }, { "target": "com.amazonaws.elasticache#TagQuotaPerResourceExceeded" }, { "target": "com.amazonaws.elasticache#UserGroupNotFoundFault" } ], "traits": { "smithy.api#documentation": "Creates a Valkey or Redis OSS (cluster mode disabled) or a Valkey or Redis OSS (cluster mode enabled) replication\n group.
\nThis API can be used to create a standalone regional replication group or a secondary\n replication group associated with a Global datastore.
\nA Valkey or Redis OSS (cluster mode disabled) replication group is a collection of nodes, where\n one of the nodes is a read/write primary and the others are read-only replicas.\n Writes to the primary are asynchronously propagated to the replicas.
\nA Valkey or Redis OSS cluster-mode enabled cluster is comprised of from 1 to 90 shards (API/CLI:\n node groups). Each shard has a primary node and up to 5 read-only replica nodes. The\n configuration can range from 90 shards and 0 replicas to 15 shards and 5 replicas, which\n is the maximum number or replicas allowed.
\nThe node or shard limit can be increased to a maximum of 500 per cluster if the Valkey or Redis OSS \n engine version is 5.0.6 or higher. For example, you can choose to configure a 500 node\n cluster that ranges between 83 shards (one primary and 5 replicas per shard) and 500\n shards (single primary and no replicas). Make sure there are enough available IP\n addresses to accommodate the increase. Common pitfalls include the subnets in the subnet\n group have too small a CIDR range or the subnets are shared and heavily used by other\n clusters. For more information, see Creating a Subnet\n Group. For versions below 5.0.6, the limit is 250 per cluster.
\nTo request a limit increase, see Amazon Service Limits and\n choose the limit type Nodes per cluster per instance\n type.
\nWhen a Valkey or Redis OSS (cluster mode disabled) replication group has been successfully created,\n you can add one or more read replicas to it, up to a total of 5 read replicas. If you\n need to increase or decrease the number of node groups (console: shards), you can use scaling. \n For more information, see Scaling self-designed clusters in the ElastiCache User\n Guide.
\nThis operation is valid for Valkey and Redis OSS only.
\nThe replication group identifier. This parameter is stored as a lowercase\n string.
\nConstraints:
\nA name must contain from 1 to 40 alphanumeric characters or hyphens.
\nThe first character must be a letter.
\nA name cannot end with a hyphen or contain two consecutive hyphens.
\nA user-created description for the replication group.
", "smithy.api#required": {} } }, "GlobalReplicationGroupId": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "The name of the Global datastore
" } }, "PrimaryClusterId": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "The identifier of the cluster that serves as the primary for this replication group.\n This cluster must already exist and have a status of available.
This parameter is not required if NumCacheClusters,\n NumNodeGroups, or ReplicasPerNodeGroup is\n specified.
Specifies whether a read-only replica is automatically promoted to read/write primary\n if the existing primary fails.
\n\n AutomaticFailoverEnabled must be enabled for Valkey or Redis OSS (cluster mode enabled)\n replication groups.
Default: false
" } }, "MultiAZEnabled": { "target": "com.amazonaws.elasticache#BooleanOptional", "traits": { "smithy.api#documentation": "A flag indicating if you have Multi-AZ enabled to enhance fault tolerance. For more\n information, see Minimizing Downtime: Multi-AZ.
" } }, "NumCacheClusters": { "target": "com.amazonaws.elasticache#IntegerOptional", "traits": { "smithy.api#documentation": "The number of clusters this replication group initially has.
\nThis parameter is not used if there is more than one node group (shard). You should\n use ReplicasPerNodeGroup instead.
If AutomaticFailoverEnabled is true, the value of this\n parameter must be at least 2. If AutomaticFailoverEnabled is\n false you can omit this parameter (it will default to 1), or you can\n explicitly set it to a value between 2 and 6.
The maximum permitted value for NumCacheClusters is 6 (1 primary plus 5\n replicas).
A list of EC2 Availability Zones in which the replication group's clusters are\n created. The order of the Availability Zones in the list is the order in which clusters\n are allocated. The primary cluster is created in the first AZ in the list.
\nThis parameter is not used if there is more than one node group (shard). You should\n use NodeGroupConfiguration instead.
If you are creating your replication group in an Amazon VPC (recommended), you can\n only locate clusters in Availability Zones associated with the subnets in the\n selected subnet group.
\nThe number of Availability Zones listed must equal the value of\n NumCacheClusters.
Default: system chosen Availability Zones.
" } }, "NumNodeGroups": { "target": "com.amazonaws.elasticache#IntegerOptional", "traits": { "smithy.api#documentation": "An optional parameter that specifies the number of node groups (shards) for this Valkey or Redis OSS (cluster mode enabled) replication group. For Valkey or Redis OSS (cluster mode disabled) either omit\n this parameter or set it to 1.
\nDefault: 1
" } }, "ReplicasPerNodeGroup": { "target": "com.amazonaws.elasticache#IntegerOptional", "traits": { "smithy.api#documentation": "An optional parameter that specifies the number of replica nodes in each node group\n (shard). Valid values are 0 to 5.
" } }, "NodeGroupConfiguration": { "target": "com.amazonaws.elasticache#NodeGroupConfigurationList", "traits": { "smithy.api#documentation": "A list of node group (shard) configuration options. Each node group (shard)\n configuration has the following members: PrimaryAvailabilityZone,\n ReplicaAvailabilityZones, ReplicaCount, and\n Slots.
If you're creating a Valkey or Redis OSS (cluster mode disabled) or a Valkey or Redis OSS (cluster mode enabled)\n replication group, you can use this parameter to individually configure each node group\n (shard), or you can omit this parameter. However, it is required when seeding a Valkey or Redis OSS (cluster mode enabled) cluster from a S3 rdb file. You must configure each node group\n (shard) using this parameter because you must specify the slots for each node\n group.
" } }, "CacheNodeType": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "The compute and memory capacity of the nodes in the node group (shard).
\nThe following node types are supported by ElastiCache. Generally speaking, the current\n generation types provide more memory and computational power at lower cost when compared\n to their equivalent previous generation counterparts.
\nGeneral purpose:
\nCurrent generation:
\n\n M7g node types:\n \t\t\t\t\tcache.m7g.large,\n \t\t\t\t\tcache.m7g.xlarge,\n \t\t\t\t\tcache.m7g.2xlarge,\n \t\t\t\t\tcache.m7g.4xlarge,\n \t\t\t\t\tcache.m7g.8xlarge,\n \t\t\t\t\tcache.m7g.12xlarge,\n \t\t\t\t\tcache.m7g.16xlarge\n
For region availability, see Supported Node Types\n
\n\n M6g node types (available only for Redis OSS engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward):\n\t\t\t\t\t \n\t\t\t\t\t \tcache.m6g.large,\n\t\t\t\t\t\t\tcache.m6g.xlarge,\n\t\t\t\t\t\t\tcache.m6g.2xlarge,\n\t\t\t\t\t\t\tcache.m6g.4xlarge,\n\t\t\t\t\t\t\tcache.m6g.8xlarge,\n\t\t\t\t\t\t\tcache.m6g.12xlarge,\n\t\t\t\t\t\t\tcache.m6g.16xlarge\n
\n M5 node types:\n cache.m5.large,\n \t\t\t\t\t\tcache.m5.xlarge,\n \t\t\t\t\t\tcache.m5.2xlarge,\n \t\t\t\t\t\tcache.m5.4xlarge,\n \t\t\t\t\t\tcache.m5.12xlarge,\n \t\t\t\t\t\tcache.m5.24xlarge\n
\n M4 node types:\n cache.m4.large,\n \t\t\t\t\t\tcache.m4.xlarge,\n \t\t\t\t\t\tcache.m4.2xlarge,\n \t\t\t\t\t\tcache.m4.4xlarge,\n \t\t\t\t\t\tcache.m4.10xlarge\n
\n T4g node types (available only for Redis OSS engine version 5.0.6 onward and Memcached engine version 1.5.16 onward):\n\t\t\t\t\t cache.t4g.micro,\n\t\t\t\t\t cache.t4g.small,\n\t\t\t\t\t cache.t4g.medium\n
\n T3 node types:\n cache.t3.micro, \n \t\t\t\t\t\tcache.t3.small,\n \t\t\t\t\t\tcache.t3.medium\n
\n T2 node types:\n cache.t2.micro, \n \t\t\t\t\t\tcache.t2.small,\n \t\t\t\t\t\tcache.t2.medium\n
Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)
\n\n T1 node types:\n cache.t1.micro\n
\n M1 node types:\n cache.m1.small, \n\t\t\t\t\t\t cache.m1.medium, \n\t\t\t\t\t\t cache.m1.large,\n\t\t\t\t\t\t cache.m1.xlarge\n
\n M3 node types:\n cache.m3.medium,\n \t\t\t\t\t\tcache.m3.large, \n \t\t\t\t\t\tcache.m3.xlarge,\n \t\t\t\t\t\tcache.m3.2xlarge\n
Compute optimized:
\nPrevious generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)
\n\n C1 node types:\n cache.c1.xlarge\n
Memory optimized:
\nCurrent generation:
\n\n R7g node types:\t\n\t\t\t\t\t\t\tcache.r7g.large,\n\t\t\t\t\t\t\tcache.r7g.xlarge,\n\t\t\t\t\t\t\tcache.r7g.2xlarge,\n\t\t\t\t\t\t\tcache.r7g.4xlarge,\n\t\t\t\t\t\t\tcache.r7g.8xlarge,\n\t\t\t\t\t\t\tcache.r7g.12xlarge,\n\t\t\t\t\t\t\tcache.r7g.16xlarge\n
For region availability, see Supported Node Types\n
\n\n R6g node types (available only for Redis OSS engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward):\n\t\t\t\t\t\t\tcache.r6g.large,\n\t\t\t\t\t\t\tcache.r6g.xlarge,\n\t\t\t\t\t\t\tcache.r6g.2xlarge,\n\t\t\t\t\t\t\tcache.r6g.4xlarge,\n\t\t\t\t\t\t\tcache.r6g.8xlarge,\n\t\t\t\t\t\t\tcache.r6g.12xlarge,\n\t\t\t\t\t\t\tcache.r6g.16xlarge\n
\n R5 node types:\n cache.r5.large,\n \t\t\t\t\t cache.r5.xlarge,\n \t\t\t\t\t cache.r5.2xlarge,\n \t\t\t\t\t cache.r5.4xlarge,\n \t\t\t\t\t cache.r5.12xlarge,\n \t\t\t\t\t cache.r5.24xlarge\n
\n R4 node types:\n cache.r4.large,\n \t\t\t\t\t cache.r4.xlarge,\n \t\t\t\t\t cache.r4.2xlarge,\n \t\t\t\t\t cache.r4.4xlarge,\n \t\t\t\t\t cache.r4.8xlarge,\n \t\t\t\t\t cache.r4.16xlarge\n
Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)
\n\n M2 node types:\n cache.m2.xlarge, \n \t\t\t\t\t\tcache.m2.2xlarge,\n \t\t\t\t\t\tcache.m2.4xlarge\n
\n R3 node types:\n cache.r3.large, \n \t\t\t\t\t\tcache.r3.xlarge,\n \t\t\t\t\t\tcache.r3.2xlarge, \n \t\t\t\t\t\tcache.r3.4xlarge,\n \t\t\t\t\t\tcache.r3.8xlarge\n
\n Additional node type info\n
\nAll current generation instance types are created in Amazon VPC by\n default.
\nValkey or Redis OSS append-only files (AOF) are not supported for T1 or T2 instances.
\nValkey or Redis OSS Multi-AZ with automatic failover is not supported on T1\n instances.
\nThe configuration variables appendonly and\n appendfsync are not supported on Valkey, or on Redis OSS version 2.8.22 and\n later.
The name of the cache engine to be used for the clusters in this replication group.\n The value must be set to valkey or redis.
The version number of the cache engine to be used for the clusters in this replication\n group. To view the supported cache engine versions, use the\n DescribeCacheEngineVersions operation.
\n Important: You can upgrade to a newer engine version\n (see Selecting\n a Cache Engine and Version) in the ElastiCache User\n Guide, but you cannot downgrade to an earlier engine version. If you want\n to use an earlier engine version, you must delete the existing cluster or replication\n group and create it anew with the earlier engine version.
" } }, "CacheParameterGroupName": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "The name of the parameter group to associate with this replication group. If this\n argument is omitted, the default cache parameter group for the specified engine is\n used.
\nIf you are running Valkey or Redis OSS version 3.2.4 or later, only one node group (shard), and want\n to use a default parameter group, we recommend that you specify the parameter group by\n name.
\nTo create a Valkey or Redis OSS (cluster mode disabled) replication group, use\n CacheParameterGroupName=default.redis3.2.
To create a Valkey or Redis OSS (cluster mode enabled) replication group, use\n CacheParameterGroupName=default.redis3.2.cluster.on.
The name of the cache subnet group to be used for the replication group.
\nIf you're going to launch your cluster in an Amazon VPC, you need to create a\n subnet group before you start creating a cluster. For more information, see Subnets and Subnet Groups.
\nA list of cache security group names to associate with this replication group.
" } }, "SecurityGroupIds": { "target": "com.amazonaws.elasticache#SecurityGroupIdsList", "traits": { "smithy.api#documentation": "One or more Amazon VPC security groups associated with this replication group.
\nUse this parameter only when you are creating a replication group in an Amazon Virtual\n Private Cloud (Amazon VPC).
" } }, "Tags": { "target": "com.amazonaws.elasticache#TagList", "traits": { "smithy.api#documentation": "A list of tags to be added to this resource. Tags are comma-separated key,value pairs\n (e.g. Key=myKey, Value=myKeyValue. You can include multiple\n tags as shown following: Key=myKey, Value=myKeyValue\n Key=mySecondKey, Value=mySecondKeyValue. Tags on\n replication groups will be replicated to all nodes.
A list of Amazon Resource Names (ARN) that uniquely identify the Valkey or Redis OSS RDB snapshot\n files stored in Amazon S3. The snapshot files are used to populate the new replication\n group. The Amazon S3 object name in the ARN cannot contain any commas. The new\n replication group will have the number of node groups (console: shards) specified by the\n parameter NumNodeGroups or the number of node groups configured by\n NodeGroupConfiguration regardless of the number of ARNs\n specified here.
\nExample of an Amazon S3 ARN: arn:aws:s3:::my_bucket/snapshot1.rdb\n
The name of a snapshot from which to restore data into the new replication group. The\n snapshot status changes to restoring while the new replication group is\n being created.
Specifies the weekly time range during which maintenance on the cluster is performed.\n It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The\n minimum maintenance window is a 60 minute period.
\nValid values for ddd are:
\n sun\n
\n mon\n
\n tue\n
\n wed\n
\n thu\n
\n fri\n
\n sat\n
Example: sun:23:00-mon:01:30\n
The port number on which each member of the replication group accepts\n connections.
" } }, "NotificationTopicArn": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic\n to which notifications are sent.
\nThe Amazon SNS topic owner must be the same as the cluster owner.
\n\u00a0If you are running Valkey 7.2 and above or Redis OSS engine version 6.0 and above, set this parameter to yes \n to opt-in to the next auto minor version upgrade campaign. This parameter is\n disabled for previous versions.\u00a0
" } }, "SnapshotRetentionLimit": { "target": "com.amazonaws.elasticache#IntegerOptional", "traits": { "smithy.api#documentation": "The number of days for which ElastiCache retains automatic snapshots before deleting\n them. For example, if you set SnapshotRetentionLimit to 5, a snapshot that\n was taken today is retained for 5 days before being deleted.
Default: 0 (i.e., automatic backups are disabled for this cluster).
" } }, "SnapshotWindow": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot\n of your node group (shard).
\nExample: 05:00-09:00\n
If you do not specify this parameter, ElastiCache automatically chooses an appropriate\n time range.
" } }, "AuthToken": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "\n Reserved parameter. The password used to access a\n password protected server.
\n\n AuthToken can be specified only on replication groups where\n TransitEncryptionEnabled is true.
For HIPAA compliance, you must specify TransitEncryptionEnabled as\n true, an AuthToken, and a\n CacheSubnetGroup.
Password constraints:
\nMust be only printable ASCII characters.
\nMust be at least 16 characters and no more than 128 characters in\n length.
\nThe only permitted printable special characters are !, &, #, $, ^, <,\n >, and -. Other printable special characters cannot be used in the AUTH\n token.
\nFor more information, see AUTH\n password at http://redis.io/commands/AUTH.
" } }, "TransitEncryptionEnabled": { "target": "com.amazonaws.elasticache#BooleanOptional", "traits": { "smithy.api#documentation": "A flag that enables in-transit encryption when set to true.
This parameter is valid only if the Engine parameter is\n redis, the EngineVersion parameter is 3.2.6,\n 4.x or later, and the cluster is being created in an Amazon VPC.
If you enable in-transit encryption, you must also specify a value for\n CacheSubnetGroup.
\n Required: Only available when creating a replication\n group in an Amazon VPC using Redis OSS version 3.2.6, 4.x or\n later.
Default: false\n
For HIPAA compliance, you must specify TransitEncryptionEnabled as\n true, an AuthToken, and a\n CacheSubnetGroup.
A flag that enables encryption at-rest on the replication group when set to true.\n In some cases, encryption at-rest may be enabled even when this value is false.\n Use StorageEncryptionType to view the effective encryption state of a cluster.
You cannot modify the value of AtRestEncryptionEnabled after the replication group is created.
Default: true when using Valkey, false when using Redis OSS
The ID of the KMS key used to encrypt the disk in the cluster.
" } }, "UserGroupIds": { "target": "com.amazonaws.elasticache#UserGroupIdListInput", "traits": { "smithy.api#documentation": "The user group to associate with the replication group.
" } }, "LogDeliveryConfigurations": { "target": "com.amazonaws.elasticache#LogDeliveryConfigurationRequestList", "traits": { "smithy.api#documentation": "Specifies the destination, format and type of the logs.
" } }, "DataTieringEnabled": { "target": "com.amazonaws.elasticache#BooleanOptional", "traits": { "smithy.api#documentation": "Enables data tiering. Data tiering is only supported for replication groups using the\n r6gd node type. This parameter must be set to true when using r6gd nodes. For more\n information, see Data tiering.
" } }, "NetworkType": { "target": "com.amazonaws.elasticache#NetworkType", "traits": { "smithy.api#documentation": "Must be either ipv4 | ipv6 | dual_stack. IPv6\n is supported for workloads using Valkey 7.2 and above, Redis OSS engine version 6.2\n to 7.1 and Memcached engine version 1.6.6 and above on all instances built on the Nitro system.
The network type you choose when creating a replication group, either\n ipv4 | ipv6. IPv6 is supported for workloads using Valkey 7.2 and above, Redis OSS engine version 6.2\n to 7.1 or Memcached engine version 1.6.6 and above on all instances built on\n the Nitro system.
A setting that allows you to migrate your clients to use in-transit encryption, with\n no downtime.
\nWhen setting TransitEncryptionEnabled to true, you can set\n your TransitEncryptionMode to preferred in the same request,\n to allow both encrypted and unencrypted connections at the same time. Once you migrate\n all your Valkey or Redis OSS clients to use encrypted connections you can modify the value to\n required to allow encrypted connections only.
Setting TransitEncryptionMode to required is a two-step\n process that requires you to first set the TransitEncryptionMode to\n preferred, after that you can set TransitEncryptionMode to\n required.
This process will not trigger the replacement of the replication group.
" } }, "ClusterMode": { "target": "com.amazonaws.elasticache#ClusterMode", "traits": { "smithy.api#documentation": "Enabled or Disabled. To modify cluster mode from Disabled to Enabled, you must first\n set the cluster mode to Compatible. Compatible mode allows your Valkey or Redis OSS clients to connect\n using both cluster mode enabled and cluster mode disabled. After you migrate all Valkey or Redis OSS \n clients to use cluster mode enabled, you can then complete cluster mode configuration\n and set the cluster mode to Enabled.
" } }, "ServerlessCacheSnapshotName": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "The name of the snapshot used to create a replication group. Available for Valkey, Redis OSS only.
" } }, "Durability": { "target": "com.amazonaws.elasticache#Durability", "traits": { "smithy.api#documentation": "Specifies the durability setting for the replication group.\n When set to default, the service determines the effective durability based on\n the engine version, cluster mode, and other parameters. The resolved setting is reflected\n in the EffectiveDurability property of the replication group. For more\n information, see Durability.
Represents the input of a CreateReplicationGroup operation.
Creates a serverless cache.
" } }, "com.amazonaws.elasticache#CreateServerlessCacheRequest": { "type": "structure", "members": { "ServerlessCacheName": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "User-provided identifier for the serverless cache. This parameter is stored as a lowercase string.
", "smithy.api#required": {} } }, "Description": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "User-provided description for the serverless cache. \n The default is NULL, i.e. if no description is provided then an empty string will be returned. \n The maximum length is 255 characters.
" } }, "Engine": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The name of the cache engine to be used for creating the serverless cache.
", "smithy.api#required": {} } }, "MajorEngineVersion": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "The version of the cache engine that will be used to create the serverless cache.
" } }, "CacheUsageLimits": { "target": "com.amazonaws.elasticache#CacheUsageLimits", "traits": { "smithy.api#documentation": "Sets the cache usage limits for storage and ElastiCache Processing Units for the cache.
" } }, "KmsKeyId": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "ARN of the customer managed key for encrypting the data at rest. If no KMS key is provided, a default service key is used.
" } }, "SecurityGroupIds": { "target": "com.amazonaws.elasticache#SecurityGroupIdsList", "traits": { "smithy.api#documentation": "A list of the one or more VPC security groups to be associated with the serverless cache. \n The security group will authorize traffic access for the VPC end-point (private-link). \n If no other information is given this will be the VPC\u2019s Default Security Group that is associated with the cluster VPC \n end-point.
" } }, "SnapshotArnsToRestore": { "target": "com.amazonaws.elasticache#SnapshotArnsList", "traits": { "smithy.api#documentation": "The ARN(s) of the snapshot that the new serverless cache will be created from. Available for Valkey, Redis OSS and Serverless Memcached only.
" } }, "Tags": { "target": "com.amazonaws.elasticache#TagList", "traits": { "smithy.api#documentation": "The list of tags (key, value) pairs to be added to the serverless cache resource. Default is NULL.
" } }, "UserGroupId": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "The identifier of the UserGroup to be associated with the serverless cache. Available for Valkey and Redis OSS only. Default is NULL.
" } }, "SubnetIds": { "target": "com.amazonaws.elasticache#SubnetIdsList", "traits": { "smithy.api#documentation": "A list of the identifiers of the subnets where the VPC endpoint for the serverless cache will be deployed. \n All the subnetIds must belong to the same VPC.
" } }, "SnapshotRetentionLimit": { "target": "com.amazonaws.elasticache#IntegerOptional", "traits": { "smithy.api#documentation": "The number of days for which ElastiCache retains automatic snapshots before deleting them.\n Available for Valkey, Redis OSS and Serverless Memcached only. The maximum value allowed is 35 days.
" } }, "DailySnapshotTime": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "The daily time that snapshots will be created from the new serverless cache. By default this number is populated with \n 0, i.e. no snapshots will be created on an automatic daily basis. Available for Valkey, Redis OSS and Serverless Memcached only.
" } }, "NetworkType": { "target": "com.amazonaws.elasticache#NetworkType", "traits": { "smithy.api#documentation": "The IP protocol version used by the serverless cache.\n Must be either ipv4 | ipv6 | dual_stack.\n ipv6 is only supported with IPv6-only subnets.\n If not specified, defaults to ipv4, unless all provided subnets are IPv6-only, in which case it defaults to ipv6.\n
The connection type for the serverless cache.\n Must be either vpc | public.\n Use vpc to access the cache through a VPC endpoint, or public to access the cache over the internet.\n If not specified, defaults to vpc.\n This value cannot be changed after the serverless cache is created.\n Setting this to public requires Valkey 9 or above.
Which serverless cache integrations to enable. Valid values are:
\n\n dynamodb \u2013 DynamoDB integration.
DynamoDB integration requires the Valkey engine with a major engine version of 9 or above.\n If not specified, no integrations are enabled.
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.elasticache#CreateServerlessCacheResponse": { "type": "structure", "members": { "ServerlessCache": { "target": "com.amazonaws.elasticache#ServerlessCache", "traits": { "smithy.api#documentation": "The response for the attempt to create the serverless cache.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.elasticache#CreateServerlessCacheSnapshot": { "type": "operation", "input": { "target": "com.amazonaws.elasticache#CreateServerlessCacheSnapshotRequest" }, "output": { "target": "com.amazonaws.elasticache#CreateServerlessCacheSnapshotResponse" }, "errors": [ { "target": "com.amazonaws.elasticache#InvalidParameterCombinationException" }, { "target": "com.amazonaws.elasticache#InvalidParameterValueException" }, { "target": "com.amazonaws.elasticache#InvalidServerlessCacheStateFault" }, { "target": "com.amazonaws.elasticache#ServerlessCacheNotFoundFault" }, { "target": "com.amazonaws.elasticache#ServerlessCacheSnapshotAlreadyExistsFault" }, { "target": "com.amazonaws.elasticache#ServerlessCacheSnapshotQuotaExceededFault" }, { "target": "com.amazonaws.elasticache#ServiceLinkedRoleNotFoundFault" }, { "target": "com.amazonaws.elasticache#TagQuotaPerResourceExceeded" } ], "traits": { "smithy.api#documentation": "This API creates a copy of an entire ServerlessCache at a specific moment in time. Available for Valkey, Redis OSS and Serverless Memcached only.
" } }, "com.amazonaws.elasticache#CreateServerlessCacheSnapshotRequest": { "type": "structure", "members": { "ServerlessCacheSnapshotName": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The name for the snapshot being created. Must be unique for the customer account. Available for Valkey, Redis OSS and Serverless Memcached only.\n Must be between 1 and 255 characters. This value is stored as a lowercase string.
", "smithy.api#required": {} } }, "ServerlessCacheName": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The name of an existing serverless cache. The snapshot is created from this cache. Available for Valkey, Redis OSS and Serverless Memcached only.
", "smithy.api#required": {} } }, "KmsKeyId": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "The ID of the KMS key used to encrypt the snapshot. Available for Valkey, Redis OSS and Serverless Memcached only. Default: NULL
" } }, "Tags": { "target": "com.amazonaws.elasticache#TagList", "traits": { "smithy.api#documentation": "A list of tags to be added to the snapshot resource. A tag is a key-value pair. Available for Valkey, Redis OSS and Serverless Memcached only.
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.elasticache#CreateServerlessCacheSnapshotResponse": { "type": "structure", "members": { "ServerlessCacheSnapshot": { "target": "com.amazonaws.elasticache#ServerlessCacheSnapshot", "traits": { "smithy.api#documentation": "The state of a serverless cache snapshot at a specific point in time, to the millisecond. Available for Valkey, Redis OSS and Serverless Memcached only.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.elasticache#CreateSnapshot": { "type": "operation", "input": { "target": "com.amazonaws.elasticache#CreateSnapshotMessage" }, "output": { "target": "com.amazonaws.elasticache#CreateSnapshotResult" }, "errors": [ { "target": "com.amazonaws.elasticache#CacheClusterNotFoundFault" }, { "target": "com.amazonaws.elasticache#InvalidCacheClusterStateFault" }, { "target": "com.amazonaws.elasticache#InvalidParameterCombinationException" }, { "target": "com.amazonaws.elasticache#InvalidParameterValueException" }, { "target": "com.amazonaws.elasticache#InvalidReplicationGroupStateFault" }, { "target": "com.amazonaws.elasticache#ReplicationGroupNotFoundFault" }, { "target": "com.amazonaws.elasticache#SnapshotAlreadyExistsFault" }, { "target": "com.amazonaws.elasticache#SnapshotFeatureNotSupportedFault" }, { "target": "com.amazonaws.elasticache#SnapshotQuotaExceededFault" }, { "target": "com.amazonaws.elasticache#TagQuotaPerResourceExceeded" } ], "traits": { "smithy.api#documentation": "Creates a copy of an entire cluster or replication group at a specific moment in\n time.
\nThis operation is valid for Valkey or Redis OSS only.
\nThe identifier of an existing replication group. The snapshot is created from this\n replication group.
" } }, "CacheClusterId": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "The identifier of an existing cluster. The snapshot is created from this\n cluster.
" } }, "SnapshotName": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "A name for the snapshot being created. This value is stored as a lowercase string.
", "smithy.api#required": {} } }, "KmsKeyId": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "The ID of the KMS key used to encrypt the snapshot.
" } }, "Tags": { "target": "com.amazonaws.elasticache#TagList", "traits": { "smithy.api#documentation": "A list of tags to be added to this resource. A tag is a key-value pair. A tag key must\n be accompanied by a tag value, although null is accepted.
" } } }, "traits": { "smithy.api#documentation": "Represents the input of a CreateSnapshot operation.
For Valkey engine version 7.2 onwards and Redis OSS 6.0 to 7.1: Creates a user. For more information, see\n Using Role Based Access Control (RBAC).
" } }, "com.amazonaws.elasticache#CreateUserGroup": { "type": "operation", "input": { "target": "com.amazonaws.elasticache#CreateUserGroupMessage" }, "output": { "target": "com.amazonaws.elasticache#UserGroup" }, "errors": [ { "target": "com.amazonaws.elasticache#DefaultUserRequired" }, { "target": "com.amazonaws.elasticache#DuplicateUserNameFault" }, { "target": "com.amazonaws.elasticache#InvalidParameterValueException" }, { "target": "com.amazonaws.elasticache#ServiceLinkedRoleNotFoundFault" }, { "target": "com.amazonaws.elasticache#TagQuotaPerResourceExceeded" }, { "target": "com.amazonaws.elasticache#UserGroupAlreadyExistsFault" }, { "target": "com.amazonaws.elasticache#UserGroupQuotaExceededFault" }, { "target": "com.amazonaws.elasticache#UserNotFoundFault" } ], "traits": { "smithy.api#documentation": "For Valkey engine version 7.2 onwards and Redis OSS 6.0 to 7.1: Creates a user group. For more\n information, see Using Role Based Access Control (RBAC)\n
" } }, "com.amazonaws.elasticache#CreateUserGroupMessage": { "type": "structure", "members": { "UserGroupId": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The ID of the user group. This value is stored as a lowercase string.
", "smithy.api#required": {} } }, "Engine": { "target": "com.amazonaws.elasticache#EngineType", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "Sets the engine listed in a user group. The options are valkey or redis.
", "smithy.api#required": {} } }, "UserIds": { "target": "com.amazonaws.elasticache#UserIdListInput", "traits": { "smithy.api#documentation": "The list of user IDs that belong to the user group.
" } }, "Tags": { "target": "com.amazonaws.elasticache#TagList", "traits": { "smithy.api#documentation": "A list of tags to be added to this resource. A tag is a key-value pair. A tag key must\n be accompanied by a tag value, although null is accepted. Available for Valkey and Redis OSS only.
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.elasticache#CreateUserMessage": { "type": "structure", "members": { "UserId": { "target": "com.amazonaws.elasticache#UserId", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The ID of the user. This value is stored as a lowercase string.
", "smithy.api#required": {} } }, "UserName": { "target": "com.amazonaws.elasticache#UserName", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The username of the user.
", "smithy.api#required": {} } }, "Engine": { "target": "com.amazonaws.elasticache#EngineType", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The options are valkey or redis.
", "smithy.api#required": {} } }, "Passwords": { "target": "com.amazonaws.elasticache#PasswordListInput", "traits": { "smithy.api#documentation": "Passwords used for this user. You can create up to two passwords for each user.
" } }, "AccessString": { "target": "com.amazonaws.elasticache#AccessString", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "Access permissions string used for this user.
", "smithy.api#required": {} } }, "NoPasswordRequired": { "target": "com.amazonaws.elasticache#BooleanOptional", "traits": { "smithy.api#documentation": "Indicates a password is not required for this user.
" } }, "Tags": { "target": "com.amazonaws.elasticache#TagList", "traits": { "smithy.api#documentation": "A list of tags to be added to this resource. A tag is a key-value pair. A tag key must\n be accompanied by a tag value, although null is accepted.
" } }, "AuthenticationMode": { "target": "com.amazonaws.elasticache#AuthenticationMode", "traits": { "smithy.api#documentation": "Specifies how to authenticate the user.
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.elasticache#CustomerNodeEndpoint": { "type": "structure", "members": { "Address": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "The address of the node endpoint
" } }, "Port": { "target": "com.amazonaws.elasticache#IntegerOptional", "traits": { "smithy.api#documentation": "The port of the node endpoint
" } } }, "traits": { "smithy.api#documentation": "The endpoint from which data should be migrated.
" } }, "com.amazonaws.elasticache#CustomerNodeEndpointList": { "type": "list", "member": { "target": "com.amazonaws.elasticache#CustomerNodeEndpoint" } }, "com.amazonaws.elasticache#DataStorage": { "type": "structure", "members": { "Maximum": { "target": "com.amazonaws.elasticache#IntegerOptional", "traits": { "smithy.api#documentation": "The upper limit for data storage the cache is set to use.
" } }, "Minimum": { "target": "com.amazonaws.elasticache#IntegerOptional", "traits": { "smithy.api#documentation": "The lower limit for data storage the cache is set to use.
" } }, "Unit": { "target": "com.amazonaws.elasticache#DataStorageUnit", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The unit that the storage is measured in, in GB.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "The data storage limit.
" } }, "com.amazonaws.elasticache#DataStorageUnit": { "type": "enum", "members": { "GB": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "GB" } } } }, "com.amazonaws.elasticache#DataTieringStatus": { "type": "enum", "members": { "ENABLED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "enabled" } }, "DISABLED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "disabled" } } } }, "com.amazonaws.elasticache#DecreaseNodeGroupsInGlobalReplicationGroup": { "type": "operation", "input": { "target": "com.amazonaws.elasticache#DecreaseNodeGroupsInGlobalReplicationGroupMessage" }, "output": { "target": "com.amazonaws.elasticache#DecreaseNodeGroupsInGlobalReplicationGroupResult" }, "errors": [ { "target": "com.amazonaws.elasticache#GlobalReplicationGroupNotFoundFault" }, { "target": "com.amazonaws.elasticache#InvalidGlobalReplicationGroupStateFault" }, { "target": "com.amazonaws.elasticache#InvalidParameterCombinationException" }, { "target": "com.amazonaws.elasticache#InvalidParameterValueException" } ], "traits": { "smithy.api#documentation": "Decreases the number of node groups in a Global datastore
" } }, "com.amazonaws.elasticache#DecreaseNodeGroupsInGlobalReplicationGroupMessage": { "type": "structure", "members": { "GlobalReplicationGroupId": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The name of the Global datastore
", "smithy.api#required": {} } }, "NodeGroupCount": { "target": "com.amazonaws.elasticache#Integer", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The number of node groups (shards) that results from the modification of the shard\n configuration
", "smithy.api#required": {} } }, "GlobalNodeGroupsToRemove": { "target": "com.amazonaws.elasticache#GlobalNodeGroupIdList", "traits": { "smithy.api#documentation": "If the value of NodeGroupCount is less than the current number of node groups\n (shards), then either NodeGroupsToRemove or NodeGroupsToRetain is required.\n GlobalNodeGroupsToRemove is a list of NodeGroupIds to remove from the cluster.\n ElastiCache will attempt to remove all node groups listed by\n GlobalNodeGroupsToRemove from the cluster.
" } }, "GlobalNodeGroupsToRetain": { "target": "com.amazonaws.elasticache#GlobalNodeGroupIdList", "traits": { "smithy.api#documentation": "If the value of NodeGroupCount is less than the current number of node groups\n (shards), then either NodeGroupsToRemove or NodeGroupsToRetain is required.\n GlobalNodeGroupsToRetain is a list of NodeGroupIds to retain from the cluster.\n ElastiCache will attempt to retain all node groups listed by\n GlobalNodeGroupsToRetain from the cluster.
" } }, "ApplyImmediately": { "target": "com.amazonaws.elasticache#Boolean", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "Indicates that the shard reconfiguration process begins immediately. At present, the\n only permitted value for this parameter is true.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.elasticache#DecreaseNodeGroupsInGlobalReplicationGroupResult": { "type": "structure", "members": { "GlobalReplicationGroup": { "target": "com.amazonaws.elasticache#GlobalReplicationGroup" } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.elasticache#DecreaseReplicaCount": { "type": "operation", "input": { "target": "com.amazonaws.elasticache#DecreaseReplicaCountMessage" }, "output": { "target": "com.amazonaws.elasticache#DecreaseReplicaCountResult" }, "errors": [ { "target": "com.amazonaws.elasticache#ClusterQuotaForCustomerExceededFault" }, { "target": "com.amazonaws.elasticache#InsufficientCacheClusterCapacityFault" }, { "target": "com.amazonaws.elasticache#InvalidCacheClusterStateFault" }, { "target": "com.amazonaws.elasticache#InvalidParameterCombinationException" }, { "target": "com.amazonaws.elasticache#InvalidParameterValueException" }, { "target": "com.amazonaws.elasticache#InvalidReplicationGroupStateFault" }, { "target": "com.amazonaws.elasticache#InvalidVPCNetworkStateFault" }, { "target": "com.amazonaws.elasticache#NodeGroupsPerReplicationGroupQuotaExceededFault" }, { "target": "com.amazonaws.elasticache#NodeQuotaForCustomerExceededFault" }, { "target": "com.amazonaws.elasticache#NoOperationFault" }, { "target": "com.amazonaws.elasticache#ReplicationGroupNotFoundFault" }, { "target": "com.amazonaws.elasticache#ServiceLinkedRoleNotFoundFault" } ], "traits": { "smithy.api#documentation": "Dynamically decreases the number of replicas in a Valkey or Redis OSS (cluster mode disabled)\n replication group or the number of replica nodes in one or more node groups (shards) of\n a Valkey or Redis OSS (cluster mode enabled) replication group. This operation is performed with no\n cluster down time.
" } }, "com.amazonaws.elasticache#DecreaseReplicaCountMessage": { "type": "structure", "members": { "ReplicationGroupId": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The id of the replication group from which you want to remove replica\n nodes.
", "smithy.api#required": {} } }, "NewReplicaCount": { "target": "com.amazonaws.elasticache#IntegerOptional", "traits": { "smithy.api#documentation": "The number of read replica nodes you want at the completion of this operation. For Valkey or Redis OSS (cluster mode disabled) replication groups, this is the number of replica nodes in\n the replication group. For Valkey or Redis OSS (cluster mode enabled) replication groups, this is the\n number of replica nodes in each of the replication group's node groups.
\nThe minimum number of replicas in a shard or replication group is:
\nValkey or Redis OSS (cluster mode disabled)
\nIf Multi-AZ is enabled: 1
\nIf Multi-AZ is not enabled: 0
\nValkey or Redis OSS (cluster mode enabled): 0 (though you will not be able to failover to\n a replica if your primary node fails)
\nA list of ConfigureShard objects that can be used to configure each\n shard in a Valkey or Redis OSS replication group. The\n ConfigureShard has three members: NewReplicaCount,\n NodeGroupId, and PreferredAvailabilityZones.
A list of the node ids to remove from the replication group or node group\n (shard).
" } }, "ApplyImmediately": { "target": "com.amazonaws.elasticache#Boolean", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "If True, the number of replica nodes is decreased immediately.\n ApplyImmediately=False is not currently supported.
The default user assigned to the user group.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.elasticache#DefaultUserRequired": { "type": "structure", "members": { "message": { "target": "com.amazonaws.elasticache#ExceptionMessage" } }, "traits": { "aws.protocols#awsQueryError": { "code": "DefaultUserRequired", "httpResponseCode": 400 }, "smithy.api#documentation": "You must add default user to a user group.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.elasticache#DeleteCacheCluster": { "type": "operation", "input": { "target": "com.amazonaws.elasticache#DeleteCacheClusterMessage" }, "output": { "target": "com.amazonaws.elasticache#DeleteCacheClusterResult" }, "errors": [ { "target": "com.amazonaws.elasticache#CacheClusterNotFoundFault" }, { "target": "com.amazonaws.elasticache#InvalidCacheClusterStateFault" }, { "target": "com.amazonaws.elasticache#InvalidParameterCombinationException" }, { "target": "com.amazonaws.elasticache#InvalidParameterValueException" }, { "target": "com.amazonaws.elasticache#SnapshotAlreadyExistsFault" }, { "target": "com.amazonaws.elasticache#SnapshotFeatureNotSupportedFault" }, { "target": "com.amazonaws.elasticache#SnapshotQuotaExceededFault" } ], "traits": { "smithy.api#documentation": "Deletes a previously provisioned cluster. DeleteCacheCluster deletes all\n associated cache nodes, node endpoints and the cluster itself. When you receive a\n successful response from this operation, Amazon ElastiCache immediately begins deleting\n the cluster; you cannot cancel or revert this operation.
This operation is not valid for:
\nValkey or Redis OSS (cluster mode enabled) clusters
\nValkey or Redis OSS (cluster mode disabled) clusters
\nA cluster that is the last read replica of a replication group
\nA cluster that is the primary node of a replication group
\nA node group (shard) that has Multi-AZ mode enabled
\nA cluster from a Valkey or Redis OSS (cluster mode enabled) replication group
\nA cluster that is not in the available state
The cluster identifier for the cluster to be deleted. This parameter is not case\n sensitive.
", "smithy.api#required": {} } }, "FinalSnapshotIdentifier": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "The user-supplied name of a final cluster snapshot. This is the unique name that\n identifies the snapshot. ElastiCache creates the snapshot, and then deletes the cluster\n immediately afterward.
" } } }, "traits": { "smithy.api#documentation": "Represents the input of a DeleteCacheCluster operation.
Deletes the specified cache parameter group. You cannot delete a cache parameter group\n if it is associated with any cache clusters. You cannot delete the default cache\n parameter groups in your account.
", "smithy.api#examples": [ { "title": "DeleteCacheParameterGroup", "documentation": "Deletes the Amazon ElastiCache parameter group custom-mem1-4.", "input": { "CacheParameterGroupName": "custom-mem1-4" } } ] } }, "com.amazonaws.elasticache#DeleteCacheParameterGroupMessage": { "type": "structure", "members": { "CacheParameterGroupName": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The name of the cache parameter group to delete.
\nThe specified cache security group must not be associated with any\n clusters.
\nRepresents the input of a DeleteCacheParameterGroup operation.
Deletes a cache security group.
\nYou cannot delete a cache security group if it is associated with any\n clusters.
\nThe name of the cache security group to delete.
\nYou cannot delete the default security group.
\nRepresents the input of a DeleteCacheSecurityGroup operation.
Deletes a cache subnet group.
\nYou cannot delete a default cache subnet group or one that is associated with any\n clusters.
\nThe name of the cache subnet group to delete.
\nConstraints: Must contain no more than 255 alphanumeric characters or hyphens.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Represents the input of a DeleteCacheSubnetGroup operation.
Deleting a Global datastore is a two-step process:
\nFirst, you must DisassociateGlobalReplicationGroup to remove\n the secondary clusters in the Global datastore.
\nOnce the Global datastore contains only the primary cluster, you can use the\n DeleteGlobalReplicationGroup API to delete the Global datastore\n while retainining the primary cluster using\n RetainPrimaryReplicationGroup=true.
Since the Global Datastore has only a primary cluster, you can delete the Global\n Datastore while retaining the primary by setting\n RetainPrimaryReplicationGroup=true. The primary cluster is never\n deleted when deleting a Global Datastore. It can only be deleted when it no longer is\n associated with any Global Datastore.
When you receive a successful response from this operation, Amazon ElastiCache\n immediately begins deleting the selected resources; you cannot cancel or revert this\n operation.
" } }, "com.amazonaws.elasticache#DeleteGlobalReplicationGroupMessage": { "type": "structure", "members": { "GlobalReplicationGroupId": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The name of the Global datastore
", "smithy.api#required": {} } }, "RetainPrimaryReplicationGroup": { "target": "com.amazonaws.elasticache#Boolean", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The primary replication group is retained as a standalone replication group.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.elasticache#DeleteGlobalReplicationGroupResult": { "type": "structure", "members": { "GlobalReplicationGroup": { "target": "com.amazonaws.elasticache#GlobalReplicationGroup" } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.elasticache#DeleteReplicationGroup": { "type": "operation", "input": { "target": "com.amazonaws.elasticache#DeleteReplicationGroupMessage" }, "output": { "target": "com.amazonaws.elasticache#DeleteReplicationGroupResult" }, "errors": [ { "target": "com.amazonaws.elasticache#InvalidParameterCombinationException" }, { "target": "com.amazonaws.elasticache#InvalidParameterValueException" }, { "target": "com.amazonaws.elasticache#InvalidReplicationGroupStateFault" }, { "target": "com.amazonaws.elasticache#ReplicationGroupNotFoundFault" }, { "target": "com.amazonaws.elasticache#SnapshotAlreadyExistsFault" }, { "target": "com.amazonaws.elasticache#SnapshotFeatureNotSupportedFault" }, { "target": "com.amazonaws.elasticache#SnapshotQuotaExceededFault" } ], "traits": { "smithy.api#documentation": "Deletes an existing replication group. By default, this operation deletes the entire\n replication group, including the primary/primaries and all of the read replicas. If the\n replication group has only one primary, you can optionally delete only the read\n replicas, while retaining the primary by setting\n RetainPrimaryCluster=true.
When you receive a successful response from this operation, Amazon ElastiCache\n immediately begins deleting the selected resources; you cannot cancel or revert this\n operation.
\n\n CreateSnapshot permission is required to create a final snapshot. \n Without this permission, the API call will fail with an Access Denied exception.
This operation is valid for Redis OSS only.
\nThe identifier for the cluster to be deleted. This parameter is not case\n sensitive.
", "smithy.api#required": {} } }, "RetainPrimaryCluster": { "target": "com.amazonaws.elasticache#BooleanOptional", "traits": { "smithy.api#documentation": "If set to true, all of the read replicas are deleted, but the primary\n node is retained.
The name of a final node group (shard) snapshot. ElastiCache creates the snapshot from\n the primary node in the cluster, rather than one of the replicas; this is to ensure that\n it captures the freshest data. After the final snapshot is taken, the replication group\n is immediately deleted.
" } } }, "traits": { "smithy.api#documentation": "Represents the input of a DeleteReplicationGroup operation.
Deletes a specified existing serverless cache.
\n\n CreateServerlessCacheSnapshot permission is required to create a final snapshot. \n Without this permission, the API call will fail with an Access Denied exception.
The identifier of the serverless cache to be deleted.
", "smithy.api#required": {} } }, "FinalSnapshotName": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "Name of the final snapshot to be taken before the serverless cache is deleted. Available for Valkey, Redis OSS and Serverless Memcached only.\n Default: NULL, i.e. a final snapshot is not taken.
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.elasticache#DeleteServerlessCacheResponse": { "type": "structure", "members": { "ServerlessCache": { "target": "com.amazonaws.elasticache#ServerlessCache", "traits": { "smithy.api#documentation": "Provides the details of the specified serverless cache that is about to be deleted.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.elasticache#DeleteServerlessCacheSnapshot": { "type": "operation", "input": { "target": "com.amazonaws.elasticache#DeleteServerlessCacheSnapshotRequest" }, "output": { "target": "com.amazonaws.elasticache#DeleteServerlessCacheSnapshotResponse" }, "errors": [ { "target": "com.amazonaws.elasticache#InvalidParameterValueException" }, { "target": "com.amazonaws.elasticache#InvalidServerlessCacheSnapshotStateFault" }, { "target": "com.amazonaws.elasticache#ServerlessCacheSnapshotNotFoundFault" }, { "target": "com.amazonaws.elasticache#ServiceLinkedRoleNotFoundFault" } ], "traits": { "smithy.api#documentation": "Deletes an existing serverless cache snapshot. Available for Valkey, Redis OSS and Serverless Memcached only.
" } }, "com.amazonaws.elasticache#DeleteServerlessCacheSnapshotRequest": { "type": "structure", "members": { "ServerlessCacheSnapshotName": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "Idenfitier of the snapshot to be deleted. Available for Valkey, Redis OSS and Serverless Memcached only.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.elasticache#DeleteServerlessCacheSnapshotResponse": { "type": "structure", "members": { "ServerlessCacheSnapshot": { "target": "com.amazonaws.elasticache#ServerlessCacheSnapshot", "traits": { "smithy.api#documentation": "The snapshot to be deleted. Available for Valkey, Redis OSS and Serverless Memcached only.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.elasticache#DeleteSnapshot": { "type": "operation", "input": { "target": "com.amazonaws.elasticache#DeleteSnapshotMessage" }, "output": { "target": "com.amazonaws.elasticache#DeleteSnapshotResult" }, "errors": [ { "target": "com.amazonaws.elasticache#InvalidParameterCombinationException" }, { "target": "com.amazonaws.elasticache#InvalidParameterValueException" }, { "target": "com.amazonaws.elasticache#InvalidSnapshotStateFault" }, { "target": "com.amazonaws.elasticache#SnapshotNotFoundFault" } ], "traits": { "smithy.api#documentation": "Deletes an existing snapshot. When you receive a successful response from this\n operation, ElastiCache immediately begins deleting the snapshot; you cannot cancel or\n revert this operation.
\nThis operation is valid for Valkey or Redis OSS only.
\nThe name of the snapshot to be deleted.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Represents the input of a DeleteSnapshot operation.
For Valkey engine version 7.2 onwards and Redis OSS 6.0 onwards: Deletes a user. The user will be removed from\n all user groups and in turn removed from all replication groups. For more information,\n see Using Role Based Access Control (RBAC).
" } }, "com.amazonaws.elasticache#DeleteUserGroup": { "type": "operation", "input": { "target": "com.amazonaws.elasticache#DeleteUserGroupMessage" }, "output": { "target": "com.amazonaws.elasticache#UserGroup" }, "errors": [ { "target": "com.amazonaws.elasticache#InvalidParameterValueException" }, { "target": "com.amazonaws.elasticache#InvalidUserGroupStateFault" }, { "target": "com.amazonaws.elasticache#ServiceLinkedRoleNotFoundFault" }, { "target": "com.amazonaws.elasticache#UserGroupNotFoundFault" } ], "traits": { "smithy.api#documentation": "For Valkey engine version 7.2 onwards and Redis OSS 6.0 onwards: Deletes a user group. The user group must first\n be disassociated from the replication group before it can be deleted. For more\n information, see Using Role Based Access Control (RBAC).
" } }, "com.amazonaws.elasticache#DeleteUserGroupMessage": { "type": "structure", "members": { "UserGroupId": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The ID of the user group.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.elasticache#DeleteUserMessage": { "type": "structure", "members": { "UserId": { "target": "com.amazonaws.elasticache#UserId", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The ID of the user.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.elasticache#DescribeCacheClusters": { "type": "operation", "input": { "target": "com.amazonaws.elasticache#DescribeCacheClustersMessage" }, "output": { "target": "com.amazonaws.elasticache#CacheClusterMessage" }, "errors": [ { "target": "com.amazonaws.elasticache#CacheClusterNotFoundFault" }, { "target": "com.amazonaws.elasticache#InvalidParameterCombinationException" }, { "target": "com.amazonaws.elasticache#InvalidParameterValueException" } ], "traits": { "smithy.api#documentation": "Returns information about all provisioned clusters if no cluster identifier is\n specified, or about a specific cache cluster if a cluster identifier is supplied.
\nBy default, abbreviated information about the clusters is returned. You can use the\n optional ShowCacheNodeInfo flag to retrieve detailed information\n about the cache nodes associated with the clusters. These details include the DNS\n address and port for the cache node endpoint.
\nIf the cluster is in the creating state, only cluster-level\n information is displayed until all of the nodes are successfully provisioned.
\nIf the cluster is in the deleting state, only cluster-level\n information is displayed.
\nIf cache nodes are currently being added to the cluster, node endpoint information and\n creation time for the additional nodes are not displayed until they are completely\n provisioned. When the cluster state is available, the cluster is\n ready for use.
\nIf cache nodes are currently being removed from the cluster, no endpoint information\n for the removed nodes is displayed.
", "smithy.api#examples": [ { "title": "DescribeCacheClusters", "documentation": "Lists the details for the cache cluster my-mem-cluster.", "input": { "CacheClusterId": "my-mem-cluster", "ShowCacheNodeInfo": true }, "output": { "CacheClusters": [ { "Engine": "memcached", "CacheNodes": [ { "CacheNodeId": "0001", "Endpoint": { "Port": 11211, "Address": "my-mem-cluster.ameaqx.0001.use1.cache.amazonaws.com" }, "CacheNodeStatus": "available", "ParameterGroupStatus": "in-sync", "CacheNodeCreateTime": "2016-12-21T21:59:43.794Z", "CustomerAvailabilityZone": "us-east-1b" }, { "CacheNodeId": "0002", "Endpoint": { "Port": 11211, "Address": "my-mem-cluster.ameaqx.0002.use1.cache.amazonaws.com" }, "CacheNodeStatus": "available", "ParameterGroupStatus": "in-sync", "CacheNodeCreateTime": "2016-12-21T21:59:43.794Z", "CustomerAvailabilityZone": "us-east-1a" } ], "CacheParameterGroup": { "CacheNodeIdsToReboot": [], "CacheParameterGroupName": "default.memcached1.4", "ParameterApplyStatus": "in-sync" }, "CacheClusterId": "my-mem-cluster", "PreferredAvailabilityZone": "Multiple", "ConfigurationEndpoint": { "Port": 11211, "Address": "my-mem-cluster.ameaqx.cfg.use1.cache.amazonaws.com" }, "CacheSecurityGroups": [], "CacheClusterCreateTime": "2016-12-21T21:59:43.794Z", "AutoMinorVersionUpgrade": true, "CacheClusterStatus": "available", "NumCacheNodes": 2, "ClientDownloadLandingPage": "https://console.aws.amazon.com/elasticache/home#client-download:", "CacheSubnetGroupName": "default", "EngineVersion": "1.4.24", "PendingModifiedValues": {}, "PreferredMaintenanceWindow": "wed:06:00-wed:07:00", "CacheNodeType": "cache.t2.medium" } ] } }, { "title": "DescribeCacheClusters", "documentation": "Lists the details for up to 50 cache clusters.", "input": { "CacheClusterId": "my-mem-cluster" }, "output": { "CacheClusters": [ { "Engine": "memcached", "CacheParameterGroup": { "CacheNodeIdsToReboot": [], "CacheParameterGroupName": "default.memcached1.4", "ParameterApplyStatus": "in-sync" }, "CacheClusterId": "my-mem-cluster", "PreferredAvailabilityZone": "Multiple", "ConfigurationEndpoint": { "Port": 11211, "Address": "my-mem-cluster.abcdef.cfg.use1.cache.amazonaws.com" }, "CacheSecurityGroups": [], "CacheClusterCreateTime": "2016-12-21T21:59:43.794Z", "AutoMinorVersionUpgrade": true, "CacheClusterStatus": "available", "NumCacheNodes": 2, "ClientDownloadLandingPage": "https://console.aws.amazon.com/elasticache/home#client-download:", "CacheSubnetGroupName": "default", "EngineVersion": "1.4.24", "PendingModifiedValues": {}, "PreferredMaintenanceWindow": "wed:06:00-wed:07:00", "CacheNodeType": "cache.t2.medium" } ] } } ], "smithy.api#paginated": { "inputToken": "Marker", "outputToken": "Marker", "items": "CacheClusters", "pageSize": "MaxRecords" }, "smithy.api#suppress": [ "WaitableTraitInvalidErrorType" ], "smithy.waiters#waitable": { "CacheClusterAvailable": { "documentation": "Wait until ElastiCache cluster is available.", "acceptors": [ { "state": "success", "matcher": { "output": { "path": "CacheClusters[].CacheClusterStatus", "expected": "available", "comparator": "allStringEquals" } } }, { "state": "failure", "matcher": { "output": { "path": "CacheClusters[].CacheClusterStatus", "expected": "deleted", "comparator": "anyStringEquals" } } }, { "state": "failure", "matcher": { "output": { "path": "CacheClusters[].CacheClusterStatus", "expected": "deleting", "comparator": "anyStringEquals" } } }, { "state": "failure", "matcher": { "output": { "path": "CacheClusters[].CacheClusterStatus", "expected": "incompatible-network", "comparator": "anyStringEquals" } } }, { "state": "failure", "matcher": { "output": { "path": "CacheClusters[].CacheClusterStatus", "expected": "restore-failed", "comparator": "anyStringEquals" } } } ], "minDelay": 15 }, "CacheClusterDeleted": { "documentation": "Wait until ElastiCache cluster is deleted.", "acceptors": [ { "state": "success", "matcher": { "output": { "path": "CacheClusters[].CacheClusterStatus", "expected": "deleted", "comparator": "allStringEquals" } } }, { "state": "success", "matcher": { "errorType": "CacheClusterNotFound" } }, { "state": "failure", "matcher": { "output": { "path": "CacheClusters[].CacheClusterStatus", "expected": "available", "comparator": "anyStringEquals" } } }, { "state": "failure", "matcher": { "output": { "path": "CacheClusters[].CacheClusterStatus", "expected": "creating", "comparator": "anyStringEquals" } } }, { "state": "failure", "matcher": { "output": { "path": "CacheClusters[].CacheClusterStatus", "expected": "incompatible-network", "comparator": "anyStringEquals" } } }, { "state": "failure", "matcher": { "output": { "path": "CacheClusters[].CacheClusterStatus", "expected": "modifying", "comparator": "anyStringEquals" } } }, { "state": "failure", "matcher": { "output": { "path": "CacheClusters[].CacheClusterStatus", "expected": "restore-failed", "comparator": "anyStringEquals" } } }, { "state": "failure", "matcher": { "output": { "path": "CacheClusters[].CacheClusterStatus", "expected": "snapshotting", "comparator": "anyStringEquals" } } } ], "minDelay": 15 } } } }, "com.amazonaws.elasticache#DescribeCacheClustersMessage": { "type": "structure", "members": { "CacheClusterId": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "The user-supplied cluster identifier. If this parameter is specified, only information\n about that specific cluster is returned. This parameter isn't case sensitive.
" } }, "MaxRecords": { "target": "com.amazonaws.elasticache#IntegerOptional", "traits": { "smithy.api#documentation": "The maximum number of records to include in the response. If more records exist than\n the specified MaxRecords value, a marker is included in the response so\n that the remaining results can be retrieved.
Default: 100
\nConstraints: minimum 20; maximum 100.
" } }, "Marker": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "An optional marker returned from a prior request. Use this marker for pagination of\n results from this operation. If this parameter is specified, the response includes only\n records beyond the marker, up to the value specified by MaxRecords.
An optional flag that can be included in the DescribeCacheCluster request\n to retrieve information about the individual cache nodes.
An optional flag that can be included in the DescribeCacheCluster request\n to show only nodes (API/CLI: clusters) that are not members of a replication group. In\n practice, this means Memcached and single node Valkey or Redis OSS clusters.
Represents the input of a DescribeCacheClusters operation.
Returns a list of the available cache engines and their versions.
", "smithy.api#examples": [ { "title": "DescribeCacheEngineVersions", "documentation": "Lists the details for up to 25 Memcached and Redis cache engine versions.", "output": { "CacheEngineVersions": [ { "Engine": "memcached", "CacheEngineDescription": "memcached", "CacheEngineVersionDescription": "memcached version 1.4.14", "CacheParameterGroupFamily": "memcached1.4", "EngineVersion": "1.4.14" }, { "Engine": "memcached", "CacheEngineDescription": "memcached", "CacheEngineVersionDescription": "memcached version 1.4.24", "CacheParameterGroupFamily": "memcached1.4", "EngineVersion": "1.4.24" }, { "Engine": "memcached", "CacheEngineDescription": "memcached", "CacheEngineVersionDescription": "memcached version 1.4.33", "CacheParameterGroupFamily": "memcached1.4", "EngineVersion": "1.4.33" }, { "Engine": "memcached", "CacheEngineDescription": "memcached", "CacheEngineVersionDescription": "memcached version 1.4.5", "CacheParameterGroupFamily": "memcached1.4", "EngineVersion": "1.4.5" }, { "Engine": "redis", "CacheEngineDescription": "Redis", "CacheEngineVersionDescription": "redis version 2.6.13", "CacheParameterGroupFamily": "redis2.6", "EngineVersion": "2.6.13" }, { "Engine": "redis", "CacheEngineDescription": "Redis", "CacheEngineVersionDescription": "redis version 2.8.19", "CacheParameterGroupFamily": "redis2.8", "EngineVersion": "2.8.19" }, { "Engine": "redis", "CacheEngineDescription": "Redis", "CacheEngineVersionDescription": "redis version 2.8.21", "CacheParameterGroupFamily": "redis2.8", "EngineVersion": "2.8.21" }, { "Engine": "redis", "CacheEngineDescription": "Redis", "CacheEngineVersionDescription": "redis version 2.8.22 R5", "CacheParameterGroupFamily": "redis2.8", "EngineVersion": "2.8.22" }, { "Engine": "redis", "CacheEngineDescription": "Redis", "CacheEngineVersionDescription": "redis version 2.8.23 R4", "CacheParameterGroupFamily": "redis2.8", "EngineVersion": "2.8.23" }, { "Engine": "redis", "CacheEngineDescription": "Redis", "CacheEngineVersionDescription": "redis version 2.8.24 R3", "CacheParameterGroupFamily": "redis2.8", "EngineVersion": "2.8.24" }, { "Engine": "redis", "CacheEngineDescription": "Redis", "CacheEngineVersionDescription": "redis version 2.8.6", "CacheParameterGroupFamily": "redis2.8", "EngineVersion": "2.8.6" }, { "Engine": "redis", "CacheEngineDescription": "Redis", "CacheEngineVersionDescription": "redis version 3.2.4", "CacheParameterGroupFamily": "redis3.2", "EngineVersion": "3.2.4" } ] } }, { "title": "DescribeCacheEngineVersions", "documentation": "Lists the details for up to 50 Redis cache engine versions.", "input": { "Engine": "redis", "MaxRecords": 50, "DefaultOnly": false }, "output": { "Marker": "", "CacheEngineVersions": [ { "Engine": "redis", "CacheEngineDescription": "Redis", "CacheEngineVersionDescription": "redis version 2.6.13", "CacheParameterGroupFamily": "redis2.6", "EngineVersion": "2.6.13" }, { "Engine": "redis", "CacheEngineDescription": "Redis", "CacheEngineVersionDescription": "redis version 2.8.19", "CacheParameterGroupFamily": "redis2.8", "EngineVersion": "2.8.19" }, { "Engine": "redis", "CacheEngineDescription": "Redis", "CacheEngineVersionDescription": "redis version 2.8.21", "CacheParameterGroupFamily": "redis2.8", "EngineVersion": "2.8.21" }, { "Engine": "redis", "CacheEngineDescription": "Redis", "CacheEngineVersionDescription": "redis version 2.8.22 R5", "CacheParameterGroupFamily": "redis2.8", "EngineVersion": "2.8.22" }, { "Engine": "redis", "CacheEngineDescription": "Redis", "CacheEngineVersionDescription": "redis version 2.8.23 R4", "CacheParameterGroupFamily": "redis2.8", "EngineVersion": "2.8.23" }, { "Engine": "redis", "CacheEngineDescription": "Redis", "CacheEngineVersionDescription": "redis version 2.8.24 R3", "CacheParameterGroupFamily": "redis2.8", "EngineVersion": "2.8.24" }, { "Engine": "redis", "CacheEngineDescription": "Redis", "CacheEngineVersionDescription": "redis version 2.8.6", "CacheParameterGroupFamily": "redis2.8", "EngineVersion": "2.8.6" }, { "Engine": "redis", "CacheEngineDescription": "Redis", "CacheEngineVersionDescription": "redis version 3.2.4", "CacheParameterGroupFamily": "redis3.2", "EngineVersion": "3.2.4" } ] } } ], "smithy.api#paginated": { "inputToken": "Marker", "outputToken": "Marker", "items": "CacheEngineVersions", "pageSize": "MaxRecords" } } }, "com.amazonaws.elasticache#DescribeCacheEngineVersionsMessage": { "type": "structure", "members": { "Engine": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "The cache engine to return. Valid values: memcached |\n redis\n
The cache engine version to return.
\nExample: 1.4.14\n
The name of a specific cache parameter group family to return details for.
\nValid values are: memcached1.4 | memcached1.5 |\n memcached1.6 | redis2.6 | redis2.8 |\n redis3.2 | redis4.0 | redis5.0 |\n redis6.x | redis6.2 | redis7 | valkey7\n
Constraints:
\nMust be 1 to 255 alphanumeric characters
\nFirst character must be a letter
\nCannot end with a hyphen or contain two consecutive hyphens
\nThe maximum number of records to include in the response. If more records exist than\n the specified MaxRecords value, a marker is included in the response so\n that the remaining results can be retrieved.
Default: 100
\nConstraints: minimum 20; maximum 100.
" } }, "Marker": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "An optional marker returned from a prior request. Use this marker for pagination of\n results from this operation. If this parameter is specified, the response includes only\n records beyond the marker, up to the value specified by MaxRecords.
If true, specifies that only the default version of the specified engine\n or engine and major version combination is to be returned.
Represents the input of a DescribeCacheEngineVersions operation.
Returns a list of cache parameter group descriptions. If a cache parameter group name\n is specified, the list contains only the descriptions for that group.
", "smithy.api#examples": [ { "title": "DescribeCacheParameterGroups", "documentation": "Returns a list of cache parameter group descriptions. If a cache parameter group name is specified, the list contains only the descriptions for that group.", "input": { "CacheParameterGroupName": "custom-mem1-4" }, "output": { "CacheParameterGroups": [ { "CacheParameterGroupName": "custom-mem1-4", "CacheParameterGroupFamily": "memcached1.4", "Description": "Custom memcache param group" } ] } } ], "smithy.api#paginated": { "inputToken": "Marker", "outputToken": "Marker", "items": "CacheParameterGroups", "pageSize": "MaxRecords" } } }, "com.amazonaws.elasticache#DescribeCacheParameterGroupsMessage": { "type": "structure", "members": { "CacheParameterGroupName": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "The name of a specific cache parameter group to return details for.
" } }, "MaxRecords": { "target": "com.amazonaws.elasticache#IntegerOptional", "traits": { "smithy.api#documentation": "The maximum number of records to include in the response. If more records exist than\n the specified MaxRecords value, a marker is included in the response so\n that the remaining results can be retrieved.
Default: 100
\nConstraints: minimum 20; maximum 100.
" } }, "Marker": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "An optional marker returned from a prior request. Use this marker for pagination of\n results from this operation. If this parameter is specified, the response includes only\n records beyond the marker, up to the value specified by MaxRecords.
Represents the input of a DescribeCacheParameterGroups operation.
Returns the detailed parameter list for a particular cache parameter group.
", "smithy.api#examples": [ { "title": "DescribeCacheParameters", "documentation": "Lists up to 100 user parameter values for the parameter group custom.redis2.8.", "input": { "CacheParameterGroupName": "custom-redis2-8", "Source": "user", "MaxRecords": 100 }, "output": { "Marker": "", "Parameters": [ { "Description": "Apply rehashing or not.", "DataType": "string", "ChangeType": "requires-reboot", "IsModifiable": true, "AllowedValues": "yes,no", "Source": "system", "ParameterValue": "yes", "ParameterName": "activerehashing", "MinimumEngineVersion": "2.8.6" }, { "Description": "fsync policy for AOF persistence", "DataType": "string", "ChangeType": "immediate", "IsModifiable": true, "AllowedValues": "always,everysec,no", "Source": "system", "ParameterValue": "everysec", "ParameterName": "appendfsync", "MinimumEngineVersion": "2.8.6" }, { "Description": "Enable Redis persistence.", "DataType": "string", "ChangeType": "immediate", "IsModifiable": true, "AllowedValues": "yes,no", "Source": "system", "ParameterValue": "no", "ParameterName": "appendonly", "MinimumEngineVersion": "2.8.6" }, { "Description": "Normal client output buffer hard limit in bytes.", "DataType": "integer", "ChangeType": "immediate", "IsModifiable": true, "AllowedValues": "0-", "Source": "system", "ParameterValue": "0", "ParameterName": "client-output-buffer-limit-normal-hard-limit", "MinimumEngineVersion": "2.8.6" }, { "Description": "Normal client output buffer soft limit in bytes.", "DataType": "integer", "ChangeType": "immediate", "IsModifiable": true, "AllowedValues": "0-", "Source": "system", "ParameterValue": "0", "ParameterName": "client-output-buffer-limit-normal-soft-limit", "MinimumEngineVersion": "2.8.6" }, { "Description": "Normal client output buffer soft limit in seconds.", "DataType": "integer", "ChangeType": "immediate", "IsModifiable": true, "AllowedValues": "0-", "Source": "system", "ParameterValue": "0", "ParameterName": "client-output-buffer-limit-normal-soft-seconds", "MinimumEngineVersion": "2.8.6" }, { "Description": "Pubsub client output buffer hard limit in bytes.", "DataType": "integer", "ChangeType": "immediate", "IsModifiable": true, "AllowedValues": "0-", "Source": "system", "ParameterValue": "33554432", "ParameterName": "client-output-buffer-limit-pubsub-hard-limit", "MinimumEngineVersion": "2.8.6" }, { "Description": "Pubsub client output buffer soft limit in bytes.", "DataType": "integer", "ChangeType": "immediate", "IsModifiable": true, "AllowedValues": "0-", "Source": "system", "ParameterValue": "8388608", "ParameterName": "client-output-buffer-limit-pubsub-soft-limit", "MinimumEngineVersion": "2.8.6" }, { "Description": "Pubsub client output buffer soft limit in seconds.", "DataType": "integer", "ChangeType": "immediate", "IsModifiable": true, "AllowedValues": "0-", "Source": "system", "ParameterValue": "60", "ParameterName": "client-output-buffer-limit-pubsub-soft-seconds", "MinimumEngineVersion": "2.8.6" }, { "Description": "Slave client output buffer soft limit in seconds.", "DataType": "integer", "ChangeType": "immediate", "IsModifiable": false, "AllowedValues": "0-", "Source": "system", "ParameterValue": "60", "ParameterName": "client-output-buffer-limit-slave-soft-seconds", "MinimumEngineVersion": "2.8.6" }, { "Description": "If enabled, clients who attempt to write to a read-only slave will be disconnected. Applicable to 2.8.23 and higher.", "DataType": "string", "ChangeType": "immediate", "IsModifiable": true, "AllowedValues": "yes,no", "Source": "system", "ParameterValue": "yes", "ParameterName": "close-on-slave-write", "MinimumEngineVersion": "2.8.23" }, { "Description": "Set the number of databases.", "DataType": "integer", "ChangeType": "requires-reboot", "IsModifiable": true, "AllowedValues": "1-1200000", "Source": "system", "ParameterValue": "16", "ParameterName": "databases", "MinimumEngineVersion": "2.8.6" }, { "Description": "The maximum number of hash entries in order for the dataset to be compressed.", "DataType": "integer", "ChangeType": "immediate", "IsModifiable": true, "AllowedValues": "0-", "Source": "system", "ParameterValue": "512", "ParameterName": "hash-max-ziplist-entries", "MinimumEngineVersion": "2.8.6" }, { "Description": "The threshold of biggest hash entries in order for the dataset to be compressed.", "DataType": "integer", "ChangeType": "immediate", "IsModifiable": true, "AllowedValues": "0-", "Source": "system", "ParameterValue": "64", "ParameterName": "hash-max-ziplist-value", "MinimumEngineVersion": "2.8.6" }, { "Description": "The maximum number of list entries in order for the dataset to be compressed.", "DataType": "integer", "ChangeType": "immediate", "IsModifiable": true, "AllowedValues": "0-", "Source": "system", "ParameterValue": "512", "ParameterName": "list-max-ziplist-entries", "MinimumEngineVersion": "2.8.6" }, { "Description": "The threshold of biggest list entries in order for the dataset to be compressed.", "DataType": "integer", "ChangeType": "immediate", "IsModifiable": true, "AllowedValues": "0-", "Source": "system", "ParameterValue": "64", "ParameterName": "list-max-ziplist-value", "MinimumEngineVersion": "2.8.6" }, { "Description": "Max execution time of a Lua script in milliseconds. 0 for unlimited execution without warnings.", "DataType": "integer", "ChangeType": "immediate", "IsModifiable": false, "AllowedValues": "5000", "Source": "system", "ParameterValue": "5000", "ParameterName": "lua-time-limit", "MinimumEngineVersion": "2.8.6" }, { "Description": "The maximum number of Redis clients.", "DataType": "integer", "ChangeType": "requires-reboot", "IsModifiable": false, "AllowedValues": "1-65000", "Source": "system", "ParameterValue": "65000", "ParameterName": "maxclients", "MinimumEngineVersion": "2.8.6" }, { "Description": "Max memory policy.", "DataType": "string", "ChangeType": "immediate", "IsModifiable": true, "AllowedValues": "volatile-lru,allkeys-lru,volatile-random,allkeys-random,volatile-ttl,noeviction", "Source": "system", "ParameterValue": "volatile-lru", "ParameterName": "maxmemory-policy", "MinimumEngineVersion": "2.8.6" }, { "Description": "Max memory samples.", "DataType": "integer", "ChangeType": "immediate", "IsModifiable": true, "AllowedValues": "1-", "Source": "system", "ParameterValue": "3", "ParameterName": "maxmemory-samples", "MinimumEngineVersion": "2.8.6" }, { "Description": "Maximum number of seconds within which the master must receive a ping from a slave to take writes. Use this parameter together with min-slaves-to-write to regulate when the master stops accepting writes. Setting this value to 0 means the master always takes writes.", "DataType": "integer", "ChangeType": "immediate", "IsModifiable": true, "AllowedValues": "0-", "Source": "system", "ParameterValue": "10", "ParameterName": "min-slaves-max-lag", "MinimumEngineVersion": "2.8.6" }, { "Description": "Number of slaves that must be connected in order for master to take writes. Use this parameter together with min-slaves-max-lag to regulate when the master stops accepting writes. Setting this to 0 means the master always takes writes.", "DataType": "integer", "ChangeType": "immediate", "IsModifiable": true, "AllowedValues": "0-", "Source": "system", "ParameterValue": "0", "ParameterName": "min-slaves-to-write", "MinimumEngineVersion": "2.8.6" }, { "Description": "The keyspace events for Redis to notify Pub/Sub clients about. By default all notifications are disabled", "DataType": "string", "ChangeType": "immediate", "Source": "system", "IsModifiable": true, "ParameterName": "notify-keyspace-events", "MinimumEngineVersion": "2.8.6" }, { "Description": "The replication backlog size in bytes for PSYNC. This is the size of the buffer which accumulates slave data when slave is disconnected for some time, so that when slave reconnects again, only transfer the portion of data which the slave missed. Minimum value is 16K.", "DataType": "integer", "ChangeType": "immediate", "IsModifiable": true, "AllowedValues": "16384-", "Source": "system", "ParameterValue": "1048576", "ParameterName": "repl-backlog-size", "MinimumEngineVersion": "2.8.6" }, { "Description": "The amount of time in seconds after the master no longer have any slaves connected for the master to free the replication backlog. A value of 0 means to never release the backlog.", "DataType": "integer", "ChangeType": "immediate", "IsModifiable": true, "AllowedValues": "0-", "Source": "system", "ParameterValue": "3600", "ParameterName": "repl-backlog-ttl", "MinimumEngineVersion": "2.8.6" }, { "Description": "The timeout in seconds for bulk transfer I/O during sync and master timeout from the perspective of the slave, and slave timeout from the perspective of the master.", "DataType": "integer", "ChangeType": "immediate", "IsModifiable": true, "AllowedValues": "11-", "Source": "system", "ParameterValue": "60", "ParameterName": "repl-timeout", "MinimumEngineVersion": "2.8.6" }, { "Description": "The amount of memory reserved for non-cache memory usage, in bytes. You may want to increase this parameter for nodes with read replicas, AOF enabled, etc, to reduce swap usage.", "DataType": "integer", "ChangeType": "immediate", "IsModifiable": true, "AllowedValues": "0-", "Source": "system", "ParameterValue": "0", "ParameterName": "reserved-memory", "MinimumEngineVersion": "2.8.6" }, { "Description": "The limit in the size of the set in order for the dataset to be compressed.", "DataType": "integer", "ChangeType": "immediate", "IsModifiable": true, "AllowedValues": "0-", "Source": "system", "ParameterValue": "512", "ParameterName": "set-max-intset-entries", "MinimumEngineVersion": "2.8.6" }, { "Description": "Configures if chaining of slaves is allowed", "DataType": "string", "ChangeType": "immediate", "IsModifiable": false, "AllowedValues": "yes,no", "Source": "system", "ParameterValue": "no", "ParameterName": "slave-allow-chaining", "MinimumEngineVersion": "2.8.6" }, { "Description": "The execution time, in microseconds, to exceed in order for the command to get logged. Note that a negative number disables the slow log, while a value of zero forces the logging of every command.", "DataType": "integer", "ChangeType": "immediate", "IsModifiable": true, "AllowedValues": "-", "Source": "system", "ParameterValue": "10000", "ParameterName": "slowlog-log-slower-than", "MinimumEngineVersion": "2.8.6" }, { "Description": "The length of the slow log. There is no limit to this length. Just be aware that it will consume memory. You can reclaim memory used by the slow log with SLOWLOG RESET.", "DataType": "integer", "ChangeType": "immediate", "IsModifiable": true, "AllowedValues": "0-", "Source": "system", "ParameterValue": "128", "ParameterName": "slowlog-max-len", "MinimumEngineVersion": "2.8.6" }, { "Description": "If non-zero, send ACKs every given number of seconds.", "DataType": "integer", "ChangeType": "immediate", "IsModifiable": true, "AllowedValues": "0-", "Source": "system", "ParameterValue": "0", "ParameterName": "tcp-keepalive", "MinimumEngineVersion": "2.8.6" }, { "Description": "Close connection if client is idle for a given number of seconds, or never if 0.", "DataType": "integer", "ChangeType": "immediate", "IsModifiable": true, "AllowedValues": "0,20-", "Source": "system", "ParameterValue": "0", "ParameterName": "timeout", "MinimumEngineVersion": "2.8.6" }, { "Description": "The maximum number of sorted set entries in order for the dataset to be compressed.", "DataType": "integer", "ChangeType": "immediate", "IsModifiable": true, "AllowedValues": "0-", "Source": "system", "ParameterValue": "128", "ParameterName": "zset-max-ziplist-entries", "MinimumEngineVersion": "2.8.6" }, { "Description": "The threshold of biggest sorted set entries in order for the dataset to be compressed.", "DataType": "integer", "ChangeType": "immediate", "IsModifiable": true, "AllowedValues": "0-", "Source": "system", "ParameterValue": "64", "ParameterName": "zset-max-ziplist-value", "MinimumEngineVersion": "2.8.6" } ] } } ], "smithy.api#paginated": { "inputToken": "Marker", "outputToken": "Marker", "items": "Parameters", "pageSize": "MaxRecords" } } }, "com.amazonaws.elasticache#DescribeCacheParametersMessage": { "type": "structure", "members": { "CacheParameterGroupName": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The name of a specific cache parameter group to return details for.
", "smithy.api#required": {} } }, "Source": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "The parameter types to return.
\nValid values: user | system |\n engine-default\n
The maximum number of records to include in the response. If more records exist than\n the specified MaxRecords value, a marker is included in the response so\n that the remaining results can be retrieved.
Default: 100
\nConstraints: minimum 20; maximum 100.
" } }, "Marker": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "An optional marker returned from a prior request. Use this marker for pagination of\n results from this operation. If this parameter is specified, the response includes only\n records beyond the marker, up to the value specified by MaxRecords.
Represents the input of a DescribeCacheParameters operation.
Returns a list of cache security group descriptions. If a cache security group name is\n specified, the list contains only the description of that group. This applicable only\n when you have ElastiCache in Classic setup
", "smithy.api#examples": [ { "title": "DescribeCacheSecurityGroups", "documentation": "Returns a list of cache security group descriptions. If a cache security group name is specified, the list contains only the description of that group.", "input": { "CacheSecurityGroupName": "my-sec-group" } } ], "smithy.api#paginated": { "inputToken": "Marker", "outputToken": "Marker", "items": "CacheSecurityGroups", "pageSize": "MaxRecords" } } }, "com.amazonaws.elasticache#DescribeCacheSecurityGroupsMessage": { "type": "structure", "members": { "CacheSecurityGroupName": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "The name of the cache security group to return details for.
" } }, "MaxRecords": { "target": "com.amazonaws.elasticache#IntegerOptional", "traits": { "smithy.api#documentation": "The maximum number of records to include in the response. If more records exist than\n the specified MaxRecords value, a marker is included in the response so\n that the remaining results can be retrieved.
Default: 100
\nConstraints: minimum 20; maximum 100.
" } }, "Marker": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "An optional marker returned from a prior request. Use this marker for pagination of\n results from this operation. If this parameter is specified, the response includes only\n records beyond the marker, up to the value specified by MaxRecords.
Represents the input of a DescribeCacheSecurityGroups operation.
Returns a list of cache subnet group descriptions. If a subnet group name is\n specified, the list contains only the description of that group. This is applicable only\n when you have ElastiCache in VPC setup. All ElastiCache clusters now launch in VPC by\n default.
", "smithy.api#examples": [ { "title": "DescribeCacheSubnetGroups", "documentation": "Describes up to 25 cache subnet groups.", "input": { "MaxRecords": 25 }, "output": { "Marker": "", "CacheSubnetGroups": [ { "VpcId": "vpc-91280df6", "CacheSubnetGroupDescription": "Default CacheSubnetGroup", "Subnets": [ { "SubnetIdentifier": "subnet-1a2b3c4d", "SubnetAvailabilityZone": { "Name": "us-east-1a" } }, { "SubnetIdentifier": "subnet-a1b2c3d4", "SubnetAvailabilityZone": { "Name": "us-east-1c" } }, { "SubnetIdentifier": "subnet-abcd1234", "SubnetAvailabilityZone": { "Name": "us-east-1e" } }, { "SubnetIdentifier": "subnet-1234abcd", "SubnetAvailabilityZone": { "Name": "us-east-1b" } } ], "CacheSubnetGroupName": "default" } ] } } ], "smithy.api#paginated": { "inputToken": "Marker", "outputToken": "Marker", "items": "CacheSubnetGroups", "pageSize": "MaxRecords" } } }, "com.amazonaws.elasticache#DescribeCacheSubnetGroupsMessage": { "type": "structure", "members": { "CacheSubnetGroupName": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "The name of the cache subnet group to return details for.
" } }, "MaxRecords": { "target": "com.amazonaws.elasticache#IntegerOptional", "traits": { "smithy.api#documentation": "The maximum number of records to include in the response. If more records exist than\n the specified MaxRecords value, a marker is included in the response so\n that the remaining results can be retrieved.
Default: 100
\nConstraints: minimum 20; maximum 100.
" } }, "Marker": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "An optional marker returned from a prior request. Use this marker for pagination of\n results from this operation. If this parameter is specified, the response includes only\n records beyond the marker, up to the value specified by MaxRecords.
Represents the input of a DescribeCacheSubnetGroups operation.
Returns the default engine and system parameter information for the specified cache\n engine.
", "smithy.api#examples": [ { "title": "DescribeEngineDefaultParameters", "documentation": "Returns the default engine and system parameter information for the specified cache engine.", "input": { "CacheParameterGroupFamily": "redis2.8", "MaxRecords": 25 }, "output": { "EngineDefaults": { "Marker": "bWluLXNsYXZlcy10by13cml0ZQ==", "CacheParameterGroupFamily": "redis2.8", "Parameters": [ { "Description": "Apply rehashing or not.", "DataType": "string", "ChangeType": "requires-reboot", "IsModifiable": true, "AllowedValues": "yes,no", "Source": "system", "ParameterValue": "yes", "ParameterName": "activerehashing", "MinimumEngineVersion": "2.8.6" }, { "Description": "fsync policy for AOF persistence", "DataType": "string", "ChangeType": "immediate", "IsModifiable": true, "AllowedValues": "always,everysec,no", "Source": "system", "ParameterValue": "everysec", "ParameterName": "appendfsync", "MinimumEngineVersion": "2.8.6" }, { "Description": "Enable Redis persistence.", "DataType": "string", "ChangeType": "immediate", "IsModifiable": true, "AllowedValues": "yes,no", "Source": "system", "ParameterValue": "no", "ParameterName": "appendonly", "MinimumEngineVersion": "2.8.6" }, { "Description": "Normal client output buffer hard limit in bytes.", "DataType": "integer", "ChangeType": "immediate", "IsModifiable": true, "AllowedValues": "0-", "Source": "system", "ParameterValue": "0", "ParameterName": "client-output-buffer-limit-normal-hard-limit", "MinimumEngineVersion": "2.8.6" }, { "Description": "Normal client output buffer soft limit in bytes.", "DataType": "integer", "ChangeType": "immediate", "IsModifiable": true, "AllowedValues": "0-", "Source": "system", "ParameterValue": "0", "ParameterName": "client-output-buffer-limit-normal-soft-limit", "MinimumEngineVersion": "2.8.6" }, { "Description": "Normal client output buffer soft limit in seconds.", "DataType": "integer", "ChangeType": "immediate", "IsModifiable": true, "AllowedValues": "0-", "Source": "system", "ParameterValue": "0", "ParameterName": "client-output-buffer-limit-normal-soft-seconds", "MinimumEngineVersion": "2.8.6" }, { "Description": "Pubsub client output buffer hard limit in bytes.", "DataType": "integer", "ChangeType": "immediate", "IsModifiable": true, "AllowedValues": "0-", "Source": "system", "ParameterValue": "33554432", "ParameterName": "client-output-buffer-limit-pubsub-hard-limit", "MinimumEngineVersion": "2.8.6" }, { "Description": "Pubsub client output buffer soft limit in bytes.", "DataType": "integer", "ChangeType": "immediate", "IsModifiable": true, "AllowedValues": "0-", "Source": "system", "ParameterValue": "8388608", "ParameterName": "client-output-buffer-limit-pubsub-soft-limit", "MinimumEngineVersion": "2.8.6" }, { "Description": "Pubsub client output buffer soft limit in seconds.", "DataType": "integer", "ChangeType": "immediate", "IsModifiable": true, "AllowedValues": "0-", "Source": "system", "ParameterValue": "60", "ParameterName": "client-output-buffer-limit-pubsub-soft-seconds", "MinimumEngineVersion": "2.8.6" }, { "Description": "Slave client output buffer soft limit in seconds.", "DataType": "integer", "ChangeType": "immediate", "IsModifiable": false, "AllowedValues": "0-", "Source": "system", "ParameterValue": "60", "ParameterName": "client-output-buffer-limit-slave-soft-seconds", "MinimumEngineVersion": "2.8.6" }, { "Description": "If enabled, clients who attempt to write to a read-only slave will be disconnected. Applicable to 2.8.23 and higher.", "DataType": "string", "ChangeType": "immediate", "IsModifiable": true, "AllowedValues": "yes,no", "Source": "system", "ParameterValue": "yes", "ParameterName": "close-on-slave-write", "MinimumEngineVersion": "2.8.23" }, { "Description": "Set the number of databases.", "DataType": "integer", "ChangeType": "requires-reboot", "IsModifiable": true, "AllowedValues": "1-1200000", "Source": "system", "ParameterValue": "16", "ParameterName": "databases", "MinimumEngineVersion": "2.8.6" }, { "Description": "The maximum number of hash entries in order for the dataset to be compressed.", "DataType": "integer", "ChangeType": "immediate", "IsModifiable": true, "AllowedValues": "0-", "Source": "system", "ParameterValue": "512", "ParameterName": "hash-max-ziplist-entries", "MinimumEngineVersion": "2.8.6" }, { "Description": "The threshold of biggest hash entries in order for the dataset to be compressed.", "DataType": "integer", "ChangeType": "immediate", "IsModifiable": true, "AllowedValues": "0-", "Source": "system", "ParameterValue": "64", "ParameterName": "hash-max-ziplist-value", "MinimumEngineVersion": "2.8.6" }, { "Description": "The maximum number of list entries in order for the dataset to be compressed.", "DataType": "integer", "ChangeType": "immediate", "IsModifiable": true, "AllowedValues": "0-", "Source": "system", "ParameterValue": "512", "ParameterName": "list-max-ziplist-entries", "MinimumEngineVersion": "2.8.6" }, { "Description": "The threshold of biggest list entries in order for the dataset to be compressed.", "DataType": "integer", "ChangeType": "immediate", "IsModifiable": true, "AllowedValues": "0-", "Source": "system", "ParameterValue": "64", "ParameterName": "list-max-ziplist-value", "MinimumEngineVersion": "2.8.6" }, { "Description": "Max execution time of a Lua script in milliseconds. 0 for unlimited execution without warnings.", "DataType": "integer", "ChangeType": "immediate", "IsModifiable": false, "AllowedValues": "5000", "Source": "system", "ParameterValue": "5000", "ParameterName": "lua-time-limit", "MinimumEngineVersion": "2.8.6" }, { "Description": "The maximum number of Redis clients.", "DataType": "integer", "ChangeType": "requires-reboot", "IsModifiable": false, "AllowedValues": "1-65000", "Source": "system", "ParameterValue": "65000", "ParameterName": "maxclients", "MinimumEngineVersion": "2.8.6" }, { "Description": "Max memory policy.", "DataType": "string", "ChangeType": "immediate", "IsModifiable": true, "AllowedValues": "volatile-lru,allkeys-lru,volatile-random,allkeys-random,volatile-ttl,noeviction", "Source": "system", "ParameterValue": "volatile-lru", "ParameterName": "maxmemory-policy", "MinimumEngineVersion": "2.8.6" }, { "Description": "Max memory samples.", "DataType": "integer", "ChangeType": "immediate", "IsModifiable": true, "AllowedValues": "1-", "Source": "system", "ParameterValue": "3", "ParameterName": "maxmemory-samples", "MinimumEngineVersion": "2.8.6" }, { "Description": "Maximum number of seconds within which the master must receive a ping from a slave to take writes. Use this parameter together with min-slaves-to-write to regulate when the master stops accepting writes. Setting this value to 0 means the master always takes writes.", "DataType": "integer", "ChangeType": "immediate", "IsModifiable": true, "AllowedValues": "0-", "Source": "system", "ParameterValue": "10", "ParameterName": "min-slaves-max-lag", "MinimumEngineVersion": "2.8.6" }, { "Description": "Number of slaves that must be connected in order for master to take writes. Use this parameter together with min-slaves-max-lag to regulate when the master stops accepting writes. Setting this to 0 means the master always takes writes.", "DataType": "integer", "ChangeType": "immediate", "IsModifiable": true, "AllowedValues": "0-", "Source": "system", "ParameterValue": "0", "ParameterName": "min-slaves-to-write", "MinimumEngineVersion": "2.8.6" } ], "CacheNodeTypeSpecificParameters": [ { "Description": "Slave client output buffer hard limit in bytes.", "DataType": "integer", "ChangeType": "immediate", "AllowedValues": "0-", "Source": "system", "IsModifiable": false, "CacheNodeTypeSpecificValues": [ { "Value": "650117120", "CacheNodeType": "cache.c1.xlarge" }, { "Value": "702545920", "CacheNodeType": "cache.m1.large" }, { "Value": "309329920", "CacheNodeType": "cache.m1.medium" }, { "Value": "94371840", "CacheNodeType": "cache.m1.small" }, { "Value": "1488977920", "CacheNodeType": "cache.m1.xlarge" }, { "Value": "3502243840", "CacheNodeType": "cache.m2.2xlarge" }, { "Value": "7088373760", "CacheNodeType": "cache.m2.4xlarge" }, { "Value": "1709178880", "CacheNodeType": "cache.m2.xlarge" }, { "Value": "2998927360", "CacheNodeType": "cache.m3.2xlarge" }, { "Value": "650117120", "CacheNodeType": "cache.m3.large" }, { "Value": "309329920", "CacheNodeType": "cache.m3.medium" }, { "Value": "1426063360", "CacheNodeType": "cache.m3.xlarge" }, { "Value": "16604761424", "CacheNodeType": "cache.m4.10xlarge" }, { "Value": "3188912636", "CacheNodeType": "cache.m4.2xlarge" }, { "Value": "6525729063", "CacheNodeType": "cache.m4.4xlarge" }, { "Value": "689259315", "CacheNodeType": "cache.m4.large" }, { "Value": "1532850176", "CacheNodeType": "cache.m4.xlarge" }, { "Value": "6081740800", "CacheNodeType": "cache.r3.2xlarge" }, { "Value": "12268339200", "CacheNodeType": "cache.r3.4xlarge" }, { "Value": "24536678400", "CacheNodeType": "cache.r3.8xlarge" }, { "Value": "1468006400", "CacheNodeType": "cache.r3.large" }, { "Value": "3040870400", "CacheNodeType": "cache.r3.xlarge" }, { "Value": "14260633", "CacheNodeType": "cache.t1.micro" }, { "Value": "346134937", "CacheNodeType": "cache.t2.medium" }, { "Value": "58195968", "CacheNodeType": "cache.t2.micro" }, { "Value": "166513868", "CacheNodeType": "cache.t2.small" } ], "ParameterName": "client-output-buffer-limit-slave-hard-limit", "MinimumEngineVersion": "2.8.6" }, { "Description": "Slave client output buffer soft limit in bytes.", "DataType": "integer", "ChangeType": "immediate", "AllowedValues": "0-", "Source": "system", "IsModifiable": false, "CacheNodeTypeSpecificValues": [ { "Value": "650117120", "CacheNodeType": "cache.c1.xlarge" }, { "Value": "702545920", "CacheNodeType": "cache.m1.large" }, { "Value": "309329920", "CacheNodeType": "cache.m1.medium" }, { "Value": "94371840", "CacheNodeType": "cache.m1.small" }, { "Value": "1488977920", "CacheNodeType": "cache.m1.xlarge" }, { "Value": "3502243840", "CacheNodeType": "cache.m2.2xlarge" }, { "Value": "7088373760", "CacheNodeType": "cache.m2.4xlarge" }, { "Value": "1709178880", "CacheNodeType": "cache.m2.xlarge" }, { "Value": "2998927360", "CacheNodeType": "cache.m3.2xlarge" }, { "Value": "650117120", "CacheNodeType": "cache.m3.large" }, { "Value": "309329920", "CacheNodeType": "cache.m3.medium" }, { "Value": "1426063360", "CacheNodeType": "cache.m3.xlarge" }, { "Value": "16604761424", "CacheNodeType": "cache.m4.10xlarge" }, { "Value": "3188912636", "CacheNodeType": "cache.m4.2xlarge" }, { "Value": "6525729063", "CacheNodeType": "cache.m4.4xlarge" }, { "Value": "689259315", "CacheNodeType": "cache.m4.large" }, { "Value": "1532850176", "CacheNodeType": "cache.m4.xlarge" }, { "Value": "6081740800", "CacheNodeType": "cache.r3.2xlarge" }, { "Value": "12268339200", "CacheNodeType": "cache.r3.4xlarge" }, { "Value": "24536678400", "CacheNodeType": "cache.r3.8xlarge" }, { "Value": "1468006400", "CacheNodeType": "cache.r3.large" }, { "Value": "3040870400", "CacheNodeType": "cache.r3.xlarge" }, { "Value": "14260633", "CacheNodeType": "cache.t1.micro" }, { "Value": "346134937", "CacheNodeType": "cache.t2.medium" }, { "Value": "58195968", "CacheNodeType": "cache.t2.micro" }, { "Value": "166513868", "CacheNodeType": "cache.t2.small" } ], "ParameterName": "client-output-buffer-limit-slave-soft-limit", "MinimumEngineVersion": "2.8.6" }, { "Description": "The maximum configurable amount of memory to use to store items, in bytes.", "DataType": "integer", "ChangeType": "immediate", "AllowedValues": "0-", "Source": "system", "IsModifiable": false, "CacheNodeTypeSpecificValues": [ { "Value": "6501171200", "CacheNodeType": "cache.c1.xlarge" }, { "Value": "7025459200", "CacheNodeType": "cache.m1.large" }, { "Value": "3093299200", "CacheNodeType": "cache.m1.medium" }, { "Value": "943718400", "CacheNodeType": "cache.m1.small" }, { "Value": "14889779200", "CacheNodeType": "cache.m1.xlarge" }, { "Value": "35022438400", "CacheNodeType": "cache.m2.2xlarge" }, { "Value": "70883737600", "CacheNodeType": "cache.m2.4xlarge" }, { "Value": "17091788800", "CacheNodeType": "cache.m2.xlarge" }, { "Value": "29989273600", "CacheNodeType": "cache.m3.2xlarge" }, { "Value": "6501171200", "CacheNodeType": "cache.m3.large" }, { "Value": "2988441600", "CacheNodeType": "cache.m3.medium" }, { "Value": "14260633600", "CacheNodeType": "cache.m3.xlarge" }, { "Value": "166047614239", "CacheNodeType": "cache.m4.10xlarge" }, { "Value": "31889126359", "CacheNodeType": "cache.m4.2xlarge" }, { "Value": "65257290629", "CacheNodeType": "cache.m4.4xlarge" }, { "Value": "6892593152", "CacheNodeType": "cache.m4.large" }, { "Value": "15328501760", "CacheNodeType": "cache.m4.xlarge" }, { "Value": "62495129600", "CacheNodeType": "cache.r3.2xlarge" }, { "Value": "126458265600", "CacheNodeType": "cache.r3.4xlarge" }, { "Value": "254384537600", "CacheNodeType": "cache.r3.8xlarge" }, { "Value": "14470348800", "CacheNodeType": "cache.r3.large" }, { "Value": "30513561600", "CacheNodeType": "cache.r3.xlarge" }, { "Value": "142606336", "CacheNodeType": "cache.t1.micro" }, { "Value": "3461349376", "CacheNodeType": "cache.t2.medium" }, { "Value": "581959680", "CacheNodeType": "cache.t2.micro" }, { "Value": "1665138688", "CacheNodeType": "cache.t2.small" } ], "ParameterName": "maxmemory", "MinimumEngineVersion": "2.8.6" } ] } } } ], "smithy.api#paginated": { "inputToken": "Marker", "outputToken": "EngineDefaults.Marker", "items": "EngineDefaults.Parameters", "pageSize": "MaxRecords" } } }, "com.amazonaws.elasticache#DescribeEngineDefaultParametersMessage": { "type": "structure", "members": { "CacheParameterGroupFamily": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The name of the cache parameter group family.
\nValid values are: memcached1.4 | memcached1.5 |\n memcached1.6 | redis2.6 | redis2.8 |\n redis3.2 | redis4.0 | redis5.0 |\n redis6.x | redis6.2 | redis7\n
The maximum number of records to include in the response. If more records exist than\n the specified MaxRecords value, a marker is included in the response so\n that the remaining results can be retrieved.
Default: 100
\nConstraints: minimum 20; maximum 100.
" } }, "Marker": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "An optional marker returned from a prior request. Use this marker for pagination of\n results from this operation. If this parameter is specified, the response includes only\n records beyond the marker, up to the value specified by MaxRecords.
Represents the input of a DescribeEngineDefaultParameters\n operation.
Returns events related to clusters, cache security groups, and cache parameter groups.\n You can obtain events specific to a particular cluster, cache security group, or cache\n parameter group by providing the name as a parameter.
\nBy default, only the events occurring within the last hour are returned; however, you\n can retrieve up to 14 days' worth of events if necessary.
", "smithy.api#examples": [ { "title": "DescribeEvents", "documentation": "Describes all the cache-cluster events for the past 120 minutes.", "input": { "SourceType": "cache-cluster", "Duration": 360 }, "output": { "Marker": "", "Events": [ { "Date": "2016-12-22T16:27:56.088Z", "Message": "Added cache node 0001 in availability zone us-east-1e", "SourceIdentifier": "redis-cluster", "SourceType": "cache-cluster" }, { "Date": "2016-12-22T16:27:56.078Z", "Message": "Cache cluster created", "SourceIdentifier": "redis-cluster", "SourceType": "cache-cluster" }, { "Date": "2016-12-22T16:05:17.326Z", "Message": "Added cache node 0002 in availability zone us-east-1c", "SourceIdentifier": "my-memcached2", "SourceType": "cache-cluster" }, { "Date": "2016-12-22T16:05:17.323Z", "Message": "Added cache node 0001 in availability zone us-east-1e", "SourceIdentifier": "my-memcached2", "SourceType": "cache-cluster" }, { "Date": "2016-12-22T16:05:17.314Z", "Message": "Cache cluster created", "SourceIdentifier": "my-memcached2", "SourceType": "cache-cluster" } ] } }, { "title": "DescribeEvents", "documentation": "Describes all the replication-group events from 3:00P to 5:00P on November 11, 2016.", "input": { "StartTime": "2016-12-22T15:00:00.000Z" }, "output": { "Marker": "", "Events": [ { "Date": "2016-12-22T21:35:46.674Z", "Message": "Snapshot succeeded for snapshot with ID 'cr-bkup' of replication group with ID 'clustered-redis'", "SourceIdentifier": "clustered-redis-0001-001", "SourceType": "cache-cluster" }, { "Date": "2016-12-22T16:27:56.088Z", "Message": "Added cache node 0001 in availability zone us-east-1e", "SourceIdentifier": "redis-cluster", "SourceType": "cache-cluster" }, { "Date": "2016-12-22T16:27:56.078Z", "Message": "Cache cluster created", "SourceIdentifier": "redis-cluster", "SourceType": "cache-cluster" }, { "Date": "2016-12-22T16:05:17.326Z", "Message": "Added cache node 0002 in availability zone us-east-1c", "SourceIdentifier": "my-memcached2", "SourceType": "cache-cluster" }, { "Date": "2016-12-22T16:05:17.323Z", "Message": "Added cache node 0001 in availability zone us-east-1e", "SourceIdentifier": "my-memcached2", "SourceType": "cache-cluster" }, { "Date": "2016-12-22T16:05:17.314Z", "Message": "Cache cluster created", "SourceIdentifier": "my-memcached2", "SourceType": "cache-cluster" } ] } } ], "smithy.api#paginated": { "inputToken": "Marker", "outputToken": "Marker", "items": "Events", "pageSize": "MaxRecords" }, "smithy.test#smokeTests": [ { "id": "DescribeEventsSuccess", "params": {}, "vendorParams": { "region": "us-west-2" }, "vendorParamsShape": "aws.test#AwsVendorParams", "expect": { "success": {} } } ] } }, "com.amazonaws.elasticache#DescribeEventsMessage": { "type": "structure", "members": { "SourceIdentifier": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "The identifier of the event source for which events are returned. If not specified,\n all sources are included in the response.
" } }, "SourceType": { "target": "com.amazonaws.elasticache#SourceType", "traits": { "smithy.api#documentation": "The event source to retrieve events for. If no value is specified, all events are\n returned.
" } }, "StartTime": { "target": "com.amazonaws.elasticache#TStamp", "traits": { "smithy.api#documentation": "The beginning of the time interval to retrieve events for, specified in ISO 8601\n format.
\n\n Example: 2017-03-30T07:03:49.555Z
" } }, "EndTime": { "target": "com.amazonaws.elasticache#TStamp", "traits": { "smithy.api#documentation": "The end of the time interval for which to retrieve events, specified in ISO 8601\n format.
\n\n Example: 2017-03-30T07:03:49.555Z
" } }, "Duration": { "target": "com.amazonaws.elasticache#IntegerOptional", "traits": { "smithy.api#documentation": "The number of minutes worth of events to retrieve.
" } }, "MaxRecords": { "target": "com.amazonaws.elasticache#IntegerOptional", "traits": { "smithy.api#documentation": "The maximum number of records to include in the response. If more records exist than\n the specified MaxRecords value, a marker is included in the response so\n that the remaining results can be retrieved.
Default: 100
\nConstraints: minimum 20; maximum 100.
" } }, "Marker": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "An optional marker returned from a prior request. Use this marker for pagination of\n results from this operation. If this parameter is specified, the response includes only\n records beyond the marker, up to the value specified by MaxRecords.
Represents the input of a DescribeEvents operation.
Returns information about a particular global replication group. If no identifier is\n specified, returns information about all Global datastores.
", "smithy.api#paginated": { "inputToken": "Marker", "outputToken": "Marker", "items": "GlobalReplicationGroups", "pageSize": "MaxRecords" } } }, "com.amazonaws.elasticache#DescribeGlobalReplicationGroupsMessage": { "type": "structure", "members": { "GlobalReplicationGroupId": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "The name of the Global datastore
" } }, "MaxRecords": { "target": "com.amazonaws.elasticache#IntegerOptional", "traits": { "smithy.api#documentation": "The maximum number of records to include in the response. If more records exist than\n the specified MaxRecords value, a marker is included in the response so that the\n remaining results can be retrieved.
" } }, "Marker": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "An optional marker returned from a prior request. Use this marker for pagination of\n results from this operation. If this parameter is specified, the response includes only\n records beyond the marker, up to the value specified by MaxRecords.
Returns the list of members that comprise the Global datastore.
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.elasticache#DescribeGlobalReplicationGroupsResult": { "type": "structure", "members": { "Marker": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "An optional marker returned from a prior request. Use this marker for pagination of\n results from this operation. If this parameter is specified, the response includes only\n records beyond the marker, up to the value specified by MaxRecords. >
" } }, "GlobalReplicationGroups": { "target": "com.amazonaws.elasticache#GlobalReplicationGroupList", "traits": { "smithy.api#documentation": "Indicates the slot configuration and global identifier for each slice group.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.elasticache#DescribeReplicationGroups": { "type": "operation", "input": { "target": "com.amazonaws.elasticache#DescribeReplicationGroupsMessage" }, "output": { "target": "com.amazonaws.elasticache#ReplicationGroupMessage" }, "errors": [ { "target": "com.amazonaws.elasticache#InvalidParameterCombinationException" }, { "target": "com.amazonaws.elasticache#InvalidParameterValueException" }, { "target": "com.amazonaws.elasticache#ReplicationGroupNotFoundFault" } ], "traits": { "smithy.api#documentation": "Returns information about a particular replication group. If no identifier is\n specified, DescribeReplicationGroups returns information about all\n replication groups.
This operation is valid for Valkey or Redis OSS only.
\nThe identifier for the replication group to be described. This parameter is not case\n sensitive.
\nIf you do not specify this parameter, information about all replication groups is\n returned.
" } }, "MaxRecords": { "target": "com.amazonaws.elasticache#IntegerOptional", "traits": { "smithy.api#documentation": "The maximum number of records to include in the response. If more records exist than\n the specified MaxRecords value, a marker is included in the response so\n that the remaining results can be retrieved.
Default: 100
\nConstraints: minimum 20; maximum 100.
" } }, "Marker": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "An optional marker returned from a prior request. Use this marker for pagination of\n results from this operation. If this parameter is specified, the response includes only\n records beyond the marker, up to the value specified by MaxRecords.
Represents the input of a DescribeReplicationGroups operation.
Returns information about reserved cache nodes for this account, or about a specified\n reserved cache node.
", "smithy.api#examples": [ { "title": "DescribeReservedCacheNodes", "documentation": "Returns information about reserved cache nodes for this account, or about a specified reserved cache node. If the account has no reserved cache nodes, the operation returns an empty list, as shown here.", "input": { "MaxRecords": 25 } } ], "smithy.api#paginated": { "inputToken": "Marker", "outputToken": "Marker", "items": "ReservedCacheNodes", "pageSize": "MaxRecords" } } }, "com.amazonaws.elasticache#DescribeReservedCacheNodesMessage": { "type": "structure", "members": { "ReservedCacheNodeId": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "The reserved cache node identifier filter value. Use this parameter to show only the\n reservation that matches the specified reservation ID.
" } }, "ReservedCacheNodesOfferingId": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "The offering identifier filter value. Use this parameter to show only purchased\n reservations matching the specified offering identifier.
" } }, "CacheNodeType": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "The cache node type filter value. Use this parameter to show only those reservations\n matching the specified cache node type.
\nThe following node types are supported by ElastiCache. Generally speaking, the current\n generation types provide more memory and computational power at lower cost when compared\n to their equivalent previous generation counterparts.
\nGeneral purpose:
\nCurrent generation:
\n\n M7g node types:\n \t\t\t\t\tcache.m7g.large,\n \t\t\t\t\tcache.m7g.xlarge,\n \t\t\t\t\tcache.m7g.2xlarge,\n \t\t\t\t\tcache.m7g.4xlarge,\n \t\t\t\t\tcache.m7g.8xlarge,\n \t\t\t\t\tcache.m7g.12xlarge,\n \t\t\t\t\tcache.m7g.16xlarge\n
For region availability, see Supported Node Types\n
\n\n M6g node types (available only for Redis OSS engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward):\n\t\t\t\t\t \n\t\t\t\t\t \tcache.m6g.large,\n\t\t\t\t\t\t\tcache.m6g.xlarge,\n\t\t\t\t\t\t\tcache.m6g.2xlarge,\n\t\t\t\t\t\t\tcache.m6g.4xlarge,\n\t\t\t\t\t\t\tcache.m6g.8xlarge,\n\t\t\t\t\t\t\tcache.m6g.12xlarge,\n\t\t\t\t\t\t\tcache.m6g.16xlarge\n
\n M5 node types:\n cache.m5.large,\n \t\t\t\t\t\tcache.m5.xlarge,\n \t\t\t\t\t\tcache.m5.2xlarge,\n \t\t\t\t\t\tcache.m5.4xlarge,\n \t\t\t\t\t\tcache.m5.12xlarge,\n \t\t\t\t\t\tcache.m5.24xlarge\n
\n M4 node types:\n cache.m4.large,\n \t\t\t\t\t\tcache.m4.xlarge,\n \t\t\t\t\t\tcache.m4.2xlarge,\n \t\t\t\t\t\tcache.m4.4xlarge,\n \t\t\t\t\t\tcache.m4.10xlarge\n
\n T4g node types (available only for Redis OSS engine version 5.0.6 onward and Memcached engine version 1.5.16 onward):\n\t\t\t\t\t cache.t4g.micro,\n\t\t\t\t\t cache.t4g.small,\n\t\t\t\t\t cache.t4g.medium\n
\n T3 node types:\n cache.t3.micro, \n \t\t\t\t\t\tcache.t3.small,\n \t\t\t\t\t\tcache.t3.medium\n
\n T2 node types:\n cache.t2.micro, \n \t\t\t\t\t\tcache.t2.small,\n \t\t\t\t\t\tcache.t2.medium\n
Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)
\n\n T1 node types:\n cache.t1.micro\n
\n M1 node types:\n cache.m1.small, \n\t\t\t\t\t\t cache.m1.medium, \n\t\t\t\t\t\t cache.m1.large,\n\t\t\t\t\t\t cache.m1.xlarge\n
\n M3 node types:\n cache.m3.medium,\n \t\t\t\t\t\tcache.m3.large, \n \t\t\t\t\t\tcache.m3.xlarge,\n \t\t\t\t\t\tcache.m3.2xlarge\n
Compute optimized:
\nPrevious generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)
\n\n C1 node types:\n cache.c1.xlarge\n
Memory optimized:
\nCurrent generation:
\n\n R7g node types:\t\n\t\t\t\t\t\t\tcache.r7g.large,\n\t\t\t\t\t\t\tcache.r7g.xlarge,\n\t\t\t\t\t\t\tcache.r7g.2xlarge,\n\t\t\t\t\t\t\tcache.r7g.4xlarge,\n\t\t\t\t\t\t\tcache.r7g.8xlarge,\n\t\t\t\t\t\t\tcache.r7g.12xlarge,\n\t\t\t\t\t\t\tcache.r7g.16xlarge\n
For region availability, see Supported Node Types\n
\n\n R6g node types (available only for Redis OSS engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward):\n\t\t\t\t\t\t\tcache.r6g.large,\n\t\t\t\t\t\t\tcache.r6g.xlarge,\n\t\t\t\t\t\t\tcache.r6g.2xlarge,\n\t\t\t\t\t\t\tcache.r6g.4xlarge,\n\t\t\t\t\t\t\tcache.r6g.8xlarge,\n\t\t\t\t\t\t\tcache.r6g.12xlarge,\n\t\t\t\t\t\t\tcache.r6g.16xlarge\n
\n R5 node types:\n cache.r5.large,\n \t\t\t\t\t cache.r5.xlarge,\n \t\t\t\t\t cache.r5.2xlarge,\n \t\t\t\t\t cache.r5.4xlarge,\n \t\t\t\t\t cache.r5.12xlarge,\n \t\t\t\t\t cache.r5.24xlarge\n
\n R4 node types:\n cache.r4.large,\n \t\t\t\t\t cache.r4.xlarge,\n \t\t\t\t\t cache.r4.2xlarge,\n \t\t\t\t\t cache.r4.4xlarge,\n \t\t\t\t\t cache.r4.8xlarge,\n \t\t\t\t\t cache.r4.16xlarge\n
Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)
\n\n M2 node types:\n cache.m2.xlarge, \n \t\t\t\t\t\tcache.m2.2xlarge,\n \t\t\t\t\t\tcache.m2.4xlarge\n
\n R3 node types:\n cache.r3.large, \n \t\t\t\t\t\tcache.r3.xlarge,\n \t\t\t\t\t\tcache.r3.2xlarge, \n \t\t\t\t\t\tcache.r3.4xlarge,\n \t\t\t\t\t\tcache.r3.8xlarge\n
\n Additional node type info\n
\nAll current generation instance types are created in Amazon VPC by\n default.
\nValkey or Redis OSS append-only files (AOF) are not supported for T1 or T2 instances.
\nValkey or Redis OSS Multi-AZ with automatic failover is not supported on T1\n instances.
\nThe configuration variables appendonly and\n appendfsync are not supported on Valkey, or on Redis OSS version 2.8.22 and\n later.
The duration filter value, specified in years or seconds. Use this parameter to show\n only reservations for this duration.
\nValid Values: 1 | 3 | 31536000 | 94608000\n
The product description filter value. Use this parameter to show only those\n reservations matching the specified product description.
" } }, "OfferingType": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "The offering type filter value. Use this parameter to show only the available\n offerings matching the specified offering type.
\nValid values: \"Light Utilization\"|\"Medium Utilization\"|\"Heavy Utilization\"|\"All\n Upfront\"|\"Partial Upfront\"| \"No Upfront\"\n
The maximum number of records to include in the response. If more records exist than\n the specified MaxRecords value, a marker is included in the response so\n that the remaining results can be retrieved.
Default: 100
\nConstraints: minimum 20; maximum 100.
" } }, "Marker": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "An optional marker returned from a prior request. Use this marker for pagination of\n results from this operation. If this parameter is specified, the response includes only\n records beyond the marker, up to the value specified by MaxRecords.
Represents the input of a DescribeReservedCacheNodes operation.
Lists available reserved cache node offerings.
", "smithy.api#examples": [ { "title": "DescribeReseredCacheNodeOfferings", "documentation": "Lists available reserved cache node offerings for cache.r3.large nodes with a 3 year commitment.", "input": { "ReservedCacheNodesOfferingId": "", "CacheNodeType": "cache.r3.large", "Duration": "3", "OfferingType": "Light Utilization", "MaxRecords": 25 }, "output": { "Marker": "", "ReservedCacheNodesOfferings": [] } }, { "title": "DescribeReseredCacheNodeOfferings", "documentation": "Lists available reserved cache node offerings.", "input": { "MaxRecords": 20 }, "output": { "Marker": "1ef01f5b-433f-94ff-a530-61a56bfc8e7a", "ReservedCacheNodesOfferings": [ { "OfferingType": "Medium Utilization", "FixedPrice": 157.0, "ReservedCacheNodesOfferingId": "0167633d-37f6-4222-b872-b1f22eb79ba4", "UsagePrice": 0.017, "RecurringCharges": [], "ProductDescription": "memcached", "Duration": 94608000, "CacheNodeType": "cache.m1.small" }, { "OfferingType": "Heavy Utilization", "FixedPrice": 1248.0, "ReservedCacheNodesOfferingId": "02c04e13-baca-4e71-9ceb-620eed94827d", "UsagePrice": 0.0, "RecurringCharges": [ { "RecurringChargeAmount": 0.077, "RecurringChargeFrequency": "Hourly" } ], "ProductDescription": "redis", "Duration": 94608000, "CacheNodeType": "cache.m4.xlarge" }, { "OfferingType": "Medium Utilization", "FixedPrice": 2381.0, "ReservedCacheNodesOfferingId": "02e1755e-76e8-48e3-8d82-820a5726a458", "UsagePrice": 0.276, "RecurringCharges": [], "ProductDescription": "memcached", "Duration": 94608000, "CacheNodeType": "cache.m2.4xlarge" }, { "OfferingType": "Heavy Utilization", "FixedPrice": 188.0, "ReservedCacheNodesOfferingId": "03315215-7b87-421a-a3dd-785021e4113f", "UsagePrice": 0.0, "RecurringCharges": [ { "RecurringChargeAmount": 0.013, "RecurringChargeFrequency": "Hourly" } ], "ProductDescription": "redis", "Duration": 94608000, "CacheNodeType": "cache.m1.small" }, { "OfferingType": "Heavy Utilization", "FixedPrice": 6158.0, "ReservedCacheNodesOfferingId": "05ffbb44-2ace-4476-a2a5-8ec99f866fb3", "UsagePrice": 0.0, "RecurringCharges": [ { "RecurringChargeAmount": 1.125, "RecurringChargeFrequency": "Hourly" } ], "ProductDescription": "redis", "Duration": 31536000, "CacheNodeType": "cache.m4.10xlarge" }, { "OfferingType": "Medium Utilization", "FixedPrice": 101.0, "ReservedCacheNodesOfferingId": "065c71ae-4a4e-4f1e-bebf-37525f4c6cb2", "UsagePrice": 0.023, "RecurringCharges": [], "ProductDescription": "redis", "Duration": 31536000, "CacheNodeType": "cache.m1.small" }, { "OfferingType": "Medium Utilization", "FixedPrice": 314.0, "ReservedCacheNodesOfferingId": "06774b12-7f5e-48c1-907a-f286c63f327d", "UsagePrice": 0.034, "RecurringCharges": [], "ProductDescription": "memcached", "Duration": 94608000, "CacheNodeType": "cache.m1.medium" }, { "OfferingType": "Light Utilization", "FixedPrice": 163.0, "ReservedCacheNodesOfferingId": "0924ac6b-847f-4761-ba6b-4290b2adf719", "UsagePrice": 0.137, "RecurringCharges": [], "ProductDescription": "memcached", "Duration": 31536000, "CacheNodeType": "cache.m2.xlarge" }, { "OfferingType": "Heavy Utilization", "FixedPrice": 719.0, "ReservedCacheNodesOfferingId": "09eeb126-69b6-4d3f-8f94-ca3510629f53", "UsagePrice": 0.0, "RecurringCharges": [ { "RecurringChargeAmount": 0.049, "RecurringChargeFrequency": "Hourly" } ], "ProductDescription": "redis", "Duration": 94608000, "CacheNodeType": "cache.m2.xlarge" }, { "OfferingType": "Heavy Utilization", "FixedPrice": 4132.0, "ReservedCacheNodesOfferingId": "0a516ad8-557f-4310-9dd0-2448c2ff4d62", "UsagePrice": 0.0, "RecurringCharges": [ { "RecurringChargeAmount": 0.182, "RecurringChargeFrequency": "Hourly" } ], "ProductDescription": "redis", "Duration": 94608000, "CacheNodeType": "cache.r3.2xlarge" }, { "OfferingType": "Light Utilization", "FixedPrice": 875.0, "ReservedCacheNodesOfferingId": "0b0c1cc5-2177-4150-95d7-c67ec34dcb19", "UsagePrice": 0.363, "RecurringCharges": [], "ProductDescription": "memcached", "Duration": 94608000, "CacheNodeType": "cache.c1.xlarge" }, { "OfferingType": "Heavy Utilization", "FixedPrice": 12483.0, "ReservedCacheNodesOfferingId": "0c2b139b-1cff-43d0-8fba-0c753f9b1950", "UsagePrice": 0.0, "RecurringCharges": [ { "RecurringChargeAmount": 0.76, "RecurringChargeFrequency": "Hourly" } ], "ProductDescription": "memcached", "Duration": 94608000, "CacheNodeType": "cache.m4.10xlarge" }, { "OfferingType": "Heavy Utilization", "FixedPrice": 1620.0, "ReservedCacheNodesOfferingId": "0c52115b-38cb-47a2-8dbc-e02e40b6a13f", "UsagePrice": 0.0, "RecurringCharges": [ { "RecurringChargeAmount": 0.207, "RecurringChargeFrequency": "Hourly" } ], "ProductDescription": "memcached", "Duration": 31536000, "CacheNodeType": "cache.c1.xlarge" }, { "OfferingType": "Medium Utilization", "FixedPrice": 2381.0, "ReservedCacheNodesOfferingId": "12fcb19c-5416-4e1d-934f-28f1e2cb8599", "UsagePrice": 0.276, "RecurringCharges": [], "ProductDescription": "redis", "Duration": 94608000, "CacheNodeType": "cache.m2.4xlarge" }, { "OfferingType": "Heavy Utilization", "FixedPrice": 616.0, "ReservedCacheNodesOfferingId": "13af20ad-914d-4d8b-9763-fa2e565f3549", "UsagePrice": 0.0, "RecurringCharges": [ { "RecurringChargeAmount": 0.112, "RecurringChargeFrequency": "Hourly" } ], "ProductDescription": "memcached", "Duration": 31536000, "CacheNodeType": "cache.m4.xlarge" }, { "OfferingType": "Heavy Utilization", "FixedPrice": 16528.0, "ReservedCacheNodesOfferingId": "14da3d3f-b526-4dbf-b09b-355578b2a576", "UsagePrice": 0.0, "RecurringCharges": [ { "RecurringChargeAmount": 0.729, "RecurringChargeFrequency": "Hourly" } ], "ProductDescription": "memcached", "Duration": 94608000, "CacheNodeType": "cache.r3.8xlarge" }, { "OfferingType": "Light Utilization", "FixedPrice": 140.0, "ReservedCacheNodesOfferingId": "15d7018c-71fb-4717-8409-4bdcdca18da7", "UsagePrice": 0.052, "RecurringCharges": [], "ProductDescription": "redis", "Duration": 94608000, "CacheNodeType": "cache.m1.medium" }, { "OfferingType": "Heavy Utilization", "FixedPrice": 4993.0, "ReservedCacheNodesOfferingId": "1ae7ec5f-a76e-49b6-822b-629b1768a13a", "UsagePrice": 0.0, "RecurringCharges": [ { "RecurringChargeAmount": 0.304, "RecurringChargeFrequency": "Hourly" } ], "ProductDescription": "memcached", "Duration": 94608000, "CacheNodeType": "cache.m4.4xlarge" }, { "OfferingType": "Heavy Utilization", "FixedPrice": 1772.0, "ReservedCacheNodesOfferingId": "1d31242b-3925-48d1-b882-ce03204e6013", "UsagePrice": 0.0, "RecurringCharges": [ { "RecurringChargeAmount": 0.25, "RecurringChargeFrequency": "Hourly" } ], "ProductDescription": "redis", "Duration": 31536000, "CacheNodeType": "cache.m3.2xlarge" }, { "OfferingType": "Medium Utilization", "FixedPrice": 54.0, "ReservedCacheNodesOfferingId": "1ef01f5b-94ff-433f-a530-61a56bfc8e7a", "UsagePrice": 0.008, "RecurringCharges": [], "ProductDescription": "memcached", "Duration": 31536000, "CacheNodeType": "cache.t1.micro" } ] } }, { "title": "DescribeReseredCacheNodeOfferings", "documentation": "Lists available reserved cache node offerings.", "input": { "ReservedCacheNodesOfferingId": "438012d3-4052-4cc7-b2e3-8d3372e0e706", "CacheNodeType": "", "Duration": "", "ProductDescription": "", "OfferingType": "", "MaxRecords": 25, "Marker": "" }, "output": { "Marker": "", "ReservedCacheNodesOfferings": [] } } ], "smithy.api#paginated": { "inputToken": "Marker", "outputToken": "Marker", "items": "ReservedCacheNodesOfferings", "pageSize": "MaxRecords" } } }, "com.amazonaws.elasticache#DescribeReservedCacheNodesOfferingsMessage": { "type": "structure", "members": { "ReservedCacheNodesOfferingId": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "The offering identifier filter value. Use this parameter to show only the available\n offering that matches the specified reservation identifier.
\nExample: 438012d3-4052-4cc7-b2e3-8d3372e0e706\n
The cache node type filter value. Use this parameter to show only the available\n offerings matching the specified cache node type.
\nThe following node types are supported by ElastiCache. Generally speaking, the current\n generation types provide more memory and computational power at lower cost when compared\n to their equivalent previous generation counterparts.
\nGeneral purpose:
\nCurrent generation:
\n\n M7g node types:\n \t\t\t\t\tcache.m7g.large,\n \t\t\t\t\tcache.m7g.xlarge,\n \t\t\t\t\tcache.m7g.2xlarge,\n \t\t\t\t\tcache.m7g.4xlarge,\n \t\t\t\t\tcache.m7g.8xlarge,\n \t\t\t\t\tcache.m7g.12xlarge,\n \t\t\t\t\tcache.m7g.16xlarge\n
For region availability, see Supported Node Types\n
\n\n M6g node types (available only for Redis OSS engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward):\n\t\t\t\t\t \n\t\t\t\t\t \tcache.m6g.large,\n\t\t\t\t\t\t\tcache.m6g.xlarge,\n\t\t\t\t\t\t\tcache.m6g.2xlarge,\n\t\t\t\t\t\t\tcache.m6g.4xlarge,\n\t\t\t\t\t\t\tcache.m6g.8xlarge,\n\t\t\t\t\t\t\tcache.m6g.12xlarge,\n\t\t\t\t\t\t\tcache.m6g.16xlarge\n
\n M5 node types:\n cache.m5.large,\n \t\t\t\t\t\tcache.m5.xlarge,\n \t\t\t\t\t\tcache.m5.2xlarge,\n \t\t\t\t\t\tcache.m5.4xlarge,\n \t\t\t\t\t\tcache.m5.12xlarge,\n \t\t\t\t\t\tcache.m5.24xlarge\n
\n M4 node types:\n cache.m4.large,\n \t\t\t\t\t\tcache.m4.xlarge,\n \t\t\t\t\t\tcache.m4.2xlarge,\n \t\t\t\t\t\tcache.m4.4xlarge,\n \t\t\t\t\t\tcache.m4.10xlarge\n
\n T4g node types (available only for Redis OSS engine version 5.0.6 onward and Memcached engine version 1.5.16 onward):\n\t\t\t\t\t cache.t4g.micro,\n\t\t\t\t\t cache.t4g.small,\n\t\t\t\t\t cache.t4g.medium\n
\n T3 node types:\n cache.t3.micro, \n \t\t\t\t\t\tcache.t3.small,\n \t\t\t\t\t\tcache.t3.medium\n
\n T2 node types:\n cache.t2.micro, \n \t\t\t\t\t\tcache.t2.small,\n \t\t\t\t\t\tcache.t2.medium\n
Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)
\n\n T1 node types:\n cache.t1.micro\n
\n M1 node types:\n cache.m1.small, \n\t\t\t\t\t\t cache.m1.medium, \n\t\t\t\t\t\t cache.m1.large,\n\t\t\t\t\t\t cache.m1.xlarge\n
\n M3 node types:\n cache.m3.medium,\n \t\t\t\t\t\tcache.m3.large, \n \t\t\t\t\t\tcache.m3.xlarge,\n \t\t\t\t\t\tcache.m3.2xlarge\n
Compute optimized:
\nPrevious generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)
\n\n C1 node types:\n cache.c1.xlarge\n
Memory optimized:
\nCurrent generation:
\n\n R7g node types:\t\n\t\t\t\t\t\t\tcache.r7g.large,\n\t\t\t\t\t\t\tcache.r7g.xlarge,\n\t\t\t\t\t\t\tcache.r7g.2xlarge,\n\t\t\t\t\t\t\tcache.r7g.4xlarge,\n\t\t\t\t\t\t\tcache.r7g.8xlarge,\n\t\t\t\t\t\t\tcache.r7g.12xlarge,\n\t\t\t\t\t\t\tcache.r7g.16xlarge\n
For region availability, see Supported Node Types\n
\n\n R6g node types (available only for Redis OSS engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward):\n\t\t\t\t\t\t\tcache.r6g.large,\n\t\t\t\t\t\t\tcache.r6g.xlarge,\n\t\t\t\t\t\t\tcache.r6g.2xlarge,\n\t\t\t\t\t\t\tcache.r6g.4xlarge,\n\t\t\t\t\t\t\tcache.r6g.8xlarge,\n\t\t\t\t\t\t\tcache.r6g.12xlarge,\n\t\t\t\t\t\t\tcache.r6g.16xlarge\n
\n R5 node types:\n cache.r5.large,\n \t\t\t\t\t cache.r5.xlarge,\n \t\t\t\t\t cache.r5.2xlarge,\n \t\t\t\t\t cache.r5.4xlarge,\n \t\t\t\t\t cache.r5.12xlarge,\n \t\t\t\t\t cache.r5.24xlarge\n
\n R4 node types:\n cache.r4.large,\n \t\t\t\t\t cache.r4.xlarge,\n \t\t\t\t\t cache.r4.2xlarge,\n \t\t\t\t\t cache.r4.4xlarge,\n \t\t\t\t\t cache.r4.8xlarge,\n \t\t\t\t\t cache.r4.16xlarge\n
Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)
\n\n M2 node types:\n cache.m2.xlarge, \n \t\t\t\t\t\tcache.m2.2xlarge,\n \t\t\t\t\t\tcache.m2.4xlarge\n
\n R3 node types:\n cache.r3.large, \n \t\t\t\t\t\tcache.r3.xlarge,\n \t\t\t\t\t\tcache.r3.2xlarge, \n \t\t\t\t\t\tcache.r3.4xlarge,\n \t\t\t\t\t\tcache.r3.8xlarge\n
\n Additional node type info\n
\nAll current generation instance types are created in Amazon VPC by\n default.
\nValkey or Redis OSS append-only files (AOF) are not supported for T1 or T2 instances.
\nValkey or Redis OSS Multi-AZ with automatic failover is not supported on T1\n instances.
\nThe configuration variables appendonly and\n appendfsync are not supported on Valkey, or on Redis OSS version 2.8.22 and\n later.
Duration filter value, specified in years or seconds. Use this parameter to show only\n reservations for a given duration.
\nValid Values: 1 | 3 | 31536000 | 94608000\n
The product description filter value. Use this parameter to show only the available\n offerings matching the specified product description.
" } }, "OfferingType": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "The offering type filter value. Use this parameter to show only the available\n offerings matching the specified offering type.
\nValid Values: \"Light Utilization\"|\"Medium Utilization\"|\"Heavy Utilization\" |\"All\n Upfront\"|\"Partial Upfront\"| \"No Upfront\"\n
The maximum number of records to include in the response. If more records exist than\n the specified MaxRecords value, a marker is included in the response so\n that the remaining results can be retrieved.
Default: 100
\nConstraints: minimum 20; maximum 100.
" } }, "Marker": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "An optional marker returned from a prior request. Use this marker for pagination of\n results from this operation. If this parameter is specified, the response includes only\n records beyond the marker, up to the value specified by MaxRecords.
Represents the input of a DescribeReservedCacheNodesOfferings\n operation.
Returns information about serverless cache snapshots. \n By default, this API lists all of the customer\u2019s serverless cache snapshots. \n It can also describe a single serverless cache snapshot, or the snapshots associated with \n a particular serverless cache. Available for Valkey, Redis OSS and Serverless Memcached only.
", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "items": "ServerlessCacheSnapshots", "pageSize": "MaxResults" } } }, "com.amazonaws.elasticache#DescribeServerlessCacheSnapshotsRequest": { "type": "structure", "members": { "ServerlessCacheName": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "The identifier of serverless cache. If this parameter is specified, \n only snapshots associated with that specific serverless cache are described. Available for Valkey, Redis OSS and Serverless Memcached only.
" } }, "ServerlessCacheSnapshotName": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "The identifier of the serverless cache\u2019s snapshot.\n If this parameter is specified, only this snapshot is described. Available for Valkey, Redis OSS and Serverless Memcached only.
" } }, "SnapshotType": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "The type of snapshot that is being described. Available for Valkey, Redis OSS and Serverless Memcached only.
" } }, "NextToken": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "An optional marker returned from a prior request to support pagination of results from this operation. \n If this parameter is specified, the response includes only records beyond the marker, \n up to the value specified by max-results. Available for Valkey, Redis OSS and Serverless Memcached only.
" } }, "MaxResults": { "target": "com.amazonaws.elasticache#IntegerOptional", "traits": { "smithy.api#documentation": "The maximum number of records to include in the response. If more records exist than \n the specified max-results value, a market is included in the response so that remaining results \n can be retrieved. Available for Valkey, Redis OSS and Serverless Memcached only.The default is 50. The Validation Constraints are a maximum of 50.
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.elasticache#DescribeServerlessCacheSnapshotsResponse": { "type": "structure", "members": { "NextToken": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "An optional marker returned from a prior request to support pagination of results from this operation. \n If this parameter is specified, the response includes only records beyond the marker, \n up to the value specified by max-results. Available for Valkey, Redis OSS and Serverless Memcached only.
" } }, "ServerlessCacheSnapshots": { "target": "com.amazonaws.elasticache#ServerlessCacheSnapshotList", "traits": { "smithy.api#documentation": "The serverless caches snapshots associated with a given description request. Available for Valkey, Redis OSS and Serverless Memcached only.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.elasticache#DescribeServerlessCaches": { "type": "operation", "input": { "target": "com.amazonaws.elasticache#DescribeServerlessCachesRequest" }, "output": { "target": "com.amazonaws.elasticache#DescribeServerlessCachesResponse" }, "errors": [ { "target": "com.amazonaws.elasticache#InvalidParameterCombinationException" }, { "target": "com.amazonaws.elasticache#InvalidParameterValueException" }, { "target": "com.amazonaws.elasticache#ServerlessCacheNotFoundFault" } ], "traits": { "smithy.api#documentation": "Returns information about a specific serverless cache. \n If no identifier is specified, then the API returns information on all the serverless caches belonging to \n this Amazon Web Services account.
", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "items": "ServerlessCaches", "pageSize": "MaxResults" } } }, "com.amazonaws.elasticache#DescribeServerlessCachesRequest": { "type": "structure", "members": { "ServerlessCacheName": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "The identifier for the serverless cache. If this parameter is specified, \n only information about that specific serverless cache is returned. Default: NULL
" } }, "MaxResults": { "target": "com.amazonaws.elasticache#IntegerOptional", "traits": { "smithy.api#documentation": "The maximum number of records in the response. If more records exist than the specified max-records value, \n the next token is included in the response so that remaining results can be retrieved. \n The default is 50.
" } }, "NextToken": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "An optional marker returned from a prior request to support pagination of results from this operation. \n If this parameter is specified, the response includes only records beyond the marker, \n up to the value specified by MaxResults.
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.elasticache#DescribeServerlessCachesResponse": { "type": "structure", "members": { "NextToken": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "An optional marker returned from a prior request to support pagination of results from this operation. \n If this parameter is specified, the response includes only records beyond the marker, \n up to the value specified by MaxResults.
" } }, "ServerlessCaches": { "target": "com.amazonaws.elasticache#ServerlessCacheList", "traits": { "smithy.api#documentation": "The serverless caches associated with a given description request.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.elasticache#DescribeServiceUpdates": { "type": "operation", "input": { "target": "com.amazonaws.elasticache#DescribeServiceUpdatesMessage" }, "output": { "target": "com.amazonaws.elasticache#ServiceUpdatesMessage" }, "errors": [ { "target": "com.amazonaws.elasticache#InvalidParameterCombinationException" }, { "target": "com.amazonaws.elasticache#InvalidParameterValueException" }, { "target": "com.amazonaws.elasticache#ServiceUpdateNotFoundFault" } ], "traits": { "smithy.api#documentation": "Returns details of the service updates
", "smithy.api#paginated": { "inputToken": "Marker", "outputToken": "Marker", "items": "ServiceUpdates", "pageSize": "MaxRecords" } } }, "com.amazonaws.elasticache#DescribeServiceUpdatesMessage": { "type": "structure", "members": { "ServiceUpdateName": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "The unique ID of the service update
" } }, "ServiceUpdateStatus": { "target": "com.amazonaws.elasticache#ServiceUpdateStatusList", "traits": { "smithy.api#documentation": "The status of the service update
" } }, "MaxRecords": { "target": "com.amazonaws.elasticache#IntegerOptional", "traits": { "smithy.api#documentation": "The maximum number of records to include in the response
" } }, "Marker": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "An optional marker returned from a prior request. Use this marker for pagination of\n results from this operation. If this parameter is specified, the response includes only\n records beyond the marker, up to the value specified by MaxRecords.
Returns information about cluster or replication group snapshots. By default,\n DescribeSnapshots lists all of your snapshots; it can optionally\n describe a single snapshot, or just the snapshots associated with a particular cache\n cluster.
This operation is valid for Valkey or Redis OSS only.
\nAn optional marker returned from a prior request. Use this marker for pagination of\n results from this operation. If this parameter is specified, the response includes only\n records beyond the marker, up to the value specified by MaxRecords.
A list of snapshots. Each item in the list contains detailed information about one\n snapshot.
" } } }, "traits": { "smithy.api#documentation": "Represents the output of a DescribeSnapshots operation.
A user-supplied replication group identifier. If this parameter is specified, only\n snapshots associated with that specific replication group are described.
" } }, "CacheClusterId": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "A user-supplied cluster identifier. If this parameter is specified, only snapshots\n associated with that specific cluster are described.
" } }, "SnapshotName": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "A user-supplied name of the snapshot. If this parameter is specified, only this\n snapshot are described.
" } }, "SnapshotSource": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "If set to system, the output shows snapshots that were automatically\n created by ElastiCache. If set to user the output shows snapshots that were\n manually created. If omitted, the output shows both automatically and manually created\n snapshots.
An optional marker returned from a prior request. Use this marker for pagination of\n results from this operation. If this parameter is specified, the response includes only\n records beyond the marker, up to the value specified by MaxRecords.
The maximum number of records to include in the response. If more records exist than\n the specified MaxRecords value, a marker is included in the response so\n that the remaining results can be retrieved.
Default: 50
\nConstraints: minimum 20; maximum 50.
" } }, "ShowNodeGroupConfig": { "target": "com.amazonaws.elasticache#BooleanOptional", "traits": { "smithy.api#documentation": "A Boolean value which if true, the node group (shard) configuration is included in the\n snapshot description.
" } } }, "traits": { "smithy.api#documentation": "Represents the input of a DescribeSnapshotsMessage operation.
Returns details of the update actions
", "smithy.api#paginated": { "inputToken": "Marker", "outputToken": "Marker", "items": "UpdateActions", "pageSize": "MaxRecords" } } }, "com.amazonaws.elasticache#DescribeUpdateActionsMessage": { "type": "structure", "members": { "ServiceUpdateName": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "The unique ID of the service update
" } }, "ReplicationGroupIds": { "target": "com.amazonaws.elasticache#ReplicationGroupIdList", "traits": { "smithy.api#documentation": "The replication group IDs
" } }, "CacheClusterIds": { "target": "com.amazonaws.elasticache#CacheClusterIdList", "traits": { "smithy.api#documentation": "The cache cluster IDs
" } }, "Engine": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "The Elasticache engine to which the update applies. Either Valkey, Redis OSS or Memcached.
" } }, "ServiceUpdateStatus": { "target": "com.amazonaws.elasticache#ServiceUpdateStatusList", "traits": { "smithy.api#documentation": "The status of the service update
" } }, "ServiceUpdateTimeRange": { "target": "com.amazonaws.elasticache#TimeRangeFilter", "traits": { "smithy.api#documentation": "The range of time specified to search for service updates that are in available\n status
" } }, "UpdateActionStatus": { "target": "com.amazonaws.elasticache#UpdateActionStatusList", "traits": { "smithy.api#documentation": "The status of the update action.
" } }, "ShowNodeLevelUpdateStatus": { "target": "com.amazonaws.elasticache#BooleanOptional", "traits": { "smithy.api#documentation": "Dictates whether to include node level update status in the response
" } }, "MaxRecords": { "target": "com.amazonaws.elasticache#IntegerOptional", "traits": { "smithy.api#documentation": "The maximum number of records to include in the response
" } }, "Marker": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "An optional marker returned from a prior request. Use this marker for pagination of\n results from this operation. If this parameter is specified, the response includes only\n records beyond the marker, up to the value specified by MaxRecords.
Returns a list of user groups.
", "smithy.api#paginated": { "inputToken": "Marker", "outputToken": "Marker", "items": "UserGroups", "pageSize": "MaxRecords" } } }, "com.amazonaws.elasticache#DescribeUserGroupsMessage": { "type": "structure", "members": { "UserGroupId": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "The ID of the user group.
" } }, "MaxRecords": { "target": "com.amazonaws.elasticache#IntegerOptional", "traits": { "smithy.api#documentation": "The maximum number of records to include in the response. If more records exist than\n the specified MaxRecords value, a marker is included in the response so that the\n remaining results can be retrieved.
" } }, "Marker": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "An optional marker returned from a prior request. Use this marker for pagination of\n results from this operation. If this parameter is specified, the response includes only\n records beyond the marker, up to the value specified by MaxRecords. >
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.elasticache#DescribeUserGroupsResult": { "type": "structure", "members": { "UserGroups": { "target": "com.amazonaws.elasticache#UserGroupList", "traits": { "smithy.api#documentation": "Returns a list of user groups.
" } }, "Marker": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "An optional marker returned from a prior request. Use this marker for pagination of\n results from this operation. If this parameter is specified, the response includes only\n records beyond the marker, up to the value specified by MaxRecords.>
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.elasticache#DescribeUsers": { "type": "operation", "input": { "target": "com.amazonaws.elasticache#DescribeUsersMessage" }, "output": { "target": "com.amazonaws.elasticache#DescribeUsersResult" }, "errors": [ { "target": "com.amazonaws.elasticache#InvalidParameterCombinationException" }, { "target": "com.amazonaws.elasticache#ServiceLinkedRoleNotFoundFault" }, { "target": "com.amazonaws.elasticache#UserNotFoundFault" } ], "traits": { "smithy.api#documentation": "Returns a list of users.
", "smithy.api#paginated": { "inputToken": "Marker", "outputToken": "Marker", "items": "Users", "pageSize": "MaxRecords" } } }, "com.amazonaws.elasticache#DescribeUsersMessage": { "type": "structure", "members": { "Engine": { "target": "com.amazonaws.elasticache#EngineType", "traits": { "smithy.api#documentation": "The engine.
" } }, "UserId": { "target": "com.amazonaws.elasticache#UserId", "traits": { "smithy.api#documentation": "The ID of the user.
" } }, "Filters": { "target": "com.amazonaws.elasticache#FilterList", "traits": { "smithy.api#documentation": "Filter to determine the list of User IDs to return.
" } }, "MaxRecords": { "target": "com.amazonaws.elasticache#IntegerOptional", "traits": { "smithy.api#documentation": "The maximum number of records to include in the response. If more records exist than\n the specified MaxRecords value, a marker is included in the response so that the\n remaining results can be retrieved.
" } }, "Marker": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "An optional marker returned from a prior request. Use this marker for pagination of\n results from this operation. If this parameter is specified, the response includes only\n records beyond the marker, up to the value specified by MaxRecords. >
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.elasticache#DescribeUsersResult": { "type": "structure", "members": { "Users": { "target": "com.amazonaws.elasticache#UserList", "traits": { "smithy.api#documentation": "A list of users.
" } }, "Marker": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "An optional marker returned from a prior request. Use this marker for pagination of\n results from this operation. If this parameter is specified, the response includes only\n records beyond the marker, up to the value specified by MaxRecords. >
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.elasticache#DestinationDetails": { "type": "structure", "members": { "CloudWatchLogsDetails": { "target": "com.amazonaws.elasticache#CloudWatchLogsDestinationDetails", "traits": { "smithy.api#documentation": "The configuration details of the CloudWatch Logs destination.
" } }, "KinesisFirehoseDetails": { "target": "com.amazonaws.elasticache#KinesisFirehoseDestinationDetails", "traits": { "smithy.api#documentation": "The configuration details of the Kinesis Data Firehose destination.
" } } }, "traits": { "smithy.api#documentation": "Configuration details of either a CloudWatch Logs destination or Kinesis Data Firehose\n destination.
" } }, "com.amazonaws.elasticache#DestinationType": { "type": "enum", "members": { "CloudWatchLogs": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "cloudwatch-logs" } }, "KinesisFirehose": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "kinesis-firehose" } } } }, "com.amazonaws.elasticache#DisassociateGlobalReplicationGroup": { "type": "operation", "input": { "target": "com.amazonaws.elasticache#DisassociateGlobalReplicationGroupMessage" }, "output": { "target": "com.amazonaws.elasticache#DisassociateGlobalReplicationGroupResult" }, "errors": [ { "target": "com.amazonaws.elasticache#GlobalReplicationGroupNotFoundFault" }, { "target": "com.amazonaws.elasticache#InvalidGlobalReplicationGroupStateFault" }, { "target": "com.amazonaws.elasticache#InvalidParameterCombinationException" }, { "target": "com.amazonaws.elasticache#InvalidParameterValueException" } ], "traits": { "smithy.api#documentation": "Remove a secondary cluster from the Global datastore using the Global datastore name.\n The secondary cluster will no longer receive updates from the primary cluster, but will\n remain as a standalone cluster in that Amazon region.
" } }, "com.amazonaws.elasticache#DisassociateGlobalReplicationGroupMessage": { "type": "structure", "members": { "GlobalReplicationGroupId": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The name of the Global datastore
", "smithy.api#required": {} } }, "ReplicationGroupId": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The name of the secondary cluster you wish to remove from the Global datastore
", "smithy.api#required": {} } }, "ReplicationGroupRegion": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The Amazon region of secondary cluster you wish to remove from the Global\n datastore
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.elasticache#DisassociateGlobalReplicationGroupResult": { "type": "structure", "members": { "GlobalReplicationGroup": { "target": "com.amazonaws.elasticache#GlobalReplicationGroup" } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.elasticache#Double": { "type": "double" }, "com.amazonaws.elasticache#DuplicateUserNameFault": { "type": "structure", "members": { "message": { "target": "com.amazonaws.elasticache#ExceptionMessage" } }, "traits": { "aws.protocols#awsQueryError": { "code": "DuplicateUserName", "httpResponseCode": 400 }, "smithy.api#documentation": "A user with this username already exists.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.elasticache#Durability": { "type": "enum", "members": { "DEFAULT": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "default" } }, "ASYNC": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "async" } }, "SYNC": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "sync" } }, "DISABLED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "disabled" } } } }, "com.amazonaws.elasticache#EC2SecurityGroup": { "type": "structure", "members": { "Status": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "The status of the Amazon EC2 security group.
" } }, "EC2SecurityGroupName": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "The name of the Amazon EC2 security group.
" } }, "EC2SecurityGroupOwnerId": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "The Amazon account ID of the Amazon EC2 security group owner.
" } } }, "traits": { "smithy.api#documentation": "Provides ownership and status information for an Amazon EC2 security group.
" } }, "com.amazonaws.elasticache#EC2SecurityGroupList": { "type": "list", "member": { "target": "com.amazonaws.elasticache#EC2SecurityGroup", "traits": { "smithy.api#xmlName": "EC2SecurityGroup" } } }, "com.amazonaws.elasticache#ECPUPerSecond": { "type": "structure", "members": { "Maximum": { "target": "com.amazonaws.elasticache#IntegerOptional", "traits": { "smithy.api#documentation": "The configuration for the maximum number of ECPUs the cache can consume per second.
" } }, "Minimum": { "target": "com.amazonaws.elasticache#IntegerOptional", "traits": { "smithy.api#documentation": "The configuration for the minimum number of ECPUs the cache should be able consume per second.
" } } }, "traits": { "smithy.api#documentation": "The configuration for the number of ElastiCache Processing Units (ECPU) the cache can consume per second.
" } }, "com.amazonaws.elasticache#EffectiveDurability": { "type": "enum", "members": { "ASYNC": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "async" } }, "SYNC": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "sync" } }, "DISABLED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "disabled" } } } }, "com.amazonaws.elasticache#Endpoint": { "type": "structure", "members": { "Address": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "The DNS hostname of the cache node.
" } }, "Port": { "target": "com.amazonaws.elasticache#Integer", "traits": { "smithy.api#documentation": "The port number that the cache engine is listening on.
" } } }, "traits": { "smithy.api#documentation": "Represents the information required for client programs to connect to a cache\n node. This value is read-only.
" } }, "com.amazonaws.elasticache#EngineDefaults": { "type": "structure", "members": { "CacheParameterGroupFamily": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "Specifies the name of the cache parameter group family to which the engine default\n parameters apply.
\nValid values are: memcached1.4 | memcached1.5 |\n memcached1.6 | redis2.6 | redis2.8 |\n redis3.2 | redis4.0 | redis5.0 |\n redis6.0 | redis6.x | redis7\n
Provides an identifier to allow retrieval of paginated results.
" } }, "Parameters": { "target": "com.amazonaws.elasticache#ParametersList", "traits": { "smithy.api#documentation": "Contains a list of engine default parameters.
" } }, "CacheNodeTypeSpecificParameters": { "target": "com.amazonaws.elasticache#CacheNodeTypeSpecificParametersList", "traits": { "smithy.api#documentation": "A list of parameters specific to a particular cache node type. Each element in the\n list contains detailed information about one parameter.
" } } }, "traits": { "smithy.api#documentation": "Represents the output of a DescribeEngineDefaultParameters\n operation.
The identifier for the source of the event. For example, if the event occurred at the\n cluster level, the identifier would be the name of the cluster.
" } }, "SourceType": { "target": "com.amazonaws.elasticache#SourceType", "traits": { "smithy.api#documentation": "Specifies the origin of this event - a cluster, a parameter group, a security group,\n etc.
" } }, "Message": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "The text of the event.
" } }, "Date": { "target": "com.amazonaws.elasticache#TStamp", "traits": { "smithy.api#documentation": "The date and time when the event occurred.
" } } }, "traits": { "smithy.api#documentation": "Represents a single occurrence of something interesting within the system. Some\n examples of events are creating a cluster, adding or removing a cache node, or rebooting\n a node.
" } }, "com.amazonaws.elasticache#EventList": { "type": "list", "member": { "target": "com.amazonaws.elasticache#Event", "traits": { "smithy.api#xmlName": "Event" } } }, "com.amazonaws.elasticache#EventsMessage": { "type": "structure", "members": { "Marker": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "Provides an identifier to allow retrieval of paginated results.
" } }, "Events": { "target": "com.amazonaws.elasticache#EventList", "traits": { "smithy.api#documentation": "A list of events. Each element in the list contains detailed information about one\n event.
" } } }, "traits": { "smithy.api#documentation": "Represents the output of a DescribeEvents operation.
Provides the functionality to export the serverless cache snapshot data to Amazon S3. Available for Valkey and Redis OSS only.
" } }, "com.amazonaws.elasticache#ExportServerlessCacheSnapshotRequest": { "type": "structure", "members": { "ServerlessCacheSnapshotName": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The identifier of the serverless cache snapshot to be exported to S3. Available for Valkey and Redis OSS only.
", "smithy.api#required": {} } }, "S3BucketName": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "Name of the Amazon S3 bucket to export the snapshot to. The Amazon S3 bucket must also be in same region \n as the snapshot. Available for Valkey and Redis OSS only.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.elasticache#ExportServerlessCacheSnapshotResponse": { "type": "structure", "members": { "ServerlessCacheSnapshot": { "target": "com.amazonaws.elasticache#ServerlessCacheSnapshot", "traits": { "smithy.api#documentation": "The state of a serverless cache at a specific point in time, to the millisecond. Available for Valkey, Redis OSS and Serverless Memcached only.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.elasticache#FailoverGlobalReplicationGroup": { "type": "operation", "input": { "target": "com.amazonaws.elasticache#FailoverGlobalReplicationGroupMessage" }, "output": { "target": "com.amazonaws.elasticache#FailoverGlobalReplicationGroupResult" }, "errors": [ { "target": "com.amazonaws.elasticache#GlobalReplicationGroupNotFoundFault" }, { "target": "com.amazonaws.elasticache#InvalidGlobalReplicationGroupStateFault" }, { "target": "com.amazonaws.elasticache#InvalidParameterCombinationException" }, { "target": "com.amazonaws.elasticache#InvalidParameterValueException" } ], "traits": { "smithy.api#documentation": "Used to failover the primary region to a secondary region. The secondary region will\n become primary, and all other clusters will become secondary.
" } }, "com.amazonaws.elasticache#FailoverGlobalReplicationGroupMessage": { "type": "structure", "members": { "GlobalReplicationGroupId": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The name of the Global datastore
", "smithy.api#required": {} } }, "PrimaryRegion": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The Amazon region of the primary cluster of the Global datastore
", "smithy.api#required": {} } }, "PrimaryReplicationGroupId": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The name of the primary replication group
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.elasticache#FailoverGlobalReplicationGroupResult": { "type": "structure", "members": { "GlobalReplicationGroup": { "target": "com.amazonaws.elasticache#GlobalReplicationGroup" } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.elasticache#Filter": { "type": "structure", "members": { "Name": { "target": "com.amazonaws.elasticache#FilterName", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The property being filtered. For example, UserId.
", "smithy.api#required": {} } }, "Values": { "target": "com.amazonaws.elasticache#FilterValueList", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The property values to filter on. For example, \"user-123\".
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Used to streamline results of a search based on the property being filtered.
" } }, "com.amazonaws.elasticache#FilterList": { "type": "list", "member": { "target": "com.amazonaws.elasticache#Filter" } }, "com.amazonaws.elasticache#FilterName": { "type": "string", "traits": { "smithy.api#pattern": "\\S" } }, "com.amazonaws.elasticache#FilterValue": { "type": "string", "traits": { "smithy.api#pattern": "\\S" } }, "com.amazonaws.elasticache#FilterValueList": { "type": "list", "member": { "target": "com.amazonaws.elasticache#FilterValue" }, "traits": { "smithy.api#length": { "min": 1 } } }, "com.amazonaws.elasticache#GlobalNodeGroup": { "type": "structure", "members": { "GlobalNodeGroupId": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "The name of the global node group
" } }, "Slots": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "The keyspace for this node group
" } } }, "traits": { "smithy.api#documentation": "Indicates the slot configuration and global identifier for a slice group.
" } }, "com.amazonaws.elasticache#GlobalNodeGroupIdList": { "type": "list", "member": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#xmlName": "GlobalNodeGroupId" } } }, "com.amazonaws.elasticache#GlobalNodeGroupList": { "type": "list", "member": { "target": "com.amazonaws.elasticache#GlobalNodeGroup", "traits": { "smithy.api#xmlName": "GlobalNodeGroup" } } }, "com.amazonaws.elasticache#GlobalReplicationGroup": { "type": "structure", "members": { "GlobalReplicationGroupId": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "The name of the Global datastore
" } }, "GlobalReplicationGroupDescription": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "The optional description of the Global datastore
" } }, "Status": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "The status of the Global datastore
" } }, "CacheNodeType": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "The cache node type of the Global datastore
" } }, "Engine": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "The ElastiCache engine. For Valkey or Redis OSS only.
" } }, "EngineVersion": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "The ElastiCache engine version.
" } }, "Members": { "target": "com.amazonaws.elasticache#GlobalReplicationGroupMemberList", "traits": { "smithy.api#documentation": "The replication groups that comprise the Global datastore.
" } }, "ClusterEnabled": { "target": "com.amazonaws.elasticache#BooleanOptional", "traits": { "smithy.api#documentation": "A flag that indicates whether the Global datastore is cluster enabled.
" } }, "GlobalNodeGroups": { "target": "com.amazonaws.elasticache#GlobalNodeGroupList", "traits": { "smithy.api#documentation": "Indicates the slot configuration and global identifier for each slice group.
" } }, "AuthTokenEnabled": { "target": "com.amazonaws.elasticache#BooleanOptional", "traits": { "smithy.api#documentation": "A flag that enables using an AuthToken (password) when issuing Valkey or Redis OSS \n commands.
Default: false\n
A flag that enables in-transit encryption when set to true.
\n\n Required: Only available when creating a replication\n group in an Amazon VPC using Redis OSS version 3.2.6, 4.x or\n later.
A flag that enables encryption at rest when set to true.
You cannot modify the value of AtRestEncryptionEnabled after the\n replication group is created. To enable encryption at rest on a replication group you\n must set AtRestEncryptionEnabled to true when you create the\n replication group.
\n Required: Only available when creating a replication\n group in an Amazon VPC using Redis OSS version 3.2.6, 4.x or\n later.
The ARN (Amazon Resource Name) of the global replication group.
" } } }, "traits": { "smithy.api#documentation": "Consists of a primary cluster that accepts writes and an associated secondary cluster\n that resides in a different Amazon region. The secondary cluster accepts only reads. The\n primary cluster automatically replicates updates to the secondary cluster.
\nThe GlobalReplicationGroupIdSuffix represents\n the name of the Global datastore, which is what you use to associate a secondary\n cluster.
\nThe Global datastore name already exists.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.elasticache#GlobalReplicationGroupInfo": { "type": "structure", "members": { "GlobalReplicationGroupId": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "The name of the Global datastore
" } }, "GlobalReplicationGroupMemberRole": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "The role of the replication group in a Global datastore. Can be primary or\n secondary.
" } } }, "traits": { "smithy.api#documentation": "The name of the Global datastore and role of this replication group in the Global\n datastore.
" } }, "com.amazonaws.elasticache#GlobalReplicationGroupList": { "type": "list", "member": { "target": "com.amazonaws.elasticache#GlobalReplicationGroup", "traits": { "smithy.api#xmlName": "GlobalReplicationGroup" } } }, "com.amazonaws.elasticache#GlobalReplicationGroupMember": { "type": "structure", "members": { "ReplicationGroupId": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "The replication group id of the Global datastore member.
" } }, "ReplicationGroupRegion": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "The Amazon region of the Global datastore member.
" } }, "Role": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "Indicates the role of the replication group, primary or secondary.
" } }, "AutomaticFailover": { "target": "com.amazonaws.elasticache#AutomaticFailoverStatus", "traits": { "smithy.api#documentation": "Indicates whether automatic failover is enabled for the replication group.
" } }, "Status": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "The status of the membership of the replication group.
" } } }, "traits": { "smithy.api#documentation": "A member of a Global datastore. It contains the Replication Group Id, the Amazon\n region and the role of the replication group.
" } }, "com.amazonaws.elasticache#GlobalReplicationGroupMemberList": { "type": "list", "member": { "target": "com.amazonaws.elasticache#GlobalReplicationGroupMember", "traits": { "smithy.api#xmlName": "GlobalReplicationGroupMember" } } }, "com.amazonaws.elasticache#GlobalReplicationGroupNotFoundFault": { "type": "structure", "members": { "message": { "target": "com.amazonaws.elasticache#ExceptionMessage" } }, "traits": { "aws.protocols#awsQueryError": { "code": "GlobalReplicationGroupNotFoundFault", "httpResponseCode": 404 }, "smithy.api#documentation": "The Global datastore does not exist
", "smithy.api#error": "client", "smithy.api#httpError": 404 } }, "com.amazonaws.elasticache#IncreaseNodeGroupsInGlobalReplicationGroup": { "type": "operation", "input": { "target": "com.amazonaws.elasticache#IncreaseNodeGroupsInGlobalReplicationGroupMessage" }, "output": { "target": "com.amazonaws.elasticache#IncreaseNodeGroupsInGlobalReplicationGroupResult" }, "errors": [ { "target": "com.amazonaws.elasticache#GlobalReplicationGroupNotFoundFault" }, { "target": "com.amazonaws.elasticache#InvalidGlobalReplicationGroupStateFault" }, { "target": "com.amazonaws.elasticache#InvalidParameterValueException" } ], "traits": { "smithy.api#documentation": "Increase the number of node groups in the Global datastore
" } }, "com.amazonaws.elasticache#IncreaseNodeGroupsInGlobalReplicationGroupMessage": { "type": "structure", "members": { "GlobalReplicationGroupId": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The name of the Global datastore
", "smithy.api#required": {} } }, "NodeGroupCount": { "target": "com.amazonaws.elasticache#Integer", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "Total number of node groups you want
", "smithy.api#required": {} } }, "RegionalConfigurations": { "target": "com.amazonaws.elasticache#RegionalConfigurationList", "traits": { "smithy.api#documentation": "Describes the replication group IDs, the Amazon regions where they are stored and the\n shard configuration for each that comprise the Global datastore
" } }, "ApplyImmediately": { "target": "com.amazonaws.elasticache#Boolean", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "Indicates that the process begins immediately. At present, the only permitted value\n for this parameter is true.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.elasticache#IncreaseNodeGroupsInGlobalReplicationGroupResult": { "type": "structure", "members": { "GlobalReplicationGroup": { "target": "com.amazonaws.elasticache#GlobalReplicationGroup" } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.elasticache#IncreaseReplicaCount": { "type": "operation", "input": { "target": "com.amazonaws.elasticache#IncreaseReplicaCountMessage" }, "output": { "target": "com.amazonaws.elasticache#IncreaseReplicaCountResult" }, "errors": [ { "target": "com.amazonaws.elasticache#ClusterQuotaForCustomerExceededFault" }, { "target": "com.amazonaws.elasticache#InsufficientCacheClusterCapacityFault" }, { "target": "com.amazonaws.elasticache#InvalidCacheClusterStateFault" }, { "target": "com.amazonaws.elasticache#InvalidKMSKeyFault" }, { "target": "com.amazonaws.elasticache#InvalidParameterCombinationException" }, { "target": "com.amazonaws.elasticache#InvalidParameterValueException" }, { "target": "com.amazonaws.elasticache#InvalidReplicationGroupStateFault" }, { "target": "com.amazonaws.elasticache#InvalidVPCNetworkStateFault" }, { "target": "com.amazonaws.elasticache#NodeGroupsPerReplicationGroupQuotaExceededFault" }, { "target": "com.amazonaws.elasticache#NodeQuotaForCustomerExceededFault" }, { "target": "com.amazonaws.elasticache#NoOperationFault" }, { "target": "com.amazonaws.elasticache#ReplicationGroupNotFoundFault" } ], "traits": { "smithy.api#documentation": "Dynamically increases the number of replicas in a Valkey or Redis OSS (cluster mode disabled)\n replication group or the number of replica nodes in one or more node groups (shards) of\n a Valkey or Redis OSS (cluster mode enabled) replication group. This operation is performed with no\n cluster down time.
" } }, "com.amazonaws.elasticache#IncreaseReplicaCountMessage": { "type": "structure", "members": { "ReplicationGroupId": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The id of the replication group to which you want to add replica nodes.
", "smithy.api#required": {} } }, "NewReplicaCount": { "target": "com.amazonaws.elasticache#IntegerOptional", "traits": { "smithy.api#documentation": "The number of read replica nodes you want at the completion of this operation. For Valkey or Redis OSS (cluster mode disabled) replication groups, this is the number of replica nodes in\n the replication group. For Valkey or Redis OSS (cluster mode enabled) replication groups, this is the\n number of replica nodes in each of the replication group's node groups.
" } }, "ReplicaConfiguration": { "target": "com.amazonaws.elasticache#ReplicaConfigurationList", "traits": { "smithy.api#documentation": "A list of ConfigureShard objects that can be used to configure each\n shard in a Valkey or Redis OSS (cluster mode enabled) replication group. The\n ConfigureShard has three members: NewReplicaCount,\n NodeGroupId, and PreferredAvailabilityZones.
If True, the number of replica nodes is increased immediately.\n ApplyImmediately=False is not currently supported.
The requested cache node type is not available in the specified Availability Zone. For\n more information, see InsufficientCacheClusterCapacity in the ElastiCache User Guide.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.elasticache#Integer": { "type": "integer" }, "com.amazonaws.elasticache#IntegerOptional": { "type": "integer" }, "com.amazonaws.elasticache#Integration": { "type": "structure", "members": { "IntegrationType": { "target": "com.amazonaws.elasticache#IntegrationType", "traits": { "smithy.api#documentation": "The integration type. ElastiCache supports dynamodb.
The current status of the integration. Valid values are:
\n\n enabled \u2013 The integration is enabled.
\n disabled \u2013 The integration is disabled.
An integration configured on the serverless cache, and its current status.\n ElastiCache supports DynamoDB integration.
" } }, "com.amazonaws.elasticache#IntegrationList": { "type": "list", "member": { "target": "com.amazonaws.elasticache#Integration", "traits": { "smithy.api#xmlName": "Integration" } } }, "com.amazonaws.elasticache#IntegrationRequest": { "type": "structure", "members": { "IntegrationType": { "target": "com.amazonaws.elasticache#IntegrationType", "traits": { "smithy.api#documentation": "The integration type to enable.\n Must be dynamodb.
Specifies an integration to enable on the serverless cache when you create it.
" } }, "com.amazonaws.elasticache#IntegrationRequestList": { "type": "list", "member": { "target": "com.amazonaws.elasticache#IntegrationRequest", "traits": { "smithy.api#xmlName": "IntegrationRequest" } } }, "com.amazonaws.elasticache#IntegrationStatus": { "type": "enum", "members": { "ENABLED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "enabled" } }, "DISABLED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "disabled" } }, "ENABLING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "enabling" } }, "DISABLING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "disabling" } }, "FAILED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "failed" } } } }, "com.amazonaws.elasticache#IntegrationType": { "type": "enum", "members": { "DYNAMODB": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "dynamodb" } } } }, "com.amazonaws.elasticache#InvalidARNFault": { "type": "structure", "members": { "message": { "target": "com.amazonaws.elasticache#ExceptionMessage" } }, "traits": { "aws.protocols#awsQueryError": { "code": "InvalidARN", "httpResponseCode": 400 }, "smithy.api#documentation": "The requested Amazon Resource Name (ARN) does not refer to an existing\n resource.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.elasticache#InvalidCacheClusterStateFault": { "type": "structure", "members": { "message": { "target": "com.amazonaws.elasticache#ExceptionMessage" } }, "traits": { "aws.protocols#awsQueryError": { "code": "InvalidCacheClusterState", "httpResponseCode": 400 }, "smithy.api#documentation": "The requested cluster is not in the available state.
The current state of the cache parameter group does not allow the requested operation\n to occur.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.elasticache#InvalidCacheSecurityGroupStateFault": { "type": "structure", "members": { "message": { "target": "com.amazonaws.elasticache#ExceptionMessage" } }, "traits": { "aws.protocols#awsQueryError": { "code": "InvalidCacheSecurityGroupState", "httpResponseCode": 400 }, "smithy.api#documentation": "The current state of the cache security group does not allow deletion.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.elasticache#InvalidCredentialsException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.elasticache#ExceptionMessage" } }, "traits": { "aws.protocols#awsQueryError": { "code": "InvalidCredentialsException", "httpResponseCode": 408 }, "smithy.api#documentation": "You must enter valid credentials.
", "smithy.api#error": "client", "smithy.api#httpError": 408 } }, "com.amazonaws.elasticache#InvalidGlobalReplicationGroupStateFault": { "type": "structure", "members": { "message": { "target": "com.amazonaws.elasticache#ExceptionMessage" } }, "traits": { "aws.protocols#awsQueryError": { "code": "InvalidGlobalReplicationGroupState", "httpResponseCode": 400 }, "smithy.api#documentation": "The Global datastore is not available or in primary-only state.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.elasticache#InvalidKMSKeyFault": { "type": "structure", "members": { "message": { "target": "com.amazonaws.elasticache#ExceptionMessage" } }, "traits": { "aws.protocols#awsQueryError": { "code": "InvalidKMSKeyFault", "httpResponseCode": 400 }, "smithy.api#documentation": "The KMS key supplied is not valid.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.elasticache#InvalidParameterCombinationException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.elasticache#AwsQueryErrorMessage", "traits": { "smithy.api#documentation": "Two or more parameters that must not be used together were used together.
" } } }, "traits": { "aws.protocols#awsQueryError": { "code": "InvalidParameterCombination", "httpResponseCode": 400 }, "smithy.api#documentation": "Two or more incompatible parameters were specified.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.elasticache#InvalidParameterValueException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.elasticache#AwsQueryErrorMessage", "traits": { "smithy.api#documentation": "A parameter value is invalid.
" } } }, "traits": { "aws.protocols#awsQueryError": { "code": "InvalidParameterValue", "httpResponseCode": 400 }, "smithy.api#documentation": "The value for a parameter is invalid.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.elasticache#InvalidReplicationGroupStateFault": { "type": "structure", "members": { "message": { "target": "com.amazonaws.elasticache#ExceptionMessage" } }, "traits": { "aws.protocols#awsQueryError": { "code": "InvalidReplicationGroupState", "httpResponseCode": 400 }, "smithy.api#documentation": "The requested replication group is not in the available state.
The state of the serverless cache snapshot was not received. Available for Valkey, Redis OSS and Serverless Memcached only.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.elasticache#InvalidServerlessCacheStateFault": { "type": "structure", "members": { "message": { "target": "com.amazonaws.elasticache#ExceptionMessage" } }, "traits": { "aws.protocols#awsQueryError": { "code": "InvalidServerlessCacheStateFault", "httpResponseCode": 400 }, "smithy.api#documentation": "The account for these credentials is not currently active.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.elasticache#InvalidSnapshotStateFault": { "type": "structure", "members": { "message": { "target": "com.amazonaws.elasticache#ExceptionMessage" } }, "traits": { "aws.protocols#awsQueryError": { "code": "InvalidSnapshotState", "httpResponseCode": 400 }, "smithy.api#documentation": "The current state of the snapshot does not allow the requested operation to\n occur.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.elasticache#InvalidSubnet": { "type": "structure", "members": { "message": { "target": "com.amazonaws.elasticache#ExceptionMessage" } }, "traits": { "aws.protocols#awsQueryError": { "code": "InvalidSubnet", "httpResponseCode": 400 }, "smithy.api#documentation": "An invalid subnet identifier was specified.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.elasticache#InvalidUserGroupStateFault": { "type": "structure", "members": { "message": { "target": "com.amazonaws.elasticache#ExceptionMessage" } }, "traits": { "aws.protocols#awsQueryError": { "code": "InvalidUserGroupState", "httpResponseCode": 400 }, "smithy.api#documentation": "The user group is not in an active state.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.elasticache#InvalidUserStateFault": { "type": "structure", "members": { "message": { "target": "com.amazonaws.elasticache#ExceptionMessage" } }, "traits": { "aws.protocols#awsQueryError": { "code": "InvalidUserState", "httpResponseCode": 400 }, "smithy.api#documentation": "The user is not in active state.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.elasticache#InvalidVPCNetworkStateFault": { "type": "structure", "members": { "message": { "target": "com.amazonaws.elasticache#ExceptionMessage" } }, "traits": { "aws.protocols#awsQueryError": { "code": "InvalidVPCNetworkStateFault", "httpResponseCode": 400 }, "smithy.api#documentation": "The VPC network is in an invalid state.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.elasticache#IpDiscovery": { "type": "enum", "members": { "IPV4": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ipv4" } }, "IPV6": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ipv6" } } } }, "com.amazonaws.elasticache#KeyList": { "type": "list", "member": { "target": "com.amazonaws.elasticache#String" } }, "com.amazonaws.elasticache#KinesisFirehoseDestinationDetails": { "type": "structure", "members": { "DeliveryStream": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "The name of the Kinesis Data Firehose delivery stream.
" } } }, "traits": { "smithy.api#documentation": "The configuration details of the Kinesis Data Firehose destination.
" } }, "com.amazonaws.elasticache#ListAllowedNodeTypeModifications": { "type": "operation", "input": { "target": "com.amazonaws.elasticache#ListAllowedNodeTypeModificationsMessage" }, "output": { "target": "com.amazonaws.elasticache#AllowedNodeTypeModificationsMessage" }, "errors": [ { "target": "com.amazonaws.elasticache#CacheClusterNotFoundFault" }, { "target": "com.amazonaws.elasticache#InvalidParameterCombinationException" }, { "target": "com.amazonaws.elasticache#InvalidParameterValueException" }, { "target": "com.amazonaws.elasticache#ReplicationGroupNotFoundFault" } ], "traits": { "smithy.api#documentation": "Lists all available node types that you can scale with your cluster's replication\n group's current node type.
\nWhen you use the ModifyCacheCluster or\n ModifyReplicationGroup operations to scale your cluster or replication\n group, the value of the CacheNodeType parameter must be one of the node\n types returned by this operation.
The name of the cluster you want to scale up to a larger node instanced type.\n ElastiCache uses the cluster id to identify the current node type of this cluster and\n from that to create a list of node types you can scale up to.
\nYou must provide a value for either the CacheClusterId or the\n ReplicationGroupId.
The name of the replication group want to scale up to a larger node type. ElastiCache\n uses the replication group id to identify the current node type being used by this\n replication group, and from that to create a list of node types you can scale up\n to.
\nYou must provide a value for either the CacheClusterId or the\n ReplicationGroupId.
The input parameters for the ListAllowedNodeTypeModifications\n operation.
Lists all tags currently on a named resource.
\nA tag is a key-value pair where the key and value are case-sensitive. You can use\n tags to categorize and track all your ElastiCache resources.\n When you add or remove tags on replication groups, those\n actions will be replicated to all nodes in the replication group. For more information,\n see Resource-level permissions.
\nIf the cluster is not in the available state,\n ListTagsForResource returns an error.
The Amazon Resource Name (ARN) of the resource for which you want the list of tags,\n for example arn:aws:elasticache:us-west-2:0123456789:cluster:myCluster or\n arn:aws:elasticache:us-west-2:0123456789:snapshot:mySnapshot.
For more information about ARNs, see Amazon Resource Names (ARNs)\n and Amazon Web\n Services Service Namespaces.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "The input parameters for the ListTagsForResource operation.
Refers to slow-log or\n engine-log.
" } }, "DestinationType": { "target": "com.amazonaws.elasticache#DestinationType", "traits": { "smithy.api#documentation": "Returns the destination type, either cloudwatch-logs or\n kinesis-firehose.
Configuration details of either a CloudWatch Logs destination or Kinesis Data Firehose\n destination.
" } }, "LogFormat": { "target": "com.amazonaws.elasticache#LogFormat", "traits": { "smithy.api#documentation": "Returns the log format, either JSON or TEXT.
" } }, "Status": { "target": "com.amazonaws.elasticache#LogDeliveryConfigurationStatus", "traits": { "smithy.api#documentation": "Returns the log delivery configuration status. Values are one of enabling\n | disabling | modifying | active |\n error\n
Returns an error message for the log delivery configuration.
" } } }, "traits": { "smithy.api#documentation": "Returns the destination, format and type of the logs.
" } }, "com.amazonaws.elasticache#LogDeliveryConfigurationList": { "type": "list", "member": { "target": "com.amazonaws.elasticache#LogDeliveryConfiguration", "traits": { "smithy.api#xmlName": "LogDeliveryConfiguration" } } }, "com.amazonaws.elasticache#LogDeliveryConfigurationRequest": { "type": "structure", "members": { "LogType": { "target": "com.amazonaws.elasticache#LogType", "traits": { "smithy.api#documentation": "Refers to slow-log or\n engine-log..
" } }, "DestinationType": { "target": "com.amazonaws.elasticache#DestinationType", "traits": { "smithy.api#documentation": "Specify either cloudwatch-logs or kinesis-firehose as the\n destination type.
Configuration details of either a CloudWatch Logs destination or Kinesis Data Firehose\n destination.
" } }, "LogFormat": { "target": "com.amazonaws.elasticache#LogFormat", "traits": { "smithy.api#documentation": "Specifies either JSON or TEXT
" } }, "Enabled": { "target": "com.amazonaws.elasticache#BooleanOptional", "traits": { "smithy.api#documentation": "Specify if log delivery is enabled. Default true.
Specifies the destination, format and type of the logs.
" } }, "com.amazonaws.elasticache#LogDeliveryConfigurationRequestList": { "type": "list", "member": { "target": "com.amazonaws.elasticache#LogDeliveryConfigurationRequest", "traits": { "smithy.api#xmlName": "LogDeliveryConfigurationRequest" } } }, "com.amazonaws.elasticache#LogDeliveryConfigurationStatus": { "type": "enum", "members": { "ACTIVE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "active" } }, "ENABLING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "enabling" } }, "MODIFYING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "modifying" } }, "DISABLING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "disabling" } }, "ERROR": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "error" } } } }, "com.amazonaws.elasticache#LogFormat": { "type": "enum", "members": { "TEXT": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "text" } }, "JSON": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "json" } } } }, "com.amazonaws.elasticache#LogType": { "type": "enum", "members": { "SLOW_LOG": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "slow-log" } }, "ENGINE_LOG": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "engine-log" } } } }, "com.amazonaws.elasticache#MigrationHealthFault": { "type": "structure", "members": { "message": { "target": "com.amazonaws.elasticache#ExceptionMessage" } }, "traits": { "aws.protocols#awsQueryError": { "code": "MigrationHealthFault", "httpResponseCode": 400 }, "smithy.api#documentation": "The migration is not healthy. Check the events for this serverless cache for more details. For\n CompleteMigration, set Force to true to bypass this check.
The current status of the migration.
" } }, "MigrationEndpoint": { "target": "com.amazonaws.elasticache#Endpoint", "traits": { "smithy.api#documentation": "The migration endpoint, which is the standard endpoint of the serverless cache. Point your\n application at this endpoint during the migration. Until cutover, ElastiCache routes requests\n on this endpoint to your source.
" } }, "CutoverMode": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "The cutover configuration for the migration.
" } } }, "traits": { "smithy.api#documentation": "Provides a summary of the current migration status for a serverless cache.
" } }, "com.amazonaws.elasticache#ModifyCacheCluster": { "type": "operation", "input": { "target": "com.amazonaws.elasticache#ModifyCacheClusterMessage" }, "output": { "target": "com.amazonaws.elasticache#ModifyCacheClusterResult" }, "errors": [ { "target": "com.amazonaws.elasticache#CacheClusterNotFoundFault" }, { "target": "com.amazonaws.elasticache#CacheParameterGroupNotFoundFault" }, { "target": "com.amazonaws.elasticache#CacheSecurityGroupNotFoundFault" }, { "target": "com.amazonaws.elasticache#InsufficientCacheClusterCapacityFault" }, { "target": "com.amazonaws.elasticache#InvalidCacheClusterStateFault" }, { "target": "com.amazonaws.elasticache#InvalidCacheSecurityGroupStateFault" }, { "target": "com.amazonaws.elasticache#InvalidParameterCombinationException" }, { "target": "com.amazonaws.elasticache#InvalidParameterValueException" }, { "target": "com.amazonaws.elasticache#InvalidVPCNetworkStateFault" }, { "target": "com.amazonaws.elasticache#NodeQuotaForClusterExceededFault" }, { "target": "com.amazonaws.elasticache#NodeQuotaForCustomerExceededFault" } ], "traits": { "smithy.api#documentation": "Modifies the settings for a cluster. You can use this operation to change one or more\n cluster configuration parameters by specifying the parameters and the new values.
", "smithy.api#examples": [ { "title": "ModifyCacheCluster", "documentation": "Copies a snapshot to a specified name.", "input": { "CacheClusterId": "redis-cluster", "ApplyImmediately": true, "SnapshotRetentionLimit": 14 }, "output": { "CacheCluster": { "Engine": "redis", "CacheParameterGroup": { "CacheNodeIdsToReboot": [], "CacheParameterGroupName": "default.redis3.2", "ParameterApplyStatus": "in-sync" }, "SnapshotRetentionLimit": 14, "CacheClusterId": "redis-cluster", "CacheSecurityGroups": [], "NumCacheNodes": 1, "SnapshotWindow": "07:00-08:00", "CacheClusterCreateTime": "2016-12-22T16:27:56.078Z", "AutoMinorVersionUpgrade": true, "CacheClusterStatus": "available", "PreferredAvailabilityZone": "us-east-1e", "ClientDownloadLandingPage": "https://console.aws.amazon.com/elasticache/home#client-download:", "CacheSubnetGroupName": "default", "EngineVersion": "3.2.4", "PendingModifiedValues": {}, "PreferredMaintenanceWindow": "fri:09:00-fri:10:00", "CacheNodeType": "cache.r3.large" } } } ] } }, "com.amazonaws.elasticache#ModifyCacheClusterMessage": { "type": "structure", "members": { "CacheClusterId": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The cluster identifier. This value is stored as a lowercase string.
", "smithy.api#required": {} } }, "NumCacheNodes": { "target": "com.amazonaws.elasticache#IntegerOptional", "traits": { "smithy.api#documentation": "The number of cache nodes that the cluster should have. If the value for\n NumCacheNodes is greater than the sum of the number of current cache\n nodes and the number of cache nodes pending creation (which may be zero), more nodes are\n added. If the value is less than the number of existing cache nodes, nodes are removed.\n If the value is equal to the number of current cache nodes, any pending add or remove\n requests are canceled.
If you are removing cache nodes, you must use the CacheNodeIdsToRemove\n parameter to provide the IDs of the specific cache nodes to remove.
For clusters running Valkey or Redis OSS, this value must be 1. For clusters running Memcached, this\n value must be between 1 and 40.
\nAdding or removing Memcached cache nodes can be applied immediately or as a\n pending operation (see ApplyImmediately).
A pending operation to modify the number of cache nodes in a cluster during its\n maintenance window, whether by adding or removing nodes in accordance with the scale\n out architecture, is not queued. The customer's latest request to add or remove\n nodes to the cluster overrides any previous pending operations to modify the number\n of cache nodes in the cluster. For example, a request to remove 2 nodes would\n override a previous pending operation to remove 3 nodes. Similarly, a request to add\n 2 nodes would override a previous pending operation to remove 3 nodes and vice\n versa. As Memcached cache nodes may now be provisioned in different Availability\n Zones with flexible cache node placement, a request to add nodes does not\n automatically override a previous pending operation to add nodes. The customer can\n modify the previous pending operation to add more nodes or explicitly cancel the\n pending request and retry the new request. To cancel pending operations to modify\n the number of cache nodes in a cluster, use the ModifyCacheCluster\n request and set NumCacheNodes equal to the number of cache nodes\n currently in the cluster.
A list of cache node IDs to be removed. A node ID is a numeric identifier (0001, 0002,\n etc.). This parameter is only valid when NumCacheNodes is less than the\n existing number of cache nodes. The number of cache node IDs supplied in this parameter\n must match the difference between the existing number of cache nodes in the cluster or\n pending cache nodes, whichever is greater, and the value of NumCacheNodes\n in the request.
For example: If you have 3 active cache nodes, 7 pending cache nodes, and the number\n of cache nodes in this ModifyCacheCluster call is 5, you must list 2 (7 -\n 5) cache node IDs to remove.
Specifies whether the new nodes in this Memcached cluster are all created in a single\n Availability Zone or created across multiple Availability Zones.
\nValid values: single-az | cross-az.
This option is only supported for Memcached clusters.
\nYou cannot specify single-az if the Memcached cluster already has\n cache nodes in different Availability Zones. If cross-az is specified,\n existing Memcached nodes remain in their current Availability Zone.
Only newly created nodes are located in different Availability Zones.
\nThis option is only supported on Memcached clusters.
\nThe list of Availability Zones where the new Memcached cache nodes are created.
\nThis parameter is only valid when NumCacheNodes in the request is greater\n than the sum of the number of active cache nodes and the number of cache nodes pending\n creation (which may be zero). The number of Availability Zones supplied in this list\n must match the cache nodes being added in this request.
Scenarios:
\n\n Scenario 1: You have 3 active nodes and wish\n to add 2 nodes. Specify NumCacheNodes=5 (3 + 2) and optionally\n specify two Availability Zones for the two new nodes.
\n Scenario 2: You have 3 active nodes and 2\n nodes pending creation (from the scenario 1 call) and want to add 1 more node.\n Specify NumCacheNodes=6 ((3 + 2) + 1) and optionally specify an\n Availability Zone for the new node.
\n Scenario 3: You want to cancel all pending\n operations. Specify NumCacheNodes=3 to cancel all pending\n operations.
The Availability Zone placement of nodes pending creation cannot be modified. If you\n wish to cancel any nodes pending creation, add 0 nodes by setting\n NumCacheNodes to the number of current nodes.
If cross-az is specified, existing Memcached nodes remain in their\n current Availability Zone. Only newly created nodes can be located in different\n Availability Zones. For guidance on how to move existing Memcached nodes to different\n Availability Zones, see the Availability Zone\n Considerations section of Cache Node\n Considerations for Memcached.
\n Impact of new add/remove requests upon pending requests\n
\nScenario-1
\nPending Action: Delete
\nNew Request: Delete
\nResult: The new delete, pending or immediate, replaces the pending\n delete.
\nScenario-2
\nPending Action: Delete
\nNew Request: Create
\nResult: The new create, pending or immediate, replaces the pending\n delete.
\nScenario-3
\nPending Action: Create
\nNew Request: Delete
\nResult: The new delete, pending or immediate, replaces the pending\n create.
\nScenario-4
\nPending Action: Create
\nNew Request: Create
\nResult: The new create is added to the pending create.
\n\n Important: If the new create\n request is Apply Immediately - Yes,\n all creates are performed immediately. If the new create request is\n Apply Immediately - No, all\n creates are pending.
\nA list of cache security group names to authorize on this cluster. This change is\n asynchronously applied as soon as possible.
\nYou can use this parameter only with clusters that are created outside of an Amazon\n Virtual Private Cloud (Amazon VPC).
\nConstraints: Must contain no more than 255 alphanumeric characters. Must not be\n \"Default\".
" } }, "SecurityGroupIds": { "target": "com.amazonaws.elasticache#SecurityGroupIdsList", "traits": { "smithy.api#documentation": "Specifies the VPC Security Groups associated with the cluster.
\nThis parameter can be used only with clusters that are created in an Amazon Virtual\n Private Cloud (Amazon VPC).
" } }, "PreferredMaintenanceWindow": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "Specifies the weekly time range during which maintenance on the cluster is performed.\n It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The\n minimum maintenance window is a 60 minute period.
\nValid values for ddd are:
\n sun\n
\n mon\n
\n tue\n
\n wed\n
\n thu\n
\n fri\n
\n sat\n
Example: sun:23:00-mon:01:30\n
The Amazon Resource Name (ARN) of the Amazon SNS topic to which notifications are\n sent.
\nThe Amazon SNS topic owner must be same as the cluster owner.
\nThe name of the cache parameter group to apply to this cluster. This change is\n asynchronously applied as soon as possible for parameters when the\n ApplyImmediately parameter is specified as true for this\n request.
The status of the Amazon SNS notification topic. Notifications are sent only if the\n status is active.
Valid values: active | inactive\n
If true, this parameter causes the modifications in this request and any\n pending modifications to be applied, asynchronously and as soon as possible, regardless\n of the PreferredMaintenanceWindow setting for the cluster.
If false, changes to the cluster are applied on the next maintenance\n reboot, or the next failure reboot, whichever occurs first.
If you perform a ModifyCacheCluster before a pending modification is\n applied, the pending modification is replaced by the newer modification. However, \n a pending node-count increase on Memcached clusters cannot be superseded by a request \n to add fewer nodes. To change a pending node addition, first cancel it by setting \n NumCacheNodes equal to the current number of nodes in the cluster, then \n submit the new request. See the NumCacheNodes parameter for details on \n node scaling behavior.
Valid values: true | false\n
Default: false\n
The engine type used by the cache cluster. The options are valkey, memcached or redis.
" } }, "EngineVersion": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "The upgraded version of the cache engine to be run on the cache nodes.
\n\n Important: You can upgrade to a newer engine version\n (see Selecting\n a Cache Engine and Version), but you cannot downgrade to an earlier engine\n version. If you want to use an earlier engine version, you must delete the existing\n cluster and create it anew with the earlier engine version.
" } }, "AutoMinorVersionUpgrade": { "target": "com.amazonaws.elasticache#BooleanOptional", "traits": { "smithy.api#documentation": "\u00a0If you are running Valkey 7.2 or Redis OSS engine version 6.0 or later, set this parameter to yes \n to opt-in to the next auto minor version upgrade campaign. This parameter is\n disabled for previous versions.\u00a0
" } }, "SnapshotRetentionLimit": { "target": "com.amazonaws.elasticache#IntegerOptional", "traits": { "smithy.api#documentation": "The number of days for which ElastiCache retains automatic cluster snapshots before\n deleting them. For example, if you set SnapshotRetentionLimit to 5, a\n snapshot that was taken today is retained for 5 days before being deleted.
If the value of SnapshotRetentionLimit is set to zero (0), backups\n are turned off.
The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot\n of your cluster.
" } }, "CacheNodeType": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "A valid cache node type that you want to scale this cluster up to.
" } }, "AuthToken": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "Reserved parameter. The password used to access a password protected server. This\n parameter must be specified with the auth-token-update parameter. Password\n constraints:
Must be only printable ASCII characters
\nMust be at least 16 characters and no more than 128 characters in\n length
\nCannot contain any of the following characters: '/', '\"', or '@', '%'
\nFor more information, see AUTH password at AUTH.
" } }, "AuthTokenUpdateStrategy": { "target": "com.amazonaws.elasticache#AuthTokenUpdateStrategyType", "traits": { "smithy.api#documentation": "Specifies the strategy to use to update the AUTH token. This parameter must be\n specified with the auth-token parameter. Possible values:
ROTATE - default, if no update strategy is provided
\nSET - allowed only after ROTATE
\nDELETE - allowed only when transitioning to RBAC
\nFor more information, see Authenticating Users with AUTH\n
" } }, "LogDeliveryConfigurations": { "target": "com.amazonaws.elasticache#LogDeliveryConfigurationRequestList", "traits": { "smithy.api#documentation": "Specifies the destination, format and type of the logs.
" } }, "IpDiscovery": { "target": "com.amazonaws.elasticache#IpDiscovery", "traits": { "smithy.api#documentation": "The network type you choose when modifying a cluster, either ipv4 |\n ipv6. IPv6 is supported for workloads using Valkey 7.2 and above, Redis OSS engine version 6.2\n to 7.1 or Memcached engine version 1.6.6 and above on all instances built on the Nitro system.
Configures horizontal or vertical scaling for Memcached clusters, specifying the scaling percentage and interval.
" } } }, "traits": { "smithy.api#documentation": "Represents the input of a ModifyCacheCluster operation.
Modifies the parameters of a cache parameter group. You can modify up to 20 parameters\n in a single request by submitting a list parameter name and value pairs.
", "smithy.api#examples": [ { "title": "ModifyCacheParameterGroup", "documentation": "Modifies one or more parameter values in the specified parameter group. You cannot modify any default parameter group.", "input": { "CacheParameterGroupName": "custom-mem1-4", "ParameterNameValues": [ { "ParameterName": "binding_protocol", "ParameterValue": "ascii" }, { "ParameterName": "chunk_size", "ParameterValue": "96" } ] }, "output": { "CacheParameterGroupName": "custom-mem1-4" } } ] } }, "com.amazonaws.elasticache#ModifyCacheParameterGroupMessage": { "type": "structure", "members": { "CacheParameterGroupName": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The name of the cache parameter group to modify.
", "smithy.api#required": {} } }, "ParameterNameValues": { "target": "com.amazonaws.elasticache#ParameterNameValueList", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "An array of parameter names and values for the parameter update. You must supply at\n least one parameter name and value; subsequent arguments are optional. A maximum of 20\n parameters may be modified per request.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Represents the input of a ModifyCacheParameterGroup operation.
Modifies an existing cache subnet group.
", "smithy.api#examples": [ { "title": "ModifyCacheSubnetGroup", "documentation": "Modifies an existing ElastiCache subnet group.", "input": { "CacheSubnetGroupName": "my-sn-grp", "SubnetIds": [ "subnet-bcde2345" ] }, "output": { "CacheSubnetGroup": { "VpcId": "vpc-91280df6", "CacheSubnetGroupDescription": "My subnet group.", "Subnets": [ { "SubnetIdentifier": "subnet-a1b2c3d4", "SubnetAvailabilityZone": { "Name": "us-east-1c" } }, { "SubnetIdentifier": "subnet-1a2b3c4d", "SubnetAvailabilityZone": { "Name": "us-east-1e" } }, { "SubnetIdentifier": "subnet-bcde2345", "SubnetAvailabilityZone": { "Name": "us-east-1e" } }, { "SubnetIdentifier": "subnet-1234abcd", "SubnetAvailabilityZone": { "Name": "us-east-1c" } }, { "SubnetIdentifier": "subnet-abcd1234", "SubnetAvailabilityZone": { "Name": "us-east-1b" } } ], "CacheSubnetGroupName": "my-sn-grp" } } } ] } }, "com.amazonaws.elasticache#ModifyCacheSubnetGroupMessage": { "type": "structure", "members": { "CacheSubnetGroupName": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The name for the cache subnet group. This value is stored as a lowercase\n string.
\nConstraints: Must contain no more than 255 alphanumeric characters or hyphens.
\nExample: mysubnetgroup\n
A description of the cache subnet group.
" } }, "SubnetIds": { "target": "com.amazonaws.elasticache#SubnetIdentifierList", "traits": { "smithy.api#documentation": "The EC2 subnet IDs for the cache subnet group.
" } } }, "traits": { "smithy.api#documentation": "Represents the input of a ModifyCacheSubnetGroup operation.
Modifies the settings for a Global datastore.
" } }, "com.amazonaws.elasticache#ModifyGlobalReplicationGroupMessage": { "type": "structure", "members": { "GlobalReplicationGroupId": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The name of the Global datastore
", "smithy.api#required": {} } }, "ApplyImmediately": { "target": "com.amazonaws.elasticache#Boolean", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "This parameter causes the modifications in this request and any pending modifications\n to be applied, asynchronously and as soon as possible. Modifications to Global\n Replication Groups cannot be requested to be applied in PreferredMaintenceWindow.\n
", "smithy.api#required": {} } }, "CacheNodeType": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "A valid cache node type that you want to scale this Global datastore to.
" } }, "Engine": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "Modifies the engine listed in a global replication group message. The options are valkey, memcached or redis.
" } }, "EngineVersion": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "The upgraded version of the cache engine to be run on the clusters in the Global\n datastore.
" } }, "CacheParameterGroupName": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "The name of the cache parameter group to use with the Global datastore. It must be\n compatible with the major engine version used by the Global datastore.
" } }, "GlobalReplicationGroupDescription": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "A description of the Global datastore
" } }, "AutomaticFailoverEnabled": { "target": "com.amazonaws.elasticache#BooleanOptional", "traits": { "smithy.api#documentation": "Determines whether a read replica is automatically promoted to read/write primary if\n the existing primary encounters a failure.
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.elasticache#ModifyGlobalReplicationGroupResult": { "type": "structure", "members": { "GlobalReplicationGroup": { "target": "com.amazonaws.elasticache#GlobalReplicationGroup" } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.elasticache#ModifyReplicationGroup": { "type": "operation", "input": { "target": "com.amazonaws.elasticache#ModifyReplicationGroupMessage" }, "output": { "target": "com.amazonaws.elasticache#ModifyReplicationGroupResult" }, "errors": [ { "target": "com.amazonaws.elasticache#CacheClusterNotFoundFault" }, { "target": "com.amazonaws.elasticache#CacheParameterGroupNotFoundFault" }, { "target": "com.amazonaws.elasticache#CacheSecurityGroupNotFoundFault" }, { "target": "com.amazonaws.elasticache#InsufficientCacheClusterCapacityFault" }, { "target": "com.amazonaws.elasticache#InvalidCacheClusterStateFault" }, { "target": "com.amazonaws.elasticache#InvalidCacheSecurityGroupStateFault" }, { "target": "com.amazonaws.elasticache#InvalidKMSKeyFault" }, { "target": "com.amazonaws.elasticache#InvalidParameterCombinationException" }, { "target": "com.amazonaws.elasticache#InvalidParameterValueException" }, { "target": "com.amazonaws.elasticache#InvalidReplicationGroupStateFault" }, { "target": "com.amazonaws.elasticache#InvalidUserGroupStateFault" }, { "target": "com.amazonaws.elasticache#InvalidVPCNetworkStateFault" }, { "target": "com.amazonaws.elasticache#NodeQuotaForClusterExceededFault" }, { "target": "com.amazonaws.elasticache#NodeQuotaForCustomerExceededFault" }, { "target": "com.amazonaws.elasticache#ReplicationGroupNotFoundFault" }, { "target": "com.amazonaws.elasticache#UserGroupNotFoundFault" } ], "traits": { "smithy.api#documentation": "Modifies the settings for a replication group. This is limited to Valkey and Redis OSS 7 and above.
\n\n Scaling for Valkey or Redis OSS (cluster mode enabled) in\n the ElastiCache User Guide
\n\n ModifyReplicationGroupShardConfiguration in the ElastiCache API\n Reference
\nThis operation is valid for Valkey or Redis OSS only.
\nThe identifier of the replication group to modify.
", "smithy.api#required": {} } }, "ReplicationGroupDescription": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "A description for the replication group. Maximum length is 255 characters.
" } }, "PrimaryClusterId": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "For replication groups with a single primary, if this parameter is specified,\n ElastiCache promotes the specified cluster in the specified replication group to the\n primary role. The nodes of all other clusters in the replication group are read\n replicas.
" } }, "SnapshottingClusterId": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "The cluster ID that is used as the daily snapshot source for the replication group.\n This parameter cannot be set for Valkey or Redis OSS (cluster mode enabled) replication groups.
" } }, "AutomaticFailoverEnabled": { "target": "com.amazonaws.elasticache#BooleanOptional", "traits": { "smithy.api#documentation": "Determines whether a read replica is automatically promoted to read/write primary if\n the existing primary encounters a failure.
\nValid values: true | false\n
A flag to indicate MultiAZ is enabled.
" } }, "NodeGroupId": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#deprecated": {}, "smithy.api#documentation": "Deprecated. This parameter is not used.
" } }, "CacheSecurityGroupNames": { "target": "com.amazonaws.elasticache#CacheSecurityGroupNameList", "traits": { "smithy.api#documentation": "A list of cache security group names to authorize for the clusters in this replication\n group. This change is asynchronously applied as soon as possible.
\nThis parameter can be used only with replication group containing clusters running\n outside of an Amazon Virtual Private Cloud (Amazon VPC).
\nConstraints: Must contain no more than 255 alphanumeric characters. Must not be\n Default.
Specifies the VPC Security Groups associated with the clusters in the replication\n group.
\nThis parameter can be used only with replication group containing clusters running in\n an Amazon Virtual Private Cloud (Amazon VPC).
" } }, "PreferredMaintenanceWindow": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "Specifies the weekly time range during which maintenance on the cluster is performed.\n It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The\n minimum maintenance window is a 60 minute period.
\nValid values for ddd are:
\n sun\n
\n mon\n
\n tue\n
\n wed\n
\n thu\n
\n fri\n
\n sat\n
Example: sun:23:00-mon:01:30\n
The Amazon Resource Name (ARN) of the Amazon SNS topic to which notifications are\n sent.
\nThe Amazon SNS topic owner must be same as the replication group owner.
\nThe name of the cache parameter group to apply to all of the clusters in this\n replication group. This change is asynchronously applied as soon as possible for\n parameters when the ApplyImmediately parameter is specified as\n true for this request.
The status of the Amazon SNS notification topic for the replication group.\n Notifications are sent only if the status is active.
Valid values: active | inactive\n
If true, this parameter causes the modifications in this request and any\n pending modifications to be applied, asynchronously and as soon as possible, regardless\n of the PreferredMaintenanceWindow setting for the replication group.
If false, changes to the nodes in the replication group are applied on\n the next maintenance reboot, or the next failure reboot, whichever occurs first.
Valid values: true | false\n
Default: false\n
Modifies the engine listed in a replication group message. The options are valkey, memcached or redis.
" } }, "EngineVersion": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "The upgraded version of the cache engine to be run on the clusters in the replication\n group.
\n\n Important: You can upgrade to a newer engine version\n (see Selecting\n a Cache Engine and Version), but you cannot downgrade to an earlier engine\n version. If you want to use an earlier engine version, you must delete the existing\n replication group and create it anew with the earlier engine version.
" } }, "AutoMinorVersionUpgrade": { "target": "com.amazonaws.elasticache#BooleanOptional", "traits": { "smithy.api#documentation": "\u00a0If you are running Valkey or Redis OSS engine version 6.0 or later, set this parameter to yes if\n you want to opt-in to the next auto minor version upgrade campaign. This parameter is\n disabled for previous versions.\u00a0
" } }, "SnapshotRetentionLimit": { "target": "com.amazonaws.elasticache#IntegerOptional", "traits": { "smithy.api#documentation": "The number of days for which ElastiCache retains automatic node group (shard)\n snapshots before deleting them. For example, if you set\n SnapshotRetentionLimit to 5, a snapshot that was taken today is\n retained for 5 days before being deleted.
\n Important If the value of SnapshotRetentionLimit is\n set to zero (0), backups are turned off.
" } }, "SnapshotWindow": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot\n of the node group (shard) specified by SnapshottingClusterId.
Example: 05:00-09:00\n
If you do not specify this parameter, ElastiCache automatically chooses an appropriate\n time range.
" } }, "CacheNodeType": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "A valid cache node type that you want to scale this replication group to.
" } }, "AuthToken": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "Reserved parameter. The password used to access a password protected server. This\n parameter must be specified with the auth-token-update-strategy parameter.\n Password constraints:
Must be only printable ASCII characters
\nMust be at least 16 characters and no more than 128 characters in\n length
\nCannot contain any of the following characters: '/', '\"', or '@', '%'
\nFor more information, see AUTH password at AUTH.
" } }, "AuthTokenUpdateStrategy": { "target": "com.amazonaws.elasticache#AuthTokenUpdateStrategyType", "traits": { "smithy.api#documentation": "Specifies the strategy to use to update the AUTH token. This parameter must be\n specified with the auth-token parameter. Possible values:
ROTATE - default, if no update strategy is provided
\nSET - allowed only after ROTATE
\nDELETE - allowed only when transitioning to RBAC
\nFor more information, see Authenticating Users with AUTH\n
" } }, "UserGroupIdsToAdd": { "target": "com.amazonaws.elasticache#UserGroupIdList", "traits": { "smithy.api#documentation": "The ID of the user group you are associating with the replication group.
" } }, "UserGroupIdsToRemove": { "target": "com.amazonaws.elasticache#UserGroupIdList", "traits": { "smithy.api#documentation": "The ID of the user group to disassociate from the replication group, meaning the users\n in the group no longer can access the replication group.
" } }, "RemoveUserGroups": { "target": "com.amazonaws.elasticache#BooleanOptional", "traits": { "smithy.api#documentation": "Removes the user group associated with this replication group.
" } }, "LogDeliveryConfigurations": { "target": "com.amazonaws.elasticache#LogDeliveryConfigurationRequestList", "traits": { "smithy.api#documentation": "Specifies the destination, format and type of the logs.
" } }, "IpDiscovery": { "target": "com.amazonaws.elasticache#IpDiscovery", "traits": { "smithy.api#documentation": "The network type you choose when modifying a cluster, either ipv4 |\n ipv6. IPv6 is supported for workloads using Valkey 7.2 and above, Redis OSS engine version 6.2\n to 7.1 and Memcached engine version 1.6.6 and above on all instances built on the Nitro system.
A flag that enables in-transit encryption when set to true. If you are enabling\n in-transit encryption for an existing cluster, you must also set\n TransitEncryptionMode to preferred.
A setting that allows you to migrate your clients to use in-transit encryption, with\n no downtime.
\nYou must set TransitEncryptionEnabled to true, for your\n existing cluster, and set TransitEncryptionMode to preferred\n in the same request to allow both encrypted and unencrypted connections at the same\n time. Once you migrate all your Valkey or Redis OSS clients to use encrypted connections you can set\n the value to required to allow encrypted connections only.
Setting TransitEncryptionMode to required is a two-step\n process that requires you to first set the TransitEncryptionMode to\n preferred, after that you can set TransitEncryptionMode to\n required.
Enabled or Disabled. To modify cluster mode from Disabled to Enabled, you must first\n set the cluster mode to Compatible. Compatible mode allows your Valkey or Redis OSS clients to connect\n using both cluster mode enabled and cluster mode disabled. After you migrate all Valkey or Redis OSS\n clients to use cluster mode enabled, you can then complete cluster mode configuration\n and set the cluster mode to Enabled.
" } }, "Durability": { "target": "com.amazonaws.elasticache#Durability", "traits": { "smithy.api#documentation": "Specifies the durability setting for the replication group.\n Use this parameter to change the durability mode of an existing replication group,\n for example from sync to async or vice versa. For more\n information, see Durability.
Represents the input of a ModifyReplicationGroups operation.
Modifies a replication group's shards (node groups) by allowing you to add shards,\n remove shards, or rebalance the keyspaces among existing shards.
" } }, "com.amazonaws.elasticache#ModifyReplicationGroupShardConfigurationMessage": { "type": "structure", "members": { "ReplicationGroupId": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The name of the Valkey or Redis OSS (cluster mode enabled) cluster (replication group) on which the\n shards are to be configured.
", "smithy.api#required": {} } }, "NodeGroupCount": { "target": "com.amazonaws.elasticache#Integer", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The number of node groups (shards) that results from the modification of the shard\n configuration.
", "smithy.api#required": {} } }, "ApplyImmediately": { "target": "com.amazonaws.elasticache#Boolean", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "Indicates that the shard reconfiguration process begins immediately. At present, the\n only permitted value for this parameter is true.
Value: true
", "smithy.api#required": {} } }, "ReshardingConfiguration": { "target": "com.amazonaws.elasticache#ReshardingConfigurationList", "traits": { "smithy.api#documentation": "Specifies the preferred availability zones for each node group in the cluster. If the\n value of NodeGroupCount is greater than the current number of node groups\n (shards), you can use this parameter to specify the preferred availability zones of the\n cluster's shards. If you omit this parameter ElastiCache selects availability zones for\n you.
You can specify this parameter only if the value of NodeGroupCount is\n greater than the current number of node groups (shards).
If the value of NodeGroupCount is less than the current number of node\n groups (shards), then either NodeGroupsToRemove or\n NodeGroupsToRetain is required. NodeGroupsToRemove is a\n list of NodeGroupIds to remove from the cluster.
ElastiCache will attempt to remove all node groups listed by\n NodeGroupsToRemove from the cluster.
If the value of NodeGroupCount is less than the current number of node\n groups (shards), then either NodeGroupsToRemove or\n NodeGroupsToRetain is required. NodeGroupsToRetain is a\n list of NodeGroupIds to retain in the cluster.
ElastiCache will attempt to remove all node groups except those listed by\n NodeGroupsToRetain from the cluster.
Represents the input for a ModifyReplicationGroupShardConfiguration\n operation.
This API modifies the attributes of a serverless cache.
" } }, "com.amazonaws.elasticache#ModifyServerlessCacheRequest": { "type": "structure", "members": { "ServerlessCacheName": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "User-provided identifier for the serverless cache to be modified.
", "smithy.api#required": {} } }, "Description": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "User provided description for the serverless cache. \n Default = NULL, i.e. the existing description is not removed/modified. \n The description has a maximum length of 255 characters.
" } }, "CacheUsageLimits": { "target": "com.amazonaws.elasticache#CacheUsageLimits", "traits": { "smithy.api#documentation": "Modify the cache usage limit for the serverless cache.
" } }, "RemoveUserGroup": { "target": "com.amazonaws.elasticache#BooleanOptional", "traits": { "smithy.api#documentation": "The identifier of the UserGroup to be removed from association with the Valkey and Redis OSS serverless cache. Available for Valkey and Redis OSS only. Default is NULL.
" } }, "UserGroupId": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "The identifier of the UserGroup to be associated with the serverless cache. Available for Valkey and Redis OSS only. \n Default is NULL - the existing UserGroup is not removed.
" } }, "SecurityGroupIds": { "target": "com.amazonaws.elasticache#SecurityGroupIdsList", "traits": { "smithy.api#documentation": "The new list of VPC security groups to be associated with the serverless cache. \n Populating this list means the current VPC security groups will be removed. \n This security group is used to authorize traffic access for the VPC end-point (private-link). \n Default = NULL - the existing list of VPC security groups is not removed.
" } }, "SnapshotRetentionLimit": { "target": "com.amazonaws.elasticache#IntegerOptional", "traits": { "smithy.api#documentation": "The number of days for which Elasticache retains automatic snapshots before deleting them. \n Available for Valkey, Redis OSS and Serverless Memcached only.\n Default = NULL, i.e. the existing snapshot-retention-limit will not be removed or modified. \n The maximum value allowed is 35 days.
" } }, "DailySnapshotTime": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "The daily time during which Elasticache begins taking a daily snapshot of the serverless cache. Available for Valkey, Redis OSS and Serverless Memcached only.\n The default is NULL, i.e. the existing snapshot time configured for the cluster is not removed.
" } }, "Engine": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "Modifies the engine listed in a serverless cache request. The options are valkey, memcached or redis.
" } }, "MajorEngineVersion": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "Modifies the engine vesion listed in a serverless cache request.
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.elasticache#ModifyServerlessCacheResponse": { "type": "structure", "members": { "ServerlessCache": { "target": "com.amazonaws.elasticache#ServerlessCache", "traits": { "smithy.api#documentation": "The response for the attempt to modify the serverless cache.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.elasticache#ModifyUser": { "type": "operation", "input": { "target": "com.amazonaws.elasticache#ModifyUserMessage" }, "output": { "target": "com.amazonaws.elasticache#User" }, "errors": [ { "target": "com.amazonaws.elasticache#InvalidParameterCombinationException" }, { "target": "com.amazonaws.elasticache#InvalidParameterValueException" }, { "target": "com.amazonaws.elasticache#InvalidUserStateFault" }, { "target": "com.amazonaws.elasticache#ServiceLinkedRoleNotFoundFault" }, { "target": "com.amazonaws.elasticache#UserNotFoundFault" } ], "traits": { "smithy.api#documentation": "Changes user password(s) and/or access string.
" } }, "com.amazonaws.elasticache#ModifyUserGroup": { "type": "operation", "input": { "target": "com.amazonaws.elasticache#ModifyUserGroupMessage" }, "output": { "target": "com.amazonaws.elasticache#UserGroup" }, "errors": [ { "target": "com.amazonaws.elasticache#DefaultUserRequired" }, { "target": "com.amazonaws.elasticache#DuplicateUserNameFault" }, { "target": "com.amazonaws.elasticache#InvalidParameterCombinationException" }, { "target": "com.amazonaws.elasticache#InvalidParameterValueException" }, { "target": "com.amazonaws.elasticache#InvalidUserGroupStateFault" }, { "target": "com.amazonaws.elasticache#ServiceLinkedRoleNotFoundFault" }, { "target": "com.amazonaws.elasticache#UserGroupNotFoundFault" }, { "target": "com.amazonaws.elasticache#UserNotFoundFault" } ], "traits": { "smithy.api#documentation": "Changes the list of users that belong to the user group.
" } }, "com.amazonaws.elasticache#ModifyUserGroupMessage": { "type": "structure", "members": { "UserGroupId": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The ID of the user group.
", "smithy.api#required": {} } }, "UserIdsToAdd": { "target": "com.amazonaws.elasticache#UserIdListInput", "traits": { "smithy.api#documentation": "The list of user IDs to add to the user group.
" } }, "UserIdsToRemove": { "target": "com.amazonaws.elasticache#UserIdListInput", "traits": { "smithy.api#documentation": "The list of user IDs to remove from the user group.
" } }, "Engine": { "target": "com.amazonaws.elasticache#EngineType", "traits": { "smithy.api#documentation": "Modifies the engine listed in a user group. The options are valkey or redis.
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.elasticache#ModifyUserMessage": { "type": "structure", "members": { "UserId": { "target": "com.amazonaws.elasticache#UserId", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The ID of the user.
", "smithy.api#required": {} } }, "AccessString": { "target": "com.amazonaws.elasticache#AccessString", "traits": { "smithy.api#documentation": "Access permissions string used for this user.
" } }, "AppendAccessString": { "target": "com.amazonaws.elasticache#AccessString", "traits": { "smithy.api#documentation": "Adds additional user permissions to the access string.
" } }, "Passwords": { "target": "com.amazonaws.elasticache#PasswordListInput", "traits": { "smithy.api#documentation": "The passwords belonging to the user. You are allowed up to two.
" } }, "NoPasswordRequired": { "target": "com.amazonaws.elasticache#BooleanOptional", "traits": { "smithy.api#documentation": "Indicates no password is required for the user.
" } }, "AuthenticationMode": { "target": "com.amazonaws.elasticache#AuthenticationMode", "traits": { "smithy.api#documentation": "Specifies how to authenticate the user.
" } }, "Engine": { "target": "com.amazonaws.elasticache#EngineType", "traits": { "smithy.api#documentation": "Modifies the engine listed for a user. The options are valkey or redis.
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.elasticache#MultiAZStatus": { "type": "enum", "members": { "ENABLED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "enabled" } }, "DISABLED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "disabled" } } } }, "com.amazonaws.elasticache#NetworkType": { "type": "enum", "members": { "IPV4": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ipv4" } }, "IPV6": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ipv6" } }, "DUAL_STACK": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "dual_stack" } } } }, "com.amazonaws.elasticache#NetworkTypeList": { "type": "list", "member": { "target": "com.amazonaws.elasticache#NetworkType" } }, "com.amazonaws.elasticache#NoOperationFault": { "type": "structure", "members": { "message": { "target": "com.amazonaws.elasticache#ExceptionMessage" } }, "traits": { "aws.protocols#awsQueryError": { "code": "NoOperationFault", "httpResponseCode": 400 }, "smithy.api#documentation": "The operation was not performed because no changes were required.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.elasticache#NodeGroup": { "type": "structure", "members": { "NodeGroupId": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "The identifier for the node group (shard). A Valkey or Redis OSS (cluster mode disabled) replication\n group contains only 1 node group; therefore, the node group ID is 0001. A Valkey or Redis OSS (cluster mode enabled) replication group contains 1 to 90 node groups numbered 0001 to 0090.\n Optionally, the user can provide the id for a node group.
" } }, "Status": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "The current state of this replication group - creating,\n available, modifying, deleting.
The endpoint of the primary node in this node group (shard).
" } }, "ReaderEndpoint": { "target": "com.amazonaws.elasticache#Endpoint", "traits": { "smithy.api#documentation": "The endpoint of the replica nodes in this node group (shard). This value is read-only.
" } }, "Slots": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "The keyspace for this node group (shard).
" } }, "NodeGroupMembers": { "target": "com.amazonaws.elasticache#NodeGroupMemberList", "traits": { "smithy.api#documentation": "A list containing information about individual nodes within the node group\n (shard).
" } } }, "traits": { "smithy.api#documentation": "Represents a collection of cache nodes in a replication group. One node in the node\n group is the read/write primary node. All the other nodes are read-only Replica\n nodes.
" } }, "com.amazonaws.elasticache#NodeGroupConfiguration": { "type": "structure", "members": { "NodeGroupId": { "target": "com.amazonaws.elasticache#AllowedNodeGroupId", "traits": { "smithy.api#documentation": "Either the ElastiCache supplied 4-digit id or a user supplied id for the\n node group these configuration values apply to.
" } }, "Slots": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "A string that specifies the keyspace for a particular node group. Keyspaces range from\n 0 to 16,383. The string is in the format startkey-endkey.
Example: \"0-3999\"\n
The number of read replica nodes in this node group (shard).
" } }, "PrimaryAvailabilityZone": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "The Availability Zone where the primary node of this node group (shard) is\n launched.
" } }, "ReplicaAvailabilityZones": { "target": "com.amazonaws.elasticache#AvailabilityZonesList", "traits": { "smithy.api#documentation": "A list of Availability Zones to be used for the read replicas. The number of\n Availability Zones in this list must match the value of ReplicaCount or\n ReplicasPerNodeGroup if not specified.
The outpost ARN of the primary node.
" } }, "ReplicaOutpostArns": { "target": "com.amazonaws.elasticache#OutpostArnsList", "traits": { "smithy.api#documentation": "The outpost ARN of the node replicas.
" } } }, "traits": { "smithy.api#documentation": "Node group (shard) configuration options. Each node group (shard) configuration has\n the following: Slots, PrimaryAvailabilityZone,\n ReplicaAvailabilityZones, ReplicaCount.
The ID of the cluster to which the node belongs.
" } }, "CacheNodeId": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "The ID of the node within its cluster. A node ID is a numeric identifier (0001, 0002,\n etc.).
" } }, "ReadEndpoint": { "target": "com.amazonaws.elasticache#Endpoint", "traits": { "smithy.api#documentation": "The information required for client programs to connect to a node for read operations.\n The read endpoint is only applicable on Valkey or Redis OSS (cluster mode disabled) clusters.
" } }, "PreferredAvailabilityZone": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "The name of the Availability Zone in which the node is located.
" } }, "PreferredOutpostArn": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "The outpost ARN of the node group member.
" } }, "CurrentRole": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "The role that is currently assigned to the node - primary or\n replica. This member is only applicable for Valkey or Redis OSS (cluster mode\n disabled) replication groups.
Represents a single node within a node group (shard).
" } }, "com.amazonaws.elasticache#NodeGroupMemberList": { "type": "list", "member": { "target": "com.amazonaws.elasticache#NodeGroupMember", "traits": { "smithy.api#xmlName": "NodeGroupMember" } } }, "com.amazonaws.elasticache#NodeGroupMemberUpdateStatus": { "type": "structure", "members": { "CacheClusterId": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "The cache cluster ID
" } }, "CacheNodeId": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "The node ID of the cache cluster
" } }, "NodeUpdateStatus": { "target": "com.amazonaws.elasticache#NodeUpdateStatus", "traits": { "smithy.api#documentation": "The update status of the node
" } }, "NodeDeletionDate": { "target": "com.amazonaws.elasticache#TStamp", "traits": { "smithy.api#documentation": "The deletion date of the node
" } }, "NodeUpdateStartDate": { "target": "com.amazonaws.elasticache#TStamp", "traits": { "smithy.api#documentation": "The start date of the update for a node
" } }, "NodeUpdateEndDate": { "target": "com.amazonaws.elasticache#TStamp", "traits": { "smithy.api#documentation": "The end date of the update for a node
" } }, "NodeUpdateInitiatedBy": { "target": "com.amazonaws.elasticache#NodeUpdateInitiatedBy", "traits": { "smithy.api#documentation": "Reflects whether the update was initiated by the customer or automatically\n applied
" } }, "NodeUpdateInitiatedDate": { "target": "com.amazonaws.elasticache#TStamp", "traits": { "smithy.api#documentation": "The date when the update is triggered
" } }, "NodeUpdateStatusModifiedDate": { "target": "com.amazonaws.elasticache#TStamp", "traits": { "smithy.api#documentation": "The date when the NodeUpdateStatus was last modified
" } } }, "traits": { "smithy.api#documentation": "The status of the service update on the node group member
" } }, "com.amazonaws.elasticache#NodeGroupMemberUpdateStatusList": { "type": "list", "member": { "target": "com.amazonaws.elasticache#NodeGroupMemberUpdateStatus", "traits": { "smithy.api#xmlName": "NodeGroupMemberUpdateStatus" } } }, "com.amazonaws.elasticache#NodeGroupNotFoundFault": { "type": "structure", "members": { "message": { "target": "com.amazonaws.elasticache#ExceptionMessage" } }, "traits": { "aws.protocols#awsQueryError": { "code": "NodeGroupNotFoundFault", "httpResponseCode": 404 }, "smithy.api#documentation": "The node group specified by the NodeGroupId parameter could not be found.\n Please verify that the node group exists and that you spelled the\n NodeGroupId value correctly.
The ID of the node group
" } }, "NodeGroupMemberUpdateStatus": { "target": "com.amazonaws.elasticache#NodeGroupMemberUpdateStatusList", "traits": { "smithy.api#documentation": "The status of the service update on the node group member
" } } }, "traits": { "smithy.api#documentation": "The status of the service update on the node group
" } }, "com.amazonaws.elasticache#NodeGroupUpdateStatusList": { "type": "list", "member": { "target": "com.amazonaws.elasticache#NodeGroupUpdateStatus", "traits": { "smithy.api#xmlName": "NodeGroupUpdateStatus" } } }, "com.amazonaws.elasticache#NodeGroupsPerReplicationGroupQuotaExceededFault": { "type": "structure", "members": { "message": { "target": "com.amazonaws.elasticache#ExceptionMessage" } }, "traits": { "aws.protocols#awsQueryError": { "code": "NodeGroupsPerReplicationGroupQuotaExceeded", "httpResponseCode": 400 }, "smithy.api#documentation": "The request cannot be processed because it would exceed the maximum allowed number of\n node groups (shards) in a single replication group. The default maximum is 90
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.elasticache#NodeGroupsToRemoveList": { "type": "list", "member": { "target": "com.amazonaws.elasticache#AllowedNodeGroupId", "traits": { "smithy.api#xmlName": "NodeGroupToRemove" } } }, "com.amazonaws.elasticache#NodeGroupsToRetainList": { "type": "list", "member": { "target": "com.amazonaws.elasticache#AllowedNodeGroupId", "traits": { "smithy.api#xmlName": "NodeGroupToRetain" } } }, "com.amazonaws.elasticache#NodeQuotaForClusterExceededFault": { "type": "structure", "members": { "message": { "target": "com.amazonaws.elasticache#ExceptionMessage" } }, "traits": { "aws.protocols#awsQueryError": { "code": "NodeQuotaForClusterExceeded", "httpResponseCode": 400 }, "smithy.api#documentation": "The request cannot be processed because it would exceed the allowed number of cache\n nodes in a single cluster.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.elasticache#NodeQuotaForCustomerExceededFault": { "type": "structure", "members": { "message": { "target": "com.amazonaws.elasticache#ExceptionMessage" } }, "traits": { "aws.protocols#awsQueryError": { "code": "NodeQuotaForCustomerExceeded", "httpResponseCode": 400 }, "smithy.api#documentation": "The request cannot be processed because it would exceed the allowed number of cache\n nodes per customer.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.elasticache#NodeSnapshot": { "type": "structure", "members": { "CacheClusterId": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "A unique identifier for the source cluster.
" } }, "NodeGroupId": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "A unique identifier for the source node group (shard).
" } }, "CacheNodeId": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "The cache node identifier for the node in the source cluster.
" } }, "NodeGroupConfiguration": { "target": "com.amazonaws.elasticache#NodeGroupConfiguration", "traits": { "smithy.api#documentation": "The configuration for the source node group (shard).
" } }, "CacheSize": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "The size of the cache on the source cache node.
" } }, "CacheNodeCreateTime": { "target": "com.amazonaws.elasticache#TStamp", "traits": { "smithy.api#documentation": "The date and time when the cache node was created in the source cluster.
" } }, "SnapshotCreateTime": { "target": "com.amazonaws.elasticache#TStamp", "traits": { "smithy.api#documentation": "The date and time when the source node's metadata and cache data set was obtained for\n the snapshot.
" } } }, "traits": { "smithy.api#documentation": "Represents an individual cache node in a snapshot of a cluster.
" } }, "com.amazonaws.elasticache#NodeSnapshotList": { "type": "list", "member": { "target": "com.amazonaws.elasticache#NodeSnapshot", "traits": { "smithy.api#xmlName": "NodeSnapshot" } } }, "com.amazonaws.elasticache#NodeTypeList": { "type": "list", "member": { "target": "com.amazonaws.elasticache#String" } }, "com.amazonaws.elasticache#NodeUpdateInitiatedBy": { "type": "enum", "members": { "SYSTEM": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "system" } }, "CUSTOMER": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "customer" } } } }, "com.amazonaws.elasticache#NodeUpdateStatus": { "type": "enum", "members": { "NOT_APPLIED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "not-applied" } }, "WAITING_TO_START": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "waiting-to-start" } }, "IN_PROGRESS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "in-progress" } }, "STOPPING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "stopping" } }, "STOPPED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "stopped" } }, "COMPLETE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "complete" } } } }, "com.amazonaws.elasticache#NotificationConfiguration": { "type": "structure", "members": { "TopicArn": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) that identifies the topic.
" } }, "TopicStatus": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "The current state of the topic.
" } } }, "traits": { "smithy.api#documentation": "Describes a notification topic and its status. Notification topics are used for\n publishing ElastiCache events to subscribers using Amazon Simple Notification Service\n (SNS).
" } }, "com.amazonaws.elasticache#OutpostArnsList": { "type": "list", "member": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#xmlName": "OutpostArn" } } }, "com.amazonaws.elasticache#OutpostMode": { "type": "enum", "members": { "SINGLE_OUTPOST": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "single-outpost" } }, "CROSS_OUTPOST": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "cross-outpost" } } } }, "com.amazonaws.elasticache#Parameter": { "type": "structure", "members": { "ParameterName": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "The name of the parameter.
" } }, "ParameterValue": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "The value of the parameter.
" } }, "Description": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "A description of the parameter.
" } }, "Source": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "The source of the parameter.
" } }, "DataType": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "The valid data type for the parameter.
" } }, "AllowedValues": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "The valid range of values for the parameter.
" } }, "IsModifiable": { "target": "com.amazonaws.elasticache#Boolean", "traits": { "smithy.api#documentation": "Indicates whether (true) or not (false) the parameter can be\n modified. Some parameters have security or operational implications that prevent them\n from being changed.
The earliest cache engine version to which the parameter can apply.
" } }, "ChangeType": { "target": "com.amazonaws.elasticache#ChangeType", "traits": { "smithy.api#documentation": "Indicates whether a change to the parameter is applied immediately or requires a\n reboot for the change to be applied. You can force a reboot or wait until the next\n maintenance window's reboot. For more information, see Rebooting a\n Cluster.
" } } }, "traits": { "smithy.api#documentation": "Describes an individual setting that controls some aspect of ElastiCache\n behavior.
" } }, "com.amazonaws.elasticache#ParameterNameValue": { "type": "structure", "members": { "ParameterName": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "The name of the parameter.
" } }, "ParameterValue": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "The value of the parameter.
" } } }, "traits": { "smithy.api#documentation": "Describes a name-value pair that is used to update the value of a parameter.
" } }, "com.amazonaws.elasticache#ParameterNameValueList": { "type": "list", "member": { "target": "com.amazonaws.elasticache#ParameterNameValue", "traits": { "smithy.api#xmlName": "ParameterNameValue" } } }, "com.amazonaws.elasticache#ParametersList": { "type": "list", "member": { "target": "com.amazonaws.elasticache#Parameter", "traits": { "smithy.api#xmlName": "Parameter" } } }, "com.amazonaws.elasticache#PasswordListInput": { "type": "list", "member": { "target": "com.amazonaws.elasticache#String" }, "traits": { "smithy.api#length": { "min": 1 } } }, "com.amazonaws.elasticache#PendingAutomaticFailoverStatus": { "type": "enum", "members": { "ENABLED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "enabled" } }, "DISABLED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "disabled" } } } }, "com.amazonaws.elasticache#PendingLogDeliveryConfiguration": { "type": "structure", "members": { "LogType": { "target": "com.amazonaws.elasticache#LogType", "traits": { "smithy.api#documentation": "Refers to slow-log or\n engine-log..
" } }, "DestinationType": { "target": "com.amazonaws.elasticache#DestinationType", "traits": { "smithy.api#documentation": "Returns the destination type, either CloudWatch Logs or Kinesis Data Firehose.
" } }, "DestinationDetails": { "target": "com.amazonaws.elasticache#DestinationDetails", "traits": { "smithy.api#documentation": "Configuration details of either a CloudWatch Logs destination or Kinesis Data Firehose\n destination.
" } }, "LogFormat": { "target": "com.amazonaws.elasticache#LogFormat", "traits": { "smithy.api#documentation": "Returns the log format, either JSON or TEXT
" } } }, "traits": { "smithy.api#documentation": "The log delivery configurations being modified
" } }, "com.amazonaws.elasticache#PendingLogDeliveryConfigurationList": { "type": "list", "member": { "target": "com.amazonaws.elasticache#PendingLogDeliveryConfiguration" } }, "com.amazonaws.elasticache#PendingModifiedValues": { "type": "structure", "members": { "NumCacheNodes": { "target": "com.amazonaws.elasticache#IntegerOptional", "traits": { "smithy.api#documentation": "The new number of cache nodes for the cluster.
\nFor clusters running Valkey or Redis OSS, this value must be 1. For clusters running Memcached, this\n value must be between 1 and 40.
" } }, "CacheNodeIdsToRemove": { "target": "com.amazonaws.elasticache#CacheNodeIdsList", "traits": { "smithy.api#documentation": "A list of cache node IDs that are being removed (or will be removed) from the cluster.\n A node ID is a 4-digit numeric identifier (0001, 0002, etc.).
" } }, "EngineVersion": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "The new cache engine version that the cluster runs.
" } }, "CacheNodeType": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "The cache node type that this cluster or replication group is scaled to.
" } }, "AuthTokenStatus": { "target": "com.amazonaws.elasticache#AuthTokenUpdateStatus", "traits": { "smithy.api#documentation": "The auth token status
" } }, "LogDeliveryConfigurations": { "target": "com.amazonaws.elasticache#PendingLogDeliveryConfigurationList", "traits": { "smithy.api#documentation": "The log delivery configurations being modified
" } }, "TransitEncryptionEnabled": { "target": "com.amazonaws.elasticache#BooleanOptional", "traits": { "smithy.api#documentation": "A flag that enables in-transit encryption when set to true.
" } }, "TransitEncryptionMode": { "target": "com.amazonaws.elasticache#TransitEncryptionMode", "traits": { "smithy.api#documentation": "A setting that allows you to migrate your clients to use in-transit encryption, with\n no downtime.
" } }, "ScaleConfig": { "target": "com.amazonaws.elasticache#ScaleConfig", "traits": { "smithy.api#documentation": "The scaling configuration changes that are pending for the Memcached cluster.
" } } }, "traits": { "smithy.api#documentation": "A group of settings that are applied to the cluster in the future, or that are\n currently being applied.
" } }, "com.amazonaws.elasticache#PreferredAvailabilityZoneList": { "type": "list", "member": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#xmlName": "PreferredAvailabilityZone" } } }, "com.amazonaws.elasticache#PreferredOutpostArnList": { "type": "list", "member": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#xmlName": "PreferredOutpostArn" } } }, "com.amazonaws.elasticache#PrepareMigration": { "type": "operation", "input": { "target": "com.amazonaws.elasticache#PrepareMigrationRequest" }, "output": { "target": "com.amazonaws.elasticache#PrepareMigrationResponse" }, "errors": [ { "target": "com.amazonaws.elasticache#InvalidParameterValueException" }, { "target": "com.amazonaws.elasticache#InvalidServerlessCacheStateFault" }, { "target": "com.amazonaws.elasticache#ServerlessCacheAlreadyUnderMigrationFault" }, { "target": "com.amazonaws.elasticache#ServerlessCacheNotFoundFault" } ], "traits": { "smithy.api#documentation": "Prepares the serverless cache for data migration by validating the configuration and setting up the migration resources.
" } }, "com.amazonaws.elasticache#PrepareMigrationRequest": { "type": "structure", "members": { "ServerlessCacheName": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The name of the serverless cache to prepare for migration.
", "smithy.api#required": {} } }, "CustomerNodeEndpointList": { "target": "com.amazonaws.elasticache#CustomerNodeEndpointList", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The list of endpoints from which to migrate data. For serverless cache migrations, the\n list should have only one element.
", "smithy.api#required": {} } }, "SourceAuthenticationConfiguration": { "target": "com.amazonaws.elasticache#SourceAuthenticationConfiguration", "traits": { "smithy.api#documentation": "The authentication configuration for connecting to the source during migration.
" } }, "SourceTlsConfiguration": { "target": "com.amazonaws.elasticache#SourceTlsConfiguration", "traits": { "smithy.api#documentation": "The TLS configuration for connecting to the source during migration.
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.elasticache#PrepareMigrationResponse": { "type": "structure", "members": { "ServerlessCache": { "target": "com.amazonaws.elasticache#ServerlessCache", "traits": { "smithy.api#documentation": "Provides the details of the serverless cache prepared for migration.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.elasticache#ProcessedUpdateAction": { "type": "structure", "members": { "ReplicationGroupId": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "The ID of the replication group
" } }, "CacheClusterId": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "The ID of the cache cluster
" } }, "ServiceUpdateName": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "The unique ID of the service update
" } }, "UpdateActionStatus": { "target": "com.amazonaws.elasticache#UpdateActionStatus", "traits": { "smithy.api#documentation": "The status of the update action on the Valkey or Redis OSS cluster
" } } }, "traits": { "smithy.api#documentation": "Update action that has been processed for the corresponding apply/stop request
" } }, "com.amazonaws.elasticache#ProcessedUpdateActionList": { "type": "list", "member": { "target": "com.amazonaws.elasticache#ProcessedUpdateAction", "traits": { "smithy.api#xmlName": "ProcessedUpdateAction" } } }, "com.amazonaws.elasticache#PurchaseReservedCacheNodesOffering": { "type": "operation", "input": { "target": "com.amazonaws.elasticache#PurchaseReservedCacheNodesOfferingMessage" }, "output": { "target": "com.amazonaws.elasticache#PurchaseReservedCacheNodesOfferingResult" }, "errors": [ { "target": "com.amazonaws.elasticache#InvalidParameterCombinationException" }, { "target": "com.amazonaws.elasticache#InvalidParameterValueException" }, { "target": "com.amazonaws.elasticache#ReservedCacheNodeAlreadyExistsFault" }, { "target": "com.amazonaws.elasticache#ReservedCacheNodeQuotaExceededFault" }, { "target": "com.amazonaws.elasticache#ReservedCacheNodesOfferingNotFoundFault" }, { "target": "com.amazonaws.elasticache#TagQuotaPerResourceExceeded" } ], "traits": { "smithy.api#documentation": "Allows you to purchase a reserved cache node offering. Reserved nodes are not eligible\n for cancellation and are non-refundable. For more information, see Managing Costs with Reserved Nodes.
", "smithy.api#examples": [ { "title": "PurchaseReservedCacheNodesOfferings", "documentation": "Allows you to purchase a reserved cache node offering.", "input": { "ReservedCacheNodesOfferingId": "1ef01f5b-94ff-433f-a530-61a56bfc8e7a" } } ] } }, "com.amazonaws.elasticache#PurchaseReservedCacheNodesOfferingMessage": { "type": "structure", "members": { "ReservedCacheNodesOfferingId": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The ID of the reserved cache node offering to purchase.
\nExample: 438012d3-4052-4cc7-b2e3-8d3372e0e706\n
A customer-specified identifier to track this reservation.
\nThe Reserved Cache Node ID is an unique customer-specified identifier to track\n this reservation. If this parameter is not specified, ElastiCache automatically\n generates an identifier for the reservation.
\nExample: myreservationID
" } }, "CacheNodeCount": { "target": "com.amazonaws.elasticache#IntegerOptional", "traits": { "smithy.api#documentation": "The number of cache node instances to reserve.
\nDefault: 1\n
A list of tags to be added to this resource. A tag is a key-value pair. A tag key must\n be accompanied by a tag value, although null is accepted.
" } } }, "traits": { "smithy.api#documentation": "Represents the input of a PurchaseReservedCacheNodesOffering\n operation.
Redistribute slots to ensure uniform distribution across existing shards in the\n cluster.
" } }, "com.amazonaws.elasticache#RebalanceSlotsInGlobalReplicationGroupMessage": { "type": "structure", "members": { "GlobalReplicationGroupId": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The name of the Global datastore
", "smithy.api#required": {} } }, "ApplyImmediately": { "target": "com.amazonaws.elasticache#Boolean", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "If True, redistribution is applied immediately.
Reboots some, or all, of the cache nodes within a provisioned cluster. This operation\n applies any modified cache parameter groups to the cluster. The reboot operation takes\n place as soon as possible, and results in a momentary outage to the cluster. During the\n reboot, the cluster status is set to REBOOTING.
\nThe reboot causes the contents of the cache (for each cache node being rebooted) to be\n lost.
\nWhen the reboot is complete, a cluster event is created.
\nRebooting a cluster is currently supported on Memcached, Valkey and Redis OSS (cluster mode\n disabled) clusters. Rebooting is not supported on Valkey or Redis OSS (cluster mode enabled)\n clusters.
\nIf you make changes to parameters that require a Valkey or Redis OSS (cluster mode enabled) cluster\n reboot for the changes to be applied, see Rebooting a Cluster for an alternate process.
", "smithy.api#examples": [ { "title": "RebootCacheCluster", "documentation": "Reboots the specified nodes in the names cluster.", "input": { "CacheClusterId": "custom-mem1-4 ", "CacheNodeIdsToReboot": [ "0001", "0002" ] }, "output": { "CacheCluster": { "Engine": "memcached", "CacheParameterGroup": { "CacheNodeIdsToReboot": [], "CacheParameterGroupName": "default.memcached1.4", "ParameterApplyStatus": "in-sync" }, "CacheClusterId": "my-mem-cluster", "PreferredAvailabilityZone": "Multiple", "ConfigurationEndpoint": { "Port": 11211, "Address": "my-mem-cluster.abcdef.cfg.use1.cache.amazonaws.com" }, "CacheSecurityGroups": [], "CacheClusterCreateTime": "2016-12-21T21:59:43.794Z", "AutoMinorVersionUpgrade": true, "CacheClusterStatus": "rebooting cache cluster nodes", "NumCacheNodes": 2, "ClientDownloadLandingPage": "https://console.aws.amazon.com/elasticache/home#client-download:", "CacheSubnetGroupName": "default", "EngineVersion": "1.4.24", "PendingModifiedValues": {}, "PreferredMaintenanceWindow": "wed:06:00-wed:07:00", "CacheNodeType": "cache.t2.medium" } } } ] } }, "com.amazonaws.elasticache#RebootCacheClusterMessage": { "type": "structure", "members": { "CacheClusterId": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The cluster identifier. This parameter is stored as a lowercase string.
", "smithy.api#required": {} } }, "CacheNodeIdsToReboot": { "target": "com.amazonaws.elasticache#CacheNodeIdsList", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "A list of cache node IDs to reboot. A node ID is a numeric identifier (0001, 0002,\n etc.). To reboot an entire cluster, specify all of the cache node IDs.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Represents the input of a RebootCacheCluster operation.
The monetary amount of the recurring charge.
" } }, "RecurringChargeFrequency": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "The frequency of the recurring charge.
" } } }, "traits": { "smithy.api#documentation": "Contains the specific price and frequency of a recurring charges for a reserved cache\n node, or for a reserved cache node offering.
" } }, "com.amazonaws.elasticache#RecurringChargeList": { "type": "list", "member": { "target": "com.amazonaws.elasticache#RecurringCharge", "traits": { "smithy.api#xmlName": "RecurringCharge" } } }, "com.amazonaws.elasticache#RegionalConfiguration": { "type": "structure", "members": { "ReplicationGroupId": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The name of the secondary cluster
", "smithy.api#required": {} } }, "ReplicationGroupRegion": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The Amazon region where the cluster is stored
", "smithy.api#required": {} } }, "ReshardingConfiguration": { "target": "com.amazonaws.elasticache#ReshardingConfigurationList", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "A list of PreferredAvailabilityZones objects that specifies the\n configuration of a node group in the resharded cluster.
A list of the replication groups
" } }, "com.amazonaws.elasticache#RegionalConfigurationList": { "type": "list", "member": { "target": "com.amazonaws.elasticache#RegionalConfiguration", "traits": { "smithy.api#xmlName": "RegionalConfiguration" } } }, "com.amazonaws.elasticache#RemoveReplicasList": { "type": "list", "member": { "target": "com.amazonaws.elasticache#String" } }, "com.amazonaws.elasticache#RemoveTagsFromResource": { "type": "operation", "input": { "target": "com.amazonaws.elasticache#RemoveTagsFromResourceMessage" }, "output": { "target": "com.amazonaws.elasticache#TagListMessage" }, "errors": [ { "target": "com.amazonaws.elasticache#CacheClusterNotFoundFault" }, { "target": "com.amazonaws.elasticache#CacheParameterGroupNotFoundFault" }, { "target": "com.amazonaws.elasticache#CacheSecurityGroupNotFoundFault" }, { "target": "com.amazonaws.elasticache#CacheSubnetGroupNotFoundFault" }, { "target": "com.amazonaws.elasticache#GlobalReplicationGroupNotFoundFault" }, { "target": "com.amazonaws.elasticache#InvalidARNFault" }, { "target": "com.amazonaws.elasticache#InvalidParameterValueException" }, { "target": "com.amazonaws.elasticache#InvalidReplicationGroupStateFault" }, { "target": "com.amazonaws.elasticache#InvalidServerlessCacheSnapshotStateFault" }, { "target": "com.amazonaws.elasticache#InvalidServerlessCacheStateFault" }, { "target": "com.amazonaws.elasticache#ReplicationGroupNotFoundFault" }, { "target": "com.amazonaws.elasticache#ReservedCacheNodeNotFoundFault" }, { "target": "com.amazonaws.elasticache#ServerlessCacheNotFoundFault" }, { "target": "com.amazonaws.elasticache#ServerlessCacheSnapshotNotFoundFault" }, { "target": "com.amazonaws.elasticache#SnapshotNotFoundFault" }, { "target": "com.amazonaws.elasticache#TagNotFoundFault" }, { "target": "com.amazonaws.elasticache#UserGroupNotFoundFault" }, { "target": "com.amazonaws.elasticache#UserNotFoundFault" } ], "traits": { "smithy.api#documentation": "Removes the tags identified by the TagKeys list from the named resource.\n A tag is a key-value pair where the key and value are case-sensitive. You can use tags\n to categorize and track all your ElastiCache resources.\n When you add or remove tags on replication groups, those actions will\n be replicated to all nodes in the replication group. For more information, see Resource-level permissions.
The Amazon Resource Name (ARN) of the resource from which you want the tags removed,\n for example arn:aws:elasticache:us-west-2:0123456789:cluster:myCluster or\n arn:aws:elasticache:us-west-2:0123456789:snapshot:mySnapshot.
For more information about ARNs, see Amazon Resource Names (ARNs)\n and Amazon Service Namespaces.
", "smithy.api#required": {} } }, "TagKeys": { "target": "com.amazonaws.elasticache#KeyList", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "A list of TagKeys identifying the tags you want removed from the named\n resource.
Represents the input of a RemoveTagsFromResource operation.
The identifier for the replication group.
" } }, "Description": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "The user supplied description of the replication group.
" } }, "GlobalReplicationGroupInfo": { "target": "com.amazonaws.elasticache#GlobalReplicationGroupInfo", "traits": { "smithy.api#documentation": "The name of the Global datastore and role of this replication group in the Global\n datastore.
" } }, "Status": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "The current state of this replication group - creating,\n available, modifying, deleting,\n create-failed, snapshotting.
A group of settings to be applied to the replication group, either immediately or\n during the next maintenance window.
" } }, "MemberClusters": { "target": "com.amazonaws.elasticache#ClusterIdList", "traits": { "smithy.api#documentation": "The names of all the cache clusters that are part of this replication group.
" } }, "NodeGroups": { "target": "com.amazonaws.elasticache#NodeGroupList", "traits": { "smithy.api#documentation": "A list of node groups in this replication group. For Valkey or Redis OSS (cluster mode disabled)\n replication groups, this is a single-element list. For Valkey or Redis OSS (cluster mode enabled)\n replication groups, the list contains an entry for each node group (shard).
" } }, "SnapshottingClusterId": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "The cluster ID that is used as the daily snapshot source for the replication\n group.
" } }, "AutomaticFailover": { "target": "com.amazonaws.elasticache#AutomaticFailoverStatus", "traits": { "smithy.api#documentation": "Indicates the status of automatic failover for this Valkey or Redis OSS replication group.
" } }, "MultiAZ": { "target": "com.amazonaws.elasticache#MultiAZStatus", "traits": { "smithy.api#documentation": "A flag indicating if you have Multi-AZ enabled to enhance fault tolerance. For more\n information, see Minimizing Downtime: Multi-AZ\n
" } }, "ConfigurationEndpoint": { "target": "com.amazonaws.elasticache#Endpoint", "traits": { "smithy.api#documentation": "The configuration endpoint for this replication group. Use the configuration endpoint\n to connect to this replication group.
" } }, "SnapshotRetentionLimit": { "target": "com.amazonaws.elasticache#IntegerOptional", "traits": { "smithy.api#documentation": "The number of days for which ElastiCache retains automatic cluster snapshots before\n deleting them. For example, if you set SnapshotRetentionLimit to 5, a\n snapshot that was taken today is retained for 5 days before being deleted.
If the value of SnapshotRetentionLimit is set to zero (0), backups\n are turned off.
The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot\n of your node group (shard).
\nExample: 05:00-09:00\n
If you do not specify this parameter, ElastiCache automatically chooses an appropriate\n time range.
\nThis parameter is only valid if the Engine parameter is\n redis.
A flag indicating whether or not this replication group is cluster enabled; i.e.,\n whether its data can be partitioned across multiple shards (API/CLI: node\n groups).
\nValid values: true | false\n
The name of the compute and memory capacity node type for each node in the replication\n group.
" } }, "AuthTokenEnabled": { "target": "com.amazonaws.elasticache#BooleanOptional", "traits": { "smithy.api#documentation": "A flag that enables using an AuthToken (password) when issuing Valkey or Redis OSS \n commands.
Default: false\n
The date the auth token was last modified
" } }, "TransitEncryptionEnabled": { "target": "com.amazonaws.elasticache#BooleanOptional", "traits": { "smithy.api#documentation": "A flag that enables in-transit encryption when set to true.
\n Required: Only available when creating a replication\n group in an Amazon VPC using Redis OSS version 3.2.6, 4.x or\n later.
Default: false\n
A flag that enables encryption at-rest on the cluster when set to true.\n In some cases, encryption at-rest may be enabled even when this value is false.\n Use StorageEncryptionType to view the effective encryption state of a cluster.
You cannot modify the value of AtRestEncryptionEnabled after the cluster is created.
Default: true when using Valkey, false when using Redis OSS
The outpost ARNs of the replication group's member clusters.
" } }, "KmsKeyId": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "The ID of the KMS key used to encrypt the disk in the cluster.
" } }, "StorageEncryptionType": { "target": "com.amazonaws.elasticache#StorageEncryptionType", "traits": { "smithy.api#documentation": "Indicates the type of encryption for data stored at rest in the replication group.\n The value is none if at-rest encryption is not enabled,\n sse-elasticache if an ElastiCache service-managed key is used, or\n sse-kms if a customer-managed KMS key is used.
The ARN (Amazon Resource Name) of the replication group.
" } }, "UserGroupIds": { "target": "com.amazonaws.elasticache#UserGroupIdList", "traits": { "smithy.api#documentation": "The ID of the user group associated to the replication group.
" } }, "LogDeliveryConfigurations": { "target": "com.amazonaws.elasticache#LogDeliveryConfigurationList", "traits": { "smithy.api#documentation": "Returns the destination, format and type of the logs.
" } }, "ReplicationGroupCreateTime": { "target": "com.amazonaws.elasticache#TStamp", "traits": { "smithy.api#documentation": "The date and time when the cluster was created.
" } }, "DataTiering": { "target": "com.amazonaws.elasticache#DataTieringStatus", "traits": { "smithy.api#documentation": "Enables data tiering. Data tiering is only supported for replication groups using the\n r6gd node type. This parameter must be set to true when using r6gd nodes. For more\n information, see Data tiering.
" } }, "AutoMinorVersionUpgrade": { "target": "com.amazonaws.elasticache#Boolean", "traits": { "smithy.api#documentation": "If you are running Valkey 7.2 and above, or Redis OSS engine version 6.0 and above, set this parameter to yes if you\n want to opt-in to the next auto minor version upgrade campaign. This parameter is\n disabled for previous versions.
" } }, "NetworkType": { "target": "com.amazonaws.elasticache#NetworkType", "traits": { "smithy.api#documentation": "Must be either ipv4 | ipv6 | dual_stack. IPv6\n is supported for workloads using Valkey 7.2 and above, Redis OSS engine version 6.2\n to 7.1 or Memcached engine version 1.6.6 and above on all instances built on the Nitro system.
The network type you choose when modifying a cluster, either ipv4 |\n ipv6. IPv6 is supported for workloads using Valkey 7.2 and above, Redis OSS engine version 6.2\n to 7.1 or Memcached engine version 1.6.6 and above on all instances built on the Nitro system.
A setting that allows you to migrate your clients to use in-transit encryption, with\n no downtime.
" } }, "ClusterMode": { "target": "com.amazonaws.elasticache#ClusterMode", "traits": { "smithy.api#documentation": "Enabled or Disabled. To modify cluster mode from Disabled to Enabled, you must first\n set the cluster mode to Compatible. Compatible mode allows your Valkey or Redis OSS clients to connect\n using both cluster mode enabled and cluster mode disabled. After you migrate all Valkey or Redis OSS \n clients to use cluster mode enabled, you can then complete cluster mode configuration\n and set the cluster mode to Enabled.
" } }, "Engine": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "The engine used in a replication group. The options are valkey, memcached or redis.
" } }, "Durability": { "target": "com.amazonaws.elasticache#Durability", "traits": { "smithy.api#documentation": "The durability setting of the replication group. For more information, see Durability.
" } }, "EffectiveDurability": { "target": "com.amazonaws.elasticache#EffectiveDurability", "traits": { "smithy.api#documentation": "The effective durability of the replication group. When Durability is set to\n default, the service resolves the actual durability based on the engine version,\n cluster mode, and other parameters. This field reflects the resolved value. For more\n information, see Configuring Durability.
Contains all of the attributes of a specific Valkey or Redis OSS replication group.
" } }, "com.amazonaws.elasticache#ReplicationGroupAlreadyExistsFault": { "type": "structure", "members": { "message": { "target": "com.amazonaws.elasticache#ExceptionMessage" } }, "traits": { "aws.protocols#awsQueryError": { "code": "ReplicationGroupAlreadyExists", "httpResponseCode": 400 }, "smithy.api#documentation": "The specified replication group already exists.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.elasticache#ReplicationGroupAlreadyUnderMigrationFault": { "type": "structure", "members": { "message": { "target": "com.amazonaws.elasticache#ExceptionMessage" } }, "traits": { "aws.protocols#awsQueryError": { "code": "ReplicationGroupAlreadyUnderMigrationFault", "httpResponseCode": 400 }, "smithy.api#documentation": "The targeted replication group is not available.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.elasticache#ReplicationGroupIdList": { "type": "list", "member": { "target": "com.amazonaws.elasticache#String" }, "traits": { "smithy.api#length": { "min": 0, "max": 20 } } }, "com.amazonaws.elasticache#ReplicationGroupList": { "type": "list", "member": { "target": "com.amazonaws.elasticache#ReplicationGroup", "traits": { "smithy.api#xmlName": "ReplicationGroup" } } }, "com.amazonaws.elasticache#ReplicationGroupMessage": { "type": "structure", "members": { "Marker": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "Provides an identifier to allow retrieval of paginated results.
" } }, "ReplicationGroups": { "target": "com.amazonaws.elasticache#ReplicationGroupList", "traits": { "smithy.api#documentation": "A list of replication groups. Each item in the list contains detailed information\n about one replication group.
" } } }, "traits": { "smithy.api#documentation": "Represents the output of a DescribeReplicationGroups operation.
The specified replication group does not exist.
", "smithy.api#error": "client", "smithy.api#httpError": 404 } }, "com.amazonaws.elasticache#ReplicationGroupNotUnderMigrationFault": { "type": "structure", "members": { "message": { "target": "com.amazonaws.elasticache#ExceptionMessage" } }, "traits": { "aws.protocols#awsQueryError": { "code": "ReplicationGroupNotUnderMigrationFault", "httpResponseCode": 400 }, "smithy.api#documentation": "The designated replication group is not available for data migration.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.elasticache#ReplicationGroupOutpostArnList": { "type": "list", "member": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#xmlName": "ReplicationGroupOutpostArn" } } }, "com.amazonaws.elasticache#ReplicationGroupPendingModifiedValues": { "type": "structure", "members": { "PrimaryClusterId": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "The primary cluster ID that is applied immediately (if\n --apply-immediately was specified), or during the next maintenance\n window.
Indicates the status of automatic failover for this Valkey or Redis OSS replication group.
" } }, "Resharding": { "target": "com.amazonaws.elasticache#ReshardingStatus", "traits": { "smithy.api#documentation": "The status of an online resharding operation.
" } }, "AuthTokenStatus": { "target": "com.amazonaws.elasticache#AuthTokenUpdateStatus", "traits": { "smithy.api#documentation": "The auth token status
" } }, "UserGroups": { "target": "com.amazonaws.elasticache#UserGroupsUpdateStatus", "traits": { "smithy.api#documentation": "The user group being modified.
" } }, "LogDeliveryConfigurations": { "target": "com.amazonaws.elasticache#PendingLogDeliveryConfigurationList", "traits": { "smithy.api#documentation": "The log delivery configurations being modified
" } }, "TransitEncryptionEnabled": { "target": "com.amazonaws.elasticache#BooleanOptional", "traits": { "smithy.api#documentation": "A flag that enables in-transit encryption when set to true.
" } }, "TransitEncryptionMode": { "target": "com.amazonaws.elasticache#TransitEncryptionMode", "traits": { "smithy.api#documentation": "A setting that allows you to migrate your clients to use in-transit encryption, with\n no downtime.
" } }, "ClusterMode": { "target": "com.amazonaws.elasticache#ClusterMode", "traits": { "smithy.api#documentation": "Enabled or Disabled. To modify cluster mode from Disabled to Enabled, you must first\n set the cluster mode to Compatible. Compatible mode allows your Valkey or Redis OSS clients to connect\n using both cluster mode enabled and cluster mode disabled. After you migrate all Valkey or Redis OSS\n clients to use cluster mode enabled, you can then complete cluster mode configuration\n and set the cluster mode to Enabled.
" } } }, "traits": { "smithy.api#documentation": "The settings to be applied to the Valkey or Redis OSS replication group, either immediately or\n during the next maintenance window.
" } }, "com.amazonaws.elasticache#ReservedCacheNode": { "type": "structure", "members": { "ReservedCacheNodeId": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "The unique identifier for the reservation.
" } }, "ReservedCacheNodesOfferingId": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "The offering identifier.
" } }, "CacheNodeType": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "The cache node type for the reserved cache nodes.
\nThe following node types are supported by ElastiCache. Generally speaking, the current\n generation types provide more memory and computational power at lower cost when compared\n to their equivalent previous generation counterparts.
\nGeneral purpose:
\nCurrent generation:
\n\n M7g node types:\n \t\t\t\t\tcache.m7g.large,\n \t\t\t\t\tcache.m7g.xlarge,\n \t\t\t\t\tcache.m7g.2xlarge,\n \t\t\t\t\tcache.m7g.4xlarge,\n \t\t\t\t\tcache.m7g.8xlarge,\n \t\t\t\t\tcache.m7g.12xlarge,\n \t\t\t\t\tcache.m7g.16xlarge\n
For region availability, see Supported Node Types\n
\n\n M6g node types (available only for Redis OSS engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward):\n\t\t\t\t\t \n\t\t\t\t\t \tcache.m6g.large,\n\t\t\t\t\t\t\tcache.m6g.xlarge,\n\t\t\t\t\t\t\tcache.m6g.2xlarge,\n\t\t\t\t\t\t\tcache.m6g.4xlarge,\n\t\t\t\t\t\t\tcache.m6g.8xlarge,\n\t\t\t\t\t\t\tcache.m6g.12xlarge,\n\t\t\t\t\t\t\tcache.m6g.16xlarge\n
\n M5 node types:\n cache.m5.large,\n \t\t\t\t\t\tcache.m5.xlarge,\n \t\t\t\t\t\tcache.m5.2xlarge,\n \t\t\t\t\t\tcache.m5.4xlarge,\n \t\t\t\t\t\tcache.m5.12xlarge,\n \t\t\t\t\t\tcache.m5.24xlarge\n
\n M4 node types:\n cache.m4.large,\n \t\t\t\t\t\tcache.m4.xlarge,\n \t\t\t\t\t\tcache.m4.2xlarge,\n \t\t\t\t\t\tcache.m4.4xlarge,\n \t\t\t\t\t\tcache.m4.10xlarge\n
\n T4g node types (available only for Redis OSS engine version 5.0.6 onward and Memcached engine version 1.5.16 onward):\n\t\t\t\t\t cache.t4g.micro,\n\t\t\t\t\t cache.t4g.small,\n\t\t\t\t\t cache.t4g.medium\n
\n T3 node types:\n cache.t3.micro, \n \t\t\t\t\t\tcache.t3.small,\n \t\t\t\t\t\tcache.t3.medium\n
\n T2 node types:\n cache.t2.micro, \n \t\t\t\t\t\tcache.t2.small,\n \t\t\t\t\t\tcache.t2.medium\n
Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)
\n\n T1 node types:\n cache.t1.micro\n
\n M1 node types:\n cache.m1.small, \n\t\t\t\t\t\t cache.m1.medium, \n\t\t\t\t\t\t cache.m1.large,\n\t\t\t\t\t\t cache.m1.xlarge\n
\n M3 node types:\n cache.m3.medium,\n \t\t\t\t\t\tcache.m3.large, \n \t\t\t\t\t\tcache.m3.xlarge,\n \t\t\t\t\t\tcache.m3.2xlarge\n
Compute optimized:
\nPrevious generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)
\n\n C1 node types:\n cache.c1.xlarge\n
Memory optimized:
\nCurrent generation:
\n\n R7g node types:\t\n\t\t\t\t\t\t\tcache.r7g.large,\n\t\t\t\t\t\t\tcache.r7g.xlarge,\n\t\t\t\t\t\t\tcache.r7g.2xlarge,\n\t\t\t\t\t\t\tcache.r7g.4xlarge,\n\t\t\t\t\t\t\tcache.r7g.8xlarge,\n\t\t\t\t\t\t\tcache.r7g.12xlarge,\n\t\t\t\t\t\t\tcache.r7g.16xlarge\n
For region availability, see Supported Node Types\n
\n\n R6g node types (available only for Redis OSS engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward):\n\t\t\t\t\t\t\tcache.r6g.large,\n\t\t\t\t\t\t\tcache.r6g.xlarge,\n\t\t\t\t\t\t\tcache.r6g.2xlarge,\n\t\t\t\t\t\t\tcache.r6g.4xlarge,\n\t\t\t\t\t\t\tcache.r6g.8xlarge,\n\t\t\t\t\t\t\tcache.r6g.12xlarge,\n\t\t\t\t\t\t\tcache.r6g.16xlarge\n
\n R5 node types:\n cache.r5.large,\n \t\t\t\t\t cache.r5.xlarge,\n \t\t\t\t\t cache.r5.2xlarge,\n \t\t\t\t\t cache.r5.4xlarge,\n \t\t\t\t\t cache.r5.12xlarge,\n \t\t\t\t\t cache.r5.24xlarge\n
\n R4 node types:\n cache.r4.large,\n \t\t\t\t\t cache.r4.xlarge,\n \t\t\t\t\t cache.r4.2xlarge,\n \t\t\t\t\t cache.r4.4xlarge,\n \t\t\t\t\t cache.r4.8xlarge,\n \t\t\t\t\t cache.r4.16xlarge\n
Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)
\n\n M2 node types:\n cache.m2.xlarge, \n \t\t\t\t\t\tcache.m2.2xlarge,\n \t\t\t\t\t\tcache.m2.4xlarge\n
\n R3 node types:\n cache.r3.large, \n \t\t\t\t\t\tcache.r3.xlarge,\n \t\t\t\t\t\tcache.r3.2xlarge, \n \t\t\t\t\t\tcache.r3.4xlarge,\n \t\t\t\t\t\tcache.r3.8xlarge\n
\n Additional node type info\n
\nAll current generation instance types are created in Amazon VPC by\n default.
\nValkey or Redis OSS append-only files (AOF) are not supported for T1 or T2 instances.
\nValkey or Redis OSS Multi-AZ with automatic failover is not supported on T1\n instances.
\nThe configuration variables appendonly and\n appendfsync are not supported on Valkey, or on Redis OSS version 2.8.22 and\n later.
The time the reservation started.
" } }, "Duration": { "target": "com.amazonaws.elasticache#Integer", "traits": { "smithy.api#documentation": "The duration of the reservation in seconds.
" } }, "FixedPrice": { "target": "com.amazonaws.elasticache#Double", "traits": { "smithy.api#documentation": "The fixed price charged for this reserved cache node.
" } }, "UsagePrice": { "target": "com.amazonaws.elasticache#Double", "traits": { "smithy.api#documentation": "The hourly price charged for this reserved cache node.
" } }, "CacheNodeCount": { "target": "com.amazonaws.elasticache#Integer", "traits": { "smithy.api#documentation": "The number of cache nodes that have been reserved.
" } }, "ProductDescription": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "The description of the reserved cache node.
" } }, "OfferingType": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "The offering type of this reserved cache node.
" } }, "State": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "The state of the reserved cache node.
" } }, "RecurringCharges": { "target": "com.amazonaws.elasticache#RecurringChargeList", "traits": { "smithy.api#documentation": "The recurring price charged to run this reserved cache node.
" } }, "ReservationARN": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the reserved cache node.
\nExample:\n arn:aws:elasticache:us-east-1:123456789012:reserved-instance:ri-2017-03-27-08-33-25-582\n
Represents the output of a PurchaseReservedCacheNodesOffering\n operation.
You already have a reservation with the given identifier.
", "smithy.api#error": "client", "smithy.api#httpError": 404 } }, "com.amazonaws.elasticache#ReservedCacheNodeList": { "type": "list", "member": { "target": "com.amazonaws.elasticache#ReservedCacheNode", "traits": { "smithy.api#xmlName": "ReservedCacheNode" } } }, "com.amazonaws.elasticache#ReservedCacheNodeMessage": { "type": "structure", "members": { "Marker": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "Provides an identifier to allow retrieval of paginated results.
" } }, "ReservedCacheNodes": { "target": "com.amazonaws.elasticache#ReservedCacheNodeList", "traits": { "smithy.api#documentation": "A list of reserved cache nodes. Each element in the list contains detailed information\n about one node.
" } } }, "traits": { "smithy.api#documentation": "Represents the output of a DescribeReservedCacheNodes operation.
The requested reserved cache node was not found.
", "smithy.api#error": "client", "smithy.api#httpError": 404 } }, "com.amazonaws.elasticache#ReservedCacheNodeQuotaExceededFault": { "type": "structure", "members": { "message": { "target": "com.amazonaws.elasticache#ExceptionMessage" } }, "traits": { "aws.protocols#awsQueryError": { "code": "ReservedCacheNodeQuotaExceeded", "httpResponseCode": 400 }, "smithy.api#documentation": "The request cannot be processed because it would exceed the user's cache node\n quota.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.elasticache#ReservedCacheNodesOffering": { "type": "structure", "members": { "ReservedCacheNodesOfferingId": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "A unique identifier for the reserved cache node offering.
" } }, "CacheNodeType": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "The cache node type for the reserved cache node.
\nThe following node types are supported by ElastiCache. Generally speaking, the current\n generation types provide more memory and computational power at lower cost when compared\n to their equivalent previous generation counterparts.
\nGeneral purpose:
\nCurrent generation:
\n\n M7g node types:\n \t\t\t\t\tcache.m7g.large,\n \t\t\t\t\tcache.m7g.xlarge,\n \t\t\t\t\tcache.m7g.2xlarge,\n \t\t\t\t\tcache.m7g.4xlarge,\n \t\t\t\t\tcache.m7g.8xlarge,\n \t\t\t\t\tcache.m7g.12xlarge,\n \t\t\t\t\tcache.m7g.16xlarge\n
For region availability, see Supported Node Types\n
\n\n M6g node types (available only for Redis OSS engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward):\n\t\t\t\t\t \n\t\t\t\t\t \tcache.m6g.large,\n\t\t\t\t\t\t\tcache.m6g.xlarge,\n\t\t\t\t\t\t\tcache.m6g.2xlarge,\n\t\t\t\t\t\t\tcache.m6g.4xlarge,\n\t\t\t\t\t\t\tcache.m6g.8xlarge,\n\t\t\t\t\t\t\tcache.m6g.12xlarge,\n\t\t\t\t\t\t\tcache.m6g.16xlarge\n
\n M5 node types:\n cache.m5.large,\n \t\t\t\t\t\tcache.m5.xlarge,\n \t\t\t\t\t\tcache.m5.2xlarge,\n \t\t\t\t\t\tcache.m5.4xlarge,\n \t\t\t\t\t\tcache.m5.12xlarge,\n \t\t\t\t\t\tcache.m5.24xlarge\n
\n M4 node types:\n cache.m4.large,\n \t\t\t\t\t\tcache.m4.xlarge,\n \t\t\t\t\t\tcache.m4.2xlarge,\n \t\t\t\t\t\tcache.m4.4xlarge,\n \t\t\t\t\t\tcache.m4.10xlarge\n
\n T4g node types (available only for Redis OSS engine version 5.0.6 onward and Memcached engine version 1.5.16 onward):\n\t\t\t\t\t cache.t4g.micro,\n\t\t\t\t\t cache.t4g.small,\n\t\t\t\t\t cache.t4g.medium\n
\n T3 node types:\n cache.t3.micro, \n \t\t\t\t\t\tcache.t3.small,\n \t\t\t\t\t\tcache.t3.medium\n
\n T2 node types:\n cache.t2.micro, \n \t\t\t\t\t\tcache.t2.small,\n \t\t\t\t\t\tcache.t2.medium\n
Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)
\n\n T1 node types:\n cache.t1.micro\n
\n M1 node types:\n cache.m1.small, \n\t\t\t\t\t\t cache.m1.medium, \n\t\t\t\t\t\t cache.m1.large,\n\t\t\t\t\t\t cache.m1.xlarge\n
\n M3 node types:\n cache.m3.medium,\n \t\t\t\t\t\tcache.m3.large, \n \t\t\t\t\t\tcache.m3.xlarge,\n \t\t\t\t\t\tcache.m3.2xlarge\n
Compute optimized:
\nPrevious generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)
\n\n C1 node types:\n cache.c1.xlarge\n
Memory optimized:
\nCurrent generation:
\n\n R7g node types:\t\n\t\t\t\t\t\t\tcache.r7g.large,\n\t\t\t\t\t\t\tcache.r7g.xlarge,\n\t\t\t\t\t\t\tcache.r7g.2xlarge,\n\t\t\t\t\t\t\tcache.r7g.4xlarge,\n\t\t\t\t\t\t\tcache.r7g.8xlarge,\n\t\t\t\t\t\t\tcache.r7g.12xlarge,\n\t\t\t\t\t\t\tcache.r7g.16xlarge\n
For region availability, see Supported Node Types\n
\n\n R6g node types (available only for Redis OSS engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward):\n\t\t\t\t\t\t\tcache.r6g.large,\n\t\t\t\t\t\t\tcache.r6g.xlarge,\n\t\t\t\t\t\t\tcache.r6g.2xlarge,\n\t\t\t\t\t\t\tcache.r6g.4xlarge,\n\t\t\t\t\t\t\tcache.r6g.8xlarge,\n\t\t\t\t\t\t\tcache.r6g.12xlarge,\n\t\t\t\t\t\t\tcache.r6g.16xlarge\n
\n R5 node types:\n cache.r5.large,\n \t\t\t\t\t cache.r5.xlarge,\n \t\t\t\t\t cache.r5.2xlarge,\n \t\t\t\t\t cache.r5.4xlarge,\n \t\t\t\t\t cache.r5.12xlarge,\n \t\t\t\t\t cache.r5.24xlarge\n
\n R4 node types:\n cache.r4.large,\n \t\t\t\t\t cache.r4.xlarge,\n \t\t\t\t\t cache.r4.2xlarge,\n \t\t\t\t\t cache.r4.4xlarge,\n \t\t\t\t\t cache.r4.8xlarge,\n \t\t\t\t\t cache.r4.16xlarge\n
Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)
\n\n M2 node types:\n cache.m2.xlarge, \n \t\t\t\t\t\tcache.m2.2xlarge,\n \t\t\t\t\t\tcache.m2.4xlarge\n
\n R3 node types:\n cache.r3.large, \n \t\t\t\t\t\tcache.r3.xlarge,\n \t\t\t\t\t\tcache.r3.2xlarge, \n \t\t\t\t\t\tcache.r3.4xlarge,\n \t\t\t\t\t\tcache.r3.8xlarge\n
\n Additional node type info\n
\nAll current generation instance types are created in Amazon VPC by\n default.
\nValkey or Redis OSS append-only files (AOF) are not supported for T1 or T2 instances.
\nValkey or Redis OSS Multi-AZ with automatic failover is not supported on T1\n instances.
\nThe configuration variables appendonly and\n appendfsync are not supported on Valkey, or on Redis OSS version 2.8.22 and\n later.
The duration of the offering. in seconds.
" } }, "FixedPrice": { "target": "com.amazonaws.elasticache#Double", "traits": { "smithy.api#documentation": "The fixed price charged for this offering.
" } }, "UsagePrice": { "target": "com.amazonaws.elasticache#Double", "traits": { "smithy.api#documentation": "The hourly price charged for this offering.
" } }, "ProductDescription": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "The cache engine used by the offering.
" } }, "OfferingType": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "The offering type.
" } }, "RecurringCharges": { "target": "com.amazonaws.elasticache#RecurringChargeList", "traits": { "smithy.api#documentation": "The recurring price charged to run this reserved cache node.
" } } }, "traits": { "smithy.api#documentation": "Describes all of the attributes of a reserved cache node offering.
" } }, "com.amazonaws.elasticache#ReservedCacheNodesOfferingList": { "type": "list", "member": { "target": "com.amazonaws.elasticache#ReservedCacheNodesOffering", "traits": { "smithy.api#xmlName": "ReservedCacheNodesOffering" } } }, "com.amazonaws.elasticache#ReservedCacheNodesOfferingMessage": { "type": "structure", "members": { "Marker": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "Provides an identifier to allow retrieval of paginated results.
" } }, "ReservedCacheNodesOfferings": { "target": "com.amazonaws.elasticache#ReservedCacheNodesOfferingList", "traits": { "smithy.api#documentation": "A list of reserved cache node offerings. Each element in the list contains detailed\n information about one offering.
" } } }, "traits": { "smithy.api#documentation": "Represents the output of a DescribeReservedCacheNodesOfferings\n operation.
The requested cache node offering does not exist.
", "smithy.api#error": "client", "smithy.api#httpError": 404 } }, "com.amazonaws.elasticache#ResetCacheParameterGroup": { "type": "operation", "input": { "target": "com.amazonaws.elasticache#ResetCacheParameterGroupMessage" }, "output": { "target": "com.amazonaws.elasticache#CacheParameterGroupNameMessage" }, "errors": [ { "target": "com.amazonaws.elasticache#CacheParameterGroupNotFoundFault" }, { "target": "com.amazonaws.elasticache#InvalidCacheParameterGroupStateFault" }, { "target": "com.amazonaws.elasticache#InvalidGlobalReplicationGroupStateFault" }, { "target": "com.amazonaws.elasticache#InvalidParameterCombinationException" }, { "target": "com.amazonaws.elasticache#InvalidParameterValueException" } ], "traits": { "smithy.api#documentation": "Modifies the parameters of a cache parameter group to the engine or system default\n value. You can reset specific parameters by submitting a list of parameter names. To\n reset the entire cache parameter group, specify the ResetAllParameters and\n CacheParameterGroupName parameters.
The name of the cache parameter group to reset.
", "smithy.api#required": {} } }, "ResetAllParameters": { "target": "com.amazonaws.elasticache#Boolean", "traits": { "smithy.api#documentation": "If true, all parameters in the cache parameter group are reset to their\n default values. If false, only the parameters listed by\n ParameterNameValues are reset to their default values.
Valid values: true | false\n
An array of parameter names to reset to their default values. If\n ResetAllParameters is true, do not use\n ParameterNameValues. If ResetAllParameters is\n false, you must specify the name of at least one parameter to\n reset.
Represents the input of a ResetCacheParameterGroup operation.
Either the ElastiCache supplied 4-digit id or a user supplied id for the\n node group these configuration values apply to.
" } }, "PreferredAvailabilityZones": { "target": "com.amazonaws.elasticache#AvailabilityZonesList", "traits": { "smithy.api#documentation": "A list of preferred availability zones for the nodes in this cluster.
" } } }, "traits": { "smithy.api#documentation": "A list of PreferredAvailabilityZones objects that specifies the\n configuration of a node group in the resharded cluster.
Represents the progress of an online resharding operation.
" } } }, "traits": { "smithy.api#documentation": "The status of an online resharding operation.
" } }, "com.amazonaws.elasticache#RevokeCacheSecurityGroupIngress": { "type": "operation", "input": { "target": "com.amazonaws.elasticache#RevokeCacheSecurityGroupIngressMessage" }, "output": { "target": "com.amazonaws.elasticache#RevokeCacheSecurityGroupIngressResult" }, "errors": [ { "target": "com.amazonaws.elasticache#AuthorizationNotFoundFault" }, { "target": "com.amazonaws.elasticache#CacheSecurityGroupNotFoundFault" }, { "target": "com.amazonaws.elasticache#InvalidCacheSecurityGroupStateFault" }, { "target": "com.amazonaws.elasticache#InvalidParameterCombinationException" }, { "target": "com.amazonaws.elasticache#InvalidParameterValueException" } ], "traits": { "smithy.api#documentation": "Revokes ingress from a cache security group. Use this operation to disallow access\n from an Amazon EC2 security group that had been previously authorized.
", "smithy.api#examples": [ { "title": "DescribeCacheSecurityGroups", "documentation": "Returns a list of cache security group descriptions. If a cache security group name is specified, the list contains only the description of that group.", "input": { "CacheSecurityGroupName": "my-sec-grp", "EC2SecurityGroupName": "my-ec2-sec-grp", "EC2SecurityGroupOwnerId": "1234567890" } } ] } }, "com.amazonaws.elasticache#RevokeCacheSecurityGroupIngressMessage": { "type": "structure", "members": { "CacheSecurityGroupName": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The name of the cache security group to revoke ingress from.
", "smithy.api#required": {} } }, "EC2SecurityGroupName": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The name of the Amazon EC2 security group to revoke access from.
", "smithy.api#required": {} } }, "EC2SecurityGroupOwnerId": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The Amazon account number of the Amazon EC2 security group owner. Note that this is\n not the same thing as an Amazon access key ID - you must provide a valid Amazon account\n number for this parameter.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Represents the input of a RevokeCacheSecurityGroupIngress\n operation.
The percentage by which to scale the Memcached cluster, either horizontally by adding nodes or vertically by increasing resources.
" } }, "ScaleIntervalMinutes": { "target": "com.amazonaws.elasticache#IntegerOptional", "traits": { "smithy.api#documentation": "The time interval in seconds between scaling operations when performing gradual scaling for a Memcached cluster.
" } } }, "traits": { "smithy.api#documentation": "Configuration settings for horizontal or vertical scaling operations on Memcached clusters.
" } }, "com.amazonaws.elasticache#SecretManagerAuthConfig": { "type": "structure", "members": { "SecretArn": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "The ARN of the secret in Secrets Manager that contains the credentials for authenticating\n with the source.
" } } }, "traits": { "smithy.api#documentation": "Configuration for authenticating with the source using Secrets Manager during migration.
" } }, "com.amazonaws.elasticache#SecurityGroupIdsList": { "type": "list", "member": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#xmlName": "SecurityGroupId" } } }, "com.amazonaws.elasticache#SecurityGroupMembership": { "type": "structure", "members": { "SecurityGroupId": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "The identifier of the cache security group.
" } }, "Status": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "The status of the cache security group membership. The status changes whenever a cache\n security group is modified, or when the cache security groups assigned to a cluster are\n modified.
" } } }, "traits": { "smithy.api#documentation": "Represents a single cache security group and its status.
" } }, "com.amazonaws.elasticache#SecurityGroupMembershipList": { "type": "list", "member": { "target": "com.amazonaws.elasticache#SecurityGroupMembership" } }, "com.amazonaws.elasticache#ServerlessCache": { "type": "structure", "members": { "ServerlessCacheName": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "The unique identifier of the serverless cache.
" } }, "Description": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "A description of the serverless cache.
" } }, "CreateTime": { "target": "com.amazonaws.elasticache#TStamp", "traits": { "smithy.api#documentation": "When the serverless cache was created.
" } }, "Status": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "The current status of the serverless cache. The allowed values are CREATING, AVAILABLE, DELETING, CREATE-FAILED and MODIFYING.
" } }, "Engine": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "The engine the serverless cache is compatible with.
" } }, "MajorEngineVersion": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "The version number of the engine the serverless cache is compatible with.
" } }, "FullEngineVersion": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "The name and version number of the engine the serverless cache is compatible with.
" } }, "CacheUsageLimits": { "target": "com.amazonaws.elasticache#CacheUsageLimits", "traits": { "smithy.api#documentation": "The cache usage limit for the serverless cache.
" } }, "KmsKeyId": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "The ID of the Amazon Web Services Key Management Service (KMS) key that is used to encrypt data at rest in the serverless cache.
" } }, "StorageEncryptionType": { "target": "com.amazonaws.elasticache#StorageEncryptionType", "traits": { "smithy.api#documentation": "Indicates the type of encryption for data stored at rest in the serverless cache.\n Serverless caches are always encrypted at rest. The value is\n sse-elasticache if an ElastiCache service-managed key is used, or\n sse-kms if a customer-managed KMS key is used.
The IDs of the EC2 security groups associated with the serverless \n cache.
" } }, "Endpoint": { "target": "com.amazonaws.elasticache#Endpoint" }, "ReaderEndpoint": { "target": "com.amazonaws.elasticache#Endpoint" }, "ARN": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the serverless cache.
" } }, "UserGroupId": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "The identifier of the user group associated with the serverless cache. Available for Valkey and Redis OSS only. Default is NULL.
" } }, "SubnetIds": { "target": "com.amazonaws.elasticache#SubnetIdsList", "traits": { "smithy.api#documentation": "If no subnet IDs are given and your VPC is in us-west-1, then ElastiCache will select 2 default subnets across AZs in your VPC. \n For all other Regions, if no subnet IDs are given then ElastiCache will select 3 default subnets across AZs in your default VPC.
" } }, "SnapshotRetentionLimit": { "target": "com.amazonaws.elasticache#IntegerOptional", "traits": { "smithy.api#documentation": "The number of days for which ElastiCache retains automatic snapshots before deleting them. Available for Valkey, Redis OSS and Serverless Memcached only. The maximum value allowed is 35 days.
" } }, "DailySnapshotTime": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "The daily time that a cache snapshot will be created. Default is NULL, i.e. snapshots will not be created at a\n specific time on a daily basis. Available for Valkey, Redis OSS and Serverless Memcached only.
" } }, "NetworkType": { "target": "com.amazonaws.elasticache#NetworkType", "traits": { "smithy.api#documentation": "The type of IP address protocol used by the serverless cache. \n Must be either ipv4 | ipv6 | dual_stack.\n ipv6 is only supported with IPv6-only subnets. \n If not specified, defaults to ipv4, unless all provided subnets are IPv6-only, in which case it defaults to ipv6.
The connection type for the serverless cache.\n Must be either vpc | public.\n If not specified, defaults to vpc.
Provides a summary of the migration status for the serverless cache.
" } }, "Integrations": { "target": "com.amazonaws.elasticache#IntegrationList", "traits": { "smithy.api#documentation": "Configured integrations and their status.
" } } }, "traits": { "smithy.api#documentation": "The resource representing a serverless cache.
" } }, "com.amazonaws.elasticache#ServerlessCacheAlreadyExistsFault": { "type": "structure", "members": { "message": { "target": "com.amazonaws.elasticache#ExceptionMessage" } }, "traits": { "aws.protocols#awsQueryError": { "code": "ServerlessCacheAlreadyExistsFault", "httpResponseCode": 400 }, "smithy.api#documentation": "A serverless cache with this name already exists.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.elasticache#ServerlessCacheAlreadyUnderMigrationFault": { "type": "structure", "members": { "message": { "target": "com.amazonaws.elasticache#ExceptionMessage" } }, "traits": { "aws.protocols#awsQueryError": { "code": "ServerlessCacheAlreadyUnderMigrationFault", "httpResponseCode": 400 }, "smithy.api#documentation": "A migration is already in progress for this serverless cache. You cannot start another migration until the current one completes.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.elasticache#ServerlessCacheConfiguration": { "type": "structure", "members": { "ServerlessCacheName": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "The identifier of a serverless cache.
" } }, "Engine": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "The engine that the serverless cache is configured with.
" } }, "MajorEngineVersion": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "The engine version number that the serverless cache is configured with.
" } } }, "traits": { "smithy.api#documentation": "The configuration settings for a specific serverless cache.
" } }, "com.amazonaws.elasticache#ServerlessCacheList": { "type": "list", "member": { "target": "com.amazonaws.elasticache#ServerlessCache" } }, "com.amazonaws.elasticache#ServerlessCacheNotFoundFault": { "type": "structure", "members": { "message": { "target": "com.amazonaws.elasticache#ExceptionMessage" } }, "traits": { "aws.protocols#awsQueryError": { "code": "ServerlessCacheNotFoundFault", "httpResponseCode": 404 }, "smithy.api#documentation": "The serverless cache was not found or does not exist.
", "smithy.api#error": "client", "smithy.api#httpError": 404 } }, "com.amazonaws.elasticache#ServerlessCacheNotUnderMigrationFault": { "type": "structure", "members": { "message": { "target": "com.amazonaws.elasticache#ExceptionMessage" } }, "traits": { "aws.protocols#awsQueryError": { "code": "ServerlessCacheNotUnderMigrationFault", "httpResponseCode": 400 }, "smithy.api#documentation": "The serverless cache is not currently under migration.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.elasticache#ServerlessCacheQuotaForCustomerExceededFault": { "type": "structure", "members": { "message": { "target": "com.amazonaws.elasticache#ExceptionMessage" } }, "traits": { "aws.protocols#awsQueryError": { "code": "ServerlessCacheQuotaForCustomerExceededFault", "httpResponseCode": 400 }, "smithy.api#documentation": "The number of serverless caches exceeds the customer quota.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.elasticache#ServerlessCacheSnapshot": { "type": "structure", "members": { "ServerlessCacheSnapshotName": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "The identifier of a serverless cache snapshot. Available for Valkey, Redis OSS and Serverless Memcached only.
" } }, "ARN": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of a serverless cache snapshot. Available for Valkey, Redis OSS and Serverless Memcached only.
" } }, "KmsKeyId": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "The ID of the Amazon Web Services Key Management Service (KMS) key of a serverless cache snapshot. Available for Valkey, Redis OSS and Serverless Memcached only.
" } }, "SnapshotType": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "The type of snapshot of serverless cache. Available for Valkey, Redis OSS and Serverless Memcached only.
" } }, "Status": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "The current status of the serverless cache. Available for Valkey, Redis OSS and Serverless Memcached only.
" } }, "CreateTime": { "target": "com.amazonaws.elasticache#TStamp", "traits": { "smithy.api#documentation": "The date and time that the source serverless cache's metadata and cache data set was obtained for\n the snapshot. Available for Valkey, Redis OSS and Serverless Memcached only.
" } }, "ExpiryTime": { "target": "com.amazonaws.elasticache#TStamp", "traits": { "smithy.api#documentation": "The time that the serverless cache snapshot will expire. Available for Valkey, Redis OSS and Serverless Memcached only.
" } }, "BytesUsedForCache": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "The total size of a serverless cache snapshot, in bytes. Available for Valkey, Redis OSS and Serverless Memcached only.
" } }, "ServerlessCacheConfiguration": { "target": "com.amazonaws.elasticache#ServerlessCacheConfiguration", "traits": { "smithy.api#documentation": "The configuration of the serverless cache, at the time the snapshot was taken. Available for Valkey, Redis OSS and Serverless Memcached only.
" } } }, "traits": { "smithy.api#documentation": "The resource representing a serverless cache snapshot. Available for Valkey, Redis OSS and Serverless Memcached only.
" } }, "com.amazonaws.elasticache#ServerlessCacheSnapshotAlreadyExistsFault": { "type": "structure", "members": { "message": { "target": "com.amazonaws.elasticache#ExceptionMessage" } }, "traits": { "aws.protocols#awsQueryError": { "code": "ServerlessCacheSnapshotAlreadyExistsFault", "httpResponseCode": 400 }, "smithy.api#documentation": "A serverless cache snapshot with this name already exists. Available for Valkey, Redis OSS and Serverless Memcached only.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.elasticache#ServerlessCacheSnapshotList": { "type": "list", "member": { "target": "com.amazonaws.elasticache#ServerlessCacheSnapshot", "traits": { "smithy.api#xmlName": "ServerlessCacheSnapshot" } } }, "com.amazonaws.elasticache#ServerlessCacheSnapshotNotFoundFault": { "type": "structure", "members": { "message": { "target": "com.amazonaws.elasticache#ExceptionMessage" } }, "traits": { "aws.protocols#awsQueryError": { "code": "ServerlessCacheSnapshotNotFoundFault", "httpResponseCode": 404 }, "smithy.api#documentation": "This serverless cache snapshot could not be found or does not exist. Available for Valkey, Redis OSS and Serverless Memcached only.
", "smithy.api#error": "client", "smithy.api#httpError": 404 } }, "com.amazonaws.elasticache#ServerlessCacheSnapshotQuotaExceededFault": { "type": "structure", "members": { "message": { "target": "com.amazonaws.elasticache#ExceptionMessage" } }, "traits": { "aws.protocols#awsQueryError": { "code": "ServerlessCacheSnapshotQuotaExceededFault", "httpResponseCode": 400 }, "smithy.api#documentation": "The number of serverless cache snapshots exceeds the customer snapshot quota. Available for Valkey, Redis OSS and Serverless Memcached only.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.elasticache#ServiceLinkedRoleNotFoundFault": { "type": "structure", "members": { "message": { "target": "com.amazonaws.elasticache#ExceptionMessage" } }, "traits": { "aws.protocols#awsQueryError": { "code": "ServiceLinkedRoleNotFoundFault", "httpResponseCode": 400 }, "smithy.api#documentation": "The specified service linked role (SLR) was not found.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.elasticache#ServiceUpdate": { "type": "structure", "members": { "ServiceUpdateName": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "The unique ID of the service update
" } }, "ServiceUpdateReleaseDate": { "target": "com.amazonaws.elasticache#TStamp", "traits": { "smithy.api#documentation": "The date when the service update is initially available
" } }, "ServiceUpdateEndDate": { "target": "com.amazonaws.elasticache#TStamp", "traits": { "smithy.api#documentation": "The date after which the service update is no longer available
" } }, "ServiceUpdateSeverity": { "target": "com.amazonaws.elasticache#ServiceUpdateSeverity", "traits": { "smithy.api#documentation": "The severity of the service update
" } }, "ServiceUpdateRecommendedApplyByDate": { "target": "com.amazonaws.elasticache#TStamp", "traits": { "smithy.api#documentation": "The recommendend date to apply the service update in order to ensure compliance. For\n information on compliance, see Self-Service Security Updates for Compliance.
" } }, "ServiceUpdateStatus": { "target": "com.amazonaws.elasticache#ServiceUpdateStatus", "traits": { "smithy.api#documentation": "The status of the service update
" } }, "ServiceUpdateDescription": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "Provides details of the service update
" } }, "ServiceUpdateType": { "target": "com.amazonaws.elasticache#ServiceUpdateType", "traits": { "smithy.api#documentation": "Reflects the nature of the service update
" } }, "Engine": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "The Elasticache engine to which the update applies. Either Valkey, Redis OSS or Memcached.
" } }, "EngineVersion": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "The Elasticache engine version to which the update applies. Either Valkey, Redis OSS or Memcached\n engine version.
" } }, "AutoUpdateAfterRecommendedApplyByDate": { "target": "com.amazonaws.elasticache#BooleanOptional", "traits": { "smithy.api#documentation": "Indicates whether the service update will be automatically applied once the\n recommended apply-by date has expired.
" } }, "EstimatedUpdateTime": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "The estimated length of time the service update will take
" } } }, "traits": { "smithy.api#documentation": "An update that you can apply to your Valkey or Redis OSS clusters.
" } }, "com.amazonaws.elasticache#ServiceUpdateList": { "type": "list", "member": { "target": "com.amazonaws.elasticache#ServiceUpdate", "traits": { "smithy.api#xmlName": "ServiceUpdate" } } }, "com.amazonaws.elasticache#ServiceUpdateNotFoundFault": { "type": "structure", "members": { "message": { "target": "com.amazonaws.elasticache#ExceptionMessage" } }, "traits": { "aws.protocols#awsQueryError": { "code": "ServiceUpdateNotFoundFault", "httpResponseCode": 404 }, "smithy.api#documentation": "The service update doesn't exist
", "smithy.api#error": "client", "smithy.api#httpError": 404 } }, "com.amazonaws.elasticache#ServiceUpdateSeverity": { "type": "enum", "members": { "CRITICAL": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "critical" } }, "IMPORTANT": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "important" } }, "MEDIUM": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "medium" } }, "LOW": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "low" } } } }, "com.amazonaws.elasticache#ServiceUpdateStatus": { "type": "enum", "members": { "AVAILABLE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "available" } }, "CANCELLED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "cancelled" } }, "EXPIRED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "expired" } } } }, "com.amazonaws.elasticache#ServiceUpdateStatusList": { "type": "list", "member": { "target": "com.amazonaws.elasticache#ServiceUpdateStatus" }, "traits": { "smithy.api#length": { "min": 0, "max": 3 } } }, "com.amazonaws.elasticache#ServiceUpdateType": { "type": "enum", "members": { "SECURITY_UPDATE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "security-update" } } } }, "com.amazonaws.elasticache#ServiceUpdatesMessage": { "type": "structure", "members": { "Marker": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "An optional marker returned from a prior request. Use this marker for pagination of\n results from this operation. If this parameter is specified, the response includes only\n records beyond the marker, up to the value specified by MaxRecords.
A list of service updates
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.elasticache#SlaMet": { "type": "enum", "members": { "YES": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "yes" } }, "NO": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "no" } }, "NA": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "n/a" } } } }, "com.amazonaws.elasticache#SlotMigration": { "type": "structure", "members": { "ProgressPercentage": { "target": "com.amazonaws.elasticache#Double", "traits": { "smithy.api#documentation": "The percentage of the slot migration that is complete.
" } } }, "traits": { "smithy.api#documentation": "Represents the progress of an online resharding operation.
" } }, "com.amazonaws.elasticache#Snapshot": { "type": "structure", "members": { "SnapshotName": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "The name of a snapshot. For an automatic snapshot, the name is system-generated. For a\n manual snapshot, this is the user-provided name.
" } }, "ReplicationGroupId": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "The unique identifier of the source replication group.
" } }, "ReplicationGroupDescription": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "A description of the source replication group.
" } }, "CacheClusterId": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "The user-supplied identifier of the source cluster.
" } }, "SnapshotStatus": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "The status of the snapshot. Valid values: creating |\n available | restoring | copying |\n deleting.
Indicates whether the snapshot is from an automatic backup (automated) or\n was created manually (manual).
The name of the compute and memory capacity node type for the source cluster.
\nThe following node types are supported by ElastiCache. Generally speaking, the current\n generation types provide more memory and computational power at lower cost when compared\n to their equivalent previous generation counterparts.
\nGeneral purpose:
\nCurrent generation:
\n\n M7g node types:\n \t\t\t\t\tcache.m7g.large,\n \t\t\t\t\tcache.m7g.xlarge,\n \t\t\t\t\tcache.m7g.2xlarge,\n \t\t\t\t\tcache.m7g.4xlarge,\n \t\t\t\t\tcache.m7g.8xlarge,\n \t\t\t\t\tcache.m7g.12xlarge,\n \t\t\t\t\tcache.m7g.16xlarge\n
For region availability, see Supported Node Types\n
\n\n M6g node types (available only for Redis OSS engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward):\n\t\t\t\t\t \n\t\t\t\t\t \tcache.m6g.large,\n\t\t\t\t\t\t\tcache.m6g.xlarge,\n\t\t\t\t\t\t\tcache.m6g.2xlarge,\n\t\t\t\t\t\t\tcache.m6g.4xlarge,\n\t\t\t\t\t\t\tcache.m6g.8xlarge,\n\t\t\t\t\t\t\tcache.m6g.12xlarge,\n\t\t\t\t\t\t\tcache.m6g.16xlarge\n
\n M5 node types:\n cache.m5.large,\n \t\t\t\t\t\tcache.m5.xlarge,\n \t\t\t\t\t\tcache.m5.2xlarge,\n \t\t\t\t\t\tcache.m5.4xlarge,\n \t\t\t\t\t\tcache.m5.12xlarge,\n \t\t\t\t\t\tcache.m5.24xlarge\n
\n M4 node types:\n cache.m4.large,\n \t\t\t\t\t\tcache.m4.xlarge,\n \t\t\t\t\t\tcache.m4.2xlarge,\n \t\t\t\t\t\tcache.m4.4xlarge,\n \t\t\t\t\t\tcache.m4.10xlarge\n
\n T4g node types (available only for Redis OSS engine version 5.0.6 onward and Memcached engine version 1.5.16 onward):\n\t\t\t\t\t cache.t4g.micro,\n\t\t\t\t\t cache.t4g.small,\n\t\t\t\t\t cache.t4g.medium\n
\n T3 node types:\n cache.t3.micro, \n \t\t\t\t\t\tcache.t3.small,\n \t\t\t\t\t\tcache.t3.medium\n
\n T2 node types:\n cache.t2.micro, \n \t\t\t\t\t\tcache.t2.small,\n \t\t\t\t\t\tcache.t2.medium\n
Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)
\n\n T1 node types:\n cache.t1.micro\n
\n M1 node types:\n cache.m1.small, \n\t\t\t\t\t\t cache.m1.medium, \n\t\t\t\t\t\t cache.m1.large,\n\t\t\t\t\t\t cache.m1.xlarge\n
\n M3 node types:\n cache.m3.medium,\n \t\t\t\t\t\tcache.m3.large, \n \t\t\t\t\t\tcache.m3.xlarge,\n \t\t\t\t\t\tcache.m3.2xlarge\n
Compute optimized:
\nPrevious generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)
\n\n C1 node types:\n cache.c1.xlarge\n
Memory optimized:
\nCurrent generation:
\n\n R7g node types:\t\n\t\t\t\t\t\t\tcache.r7g.large,\n\t\t\t\t\t\t\tcache.r7g.xlarge,\n\t\t\t\t\t\t\tcache.r7g.2xlarge,\n\t\t\t\t\t\t\tcache.r7g.4xlarge,\n\t\t\t\t\t\t\tcache.r7g.8xlarge,\n\t\t\t\t\t\t\tcache.r7g.12xlarge,\n\t\t\t\t\t\t\tcache.r7g.16xlarge\n
For region availability, see Supported Node Types\n
\n\n R6g node types (available only for Redis OSS engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward):\n\t\t\t\t\t\t\tcache.r6g.large,\n\t\t\t\t\t\t\tcache.r6g.xlarge,\n\t\t\t\t\t\t\tcache.r6g.2xlarge,\n\t\t\t\t\t\t\tcache.r6g.4xlarge,\n\t\t\t\t\t\t\tcache.r6g.8xlarge,\n\t\t\t\t\t\t\tcache.r6g.12xlarge,\n\t\t\t\t\t\t\tcache.r6g.16xlarge\n
\n R5 node types:\n cache.r5.large,\n \t\t\t\t\t cache.r5.xlarge,\n \t\t\t\t\t cache.r5.2xlarge,\n \t\t\t\t\t cache.r5.4xlarge,\n \t\t\t\t\t cache.r5.12xlarge,\n \t\t\t\t\t cache.r5.24xlarge\n
\n R4 node types:\n cache.r4.large,\n \t\t\t\t\t cache.r4.xlarge,\n \t\t\t\t\t cache.r4.2xlarge,\n \t\t\t\t\t cache.r4.4xlarge,\n \t\t\t\t\t cache.r4.8xlarge,\n \t\t\t\t\t cache.r4.16xlarge\n
Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)
\n\n M2 node types:\n cache.m2.xlarge, \n \t\t\t\t\t\tcache.m2.2xlarge,\n \t\t\t\t\t\tcache.m2.4xlarge\n
\n R3 node types:\n cache.r3.large, \n \t\t\t\t\t\tcache.r3.xlarge,\n \t\t\t\t\t\tcache.r3.2xlarge, \n \t\t\t\t\t\tcache.r3.4xlarge,\n \t\t\t\t\t\tcache.r3.8xlarge\n
\n Additional node type info\n
\nAll current generation instance types are created in Amazon VPC by\n default.
\nValkey or Redis OSS append-only files (AOF) are not supported for T1 or T2 instances.
\nValkey or Redis OSS Multi-AZ with automatic failover is not supported on T1\n instances.
\nThe configuration variables appendonly and\n appendfsync are not supported on Valkey, or on Redis OSS version 2.8.22 and\n later.
The name of the cache engine (memcached or redis) used by\n the source cluster.
The version of the cache engine version that is used by the source cluster.
" } }, "NumCacheNodes": { "target": "com.amazonaws.elasticache#IntegerOptional", "traits": { "smithy.api#documentation": "The number of cache nodes in the source cluster.
\nFor clusters running Valkey or Redis OSS, this value must be 1. For clusters running Memcached, this\n value must be between 1 and 40.
" } }, "PreferredAvailabilityZone": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "The name of the Availability Zone in which the source cluster is located.
" } }, "PreferredOutpostArn": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "The ARN (Amazon Resource Name) of the preferred outpost.
" } }, "CacheClusterCreateTime": { "target": "com.amazonaws.elasticache#TStamp", "traits": { "smithy.api#documentation": "The date and time when the source cluster was created.
" } }, "PreferredMaintenanceWindow": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "Specifies the weekly time range during which maintenance on the cluster is performed.\n It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The\n minimum maintenance window is a 60 minute period.
\nValid values for ddd are:
\n sun\n
\n mon\n
\n tue\n
\n wed\n
\n thu\n
\n fri\n
\n sat\n
Example: sun:23:00-mon:01:30\n
The Amazon Resource Name (ARN) for the topic used by the source cluster for publishing\n notifications.
" } }, "Port": { "target": "com.amazonaws.elasticache#IntegerOptional", "traits": { "smithy.api#documentation": "The port number used by each cache nodes in the source cluster.
" } }, "CacheParameterGroupName": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "The cache parameter group that is associated with the source cluster.
" } }, "CacheSubnetGroupName": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "The name of the cache subnet group associated with the source cluster.
" } }, "VpcId": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "The Amazon Virtual Private Cloud identifier (VPC ID) of the cache subnet group for the\n source cluster.
" } }, "AutoMinorVersionUpgrade": { "target": "com.amazonaws.elasticache#Boolean", "traits": { "smithy.api#documentation": "\u00a0If you are running Valkey 7.2 and above or Redis OSS engine version 6.0 and above, set this parameter to yes if\n you want to opt-in to the next auto minor version upgrade campaign. This parameter is\n disabled for previous versions.\u00a0
" } }, "SnapshotRetentionLimit": { "target": "com.amazonaws.elasticache#IntegerOptional", "traits": { "smithy.api#documentation": "For an automatic snapshot, the number of days for which ElastiCache retains the\n snapshot before deleting it.
\nFor manual snapshots, this field reflects the SnapshotRetentionLimit for\n the source cluster when the snapshot was created. This field is otherwise ignored:\n Manual snapshots do not expire, and can only be deleted using the\n DeleteSnapshot operation.
\n Important If the value of SnapshotRetentionLimit is set\n to zero (0), backups are turned off.
" } }, "SnapshotWindow": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "The daily time range during which ElastiCache takes daily snapshots of the source\n cluster.
" } }, "NumNodeGroups": { "target": "com.amazonaws.elasticache#IntegerOptional", "traits": { "smithy.api#documentation": "The number of node groups (shards) in this snapshot. When restoring from a snapshot,\n the number of node groups (shards) in the snapshot and in the restored replication group\n must be the same.
" } }, "AutomaticFailover": { "target": "com.amazonaws.elasticache#AutomaticFailoverStatus", "traits": { "smithy.api#documentation": "Indicates the status of automatic failover for the source Valkey or Redis OSS replication\n group.
" } }, "NodeSnapshots": { "target": "com.amazonaws.elasticache#NodeSnapshotList", "traits": { "smithy.api#documentation": "A list of the cache nodes in the source cluster.
" } }, "KmsKeyId": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "The ID of the KMS key used to encrypt the snapshot.
" } }, "ARN": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "The ARN (Amazon Resource Name) of the snapshot.
" } }, "DataTiering": { "target": "com.amazonaws.elasticache#DataTieringStatus", "traits": { "smithy.api#documentation": "Enables data tiering. Data tiering is only supported for replication groups using the\n r6gd node type. This parameter must be set to true when using r6gd nodes. For more\n information, see Data tiering.
" } }, "Durability": { "target": "com.amazonaws.elasticache#Durability", "traits": { "smithy.api#documentation": "The durability setting of the cluster when the snapshot was taken. When restoring from this snapshot,\n the cluster uses this durability setting unless overridden in the restore request. For more information,\n see Durability.
" } } }, "traits": { "smithy.api#documentation": "Represents a copy of an entire Valkey or Redis OSS cluster as of the time when the snapshot was\n taken.
" } }, "com.amazonaws.elasticache#SnapshotAlreadyExistsFault": { "type": "structure", "members": { "message": { "target": "com.amazonaws.elasticache#ExceptionMessage" } }, "traits": { "aws.protocols#awsQueryError": { "code": "SnapshotAlreadyExistsFault", "httpResponseCode": 400 }, "smithy.api#documentation": "You already have a snapshot with the given name.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.elasticache#SnapshotArnsList": { "type": "list", "member": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#xmlName": "SnapshotArn" } } }, "com.amazonaws.elasticache#SnapshotFeatureNotSupportedFault": { "type": "structure", "members": { "message": { "target": "com.amazonaws.elasticache#ExceptionMessage" } }, "traits": { "aws.protocols#awsQueryError": { "code": "SnapshotFeatureNotSupportedFault", "httpResponseCode": 400 }, "smithy.api#documentation": "You attempted one of the following operations:
\nCreating a snapshot of a Valkey or Redis OSS cluster running on a\n cache.t1.micro cache node.
Creating a snapshot of a cluster that is running Memcached rather than\n Valkey or Redis OSS.
\nNeither of these are supported by ElastiCache.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.elasticache#SnapshotList": { "type": "list", "member": { "target": "com.amazonaws.elasticache#Snapshot", "traits": { "smithy.api#xmlName": "Snapshot" } } }, "com.amazonaws.elasticache#SnapshotNotFoundFault": { "type": "structure", "members": { "message": { "target": "com.amazonaws.elasticache#ExceptionMessage" } }, "traits": { "aws.protocols#awsQueryError": { "code": "SnapshotNotFoundFault", "httpResponseCode": 404 }, "smithy.api#documentation": "The requested snapshot name does not refer to an existing snapshot.
", "smithy.api#error": "client", "smithy.api#httpError": 404 } }, "com.amazonaws.elasticache#SnapshotQuotaExceededFault": { "type": "structure", "members": { "message": { "target": "com.amazonaws.elasticache#ExceptionMessage" } }, "traits": { "aws.protocols#awsQueryError": { "code": "SnapshotQuotaExceededFault", "httpResponseCode": 400 }, "smithy.api#documentation": "The request cannot be processed because it would exceed the maximum number of\n snapshots.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.elasticache#SourceAuthenticationConfiguration": { "type": "structure", "members": { "SecretManagerConfig": { "target": "com.amazonaws.elasticache#SecretManagerAuthConfig", "traits": { "smithy.api#documentation": "The Secrets Manager configuration used for authenticating with the source during migration.
" } } }, "traits": { "smithy.api#documentation": "The authentication configuration for connecting to the source during migration.
" } }, "com.amazonaws.elasticache#SourceTlsConfiguration": { "type": "structure", "members": { "SourceTlsMode": { "target": "com.amazonaws.elasticache#TlsMode", "traits": { "smithy.api#documentation": "The TLS mode to use when connecting to the source. Valid values are none and verify-ca.
The TLS certificate used to verify the identity of the source during migration.
" } } }, "traits": { "smithy.api#documentation": "The TLS configuration for connecting to the source during migration.
" } }, "com.amazonaws.elasticache#SourceType": { "type": "enum", "members": { "cache_cluster": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "cache-cluster" } }, "cache_parameter_group": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "cache-parameter-group" } }, "cache_security_group": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "cache-security-group" } }, "cache_subnet_group": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "cache-subnet-group" } }, "replication_group": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "replication-group" } }, "serverless_cache": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "serverless-cache" } }, "serverless_cache_snapshot": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "serverless-cache-snapshot" } }, "user": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "user" } }, "user_group": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "user-group" } } } }, "com.amazonaws.elasticache#StartMigration": { "type": "operation", "input": { "target": "com.amazonaws.elasticache#StartMigrationMessage" }, "output": { "target": "com.amazonaws.elasticache#StartMigrationResponse" }, "errors": [ { "target": "com.amazonaws.elasticache#InvalidCacheClusterStateFault" }, { "target": "com.amazonaws.elasticache#InvalidParameterCombinationException" }, { "target": "com.amazonaws.elasticache#InvalidParameterValueException" }, { "target": "com.amazonaws.elasticache#InvalidReplicationGroupStateFault" }, { "target": "com.amazonaws.elasticache#InvalidServerlessCacheStateFault" }, { "target": "com.amazonaws.elasticache#MigrationHealthFault" }, { "target": "com.amazonaws.elasticache#ReplicationGroupAlreadyUnderMigrationFault" }, { "target": "com.amazonaws.elasticache#ReplicationGroupNotFoundFault" }, { "target": "com.amazonaws.elasticache#ServerlessCacheNotFoundFault" }, { "target": "com.amazonaws.elasticache#ServerlessCacheNotUnderMigrationFault" } ], "traits": { "smithy.api#documentation": "Starts the migration of data.
" } }, "com.amazonaws.elasticache#StartMigrationMessage": { "type": "structure", "members": { "ServerlessCacheName": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "The name of the serverless cache to which data is being migrated.
" } }, "ReplicationGroupId": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "The ID of the replication group to which data should be migrated.
" } }, "CustomerNodeEndpointList": { "target": "com.amazonaws.elasticache#CustomerNodeEndpointList", "traits": { "smithy.api#documentation": "The list of endpoints from which to migrate data. For Valkey or Redis OSS (cluster mode\n disabled), the list should have only one element. For serverless cache migrations, ElastiCache\n uses the endpoint that you provided in PrepareMigration.
Specifies whether ElastiCache automatically attempts to complete the migration after data\n sync is established.
" } }, "ClearTargetCacheData": { "target": "com.amazonaws.elasticache#BooleanOptional", "traits": { "smithy.api#documentation": "Specifies whether ElastiCache deletes existing data in the serverless cache before migration\n begins. After StopMigration, StartMigration requires this option to\n restart the data sync.
Provides the details of the serverless cache to which ElastiCache is migrating data.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.elasticache#StopMigration": { "type": "operation", "input": { "target": "com.amazonaws.elasticache#StopMigrationRequest" }, "output": { "target": "com.amazonaws.elasticache#StopMigrationResponse" }, "errors": [ { "target": "com.amazonaws.elasticache#InvalidParameterValueException" }, { "target": "com.amazonaws.elasticache#InvalidServerlessCacheStateFault" }, { "target": "com.amazonaws.elasticache#ServerlessCacheNotFoundFault" }, { "target": "com.amazonaws.elasticache#ServerlessCacheNotUnderMigrationFault" } ], "traits": { "smithy.api#documentation": "Stops an ongoing data sync between the source and the serverless cache. The migration remains\n open and the data sync can be restarted. This operation is valid only while the migration is\n syncing; during cutover it returns\n InvalidServerlessCacheStateFault.
The name of the serverless cache for which to stop the data sync.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.elasticache#StopMigrationResponse": { "type": "structure", "members": { "ServerlessCache": { "target": "com.amazonaws.elasticache#ServerlessCache", "traits": { "smithy.api#documentation": "Provides the details of the serverless cache for which the data sync stopped.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.elasticache#StorageEncryptionType": { "type": "enum", "members": { "NONE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "none" } }, "SSE_ELASTICACHE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "sse-elasticache" } }, "SSE_KMS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "sse-kms" } } } }, "com.amazonaws.elasticache#String": { "type": "string" }, "com.amazonaws.elasticache#Subnet": { "type": "structure", "members": { "SubnetIdentifier": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "The unique identifier for the subnet.
" } }, "SubnetAvailabilityZone": { "target": "com.amazonaws.elasticache#AvailabilityZone", "traits": { "smithy.api#documentation": "The Availability Zone associated with the subnet.
" } }, "SubnetOutpost": { "target": "com.amazonaws.elasticache#SubnetOutpost", "traits": { "smithy.api#documentation": "The outpost ARN of the subnet.
" } }, "SupportedNetworkTypes": { "target": "com.amazonaws.elasticache#NetworkTypeList", "traits": { "smithy.api#documentation": "Either ipv4 | ipv6 | dual_stack. IPv6 is\n supported for workloads using Valkey 7.2 and above, Redis OSS engine version 6.2\n to 7.1 or Memcached engine version 1.6.6 and above on all instances built on the Nitro system.
Represents the subnet associated with a cluster. This parameter refers to subnets\n defined in Amazon Virtual Private Cloud (Amazon VPC) and used with ElastiCache.
" } }, "com.amazonaws.elasticache#SubnetIdentifierList": { "type": "list", "member": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#xmlName": "SubnetIdentifier" } } }, "com.amazonaws.elasticache#SubnetIdsList": { "type": "list", "member": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#xmlName": "SubnetId" } } }, "com.amazonaws.elasticache#SubnetInUse": { "type": "structure", "members": { "message": { "target": "com.amazonaws.elasticache#ExceptionMessage" } }, "traits": { "aws.protocols#awsQueryError": { "code": "SubnetInUse", "httpResponseCode": 400 }, "smithy.api#documentation": "The requested subnet is being used by another cache subnet group.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.elasticache#SubnetList": { "type": "list", "member": { "target": "com.amazonaws.elasticache#Subnet", "traits": { "smithy.api#xmlName": "Subnet" } } }, "com.amazonaws.elasticache#SubnetNotAllowedFault": { "type": "structure", "members": { "message": { "target": "com.amazonaws.elasticache#ExceptionMessage" } }, "traits": { "aws.protocols#awsQueryError": { "code": "SubnetNotAllowedFault", "httpResponseCode": 400 }, "smithy.api#documentation": "At least one subnet ID does not match the other subnet IDs. This mismatch typically\n occurs when a user sets one subnet ID to a regional Availability Zone and a different\n one to an outpost. Or when a user sets the subnet ID to an Outpost when not subscribed\n on this service.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.elasticache#SubnetOutpost": { "type": "structure", "members": { "SubnetOutpostArn": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "The outpost ARN of the subnet.
" } } }, "traits": { "smithy.api#documentation": "The ID of the outpost subnet.
" } }, "com.amazonaws.elasticache#TStamp": { "type": "timestamp" }, "com.amazonaws.elasticache#Tag": { "type": "structure", "members": { "Key": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "The key for the tag. May not be null.
" } }, "Value": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "The tag's value. May be null.
" } } }, "traits": { "smithy.api#documentation": "A tag that can be added to an ElastiCache cluster or replication group. Tags are\n composed of a Key/Value pair. You can use tags to categorize and track all your\n ElastiCache resources. When you add or\n remove tags on replication groups, those actions will be replicated to all nodes in the\n replication group. A tag with a null Value is permitted.
" } }, "com.amazonaws.elasticache#TagList": { "type": "list", "member": { "target": "com.amazonaws.elasticache#Tag", "traits": { "smithy.api#xmlName": "Tag" } } }, "com.amazonaws.elasticache#TagListMessage": { "type": "structure", "members": { "TagList": { "target": "com.amazonaws.elasticache#TagList", "traits": { "smithy.api#documentation": "A list of tags as key-value pairs.
" } } }, "traits": { "smithy.api#documentation": "Represents the output from the AddTagsToResource,\n ListTagsForResource, and RemoveTagsFromResource\n operations.
The requested tag was not found on this resource.
", "smithy.api#error": "client", "smithy.api#httpError": 404 } }, "com.amazonaws.elasticache#TagQuotaPerResourceExceeded": { "type": "structure", "members": { "message": { "target": "com.amazonaws.elasticache#ExceptionMessage" } }, "traits": { "aws.protocols#awsQueryError": { "code": "TagQuotaPerResourceExceeded", "httpResponseCode": 400 }, "smithy.api#documentation": "The request cannot be processed because it would cause the resource to have more than\n the allowed number of tags. The maximum number of tags permitted on a resource is\n 50.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.elasticache#TestFailover": { "type": "operation", "input": { "target": "com.amazonaws.elasticache#TestFailoverMessage" }, "output": { "target": "com.amazonaws.elasticache#TestFailoverResult" }, "errors": [ { "target": "com.amazonaws.elasticache#APICallRateForCustomerExceededFault" }, { "target": "com.amazonaws.elasticache#InvalidCacheClusterStateFault" }, { "target": "com.amazonaws.elasticache#InvalidKMSKeyFault" }, { "target": "com.amazonaws.elasticache#InvalidParameterCombinationException" }, { "target": "com.amazonaws.elasticache#InvalidParameterValueException" }, { "target": "com.amazonaws.elasticache#InvalidReplicationGroupStateFault" }, { "target": "com.amazonaws.elasticache#NodeGroupNotFoundFault" }, { "target": "com.amazonaws.elasticache#ReplicationGroupNotFoundFault" }, { "target": "com.amazonaws.elasticache#TestFailoverNotAvailableFault" } ], "traits": { "smithy.api#documentation": "Represents the input of a TestFailover operation which tests automatic\n failover on a specified node group (called shard in the console) in a replication group\n (called cluster in the console).
This API is designed for testing the behavior of your application in case of\n ElastiCache failover. It is not designed to be an operational tool for initiating a\n failover to overcome a problem you may have with the cluster. Moreover, in certain\n conditions such as large-scale operational events, Amazon may block this API.
\n\n Note the following\n
\nA customer can use this operation to test automatic failover on up to 15 shards\n (called node groups in the ElastiCache API and Amazon CLI) in any rolling\n 24-hour period.
\nIf calling this operation on shards in different clusters (called replication\n groups in the API and CLI), the calls can be made concurrently.
\n\n
If calling this operation multiple times on different shards in the same Valkey or Redis OSS (cluster mode enabled) replication group, the first node replacement must\n complete before a subsequent call can be made.
\nTo determine whether the node replacement is complete you can check Events\n using the Amazon ElastiCache console, the Amazon CLI, or the ElastiCache API.\n Look for the following automatic failover related events, listed here in order\n of occurrance:
\nReplication group message: Test Failover API called for node\n group \n
Cache cluster message: Failover from primary node\n \n
Replication group message: Failover from primary node\n \n
Cache cluster message: Recovering cache nodes\n \n
Cache cluster message: Finished recovery for cache nodes\n \n
For more information see:
\n\n Viewing\n ElastiCache Events in the ElastiCache User\n Guide\n
\n\n DescribeEvents in the ElastiCache API Reference
\nAlso see, Testing\n Multi-AZ in the ElastiCache User Guide.
" } }, "com.amazonaws.elasticache#TestFailoverMessage": { "type": "structure", "members": { "ReplicationGroupId": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The name of the replication group (console: cluster) whose automatic failover is being\n tested by this operation.
", "smithy.api#required": {} } }, "NodeGroupId": { "target": "com.amazonaws.elasticache#AllowedNodeGroupId", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The name of the node group (called shard in the console) in this replication group on\n which automatic failover is to be tested. You may test automatic failover on up to 15\n node groups in any rolling 24-hour period.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.elasticache#TestFailoverNotAvailableFault": { "type": "structure", "members": { "message": { "target": "com.amazonaws.elasticache#ExceptionMessage" } }, "traits": { "aws.protocols#awsQueryError": { "code": "TestFailoverNotAvailableFault", "httpResponseCode": 400 }, "smithy.api#documentation": "The TestFailover action is not available.
Async API to test connection between source and target replication group.
" } }, "com.amazonaws.elasticache#TestMigrationMessage": { "type": "structure", "members": { "ReplicationGroupId": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The ID of the replication group to which data is to be migrated.
", "smithy.api#required": {} } }, "CustomerNodeEndpointList": { "target": "com.amazonaws.elasticache#CustomerNodeEndpointList", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "List of endpoints from which data should be migrated. List should have only one\n element.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.elasticache#TestMigrationResponse": { "type": "structure", "members": { "ReplicationGroup": { "target": "com.amazonaws.elasticache#ReplicationGroup" } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.elasticache#TimeRangeFilter": { "type": "structure", "members": { "StartTime": { "target": "com.amazonaws.elasticache#TStamp", "traits": { "smithy.api#documentation": "The start time of the time range filter
" } }, "EndTime": { "target": "com.amazonaws.elasticache#TStamp", "traits": { "smithy.api#documentation": "The end time of the time range filter
" } } }, "traits": { "smithy.api#documentation": "Filters update actions from the service updates that are in available status during\n the time range.
" } }, "com.amazonaws.elasticache#TlsMode": { "type": "enum", "members": { "none": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "none" } }, "verify_ca": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "verify-ca" } } } }, "com.amazonaws.elasticache#TransitEncryptionMode": { "type": "enum", "members": { "PREFERRED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "preferred" } }, "REQUIRED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "required" } } } }, "com.amazonaws.elasticache#UGReplicationGroupIdList": { "type": "list", "member": { "target": "com.amazonaws.elasticache#String" } }, "com.amazonaws.elasticache#UGServerlessCacheIdList": { "type": "list", "member": { "target": "com.amazonaws.elasticache#String" } }, "com.amazonaws.elasticache#UnprocessedUpdateAction": { "type": "structure", "members": { "ReplicationGroupId": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "The replication group ID
" } }, "CacheClusterId": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "The ID of the cache cluster
" } }, "ServiceUpdateName": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "The unique ID of the service update
" } }, "ErrorType": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "The error type for requests that are not processed
" } }, "ErrorMessage": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "The error message that describes the reason the request was not processed
" } } }, "traits": { "smithy.api#documentation": "Update action that has failed to be processed for the corresponding apply/stop\n request
" } }, "com.amazonaws.elasticache#UnprocessedUpdateActionList": { "type": "list", "member": { "target": "com.amazonaws.elasticache#UnprocessedUpdateAction", "traits": { "smithy.api#xmlName": "UnprocessedUpdateAction" } } }, "com.amazonaws.elasticache#UpdateAction": { "type": "structure", "members": { "ReplicationGroupId": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "The ID of the replication group
" } }, "CacheClusterId": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "The ID of the cache cluster
" } }, "ServiceUpdateName": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "The unique ID of the service update
" } }, "ServiceUpdateReleaseDate": { "target": "com.amazonaws.elasticache#TStamp", "traits": { "smithy.api#documentation": "The date the update is first available
" } }, "ServiceUpdateSeverity": { "target": "com.amazonaws.elasticache#ServiceUpdateSeverity", "traits": { "smithy.api#documentation": "The severity of the service update
" } }, "ServiceUpdateStatus": { "target": "com.amazonaws.elasticache#ServiceUpdateStatus", "traits": { "smithy.api#documentation": "The status of the service update
" } }, "ServiceUpdateRecommendedApplyByDate": { "target": "com.amazonaws.elasticache#TStamp", "traits": { "smithy.api#documentation": "The recommended date to apply the service update to ensure compliance. For information\n on compliance, see Self-Service Security Updates for Compliance.
" } }, "ServiceUpdateType": { "target": "com.amazonaws.elasticache#ServiceUpdateType", "traits": { "smithy.api#documentation": "Reflects the nature of the service update
" } }, "UpdateActionAvailableDate": { "target": "com.amazonaws.elasticache#TStamp", "traits": { "smithy.api#documentation": "The date that the service update is available to a replication group
" } }, "UpdateActionStatus": { "target": "com.amazonaws.elasticache#UpdateActionStatus", "traits": { "smithy.api#documentation": "The status of the update action
" } }, "NodesUpdated": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "The progress of the service update on the replication group
" } }, "UpdateActionStatusModifiedDate": { "target": "com.amazonaws.elasticache#TStamp", "traits": { "smithy.api#documentation": "The date when the UpdateActionStatus was last modified
" } }, "SlaMet": { "target": "com.amazonaws.elasticache#SlaMet", "traits": { "smithy.api#documentation": "If yes, all nodes in the replication group have been updated by the recommended\n apply-by date. If no, at least one node in the replication group have not been updated\n by the recommended apply-by date. If N/A, the replication group was created after the\n recommended apply-by date.
" } }, "NodeGroupUpdateStatus": { "target": "com.amazonaws.elasticache#NodeGroupUpdateStatusList", "traits": { "smithy.api#documentation": "The status of the service update on the node group
" } }, "CacheNodeUpdateStatus": { "target": "com.amazonaws.elasticache#CacheNodeUpdateStatusList", "traits": { "smithy.api#documentation": "The status of the service update on the cache node
" } }, "EstimatedUpdateTime": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "The estimated length of time for the update to complete
" } }, "Engine": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "The Elasticache engine to which the update applies. Either Valkey, Redis OSS or Memcached.
" } } }, "traits": { "smithy.api#documentation": "The status of the service update for a specific replication group
" } }, "com.amazonaws.elasticache#UpdateActionList": { "type": "list", "member": { "target": "com.amazonaws.elasticache#UpdateAction", "traits": { "smithy.api#xmlName": "UpdateAction" } } }, "com.amazonaws.elasticache#UpdateActionResultsMessage": { "type": "structure", "members": { "ProcessedUpdateActions": { "target": "com.amazonaws.elasticache#ProcessedUpdateActionList", "traits": { "smithy.api#documentation": "Update actions that have been processed successfully
" } }, "UnprocessedUpdateActions": { "target": "com.amazonaws.elasticache#UnprocessedUpdateActionList", "traits": { "smithy.api#documentation": "Update actions that haven't been processed successfully
" } } } }, "com.amazonaws.elasticache#UpdateActionStatus": { "type": "enum", "members": { "NOT_APPLIED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "not-applied" } }, "WAITING_TO_START": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "waiting-to-start" } }, "IN_PROGRESS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "in-progress" } }, "STOPPING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "stopping" } }, "STOPPED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "stopped" } }, "COMPLETE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "complete" } }, "SCHEDULING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "scheduling" } }, "SCHEDULED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "scheduled" } }, "NOT_APPLICABLE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "not-applicable" } } } }, "com.amazonaws.elasticache#UpdateActionStatusList": { "type": "list", "member": { "target": "com.amazonaws.elasticache#UpdateActionStatus" }, "traits": { "smithy.api#length": { "min": 0, "max": 9 } } }, "com.amazonaws.elasticache#UpdateActionsMessage": { "type": "structure", "members": { "Marker": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "An optional marker returned from a prior request. Use this marker for pagination of\n results from this operation. If this parameter is specified, the response includes only\n records beyond the marker, up to the value specified by MaxRecords.
Returns a list of update actions
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.elasticache#User": { "type": "structure", "members": { "UserId": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "The ID of the user.
" } }, "UserName": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "The username of the user.
" } }, "Status": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "Indicates the user status. Can be \"active\", \"modifying\" or \"deleting\".
" } }, "Engine": { "target": "com.amazonaws.elasticache#EngineType", "traits": { "smithy.api#documentation": "The options are valkey or redis.
" } }, "MinimumEngineVersion": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "The minimum engine version required, which is Redis OSS 6.0
" } }, "AccessString": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "Access permissions string used for this user.
" } }, "UserGroupIds": { "target": "com.amazonaws.elasticache#UserGroupIdList", "traits": { "smithy.api#documentation": "Returns a list of the user group IDs the user belongs to.
" } }, "Authentication": { "target": "com.amazonaws.elasticache#Authentication", "traits": { "smithy.api#documentation": "Denotes whether the user requires a password to authenticate.
" } }, "ARN": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the user.
" } } } }, "com.amazonaws.elasticache#UserAlreadyExistsFault": { "type": "structure", "members": { "message": { "target": "com.amazonaws.elasticache#ExceptionMessage" } }, "traits": { "aws.protocols#awsQueryError": { "code": "UserAlreadyExists", "httpResponseCode": 400 }, "smithy.api#documentation": "A user with this ID already exists.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.elasticache#UserGroup": { "type": "structure", "members": { "UserGroupId": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "The ID of the user group.
" } }, "Status": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "Indicates user group status. Can be \"creating\", \"active\", \"modifying\",\n \"deleting\".
" } }, "Engine": { "target": "com.amazonaws.elasticache#EngineType", "traits": { "smithy.api#documentation": "The options are valkey or redis.
" } }, "UserIds": { "target": "com.amazonaws.elasticache#UserIdList", "traits": { "smithy.api#documentation": "The list of user IDs that belong to the user group.
" } }, "MinimumEngineVersion": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "The minimum engine version required, which is Redis OSS 6.0
" } }, "PendingChanges": { "target": "com.amazonaws.elasticache#UserGroupPendingChanges", "traits": { "smithy.api#documentation": "A list of updates being applied to the user group.
" } }, "ReplicationGroups": { "target": "com.amazonaws.elasticache#UGReplicationGroupIdList", "traits": { "smithy.api#documentation": "A list of replication groups that the user group can access.
" } }, "ServerlessCaches": { "target": "com.amazonaws.elasticache#UGServerlessCacheIdList", "traits": { "smithy.api#documentation": "Indicates which serverless caches the specified user group is associated with. Available for Valkey, Redis OSS and Serverless Memcached only.
" } }, "ARN": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the user group.
" } } } }, "com.amazonaws.elasticache#UserGroupAlreadyExistsFault": { "type": "structure", "members": { "message": { "target": "com.amazonaws.elasticache#ExceptionMessage" } }, "traits": { "aws.protocols#awsQueryError": { "code": "UserGroupAlreadyExists", "httpResponseCode": 400 }, "smithy.api#documentation": "The user group with this ID already exists.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.elasticache#UserGroupId": { "type": "string", "traits": { "smithy.api#length": { "min": 1 }, "smithy.api#pattern": "^[a-zA-Z][a-zA-Z0-9\\-]*$" } }, "com.amazonaws.elasticache#UserGroupIdList": { "type": "list", "member": { "target": "com.amazonaws.elasticache#UserGroupId" } }, "com.amazonaws.elasticache#UserGroupIdListInput": { "type": "list", "member": { "target": "com.amazonaws.elasticache#UserGroupId" }, "traits": { "smithy.api#length": { "min": 1 } } }, "com.amazonaws.elasticache#UserGroupList": { "type": "list", "member": { "target": "com.amazonaws.elasticache#UserGroup" } }, "com.amazonaws.elasticache#UserGroupNotFoundFault": { "type": "structure", "members": { "message": { "target": "com.amazonaws.elasticache#ExceptionMessage" } }, "traits": { "aws.protocols#awsQueryError": { "code": "UserGroupNotFound", "httpResponseCode": 404 }, "smithy.api#documentation": "The user group was not found or does not exist
", "smithy.api#error": "client", "smithy.api#httpError": 404 } }, "com.amazonaws.elasticache#UserGroupPendingChanges": { "type": "structure", "members": { "UserIdsToRemove": { "target": "com.amazonaws.elasticache#UserIdList", "traits": { "smithy.api#documentation": "The list of user IDs to remove.
" } }, "UserIdsToAdd": { "target": "com.amazonaws.elasticache#UserIdList", "traits": { "smithy.api#documentation": "The list of user IDs to add.
" } } }, "traits": { "smithy.api#documentation": "Returns the updates being applied to the user group.
" } }, "com.amazonaws.elasticache#UserGroupQuotaExceededFault": { "type": "structure", "members": { "message": { "target": "com.amazonaws.elasticache#ExceptionMessage" } }, "traits": { "aws.protocols#awsQueryError": { "code": "UserGroupQuotaExceeded", "httpResponseCode": 400 }, "smithy.api#documentation": "The number of users exceeds the user group limit.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.elasticache#UserGroupsUpdateStatus": { "type": "structure", "members": { "UserGroupIdsToAdd": { "target": "com.amazonaws.elasticache#UserGroupIdList", "traits": { "smithy.api#documentation": "The ID of the user group to add.
" } }, "UserGroupIdsToRemove": { "target": "com.amazonaws.elasticache#UserGroupIdList", "traits": { "smithy.api#documentation": "The ID of the user group to remove.
" } } }, "traits": { "smithy.api#documentation": "The status of the user group update.
" } }, "com.amazonaws.elasticache#UserId": { "type": "string", "traits": { "smithy.api#length": { "min": 1 }, "smithy.api#pattern": "^[a-zA-Z][a-zA-Z0-9\\-]*$" } }, "com.amazonaws.elasticache#UserIdList": { "type": "list", "member": { "target": "com.amazonaws.elasticache#UserId" } }, "com.amazonaws.elasticache#UserIdListInput": { "type": "list", "member": { "target": "com.amazonaws.elasticache#UserId" }, "traits": { "smithy.api#length": { "min": 1 } } }, "com.amazonaws.elasticache#UserList": { "type": "list", "member": { "target": "com.amazonaws.elasticache#User" } }, "com.amazonaws.elasticache#UserName": { "type": "string", "traits": { "smithy.api#length": { "min": 1 } } }, "com.amazonaws.elasticache#UserNotFoundFault": { "type": "structure", "members": { "message": { "target": "com.amazonaws.elasticache#ExceptionMessage" } }, "traits": { "aws.protocols#awsQueryError": { "code": "UserNotFound", "httpResponseCode": 404 }, "smithy.api#documentation": "The user does not exist or could not be found.
", "smithy.api#error": "client", "smithy.api#httpError": 404 } }, "com.amazonaws.elasticache#UserQuotaExceededFault": { "type": "structure", "members": { "message": { "target": "com.amazonaws.elasticache#ExceptionMessage" } }, "traits": { "aws.protocols#awsQueryError": { "code": "UserQuotaExceeded", "httpResponseCode": 400 }, "smithy.api#documentation": "The quota of users has been exceeded.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } } } }