@datafire/amazonaws_elasticache
v5.0.0
Published
DataFire integration for Amazon ElastiCache
Downloads
23
Readme
@datafire/amazonaws_elasticache
Client library for Amazon ElastiCache
Installation and Usage
npm install --save @datafire/amazonaws_elasticache
let amazonaws_elasticache = require('@datafire/amazonaws_elasticache').create({
accessKeyId: "",
secretAccessKey: "",
region: ""
});
amazonaws_elasticache.AddTagsToResource({
"ResourceName": "",
"Tags": []
}).then(data => {
console.log(data);
});
Description
Amazon ElastiCache Amazon ElastiCache is a web service that makes it easier to set up, operate, and scale a distributed cache in the cloud. With ElastiCache, customers get all of the benefits of a high-performance, in-memory cache with less of the administrative burden involved in launching and managing a distributed cache. The service makes setup, scaling, and cluster failure handling much simpler than in a self-managed cache deployment. In addition, through integration with Amazon CloudWatch, customers get enhanced visibility into the key performance statistics associated with their cache and can receive alarms if a part of their cache runs hot.
Actions
AddTagsToResource
amazonaws_elasticache.AddTagsToResource({
"ResourceName": "",
"Tags": []
}, context)
Input
Output
- output TagListMessage
AuthorizeCacheSecurityGroupIngress
amazonaws_elasticache.AuthorizeCacheSecurityGroupIngress({
"CacheSecurityGroupName": "",
"EC2SecurityGroupName": "",
"EC2SecurityGroupOwnerId": ""
}, context)
Input
- input
object
Output
CopySnapshot
amazonaws_elasticache.CopySnapshot({
"SourceSnapshotName": "",
"TargetSnapshotName": ""
}, context)
Input
Output
- output CopySnapshotResult
CreateCacheCluster
amazonaws_elasticache.CreateCacheCluster({
"CacheClusterId": ""
}, context)
Input
- input
object
- AZMode AZMode
- AuthToken String
- AutoMinorVersionUpgrade BooleanOptional
- CacheClusterId required String
- CacheNodeType String
- CacheParameterGroupName String
- CacheSecurityGroupNames CacheSecurityGroupNameList
- CacheSubnetGroupName String
- Engine String
- EngineVersion String
- NotificationTopicArn String
- NumCacheNodes IntegerOptional
- Port IntegerOptional
- PreferredAvailabilityZone String
- PreferredAvailabilityZones PreferredAvailabilityZoneList
- PreferredMaintenanceWindow String
- ReplicationGroupId String
- SecurityGroupIds SecurityGroupIdsList
- SnapshotArns SnapshotArnsList
- SnapshotName String
- SnapshotRetentionLimit IntegerOptional
- SnapshotWindow String
- Tags TagList
Output
- output CreateCacheClusterResult
CreateCacheParameterGroup
amazonaws_elasticache.CreateCacheParameterGroup({
"CacheParameterGroupName": "",
"CacheParameterGroupFamily": "",
"Description": ""
}, context)
Input
- input
object
Output
CreateCacheSecurityGroup
amazonaws_elasticache.CreateCacheSecurityGroup({
"CacheSecurityGroupName": "",
"Description": ""
}, context)
Input
Output
CreateCacheSubnetGroup
amazonaws_elasticache.CreateCacheSubnetGroup({
"CacheSubnetGroupName": "",
"CacheSubnetGroupDescription": "",
"SubnetIds": []
}, context)
Input
- input
object
- CacheSubnetGroupDescription required String
- CacheSubnetGroupName required String
- SubnetIds required SubnetIdentifierList
Output
- output CreateCacheSubnetGroupResult
CreateReplicationGroup
amazonaws_elasticache.CreateReplicationGroup({
"ReplicationGroupId": "",
"ReplicationGroupDescription": ""
}, context)
Input
- input
object
- AtRestEncryptionEnabled BooleanOptional
- AuthToken String
- AutoMinorVersionUpgrade BooleanOptional
- AutomaticFailoverEnabled BooleanOptional
- CacheNodeType String
- CacheParameterGroupName String
- CacheSecurityGroupNames CacheSecurityGroupNameList
- CacheSubnetGroupName String
- Engine String
- EngineVersion String
- NodeGroupConfiguration NodeGroupConfigurationList
- NotificationTopicArn String
- NumCacheClusters IntegerOptional
- NumNodeGroups IntegerOptional
- Port IntegerOptional
- PreferredCacheClusterAZs AvailabilityZonesList
- PreferredMaintenanceWindow String
- PrimaryClusterId String
- ReplicasPerNodeGroup IntegerOptional
- ReplicationGroupDescription required String
- ReplicationGroupId required String
- SecurityGroupIds SecurityGroupIdsList
- SnapshotArns SnapshotArnsList
- SnapshotName String
- SnapshotRetentionLimit IntegerOptional
- SnapshotWindow String
- Tags TagList
- TransitEncryptionEnabled BooleanOptional
Output
- output CreateReplicationGroupResult
CreateSnapshot
amazonaws_elasticache.CreateSnapshot({
"SnapshotName": ""
}, context)
Input
Output
- output CreateSnapshotResult
DeleteCacheCluster
amazonaws_elasticache.DeleteCacheCluster({
"CacheClusterId": ""
}, context)
Input
Output
- output DeleteCacheClusterResult
DeleteCacheParameterGroup
amazonaws_elasticache.DeleteCacheParameterGroup({
"CacheParameterGroupName": ""
}, context)
Input
- input
object
- CacheParameterGroupName required String
Output
Output schema unknown
DeleteCacheSecurityGroup
amazonaws_elasticache.DeleteCacheSecurityGroup({
"CacheSecurityGroupName": ""
}, context)
Input
- input
object
- CacheSecurityGroupName required String
Output
Output schema unknown
DeleteCacheSubnetGroup
amazonaws_elasticache.DeleteCacheSubnetGroup({
"CacheSubnetGroupName": ""
}, context)
Input
- input
object
- CacheSubnetGroupName required String
Output
Output schema unknown
DeleteReplicationGroup
amazonaws_elasticache.DeleteReplicationGroup({
"ReplicationGroupId": ""
}, context)
Input
- input
object
- FinalSnapshotIdentifier String
- ReplicationGroupId required String
- RetainPrimaryCluster BooleanOptional
Output
- output DeleteReplicationGroupResult
DeleteSnapshot
amazonaws_elasticache.DeleteSnapshot({
"SnapshotName": ""
}, context)
Input
- input
object
- SnapshotName required String
Output
- output DeleteSnapshotResult
DescribeCacheClusters
amazonaws_elasticache.DescribeCacheClusters({}, context)
Input
- input
object
- MaxRecords
string
- Marker
string
- CacheClusterId String
- Marker String
- MaxRecords IntegerOptional
- ShowCacheClustersNotInReplicationGroups BooleanOptional
- ShowCacheNodeInfo BooleanOptional
- MaxRecords
Output
- output CacheClusterMessage
DescribeCacheEngineVersions
amazonaws_elasticache.DescribeCacheEngineVersions({}, context)
Input
- input
object
Output
- output CacheEngineVersionMessage
DescribeCacheParameterGroups
amazonaws_elasticache.DescribeCacheParameterGroups({}, context)
Input
- input
object
- MaxRecords
string
- Marker
string
- CacheParameterGroupName String
- Marker String
- MaxRecords IntegerOptional
- MaxRecords
Output
- output CacheParameterGroupsMessage
DescribeCacheParameters
amazonaws_elasticache.DescribeCacheParameters({
"CacheParameterGroupName": ""
}, context)
Input
- input
object
- MaxRecords
string
- Marker
string
- CacheParameterGroupName required String
- Marker String
- MaxRecords IntegerOptional
- Source String
- MaxRecords
Output
- output CacheParameterGroupDetails
DescribeCacheSecurityGroups
amazonaws_elasticache.DescribeCacheSecurityGroups({}, context)
Input
- input
object
- MaxRecords
string
- Marker
string
- CacheSecurityGroupName String
- Marker String
- MaxRecords IntegerOptional
- MaxRecords
Output
- output CacheSecurityGroupMessage
DescribeCacheSubnetGroups
amazonaws_elasticache.DescribeCacheSubnetGroups({}, context)
Input
- input
object
- MaxRecords
string
- Marker
string
- CacheSubnetGroupName String
- Marker String
- MaxRecords IntegerOptional
- MaxRecords
Output
- output CacheSubnetGroupMessage
DescribeEngineDefaultParameters
amazonaws_elasticache.DescribeEngineDefaultParameters({
"CacheParameterGroupFamily": ""
}, context)
Input
- input
object
- MaxRecords
string
- Marker
string
- CacheParameterGroupFamily required String
- Marker String
- MaxRecords IntegerOptional
- MaxRecords
Output
DescribeEvents
amazonaws_elasticache.DescribeEvents({}, context)
Input
- input
object
- MaxRecords
string
- Marker
string
- Duration IntegerOptional
- EndTime TStamp
- Marker String
- MaxRecords IntegerOptional
- SourceIdentifier String
- SourceType SourceType
- StartTime TStamp
- MaxRecords
Output
- output EventsMessage
DescribeReplicationGroups
amazonaws_elasticache.DescribeReplicationGroups({}, context)
Input
- input
object
- MaxRecords
string
- Marker
string
- Marker String
- MaxRecords IntegerOptional
- ReplicationGroupId String
- MaxRecords
Output
- output ReplicationGroupMessage
DescribeReservedCacheNodes
amazonaws_elasticache.DescribeReservedCacheNodes({}, context)
Input
- input
object
Output
- output ReservedCacheNodeMessage
DescribeReservedCacheNodesOfferings
amazonaws_elasticache.DescribeReservedCacheNodesOfferings({}, context)
Input
- input
object
Output
DescribeSnapshots
amazonaws_elasticache.DescribeSnapshots({}, context)
Input
- input
object
- MaxRecords
string
- Marker
string
- CacheClusterId String
- Marker String
- MaxRecords IntegerOptional
- ReplicationGroupId String
- ShowNodeGroupConfig BooleanOptional
- SnapshotName String
- SnapshotSource String
- MaxRecords
Output
- output DescribeSnapshotsListMessage
ListAllowedNodeTypeModifications
amazonaws_elasticache.ListAllowedNodeTypeModifications({}, context)
Input
Output
ListTagsForResource
amazonaws_elasticache.ListTagsForResource({
"ResourceName": ""
}, context)
Input
- input
object
- ResourceName required String
Output
- output TagListMessage
ModifyCacheCluster
amazonaws_elasticache.ModifyCacheCluster({
"CacheClusterId": ""
}, context)
Input
- input
object
- AZMode AZMode
- ApplyImmediately Boolean
- AutoMinorVersionUpgrade BooleanOptional
- CacheClusterId required String
- CacheNodeIdsToRemove CacheNodeIdsList
- CacheNodeType String
- CacheParameterGroupName String
- CacheSecurityGroupNames CacheSecurityGroupNameList
- EngineVersion String
- NewAvailabilityZones PreferredAvailabilityZoneList
- NotificationTopicArn String
- NotificationTopicStatus String
- NumCacheNodes IntegerOptional
- PreferredMaintenanceWindow String
- SecurityGroupIds SecurityGroupIdsList
- SnapshotRetentionLimit IntegerOptional
- SnapshotWindow String
Output
- output ModifyCacheClusterResult
ModifyCacheParameterGroup
amazonaws_elasticache.ModifyCacheParameterGroup({
"CacheParameterGroupName": "",
"ParameterNameValues": []
}, context)
Input
- input
object
- CacheParameterGroupName required String
- ParameterNameValues required ParameterNameValueList
Output
ModifyCacheSubnetGroup
amazonaws_elasticache.ModifyCacheSubnetGroup({
"CacheSubnetGroupName": ""
}, context)
Input
- input
object
- CacheSubnetGroupDescription String
- CacheSubnetGroupName required String
- SubnetIds SubnetIdentifierList
Output
- output ModifyCacheSubnetGroupResult
ModifyReplicationGroup
amazonaws_elasticache.ModifyReplicationGroup({
"ReplicationGroupId": ""
}, context)
Input
- input
object
- ApplyImmediately Boolean
- AutoMinorVersionUpgrade BooleanOptional
- AutomaticFailoverEnabled BooleanOptional
- CacheNodeType String
- CacheParameterGroupName String
- CacheSecurityGroupNames CacheSecurityGroupNameList
- EngineVersion String
- NodeGroupId String
- NotificationTopicArn String
- NotificationTopicStatus String
- PreferredMaintenanceWindow String
- PrimaryClusterId String
- ReplicationGroupDescription String
- ReplicationGroupId required String
- SecurityGroupIds SecurityGroupIdsList
- SnapshotRetentionLimit IntegerOptional
- SnapshotWindow String
- SnapshottingClusterId String
Output
- output ModifyReplicationGroupResult
ModifyReplicationGroupShardConfiguration
amazonaws_elasticache.ModifyReplicationGroupShardConfiguration({
"ReplicationGroupId": "",
"NodeGroupCount": 0,
"ApplyImmediately": true
}, context)
Input
- input
object
- ApplyImmediately required Boolean
- NodeGroupCount required Integer
- NodeGroupsToRemove NodeGroupsToRemoveList
- ReplicationGroupId required String
- ReshardingConfiguration ReshardingConfigurationList
Output
PurchaseReservedCacheNodesOffering
amazonaws_elasticache.PurchaseReservedCacheNodesOffering({
"ReservedCacheNodesOfferingId": ""
}, context)
Input
- input
object
- CacheNodeCount IntegerOptional
- ReservedCacheNodeId String
- ReservedCacheNodesOfferingId required String
Output
RebootCacheCluster
amazonaws_elasticache.RebootCacheCluster({
"CacheClusterId": "",
"CacheNodeIdsToReboot": []
}, context)
Input
- input
object
- CacheClusterId required String
- CacheNodeIdsToReboot required CacheNodeIdsList
Output
- output RebootCacheClusterResult
RemoveTagsFromResource
amazonaws_elasticache.RemoveTagsFromResource({
"ResourceName": "",
"TagKeys": []
}, context)
Input
Output
- output TagListMessage
ResetCacheParameterGroup
amazonaws_elasticache.ResetCacheParameterGroup({
"CacheParameterGroupName": ""
}, context)
Input
- input
object
- CacheParameterGroupName required String
- ParameterNameValues ParameterNameValueList
- ResetAllParameters Boolean
Output
RevokeCacheSecurityGroupIngress
amazonaws_elasticache.RevokeCacheSecurityGroupIngress({
"CacheSecurityGroupName": "",
"EC2SecurityGroupName": "",
"EC2SecurityGroupOwnerId": ""
}, context)
Input
- input
object
Output
TestFailover
amazonaws_elasticache.TestFailover({
"ReplicationGroupId": "",
"NodeGroupId": ""
}, context)
Input
Output
- output TestFailoverResult
Definitions
APICallRateForCustomerExceededFault
- APICallRateForCustomerExceededFault
object
: The customer has exceeded the allowed rate of API calls.
AZMode
- AZMode
string
(values: single-az, cross-az)
AddTagsToResourceMessage
- AddTagsToResourceMessage
object
: Represents the input of an AddTagsToResource operation.
AllowedNodeTypeModificationsMessage
- AllowedNodeTypeModificationsMessage
object
: Represents the allowed node types you can use to modify your cluster or replication group.- ScaleUpModifications NodeTypeList
AuthorizationAlreadyExistsFault
- AuthorizationAlreadyExistsFault
object
: The specified Amazon EC2 security group is already authorized for the specified cache security group.
AuthorizationNotFoundFault
- AuthorizationNotFoundFault
object
: The specified Amazon EC2 security group is not authorized for the specified cache security group.
AuthorizeCacheSecurityGroupIngressMessage
- AuthorizeCacheSecurityGroupIngressMessage
object
: Represents the input of an AuthorizeCacheSecurityGroupIngress operation.
AuthorizeCacheSecurityGroupIngressResult
- AuthorizeCacheSecurityGroupIngressResult
object
- CacheSecurityGroup CacheSecurityGroup
AutomaticFailoverStatus
- AutomaticFailoverStatus
string
(values: enabled, disabled, enabling, disabling)
AvailabilityZone
- AvailabilityZone
object
: Describes an Availability Zone in which the cluster is launched.- Name String
AvailabilityZonesList
- AvailabilityZonesList
array
- items String
AwsQueryErrorMessage
- AwsQueryErrorMessage
string
Boolean
- Boolean
boolean
BooleanOptional
- BooleanOptional
boolean
CacheCluster
- CacheCluster
object
: Contains all of the attributes of a specific cluster.- AtRestEncryptionEnabled BooleanOptional
- AuthTokenEnabled BooleanOptional
- AutoMinorVersionUpgrade Boolean
- CacheClusterCreateTime TStamp
- CacheClusterId String
- CacheClusterStatus String
- CacheNodeType String
- CacheNodes CacheNodeList
- CacheParameterGroup CacheParameterGroupStatus
- CacheSecurityGroups CacheSecurityGroupMembershipList
- CacheSubnetGroupName String
- ClientDownloadLandingPage String
- ConfigurationEndpoint Endpoint
- Engine String
- EngineVersion String
- NotificationConfiguration NotificationConfiguration
- NumCacheNodes IntegerOptional
- PendingModifiedValues PendingModifiedValues
- PreferredAvailabilityZone String
- PreferredMaintenanceWindow String
- ReplicationGroupId String
- SecurityGroups SecurityGroupMembershipList
- SnapshotRetentionLimit IntegerOptional
- SnapshotWindow String
- TransitEncryptionEnabled BooleanOptional
CacheClusterAlreadyExistsFault
- CacheClusterAlreadyExistsFault
object
: You already have a cluster with the given identifier.
CacheClusterList
- CacheClusterList
array
- items CacheCluster
CacheClusterMessage
- CacheClusterMessage
object
: Represents the output of a DescribeCacheClusters operation.- CacheClusters CacheClusterList
- Marker String
CacheClusterNotFoundFault
- CacheClusterNotFoundFault
object
: The requested cluster ID does not refer to an existing cluster.
CacheEngineVersion
- CacheEngineVersion
object
: Provides all of the details about a particular cache engine version.
CacheEngineVersionList
- CacheEngineVersionList
array
- items CacheEngineVersion
CacheEngineVersionMessage
- CacheEngineVersionMessage
object
: Represents the output of a DescribeCacheEngineVersions operation.- CacheEngineVersions CacheEngineVersionList
- Marker String
CacheNode
- CacheNode
object
: Represents an individual cache node within a cluster. Each cache node runs its own instance of the cluster's protocol-compliant caching software - either Memcached or Redis. The following node types are supported by ElastiCache. Generally speaking, the current generation types provide more memory and computational power at lower cost when compared to their equivalent previous generation counterparts. General purpose: Current generation: T2 node types: cache.t2.micro, cache.t2.small, cache.t2.medium M3 node types: cache.m3.medium, cache.m3.large, cache.m3.xlarge, cache.m3.2xlarge M4 node types: cache.m4.large, cache.m4.xlarge, cache.m4.2xlarge, cache.m4.4xlarge, cache.m4.10xlarge Previous generation: (not recommended) T1 node types: cache.t1.micro M1 node types: cache.m1.small, cache.m1.medium, cache.m1.large, cache.m1.xlarge Compute optimized: Previous generation: (not recommended) C1 node types: cache.c1.xlarge Memory optimized: Current generation: R3 node types: cache.r3.large, cache.r3.xlarge, cache.r3.2xlarge, cache.r3.4xlarge, cache.r3.8xlarge Previous generation: (not recommended) M2 node types: cache.m2.xlarge, cache.m2.2xlarge, cache.m2.4xlarge Notes: All T2 instances are created in an Amazon Virtual Private Cloud (Amazon VPC). Redis (cluster mode disabled): Redis backup/restore is not supported on T1 and T2 instances. Redis (cluster mode enabled): Backup/restore is not supported on T1 instances. Redis Append-only files (AOF) functionality is not supported for T1 or T2 instances. For a complete listing of node types and specifications, see Amazon ElastiCache Product Features and Details and either Cache Node Type-Specific Parameters for Memcached or Cache Node Type-Specific Parameters for Redis.
CacheNodeIdsList
- CacheNodeIdsList
array
- items String
CacheNodeList
- CacheNodeList
array
- items CacheNode
CacheNodeTypeSpecificParameter
- CacheNodeTypeSpecificParameter
object
: A parameter that has a different value for each cache node type it is applied to. For example, in a Redis cluster, a cache.m1.large cache node type would have a larger maxmemory value than a cache.m1.small type.- AllowedValues String
- CacheNodeTypeSpecificValues CacheNodeTypeSpecificValueList
- ChangeType ChangeType
- DataType String
- Description String
- IsModifiable Boolean
- MinimumEngineVersion String
- ParameterName String
- Source String
CacheNodeTypeSpecificParametersList
- CacheNodeTypeSpecificParametersList
array
CacheNodeTypeSpecificValue
- CacheNodeTypeSpecificValue
object
: A value that applies only to a certain cache node type.
CacheNodeTypeSpecificValueList
- CacheNodeTypeSpecificValueList
array
CacheParameterGroup
- CacheParameterGroup
object
: Represents the output of a CreateCacheParameterGroup operation.
CacheParameterGroupAlreadyExistsFault
- CacheParameterGroupAlreadyExistsFault
object
: A cache parameter group with the requested name already exists.
CacheParameterGroupDetails
- CacheParameterGroupDetails
object
: Represents the output of a DescribeCacheParameters operation.- CacheNodeTypeSpecificParameters CacheNodeTypeSpecificParametersList
- Marker String
- Parameters ParametersList
CacheParameterGroupList
- CacheParameterGroupList
array
- items CacheParameterGroup
CacheParameterGroupNameMessage
- CacheParameterGroupNameMessage
object
: Represents the output of one of the following operations: ModifyCacheParameterGroup ResetCacheParameterGroup- CacheParameterGroupName String
CacheParameterGroupNotFoundFault
- CacheParameterGroupNotFoundFault
object
: The requested cache parameter group name does not refer to an existing cache parameter group.
CacheParameterGroupQuotaExceededFault
- CacheParameterGroupQuotaExceededFault
object
: The request cannot be processed because it would exceed the maximum number of cache security groups.
CacheParameterGroupStatus
- CacheParameterGroupStatus
object
: Status of the cache parameter group.- CacheNodeIdsToReboot CacheNodeIdsList
- CacheParameterGroupName String
- ParameterApplyStatus String
CacheParameterGroupsMessage
- CacheParameterGroupsMessage
object
: Represents the output of a DescribeCacheParameterGroups operation.- CacheParameterGroups CacheParameterGroupList
- Marker String
CacheSecurityGroup
- CacheSecurityGroup
object
: Represents the output of one of the following operations: AuthorizeCacheSecurityGroupIngress CreateCacheSecurityGroup RevokeCacheSecurityGroupIngress- CacheSecurityGroupName String
- Description String
- EC2SecurityGroups EC2SecurityGroupList
- OwnerId String
CacheSecurityGroupAlreadyExistsFault
- CacheSecurityGroupAlreadyExistsFault
object
: A cache security group with the specified name already exists.
CacheSecurityGroupMembership
- CacheSecurityGroupMembership
object
: Represents a cluster's status within a particular cache security group.
CacheSecurityGroupMembershipList
- CacheSecurityGroupMembershipList
array
CacheSecurityGroupMessage
- CacheSecurityGroupMessage
object
: Represents the output of a DescribeCacheSecurityGroups operation.- CacheSecurityGroups CacheSecurityGroups
- Marker String
CacheSecurityGroupNameList
- CacheSecurityGroupNameList
array
- items String
CacheSecurityGroupNotFoundFault
- CacheSecurityGroupNotFoundFault
object
: The requested cache security group name does not refer to an existing cache security group.
CacheSecurityGroupQuotaExceededFault
- CacheSecurityGroupQuotaExceededFault
object
: The request cannot be processed because it would exceed the allowed number of cache security groups.
CacheSecurityGroups
- CacheSecurityGroups
array
- items CacheSecurityGroup
CacheSubnetGroup
- CacheSubnetGroup
object
: Represents the output of one of the following operations: CreateCacheSubnetGroup ModifyCacheSubnetGroup- CacheSubnetGroupDescription String
- CacheSubnetGroupName String
- Subnets SubnetList
- VpcId String
CacheSubnetGroupAlreadyExistsFault
- CacheSubnetGroupAlreadyExistsFault
object
: The requested cache subnet group name is already in use by an existing cache subnet group.
CacheSubnetGroupInUse
- CacheSubnetGroupInUse
object
: The requested cache subnet group is currently in use.
CacheSubnetGroupMessage
- CacheSubnetGroupMessage
object
: Represents the output of a DescribeCacheSubnetGroups operation.- CacheSubnetGroups CacheSubnetGroups
- Marker String
CacheSubnetGroupNotFoundFault
- CacheSubnetGroupNotFoundFault
object
: The requested cache subnet group name does not refer to an existing cache subnet group.
CacheSubnetGroupQuotaExceededFault
- CacheSubnetGroupQuotaExceededFault
object
: The request cannot be processed because it would exceed the allowed number of cache subnet groups.
CacheSubnetGroups
- CacheSubnetGroups
array
- items CacheSubnetGroup
CacheSubnetQuotaExceededFault
- CacheSubnetQuotaExceededFault
object
: The request cannot be processed because it would exceed the allowed number of subnets in a cache subnet group.
ChangeType
- ChangeType
string
(values: immediate, requires-reboot)
ClusterIdList
- ClusterIdList
array
- items String
ClusterQuotaForCustomerExceededFault
- ClusterQuotaForCustomerExceededFault
object
: The request cannot be processed because it would exceed the allowed number of clusters per customer.
CopySnapshotMessage
- CopySnapshotMessage
object
: Represents the input of a CopySnapshotMessage operation.
CopySnapshotResult
- CopySnapshotResult
object
- Snapshot Snapshot
CreateCacheClusterMessage
- CreateCacheClusterMessage
object
: Represents the input of a CreateCacheCluster operation.- AZMode AZMode
- AuthToken String
- AutoMinorVersionUpgrade BooleanOptional
- CacheClusterId required String
- CacheNodeType String
- CacheParameterGroupName String
- CacheSecurityGroupNames CacheSecurityGroupNameList
- CacheSubnetGroupName String
- Engine String
- EngineVersion String
- NotificationTopicArn String
- NumCacheNodes IntegerOptional
- Port IntegerOptional
- PreferredAvailabilityZone String
- PreferredAvailabilityZones PreferredAvailabilityZoneList
- PreferredMaintenanceWindow String
- ReplicationGroupId String
- SecurityGroupIds SecurityGroupIdsList
- SnapshotArns SnapshotArnsList
- SnapshotName String
- SnapshotRetentionLimit IntegerOptional
- SnapshotWindow String
- Tags TagList
CreateCacheClusterResult
- CreateCacheClusterResult
object
- CacheCluster CacheCluster
CreateCacheParameterGroupMessage
- CreateCacheParameterGroupMessage
object
: Represents the input of a CreateCacheParameterGroup operation.
CreateCacheParameterGroupResult
- CreateCacheParameterGroupResult
object
- CacheParameterGroup CacheParameterGroup
CreateCacheSecurityGroupMessage
- CreateCacheSecurityGroupMessage
object
: Represents the input of a CreateCacheSecurityGroup operation.
CreateCacheSecurityGroupResult
- CreateCacheSecurityGroupResult
object
- CacheSecurityGroup CacheSecurityGroup
CreateCacheSubnetGroupMessage
- CreateCacheSubnetGroupMessage
object
: Represents the input of a CreateCacheSubnetGroup operation.- CacheSubnetGroupDescription required String
- CacheSubnetGroupName required String
- SubnetIds required SubnetIdentifierList
CreateCacheSubnetGroupResult
- CreateCacheSubnetGroupResult
object
- CacheSubnetGroup CacheSubnetGroup
CreateReplicationGroupMessage
- CreateReplicationGroupMessage
object
: Represents the input of a CreateReplicationGroup operation.- AtRestEncryptionEnabled BooleanOptional
- AuthToken String
- AutoMinorVersionUpgrade BooleanOptional
- AutomaticFailoverEnabled BooleanOptional
- CacheNodeType String
- CacheParameterGroupName String
- CacheSecurityGroupNames CacheSecurityGroupNameList
- CacheSubnetGroupName String
- Engine String
- EngineVersion String
- NodeGroupConfiguration NodeGroupConfigurationList
- NotificationTopicArn String
- NumCacheClusters IntegerOptional
- NumNodeGroups IntegerOptional
- Port IntegerOptional
- PreferredCacheClusterAZs AvailabilityZonesList
- PreferredMaintenanceWindow String
- PrimaryClusterId String
- ReplicasPerNodeGroup IntegerOptional
- ReplicationGroupDescription required String
- ReplicationGroupId required String
- SecurityGroupIds SecurityGroupIdsList
- SnapshotArns SnapshotArnsList
- SnapshotName String
- SnapshotRetentionLimit IntegerOptional
- SnapshotWindow String
- Tags TagList
- TransitEncryptionEnabled BooleanOptional
CreateReplicationGroupResult
- CreateReplicationGroupResult
object
- ReplicationGroup ReplicationGroup
CreateSnapshotMessage
- CreateSnapshotMessage
object
: Represents the input of a CreateSnapshot operation.
CreateSnapshotResult
- CreateSnapshotResult
object
- Snapshot Snapshot
DeleteCacheClusterMessage
- DeleteCacheClusterMessage
object
: Represents the input of a DeleteCacheCluster operation.
DeleteCacheClusterResult
- DeleteCacheClusterResult
object
- CacheCluster CacheCluster
DeleteCacheParameterGroupMessage
- DeleteCacheParameterGroupMessage
object
: Represents the input of a DeleteCacheParameterGroup operation.- CacheParameterGroupName required String
DeleteCacheSecurityGroupMessage
- DeleteCacheSecurityGroupMessage
object
: Represents the input of a DeleteCacheSecurityGroup operation.- CacheSecurityGroupName required String
DeleteCacheSubnetGroupMessage
- DeleteCacheSubnetGroupMessage
object
: Represents the input of a DeleteCacheSubnetGroup operation.- CacheSubnetGroupName required String
DeleteReplicationGroupMessage
- DeleteReplicationGroupMessage
object
: Represents the input of a DeleteReplicationGroup operation.- FinalSnapshotIdentifier String
- ReplicationGroupId required String
- RetainPrimaryCluster BooleanOptional
DeleteReplicationGroupResult
- DeleteReplicationGroupResult
object
- ReplicationGroup ReplicationGroup
DeleteSnapshotMessage
- DeleteSnapshotMessage
object
: Represents the input of a DeleteSnapshot operation.- SnapshotName required String
DeleteSnapshotResult
- DeleteSnapshotResult
object
- Snapshot Snapshot
DescribeCacheClustersMessage
- DescribeCacheClustersMessage
object
: Represents the input of a DescribeCacheClusters operation.- CacheClusterId String
- Marker String
- MaxRecords IntegerOptional
- ShowCacheClustersNotInReplicationGroups BooleanOptional
- ShowCacheNodeInfo BooleanOptional
DescribeCacheEngineVersionsMessage
- DescribeCacheEngineVersionsMessage
object
: Represents the input of a DescribeCacheEngineVersions operation.
DescribeCacheParameterGroupsMessage
- DescribeCacheParameterGroupsMessage
object
: Represents the input of a DescribeCacheParameterGroups operation.- CacheParameterGroupName String
- Marker String
- MaxRecords IntegerOptional
DescribeCacheParametersMessage
- DescribeCacheParametersMessage
object
: Represents the input of a DescribeCacheParameters operation.- CacheParameterGroupName required String
- Marker String
- MaxRecords IntegerOptional
- Source String
DescribeCacheSecurityGroupsMessage
- DescribeCacheSecurityGroupsMessage
object
: Represents the input of a DescribeCacheSecurityGroups operation.- CacheSecurityGroupName String
- Marker String
- MaxRecords IntegerOptional
DescribeCacheSubnetGroupsMessage
- DescribeCacheSubnetGroupsMessage
object
: Represents the input of a DescribeCacheSubnetGroups operation.- CacheSubnetGroupName String
- Marker String
- MaxRecords IntegerOptional
DescribeEngineDefaultParametersMessage
- DescribeEngineDefaultParametersMessage
object
: Represents the input of a DescribeEngineDefaultParameters operation.- CacheParameterGroupFamily required String
- Marker String
- MaxRecords IntegerOptional
DescribeEngineDefaultParametersResult
- DescribeEngineDefaultParametersResult
object
- EngineDefaults EngineDefaults
DescribeEventsMessage
- DescribeEventsMessage
object
: Represents the input of a DescribeEvents operation.- Duration IntegerOptional
- EndTime TStamp
- Marker String
- MaxRecords IntegerOptional
- SourceIdentifier String
- SourceType SourceType
- StartTime TStamp
DescribeReplicationGroupsMessage
- DescribeReplicationGroupsMessage
object
: Represents the input of a DescribeReplicationGroups operation.- Marker String
- MaxRecords IntegerOptional
- ReplicationGroupId String
DescribeReservedCacheNodesMessage
- DescribeReservedCacheNodesMessage
object
: Represents the input of a DescribeReservedCacheNodes operation.
DescribeReservedCacheNodesOfferingsMessage
- DescribeReservedCacheNodesOfferingsMessage
object
: Represents the input of a DescribeReservedCacheNodesOfferings operation.
DescribeSnapshotsListMessage
- DescribeSnapshotsListMessage
object
: Represents the output of a DescribeSnapshots operation.- Marker String
- Snapshots SnapshotList
DescribeSnapshotsMessage
- DescribeSnapshotsMessage
object
: Represents the input of a DescribeSnapshotsMessage operation.- CacheClusterId String
- Marker String
- MaxRecords IntegerOptional
- ReplicationGroupId String
- ShowNodeGroupConfig BooleanOptional
- SnapshotName String
- SnapshotSource String
Double
- Double
number
EC2SecurityGroup
- EC2SecurityGroup
object
: Provides ownership and status information for an Amazon EC2 security group.
EC2SecurityGroupList
- EC2SecurityGroupList
array
- items EC2SecurityGroup
Endpoint
- Endpoint
object
: Represents the information required for client programs to connect to a cache node.
EngineDefaults
- EngineDefaults
object
: Represents the output of a DescribeEngineDefaultParameters operation.- CacheNodeTypeSpecificParameters CacheNodeTypeSpecificParametersList
- CacheParameterGroupFamily String
- Marker String
- Parameters ParametersList
Event
- Event
object
: Represents a single occurrence of something interesting within the system. Some examples of events are creating a cluster, adding or removing a cache node, or rebooting a node.- Date TStamp
- Message String
- SourceIdentifier String
- SourceType SourceType
EventList
- EventList
array
- items Event
EventsMessage
- EventsMessage
object
: Represents the output of a DescribeEvents operation.
InsufficientCacheClusterCapacityFault
- InsufficientCacheClusterCapacityFault
object
: The requested cache node type is not available in the specified Availability Zone.
Integer
- Integer
integer
IntegerOptional
- IntegerOptional
integer
InvalidARNFault
- InvalidARNFault
object
: The requested Amazon Resource Name (ARN) does not refer to an existing resource.
InvalidCacheClusterStateFault
- InvalidCacheClusterStateFault
object
: The requested cluster is not in the available state.
InvalidCacheParameterGroupStateFault
- InvalidCacheParameterGroupStateFault
object
: The current state of the cache parameter group does not allow the requested operation to occur.
InvalidCacheSecurityGroupStateFault
- InvalidCacheSecurityGroupStateFault
object
: The current state of the cache security group does not allow deletion.
InvalidParameterCombinationException
- InvalidParameterCombinationException
object
: Two or more incompatible parameters were specified.- message AwsQueryErrorMessage
InvalidParameterValueException
- InvalidParameterValueException
object
: The value for a parameter is invalid.- message AwsQueryErrorMessage
InvalidReplicationGroupStateFault
- InvalidReplicationGroupStateFault
object
: The requested replication group is not in the available state.
InvalidSnapshotStateFault
- InvalidSnapshotStateFault
object
: The current state of the snapshot does not allow the requested operation to occur.
InvalidSubnet
- InvalidSubnet
object
: An invalid subnet identifier was specified.
InvalidVPCNetworkStateFault
- InvalidVPCNetworkStateFault
object
: The VPC network is in an invalid state.
KeyList
- KeyList
array
- items String
ListAllowedNodeTypeModificationsMessage
- ListAllowedNodeTypeModificationsMessage
object
: The input parameters for the ListAllowedNodeTypeModifications operation.
ListTagsForResourceMessage
- ListTagsForResourceMessage
object
: The input parameters for the ListTagsForResource operation.- ResourceName required String
ModifyCacheClusterMessage
- ModifyCacheClusterMessage
object
: Represents the input of a ModifyCacheCluster operation.- AZMode AZMode
- ApplyImmediately Boolean
- AutoMinorVersionUpgrade BooleanOptional
- CacheClusterId required String
- CacheNodeIdsToRemove CacheNodeIdsList
- CacheNodeType String
- CacheParameterGroupName String
- CacheSecurityGroupNames CacheSecurityGroupNameList
- EngineVersion String
- NewAvailabilityZones PreferredAvailabilityZoneList
- NotificationTopicArn String
- NotificationTopicStatus String
- NumCacheNodes IntegerOptional
- PreferredMaintenanceWindow String
- SecurityGroupIds SecurityGroupIdsList
- SnapshotRetentionLimit IntegerOptional
- SnapshotWindow String
ModifyCacheClusterResult
- ModifyCacheClusterResult
object
- CacheCluster CacheCluster
ModifyCacheParameterGroupMessage
- ModifyCacheParameterGroupMessage
object
: Represents the input of a ModifyCacheParameterGroup operation.- CacheParameterGroupName required String
- ParameterNameValues required ParameterNameValueList
ModifyCacheSubnetGroupMessage
- ModifyCacheSubnetGroupMessage
object
: Represents the input of a ModifyCacheSubnetGroup operation.- CacheSubnetGroupDescription String
- CacheSubnetGroupName required String
- SubnetIds SubnetIdentifierList
ModifyCacheSubnetGroupResult
- ModifyCacheSubnetGroupResult
object
- CacheSubnetGroup CacheSubnetGroup
ModifyReplicationGroupMessage
- ModifyReplicationGroupMessage
object
: Represents the input of a ModifyReplicationGroups operation.- ApplyImmediately Boolean
- AutoMinorVersionUpgrade BooleanOptional
- AutomaticFailoverEnabled BooleanOptional
- CacheNodeType String
- CacheParameterGroupName String
- CacheSecurityGroupNames CacheSecurityGroupNameList
- EngineVersion String
- NodeGroupId String
- NotificationTopicArn String
- NotificationTopicStatus String
- PreferredMaintenanceWindow String
- PrimaryClusterId String
- ReplicationGroupDescription String
- ReplicationGroupId required String
- SecurityGroupIds SecurityGroupIdsList
- SnapshotRetentionLimit IntegerOptional
- SnapshotWindow String
- SnapshottingClusterId String
ModifyReplicationGroupResult
- ModifyReplicationGroupResult
object
- ReplicationGroup ReplicationGroup
ModifyReplicationGroupShardConfigurationMessage
- ModifyReplicationGroupShardConfigurationMessage
object
: Represents the input for a ModifyReplicationGroupShardConfiguration operation.- ApplyImmediately required Boolean
- NodeGroupCount required Integer
- NodeGroupsToRemove NodeGroupsToRemoveList
- ReplicationGroupId required String
- ReshardingConfiguration ReshardingConfigurationList
ModifyReplicationGroupShardConfigurationResult
- ModifyReplicationGroupShardConfigurationResult
object
- ReplicationGroup ReplicationGroup
NodeGroup
- NodeGroup
object
: Represents a collection of cache nodes in a replication group. One node in the node group is the read/write primary node. All the other nodes are read-only Replica nodes.- NodeGroupId String
- NodeGroupMembers NodeGroupMemberList
- PrimaryEndpoint Endpoint
- Slots String
- Status String
NodeGroupConfiguration
- NodeGroupConfiguration
object
: Node group (shard) configuration options. Each node group (shard) configuration has the following: Slots, PrimaryAvailabilityZone, ReplicaAvailabilityZones, ReplicaCount.- PrimaryAvailabilityZone String
- ReplicaAvailabilityZones AvailabilityZonesList
- ReplicaCount IntegerOptional
- Slots String
NodeGroupConfigurationList
- NodeGroupConfigurationList
array
- items NodeGroupConfiguration
NodeGroupList
- NodeGroupList
array
- items NodeGroup
NodeGroupMember
- NodeGroupMember
object
: Represents a single node within a node group (shard).
NodeGroupMemberList
- NodeGroupMemberList
array
- items NodeGroupMember
NodeGroupNotFoundFault
- NodeGroupNotFoundFault
object
: The node group specified by the NodeGroupId parameter could not be found. Please verify that the node group exists and that you spelled the NodeGroupId value correctly.
NodeGroupsPerReplicationGroupQuotaExceededFault
- NodeGroupsPerReplicationGroupQuotaExceededFault
object
: The request cannot be processed because it would exceed the maximum allowed number of node groups (shards) in a single replication group. The default maximum is 15
NodeGroupsToRemoveList
- NodeGroupsToRemoveList
array
- items String
NodeQuotaForClusterExceededFault
- NodeQuotaForClusterExceededFault
object
: The request cannot be processed because it would exceed the allowed number of cache nodes in a single cluster.
NodeQuotaForCustomerExceededFault
- NodeQuotaForCustomerExceededFault
object
: The request cannot be processed because it would exceed the allowed number of cache nodes per customer.
NodeSnapshot
- NodeSnapshot
object
: Represents an individual cache node in a snapshot of a cluster.
NodeSnapshotList
- NodeSnapshotList
array
- items NodeSnapshot
NodeTypeList
- NodeTypeList
array
- items String
NotificationConfiguration
- NotificationConfiguration
object
: Describes a notification topic and its status. Notification topics are used for publishing ElastiCache events to subscribers using Amazon Simple Notification Service (SNS).
Parameter
- Parameter
object
: Describes an individual setting that controls some aspect of ElastiCache behavior.
ParameterNameValue
- ParameterNameValue
object
: Describes a name-value pair that is used to update the value of a parameter.
ParameterNameValueList
- ParameterNameValueList
array
- items ParameterNameValue
ParametersList
- ParametersList
array
- items Parameter
PendingAutomaticFailoverStatus
- PendingAutomaticFailoverStatus
string
(values: enabled, disabled)
PendingModifiedValues
- PendingModifiedValues
object
: A group of settings that are applied to the cluster in the future, or that are currently being applied.- CacheNodeIdsToRemove CacheNodeIdsList
- CacheNodeType String
- EngineVersion String
- NumCacheNodes IntegerOptional
PreferredAvailabilityZoneList
- PreferredAvailabilityZoneList
array
- items String
PurchaseReservedCacheNodesOfferingMessage
- PurchaseReservedCacheNodesOfferingMessage
object
: Represents the input of a PurchaseReservedCacheNodesOffering operation.- CacheNodeCount IntegerOptional
- ReservedCacheNodeId String
- ReservedCacheNodesOfferingId required String
PurchaseReservedCacheNodesOfferingResult
- PurchaseReservedCacheNodesOfferingResult
object
- ReservedCacheNode ReservedCacheNode
RebootCacheClusterMessage
- RebootCacheClusterMessage
object
: Represents the input of a RebootCacheCluster operation.- CacheClusterId required String
- CacheNodeIdsToReboot required CacheNodeIdsList
RebootCacheClusterResult
- RebootCacheClusterResult
object
- CacheCluster CacheCluster
RecurringCharge
- RecurringCharge
object
: Contains the specific price and frequency of a recurring charges for a reserved cache node, or for a reserved cache node offering.
RecurringChargeList
- RecurringChargeList
array
- items RecurringCharge
RemoveTagsFromResourceMessage
- RemoveTagsFromResourceMessage
object
: Represents the input of a RemoveTagsFromResource operation.
ReplicationGroup
- ReplicationGroup
object
: Contains all of the attributes of a specific Redis replication group.- AtRestEncryptionEnabled BooleanOptional
- AuthTokenEnabled BooleanOptional
- AutomaticFailover AutomaticFailoverStatus
- CacheNodeType String
- ClusterEnabled BooleanOptional
- ConfigurationEndpoint Endpoint
- Description String
- MemberClusters ClusterIdList
- NodeGroups NodeGroupList
- PendingModifiedValues ReplicationGroupPendingModifiedValues
- ReplicationGroupId String
- SnapshotRetentionLimit IntegerOptional
- SnapshotWindow String
- SnapshottingClusterId String
- Status String
- TransitEncryptionEnabled BooleanOptional
ReplicationGroupAlreadyExistsFault
- ReplicationGroupAlreadyExistsFault
object
: The specified replication group already exists.
ReplicationGroupList
- ReplicationGroupList
array
- items ReplicationGroup
ReplicationGroupMessage
- ReplicationGroupMessage
object
: Represents the output of a DescribeReplicationGroups operation.- Marker String
- ReplicationGroups ReplicationGroupList
ReplicationGroupNotFoundFault
- ReplicationGroupNotFoundFault
object
: The specified replication group does not exist.
ReplicationGroupPendingModifiedValues
- ReplicationGroupPendingModifiedValues
object
: The settings to be applied to the Redis replication group, either immediately or during the next maintenance window.- AutomaticFailoverStatus PendingAutomaticFailoverStatus
- PrimaryClusterId String
- Resharding ReshardingStatus
ReservedCacheNode
- ReservedCacheNode
object
: Represents the output of a PurchaseReservedCacheNodesOffering operation.
ReservedCacheNodeAlreadyExistsFault
- ReservedCacheNodeAlreadyExistsFault
object
: You already have a reservation with the given identifier.
ReservedCacheNodeList
- ReservedCacheNodeList
array
- items ReservedCacheNode
ReservedCacheNodeMessage
- ReservedCacheNodeMessage
object
: Represents the output of a DescribeReservedCacheNodes operation.- Marker String
- ReservedCacheNodes ReservedCacheNodeList
ReservedCacheNodeNotFoundFault
- ReservedCacheNodeNotFoundFault
object
: The requested reserved cache node was not found.
ReservedCacheNodeQuotaExceededFault
- ReservedCacheNodeQuotaExceededFault
object
: The request cannot be processed because it would exceed the user's cache node quota.