AWS SDK for .NET Documentation
Amazon.ElastiCache.Model Namespace
AmazonAmazon.ElastiCache.Model Did this page help you?   Yes   No    Tell us about it...
 
Declaration Syntax
C#
namespace Amazon.ElastiCache.Model
Types
All TypesClasses
IconTypeDescription
AuthorizationAlreadyExistsException
AmazonElastiCache exception

AuthorizationNotFoundException
AmazonElastiCache exception

AuthorizeCacheSecurityGroupIngressRequest
Container for the parameters to the AuthorizeCacheSecurityGroupIngress operation.

The AuthorizeCacheSecurityGroupIngress operation allows network ingress to a cache security group. Applications using ElastiCache must be running on Amazon EC2, and Amazon EC2 security groups are used as the authorization mechanism.

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


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
AmazonElastiCache exception

CacheClusterNotFoundException
AmazonElastiCache exception

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.


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
AmazonElastiCache exception

CacheParameterGroupNotFoundException
AmazonElastiCache exception

CacheParameterGroupQuotaExceededException
AmazonElastiCache exception

CacheParameterGroupStatus

The status of the cache parameter group.


CacheSecurityGroup

Represents the output of one of the following operations:

  • AuthorizeCacheSecurityGroupIngress
  • CreateCacheSecurityGroup
  • RevokeCacheSecurityGroupIngress

CacheSecurityGroupAlreadyExistsException
AmazonElastiCache exception

CacheSecurityGroupMembership

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


CacheSecurityGroupNotFoundException
AmazonElastiCache exception

CacheSecurityGroupQuotaExceededException
AmazonElastiCache exception

CacheSubnetGroup

Represents the output of one of the following operations:

  • CreateCacheSubnetGroup
  • ModifyCacheSubnetGroup

CacheSubnetGroupAlreadyExistsException
AmazonElastiCache exception

CacheSubnetGroupInUseException
AmazonElastiCache exception

CacheSubnetGroupNotFoundException
AmazonElastiCache exception

CacheSubnetGroupQuotaExceededException
AmazonElastiCache exception

CacheSubnetQuotaExceededException
AmazonElastiCache exception

ClusterQuotaForCustomerExceededException
AmazonElastiCache exception

CopySnapshotRequest
Container for the parameters to the CopySnapshot operation.

The CopySnapshot operation makes a copy of an existing snapshot.


CopySnapshotResponse
Returns information about the CopySnapshot response and response metadata.

CopySnapshotResult
The results from the CopySnapshot action.

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
The results from the CreateCacheCluster action.

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
Returns information about the CreateCacheParameterGroup response and response metadata.

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.

The CreateCacheSubnetGroup operation creates a new cache subnet group.

Use this parameter only when you are creating a cluster in an Amazon Virtual Private Cloud (VPC).


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.

The CreateReplicationGroup operation creates a replication group. A replication group is a collection of cache clusters, where one of the clusters is a read/write primary and the other clusters are read-only replicas. Writes to the primary are automatically propagated to the replicas.

When you create a replication group, you must specify an existing cache cluster that is in the primary role. When the replication group has been successfully created, you can add one or more read replica replicas to it, up to a total of five read replicas.


CreateReplicationGroupResponse
Returns information about the CreateReplicationGroup response and response metadata.

CreateReplicationGroupResult
The results from the CreateReplicationGroup action.

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
Returns information about the CreateSnapshot response and response metadata.

CreateSnapshotResult
The results from the CreateSnapshot action.

DeleteCacheClusterRequest
Container for the parameters to the DeleteCacheCluster operation.

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.


DeleteCacheClusterResponse
Returns information about the DeleteCacheCluster response and response metadata.

DeleteCacheClusterResult
The results from the DeleteCacheCluster action.

DeleteCacheParameterGroupRequest
Container for the parameters to the DeleteCacheParameterGroup operation.

The DeleteCacheParameterGroup operation deletes the specified cache parameter group. You cannot delete a cache parameter group if it is associated with any cache clusters.


DeleteCacheParameterGroupResponse
Returns information about the DeleteCacheParameterGroup response metadata. The DeleteCacheParameterGroup operation has a void result type.

DeleteCacheSecurityGroupRequest
Container for the parameters to the DeleteCacheSecurityGroup operation.

The DeleteCacheSecurityGroup operation deletes a cache security group.

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


DeleteCacheSecurityGroupResponse
Returns information about the DeleteCacheSecurityGroup response metadata. The DeleteCacheSecurityGroup operation has a void result type.

DeleteCacheSubnetGroupRequest
Container for the parameters to the DeleteCacheSubnetGroup operation.

The DeleteCacheSubnetGroup operation deletes a cache subnet group.

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


DeleteCacheSubnetGroupResponse
Returns information about the DeleteCacheSubnetGroup response metadata. The DeleteCacheSubnetGroup operation has a void result type.

DeleteReplicationGroupRequest
Container for the parameters to the DeleteReplicationGroup operation.

The DeleteReplicationGroup operation deletes an existing replication group. By default, this operation deletes the entire replication group, including the primary cache cluster and all of the read replicas. You can optionally delete only the read replicas, while retaining the primary cache cluster.

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


DeleteReplicationGroupResponse
Returns information about the DeleteReplicationGroup response and response metadata.

DeleteReplicationGroupResult
The results from the DeleteReplicationGroup action.

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
Returns information about the DeleteSnapshot response and response metadata.

DeleteSnapshotResult
The results from the DeleteSnapshot action.

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 DescribeCacheEngineVersionsResult response and response metadata.

DescribeCacheEngineVersionsResult

Represents the output of a DescribeCacheEngineVersions operation.


DescribeCacheParameterGroupsRequest
Container for the parameters to the DescribeCacheParameterGroups operation.

The DescribeCacheParameterGroups operation returns a list of cache parameter group descriptions. If a cache parameter group name is specified, the list will contain only the descriptions for that group.


DescribeCacheParameterGroupsResponse
Returns information about the DescribeCacheParameterGroupsResult 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.

The DescribeCacheSecurityGroups operation returns a list of cache security group descriptions. If a cache security group name is specified, the list will contain 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.

The DescribeCacheSubnetGroups operation returns a list of cache subnet group descriptions. If a subnet group name is specified, the list will contain only the description of that group.


DescribeCacheSubnetGroupsResponse
Returns information about the DescribeCacheSubnetGroupsResult response and response metadata.

DescribeCacheSubnetGroupsResult

Represents the output of a DescribeCacheSubnetGroups operation.


DescribeEngineDefaultParametersRequest
Container for the parameters to the DescribeEngineDefaultParameters operation.

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 DescribeEventsResult 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.

The DescribeReservedCacheNodesOfferings operation lists available reserved cache node offerings.


DescribeReservedCacheNodesOfferingsResponse
Returns information about the DescribeReservedCacheNodesOfferingsResult response and response metadata.

DescribeReservedCacheNodesOfferingsResult

Represents the output of a DescribeReservedCacheNodesOfferings operation.


DescribeReservedCacheNodesRequest
Container for the parameters to the DescribeReservedCacheNodes operation.

The DescribeReservedCacheNodes operation returns information about reserved cache nodes for this account, or about a specified reserved cache node.


DescribeReservedCacheNodesResponse
Returns information about the DescribeReservedCacheNodesResult response and response metadata.

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
Returns information about the DescribeSnapshotsResult response and response metadata.

DescribeSnapshotsResult

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
AmazonElastiCache exception

InvalidCacheClusterStateException
AmazonElastiCache exception

InvalidCacheParameterGroupStateException
AmazonElastiCache exception

InvalidCacheSecurityGroupStateException
AmazonElastiCache exception

InvalidParameterCombinationException
AmazonElastiCache exception

InvalidParameterValueException
AmazonElastiCache exception

InvalidReplicationGroupStateException
AmazonElastiCache exception

InvalidSnapshotStateException
AmazonElastiCache exception

InvalidSubnetException
AmazonElastiCache exception

InvalidVPCNetworkStateException
AmazonElastiCache exception

ModifyCacheClusterRequest
Container for the parameters to the ModifyCacheCluster operation.

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
Returns information about the ModifyCacheCluster response and response metadata.

ModifyCacheClusterResult
The results from the ModifyCacheCluster action.

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 ModifyCacheParameterGroupResult 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.

The ModifyCacheSubnetGroup operation modifies an existing cache subnet group.


ModifyCacheSubnetGroupResponse
Returns information about the ModifyCacheSubnetGroup response and response metadata.

ModifyCacheSubnetGroupResult
The results from the ModifyCacheSubnetGroup action.

ModifyReplicationGroupRequest
Container for the parameters to the ModifyReplicationGroup operation.

The ModifyReplicationGroup operation modifies the settings for a replication group.


ModifyReplicationGroupResponse
Returns information about the ModifyReplicationGroup response and response metadata.

ModifyReplicationGroupResult
The results from the ModifyReplicationGroup action.

NodeGroup

Represents a collection of cache nodes in a replication group.


NodeGroupMember

Represents a single node within a node group.


NodeQuotaForClusterExceededException
AmazonElastiCache exception

NodeQuotaForCustomerExceededException
AmazonElastiCache exception

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.

The PurchaseReservedCacheNodesOffering operation allows you to purchase a reserved cache node offering.


PurchaseReservedCacheNodesOfferingResponse
Returns information about the PurchaseReservedCacheNodesOffering response and response metadata.

PurchaseReservedCacheNodesOfferingResult
The results from the PurchaseReservedCacheNodesOffering action.

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.


ReplicationGroup

Contains all of the attributes of a specific replication group.


ReplicationGroupAlreadyExistsException
AmazonElastiCache exception

ReplicationGroupNotFoundException
AmazonElastiCache exception

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
AmazonElastiCache exception

ReservedCacheNodeNotFoundException
AmazonElastiCache exception

ReservedCacheNodeQuotaExceededException
AmazonElastiCache exception

ReservedCacheNodesOffering

Describes all of the attributes of a reserved cache node offering.


ReservedCacheNodesOfferingNotFoundException
AmazonElastiCache exception

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 ResetCacheParameterGroupResult 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
Returns information about the RevokeCacheSecurityGroupIngress response and response metadata.

RevokeCacheSecurityGroupIngressResult
The results from the RevokeCacheSecurityGroupIngress action.

SecurityGroupMembership

Represents a single cache security group and its status..


Snapshot

Represents a copy of an entire cache cluster as of the time when the snapshot was taken.


SnapshotAlreadyExistsException
AmazonElastiCache exception

SnapshotFeatureNotSupportedException
AmazonElastiCache exception

SnapshotNotFoundException
AmazonElastiCache exception

SnapshotQuotaExceededException
AmazonElastiCache exception

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
AmazonElastiCache exception