C# (CSharp) Amazon.ElastiCache.Model Пространство имен

Пространства имен

Amazon.ElastiCache.Model.Internal

Классы

Имя Описание
AddTagsToResourceRequest Container for the parameters to the AddTagsToResource operation. Adds up to 10 cost allocation tags to the named resource. A cost allocation tag is a key-value pair where the key and value are case-sensitive. You can use cost allocation tags to categorize and track your AWS costs.

When you apply tags to your ElastiCache resources, AWS generates a cost allocation report as a comma-separated value (CSV) file with your usage and costs aggregated by your tags. You can apply tags that represent business categories (such as cost centers, application names, or owners) to organize your costs across multiple services. For more information, see Using Cost Allocation Tags in Amazon ElastiCache in the ElastiCache User Guide.

AuthorizationAlreadyExistsException
AuthorizationNotFoundException
AuthorizeCacheSecurityGroupIngressRequest Container for the parameters to the AuthorizeCacheSecurityGroupIngress operation.

Authorizes ingress to a CacheSecurityGroup using EC2 Security Groups as authorization (therefore the application using the cache must be running on EC2 clusters). This API requires the following parameters: EC2SecurityGroupName and EC2SecurityGroupOwnerId.

NOTE: You cannot authorize ingress from an EC2 security group in one Region to an Amazon Cache Cluster in another.

AuthorizeCacheSecurityGroupIngressResponse Returns information about the AuthorizeCacheSecurityGroupIngress response and response metadata.
AuthorizeCacheSecurityGroupIngressResult The results from the AuthorizeCacheSecurityGroupIngress action.
AvailabilityZone

Describes an availability zone in which the cache cluster is launched.

CacheCluster

Contains all of the attributes of a specific cache cluster.

CacheClusterAlreadyExistsException
CacheClusterNotFoundException
CacheEngineVersion Provides all of the details about a particular cache engine version.
CacheNode Represents an individual cache node within a cache cluster. Each cache node runs its own instance of the cluster's protocol-compliant caching software - either Memcached or Redis.

Valid node types are as follows:

  • General purpose:

    • Current generation: cache.t2.micro, cache.t2.small, cache.t2.medium, cache.m3.medium, cache.m3.large, cache.m3.xlarge, cache.m3.2xlarge, cache.m4.large, cache.m4.xlarge, cache.m4.2xlarge, cache.m4.4xlarge, cache.m4.10xlarge

    • Previous generation: cache.t1.micro, cache.m1.small, cache.m1.medium, cache.m1.large, cache.m1.xlarge

  • Compute optimized: cache.c1.xlarge

  • Memory optimized:

    • Current generation: cache.r3.large, cache.r3.xlarge, cache.r3.2xlarge, cache.r3.4xlarge, cache.r3.8xlarge

    • Previous generation: cache.m2.xlarge, cache.m2.2xlarge, cache.m2.4xlarge

Notes:

  • All T2 instances are created in an Amazon Virtual Private Cloud (Amazon VPC).

  • Redis backup/restore is not supported for Redis (cluster mode disabled) T1 and T2 instances. Backup/restore is supported on Redis (cluster mode enabled) T2 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.

CacheNodeTypeSpecificParameter

A parameter that has a different value for each cache node type it is applied to. For example, in a Redis cache cluster, a cache.m1.large cache node type would have a larger maxmemory value than a cache.m1.small type.

CacheNodeTypeSpecificValue A value that applies only to a certain cache node type.
CacheParameterGroup

Represents the output of a CreateCacheParameterGroup operation.

CacheParameterGroupAlreadyExistsException
CacheParameterGroupNotFoundException
CacheParameterGroupQuotaExceededException
CacheParameterGroupStatus

The status of the cache parameter group.

CacheSecurityGroup

Represents the output of one of the following operations:

  • AuthorizeCacheSecurityGroupIngress
  • CreateCacheSecurityGroup
  • RevokeCacheSecurityGroupIngress
CacheSecurityGroupAlreadyExistsException
CacheSecurityGroupMembership

Represents a cache cluster's status within a particular cache security group.

CacheSecurityGroupNotFoundException
CacheSecurityGroupQuotaExceededException
CacheSubnetGroup Represents the output of one of the following actions:
  • CreateCacheSubnetGroup
  • ModifyCacheSubnetGroup
CacheSubnetGroupAlreadyExistsException
CacheSubnetGroupInUseException
CacheSubnetGroupNotFoundException
CacheSubnetGroupQuotaExceededException
CacheSubnetQuotaExceededException
ClusterQuotaForCustomerExceededException
CopySnapshotRequest Container for the parameters to the CopySnapshot operation.

The CopySnapshot operation makes a copy of an existing snapshot.

CopySnapshotResponse This is the response object from the CopySnapshot operation.
CreateCacheClusterRequest Container for the parameters to the CreateCacheCluster operation.

The CreateCacheCluster operation creates a new cache cluster. All nodes in the cache cluster run the same protocol-compliant cache engine software - either Memcached or Redis.

CreateCacheClusterResponse Returns information about the CreateCacheCluster response and response metadata.
CreateCacheClusterResult Contains all of the attributes of a specific cache cluster.
CreateCacheParameterGroupRequest Container for the parameters to the CreateCacheParameterGroup operation.

The CreateCacheParameterGroup operation creates a new cache parameter group. A cache parameter group is a collection of parameters that you apply to all of the nodes in a cache cluster.

CreateCacheParameterGroupResponse This is the response object from the CreateCacheParameterGroup operation.
CreateCacheParameterGroupResult The results from the CreateCacheParameterGroup action.
CreateCacheSecurityGroupRequest Container for the parameters to the CreateCacheSecurityGroup operation.

The CreateCacheSecurityGroup operation creates a new cache security group. Use a cache security group to control access to one or more cache clusters.

Cache security groups are only used when you are creating a cluster outside of an Amazon Virtual Private Cloud (VPC). If you are creating a cluster inside of a VPC, use a cache subnet group instead. For more information, see CreateCacheSubnetGroup .

CreateCacheSecurityGroupResponse Returns information about the CreateCacheSecurityGroup response and response metadata.
CreateCacheSecurityGroupResult The results from the CreateCacheSecurityGroup action.
CreateCacheSubnetGroupRequest Container for the parameters to the CreateCacheSubnetGroup operation.

Creates a new Cache Subnet Group.

CreateCacheSubnetGroupResponse Returns information about the CreateCacheSubnetGroup response and response metadata.
CreateCacheSubnetGroupResult The results from the CreateCacheSubnetGroup action.
CreateReplicationGroupRequest Container for the parameters to the CreateReplicationGroup operation. Creates a Redis (cluster mode disabled) or a Redis (cluster mode enabled) replication group.

A Redis (cluster mode disabled) replication group is a collection of cache clusters, where one of the cache clusters is a read/write primary and the others are read-only replicas. Writes to the primary are asynchronously propagated to the replicas.

A Redis (cluster mode enabled) replication group is a collection of 1 to 15 node groups (shards). Each node group (shard) has one read/write primary node and up to 5 read-only replica nodes. Writes to the primary are asynchronously propagated to the replicas. Redis (cluster mode enabled) replication groups partition the data across node groups (shards).

When a Redis (cluster mode disabled) replication group has been successfully created, you can add one or more read replicas to it, up to a total of 5 read replicas. You cannot alter a Redis (cluster mode enabled) replication group after it has been created.

This operation is valid for Redis only.

CreateReplicationGroupResponse Returns information about the CreateReplicationGroup response and response metadata.
CreateReplicationGroupResult Contains all of the attributes of a specific replication group.
CreateSnapshotRequest Container for the parameters to the CreateSnapshot operation.

The CreateSnapshot operation creates a copy of an entire cache cluster at a specific moment in time.

CreateSnapshotResponse This is the response object from the CreateSnapshot operation.
DeleteCacheClusterRequest Container for the parameters to the DeleteCacheCluster operation. Deletes a previously provisioned cache cluster. DeleteCacheCluster deletes all associated cache nodes, node endpoints and the cache cluster itself. When you receive a successful response from this operation, Amazon ElastiCache immediately begins deleting the cache cluster; you cannot cancel or revert this operation.

This operation cannot be used to delete a cache cluster that is the last read replica of a replication group or node group (shard) that has Multi-AZ mode enabled or a cache cluster from a Redis (cluster mode enabled) replication group.

Due to current limitations on Redis (cluster mode disabled), this operation or parameter is not supported on Redis (cluster mode enabled) replication groups.

DeleteCacheClusterResponse Contains all of the attributes of a specific cache cluster.
DeleteCacheClusterResult The results from the DeleteCacheCluster action.
DeleteCacheParameterGroupRequest Container for the parameters to the DeleteCacheParameterGroup operation. Deletes the specified cache parameter group. You cannot delete a cache parameter group if it is associated with any cache clusters.
DeleteCacheSecurityGroupRequest Container for the parameters to the DeleteCacheSecurityGroup operation. Deletes a cache security group.

You cannot delete a cache security group if it is associated with any cache clusters.

DeleteCacheSubnetGroupRequest Container for the parameters to the DeleteCacheSubnetGroup operation. Deletes a cache subnet group.

You cannot delete a cache subnet group if it is associated with any cache clusters.

DeleteReplicationGroupRequest Container for the parameters to the DeleteReplicationGroup operation. Deletes an existing replication group. By default, this operation deletes the entire replication group, including the primary/primaries and all of the read replicas. If the replication group has only one primary, you can optionally delete only the read replicas, while retaining the primary by setting RetainPrimaryCluster=true.

When you receive a successful response from this operation, Amazon ElastiCache immediately begins deleting the selected resources; you cannot cancel or revert this operation.

This operation is valid for Redis only.

DeleteReplicationGroupResponse Returns information about the DeleteReplicationGroup response and response metadata.
DeleteReplicationGroupResult Contains all of the attributes of a specific replication group.
DeleteSnapshotRequest Container for the parameters to the DeleteSnapshot operation.

The DeleteSnapshot operation deletes an existing snapshot. When you receive a successful response from this operation, ElastiCache immediately begins deleting the snapshot; you cannot cancel or revert this operation.

DeleteSnapshotResponse Represents a copy of an entire cache cluster as of the time when the snapshot was taken.
DescribeCacheClustersRequest Container for the parameters to the DescribeCacheClusters operation.

The DescribeCacheClusters operation returns information about all provisioned cache clusters if no cache cluster identifier is specified, or about a specific cache cluster if a cache cluster identifier is supplied.

By default, abbreviated information about the cache clusters(s) will be returned. You can use the optional ShowDetails flag to retrieve detailed information about the cache nodes associated with the cache clusters. These details include the DNS address and port for the cache node endpoint.

If the cluster is in the CREATING state, only cluster level information will be displayed until all of the nodes are successfully provisioned.

If the cluster is in the DELETING state, only cluster level information will be displayed.

If cache nodes are currently being added to the cache cluster, node endpoint information and creation time for the additional nodes will not be displayed until they are completely provisioned. When the cache cluster state is available , the cluster is ready for use.

If cache nodes are currently being removed from the cache cluster, no endpoint information for the removed nodes is displayed.

DescribeCacheClustersResponse Returns information about the DescribeCacheClustersResult response and response metadata.
DescribeCacheClustersResult

Represents the output of a DescribeCacheClusters operation.

DescribeCacheEngineVersionsRequest Container for the parameters to the DescribeCacheEngineVersions operation.

The DescribeCacheEngineVersions operation returns a list of the available cache engines and their versions.

DescribeCacheEngineVersionsResponse Returns information about the DescribeCacheEngineVersions response and response metadata.
DescribeCacheEngineVersionsResult

Represents the output of a DescribeCacheEngineVersions operation.

DescribeCacheParameterGroupsRequest Container for the parameters to the DescribeCacheParameterGroups operation. 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.
DescribeCacheParameterGroupsResponse Returns information about the DescribeCacheParameterGroups response and response metadata.
DescribeCacheParameterGroupsResult

Represents the output of a DescribeCacheParameterGroups operation.

DescribeCacheParametersRequest Container for the parameters to the DescribeCacheParameters operation.

The DescribeCacheParameters operation returns the detailed parameter list for a particular cache parameter group.

DescribeCacheParametersResponse Returns information about the DescribeCacheParametersResult response and response metadata.
DescribeCacheParametersResult Represents the output of a DescribeCacheParameters operation.
DescribeCacheSecurityGroupsRequest Container for the parameters to the DescribeCacheSecurityGroups operation. 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.
DescribeCacheSecurityGroupsResponse Returns information about the DescribeCacheSecurityGroupsResult response and response metadata.
DescribeCacheSecurityGroupsResult

Represents the output of a DescribeCacheSecurityGroups operation.

DescribeCacheSubnetGroupsRequest Container for the parameters to the DescribeCacheSubnetGroups operation. Returns a list of cache subnet group descriptions. If a subnet group name is specified, the list contains only the description of that group.
DescribeCacheSubnetGroupsResponse Represents the output of a DescribeCacheSubnetGroups operation.
DescribeCacheSubnetGroupsResult Represents the output of a DescribeCacheSubnetGroups operation.
DescribeEngineDefaultParametersRequest Container for the parameters to the DescribeEngineDefaultParameters operation. Returns the default engine and system parameter information for the specified cache engine.
DescribeEngineDefaultParametersResponse Returns information about the DescribeEngineDefaultParameters response and response metadata.
DescribeEngineDefaultParametersResult The results from the DescribeEngineDefaultParameters action.
DescribeEventsRequest Container for the parameters to the DescribeEvents operation.

The DescribeEvents operation returns events related to cache clusters, cache security groups, and cache parameter groups. You can obtain events specific to a particular cache cluster, cache security group, or cache parameter group by providing the name as a parameter.

By default, only the events occurring within the last hour are returned; however, you can retrieve up to 14 days' worth of events if necessary.

DescribeEventsResponse Returns information about the DescribeEvents response and response metadata.
DescribeEventsResult

Represents the output of a DescribeEvents operation.

DescribeReplicationGroupsRequest Container for the parameters to the DescribeReplicationGroups operation.

The DescribeReplicationGroups operation returns information about a particular replication group. If no identifier is specified, DescribeReplicationGroups returns information about all replication groups.

DescribeReplicationGroupsResponse Returns information about the DescribeReplicationGroupsResult response and response metadata.
DescribeReplicationGroupsResult Represents the output of a DescribeReplicationGroups operation.
DescribeReservedCacheNodesOfferingsRequest Container for the parameters to the DescribeReservedCacheNodesOfferings operation. Lists available reserved cache node offerings.
DescribeReservedCacheNodesOfferingsResponse Represents the output of a DescribeReservedCacheNodesOfferings operation.
DescribeReservedCacheNodesOfferingsResult Represents the output of a DescribeReservedCacheNodesOfferings operation.
DescribeReservedCacheNodesRequest Container for the parameters to the DescribeReservedCacheNodes operation. Returns information about reserved cache nodes for this account, or about a specified reserved cache node.
DescribeReservedCacheNodesResponse Represents the output of a DescribeReservedCacheNodes operation.
DescribeReservedCacheNodesResult Represents the output of a DescribeReservedCacheNodes operation.
DescribeSnapshotsRequest Container for the parameters to the DescribeSnapshots operation.

The DescribeSnapshots operation returns information about cache cluster snapshots. By default, DescribeSnapshots lists all of your snapshots; it can optionally describe a single snapshot, or just the snapshots associated with a particular cache cluster.

DescribeSnapshotsResponse Represents the output of a DescribeSnapshots operation.
EC2SecurityGroup Provides ownership and status information for an Amazon EC2 security group.
Endpoint

Represents the information required for client programs to connect to a cache node.

EngineDefaults Represents the output of a DescribeEngineDefaultParameters operation.
Event Represents a single occurrence of something interesting within the system. Some examples of events are creating a cache cluster, adding or removing a cache node, or rebooting a node.
InsufficientCacheClusterCapacityException
InvalidARNException
InvalidCacheClusterStateException
InvalidCacheParameterGroupStateException
InvalidCacheSecurityGroupStateException
InvalidParameterCombinationException
InvalidParameterValueException
InvalidReplicationGroupStateException
InvalidSnapshotStateException
InvalidSubnetException
InvalidVPCNetworkStateException
ListAllowedNodeTypeModificationsRequest Container for the parameters to the ListAllowedNodeTypeModifications operation. Lists all available node types that you can scale your Redis cluster's or replication group's current node type up to.

When you use the ModifyCacheCluster or ModifyReplicationGroup operations to scale up your cluster or replication group, the value of the CacheNodeType parameter must be one of the node types returned by this operation.

ListAllowedNodeTypeModificationsResponse This is the response object from the ListAllowedNodeTypeModifications operation.
ListTagsForResourceRequest Container for the parameters to the ListTagsForResource operation. Lists all cost allocation tags currently on the named resource. A cost allocation tag is a key-value pair where the key is case-sensitive and the value is optional. You can use cost allocation tags to categorize and track your AWS costs.

You can have a maximum of 10 cost allocation tags on an ElastiCache resource. For more information, see Using Cost Allocation Tags in Amazon ElastiCache.

ListTagsForResourceResponse Represents the output from the AddTagsToResource, ListTagsOnResource, and RemoveTagsFromResource operations.
ModifyCacheClusterRequest Container for the parameters to the ModifyCacheCluster operation. Modifies the settings for a cache cluster. You can use this operation to change one or more cluster configuration parameters by specifying the parameters and the new values.
ModifyCacheClusterResponse This is the response object from the ModifyCacheCluster operation.
ModifyCacheClusterResult Contains all of the attributes of a specific cache cluster.
ModifyCacheParameterGroupRequest Container for the parameters to the ModifyCacheParameterGroup operation.

The ModifyCacheParameterGroup operation modifies the parameters of a cache parameter group. You can modify up to 20 parameters in a single request by submitting a list parameter name and value pairs.

ModifyCacheParameterGroupResponse Returns information about the ModifyCacheParameterGroup response and response metadata.
ModifyCacheParameterGroupResult Represents the output of one of the following operations:
  • ModifyCacheParameterGroup
  • ResetCacheParameterGroup
ModifyCacheSubnetGroupRequest Container for the parameters to the ModifyCacheSubnetGroup operation.

Modifies an existing Cache Subnet Group.

ModifyCacheSubnetGroupResponse Represents the output of one of the following actions:
  • CreateCacheSubnetGroup
  • ModifyCacheSubnetGroup
ModifyCacheSubnetGroupResult Represents the output of one of the following operations:
  • CreateCacheSubnetGroup
  • ModifyCacheSubnetGroup
ModifyReplicationGroupRequest Container for the parameters to the ModifyReplicationGroup operation.

The ModifyReplicationGroup operation modifies the settings for a replication group.

ModifyReplicationGroupResponse This is the response object from the ModifyReplicationGroup operation.
ModifyReplicationGroupResult Contains all of the attributes of a specific replication group.
NodeGroup

Represents a collection of cache nodes in a replication group.

NodeGroupConfiguration node group (shard) configuration options. Each node group (shard) configuration has the following: Slots, PrimaryAvailabilityZone, ReplicaAvailabilityZones, ReplicaCount.
NodeGroupMember

Represents a single node within a node group.

NodeGroupsPerReplicationGroupQuotaExceededException
NodeQuotaForClusterExceededException
NodeQuotaForCustomerExceededException
NodeSnapshot Represents an individual cache node in a snapshot of a cache cluster.
NotificationConfiguration

Describes a notification topic and its status. Notification topics are used for publishing ElastiCache events to subscribers using Amazon Simple Notification Service (SNS).

Parameter

Describes an individual setting that controls some aspect of ElastiCache behavior.

ParameterNameValue Describes a name-value pair that is used to update the value of a parameter.
PendingModifiedValues

A group of settings that will be applied to the cache cluster in the future, or that are currently being applied.

PurchaseReservedCacheNodesOfferingRequest Container for the parameters to the PurchaseReservedCacheNodesOffering operation. Allows you to purchase a reserved cache node offering.
PurchaseReservedCacheNodesOfferingResponse Returns information about the PurchaseReservedCacheNodesOffering response and response metadata.
PurchaseReservedCacheNodesOfferingResult Represents the output of a PurchaseReservedCacheNodesOffering operation.
RebootCacheClusterRequest Container for the parameters to the RebootCacheCluster operation.

The RebootCacheCluster operation reboots some, or all, of the cache cluster nodes within a provisioned cache cluster. This API will apply any modified cache parameter groups to the cache cluster. The reboot action takes place as soon as possible, and results in a momentary outage to the cache cluster. During the reboot, the cache cluster status is set to REBOOTING.

The reboot causes the contents of the cache (for each cache cluster node being rebooted) to be lost.

When the reboot is complete, a cache cluster event is created.

RebootCacheClusterResponse Returns information about the RebootCacheCluster response and response metadata.
RebootCacheClusterResult The results from the RebootCacheCluster action.
RecurringCharge

Contains the specific price and frequency of a recurring charges for a reserved cache node, or for a reserved cache node offering.

RemoveTagsFromResourceRequest Container for the parameters to the RemoveTagsFromResource operation. Removes the tags identified by the TagKeys list from the named resource.
RemoveTagsFromResourceResponse Represents the output from the AddTagsToResource, ListTagsOnResource, and RemoveTagsFromResource operations.
ReplicationGroup

Contains all of the attributes of a specific replication group.

ReplicationGroupAlreadyExistsException
ReplicationGroupNotFoundException
ReplicationGroupPendingModifiedValues

The settings to be applied to the replication group, either immediately or during the next maintenance window.

ReservedCacheNode

Represents the output of a PurchaseReservedCacheNodesOffering operation.

ReservedCacheNodeAlreadyExistsException
ReservedCacheNodeNotFoundException
ReservedCacheNodeQuotaExceededException
ReservedCacheNodesOffering Describes all of the attributes of a reserved cache node offering.
ReservedCacheNodesOfferingNotFoundException
ResetCacheParameterGroupRequest Container for the parameters to the ResetCacheParameterGroup operation.

The ResetCacheParameterGroup operation modifies the parameters of a cache parameter group to the engine or system default value. You can reset specific parameters by submitting a list of parameter names. To reset the entire cache parameter group, specify the ResetAllParameters and CacheParameterGroupName parameters.

ResetCacheParameterGroupResponse Returns information about the ResetCacheParameterGroup response and response metadata.
ResetCacheParameterGroupResult Represents the output of one of the following operations:
  • ModifyCacheParameterGroup
  • ResetCacheParameterGroup
RevokeCacheSecurityGroupIngressRequest Container for the parameters to the RevokeCacheSecurityGroupIngress operation. The RevokeCacheSecurityGroupIngress operation revokes ingress from a cache security group. Use this operation to disallow access from an Amazon EC2 security group that had been previously authorized.
RevokeCacheSecurityGroupIngressResponse This is the response object from the RevokeCacheSecurityGroupIngress operation.
RevokeCacheSecurityGroupIngressResult The results from the RevokeCacheSecurityGroupIngress action.
SecurityGroupMembership

Represents a single cache security group and its status..

Snapshot Represents a copy of an entire Redis cache cluster as of the time when the snapshot was taken.
SnapshotAlreadyExistsException
SnapshotFeatureNotSupportedException
SnapshotNotFoundException
SnapshotQuotaExceededException
Subnet

Represents the subnet associated with a cache cluster. This parameter refers to subnets defined in Amazon Virtual Private Cloud (Amazon VPC) and used with ElastiCache.

SubnetInUseException
TagNotFoundException