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.

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

Availability Zone in which the Cache Cluster is launched


CacheCluster

Contains information about a Cache Cluster.


CacheClusterAlreadyExistsException
AmazonElastiCache exception

CacheClusterNotFoundException
AmazonElastiCache exception

CacheEngineVersion

This data type is used as a response element in the action DescribeCacheEngineVersions.


CacheNode

A Cache Cluster is made up of one or more Cache Nodes. Each Cache Node is an separate endpoint servicing the memcached protocol.


CacheNodeTypeSpecificParameter

A parameter that has a different value for each Cache Node Type it is applied to.


CacheNodeTypeSpecificValue

A value that applies only to a certain Cache Node Type.


CacheParameterGroup

Contains a set of parameters and their values which can be applied to a Cache Cluster.


CacheParameterGroupAlreadyExistsException
AmazonElastiCache exception

CacheParameterGroupNotFoundException
AmazonElastiCache exception

CacheParameterGroupQuotaExceededException
AmazonElastiCache exception

CacheParameterGroupStatus

The status of the Cache Parameter Group.


CacheSecurityGroup

Defines a set of EC2 Security groups that are allowed to access a Cache Cluster.


CacheSecurityGroupAlreadyExistsException
AmazonElastiCache exception

CacheSecurityGroupMembership

Links a CacheCluster to one or more CacheSecurityGroups.


CacheSecurityGroupNotFoundException
AmazonElastiCache exception

CacheSecurityGroupQuotaExceededException
AmazonElastiCache exception

CacheSubnetGroup

Contains the result of a successful invocation of the following actions:

  • CreateCacheSubnetGroup
  • ModifyCacheSubnetGroup
  • DescribeCacheSubnetGroups
  • DeleteCacheSubnetGroup

This data type is used as a response element in the DescribeCacheSubnetGroups action.


CacheSubnetGroupAlreadyExistsException
AmazonElastiCache exception

CacheSubnetGroupInUseException
AmazonElastiCache exception

CacheSubnetGroupNotFoundException
AmazonElastiCache exception

CacheSubnetGroupQuotaExceededException
AmazonElastiCache exception

CacheSubnetQuotaExceededException
AmazonElastiCache exception

ClusterQuotaForCustomerExceededException
AmazonElastiCache exception

CreateCacheClusterRequest
Container for the parameters to the CreateCacheCluster operation.

Creates a new Cache Cluster.


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.

Creates a new Cache Parameter Group. Cache Parameter groups control the parameters for 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.

Creates a new Cache Security Group. Cache Security groups control access to one or more Cache Clusters.

Only use cache security groups when you are creating a cluster outside of an Amazon Virtual Private Cloud (VPC). Inside of a VPC, use VPC security groups.


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.

DeleteCacheClusterRequest
Container for the parameters to the DeleteCacheCluster operation.

Deletes a previously provisioned Cache Cluster. A successful response from the web service indicates the request was received correctly. This action cannot be canceled or reverted. DeleteCacheCluster deletes all associated Cache Nodes, node endpoints and the Cache Cluster itself.


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.

Deletes the specified CacheParameterGroup. The CacheParameterGroup cannot be deleted 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.

Deletes a Cache Security Group.

NOTE:The specified Cache Security Group must not be 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.

Deletes a Cache Subnet Group.

NOTE:The specified Cache Subnet Group must not be associated with any Cache Clusters.


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

DescribeCacheClustersRequest
Container for the parameters to 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.

Cluster information will be returned by default. An optional ShowDetails flag can be used to retrieve detailed information about the Cache Nodes associated with the Cache Cluster. 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.

While adding Cache Nodes, node endpoint information and creation time for the additional nodes will not be displayed until they are completely provisioned. The cluster lifecycle tells the customer when new nodes are AVAILABLE.

While removing existing Cache Nodes from an cluster, endpoint information for the removed nodes will not be displayed.

DescribeCacheClusters supports pagination.


DescribeCacheClustersResponse
Returns information about the DescribeCacheClustersResult response and response metadata.

DescribeCacheClustersResult

Contains one or more Cache Clusters.


DescribeCacheEngineVersionsRequest
Container for the parameters to 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

Contains the result of a successful invocation of the DescribeCacheEngineVersions action.


DescribeCacheParameterGroupsRequest
Container for the parameters to the DescribeCacheParameterGroups operation.

Returns a list of CacheParameterGroup descriptions. If a CacheParameterGroupName is specified, the list will contain only the descriptions of the specified CacheParameterGroup.


DescribeCacheParameterGroupsResponse
Returns information about the DescribeCacheParameterGroupsResult response and response metadata.

DescribeCacheParameterGroupsResult

Contains a list of CacheParameterGroups.


DescribeCacheParametersRequest
Container for the parameters to the DescribeCacheParameters operation.

Returns the detailed parameter list for a particular CacheParameterGroup.


DescribeCacheParametersResponse
Returns information about the DescribeCacheParametersResult response and response metadata.

DescribeCacheParametersResult

Contains a list of Parametes and CacheNodeTypeSpecificParameters.


DescribeCacheSecurityGroupsRequest
Container for the parameters to the DescribeCacheSecurityGroups operation.

Returns a list of CacheSecurityGroup descriptions. If a CacheSecurityGroupName is specified, the list will contain only the description of the specified CacheSecurityGroup.


DescribeCacheSecurityGroupsResponse
Returns information about the DescribeCacheSecurityGroupsResult response and response metadata.

DescribeCacheSecurityGroupsResult

Contains a list of CacheSecurityGroups.


DescribeCacheSubnetGroupsRequest
Container for the parameters to the DescribeCacheSubnetGroups operation.

Returns a list of CacheSubnetGroup descriptions. If a CacheSubnetGroupName is specified, the list will contain only the description of the specified Cache Subnet Group.


DescribeCacheSubnetGroupsResponse
Returns information about the DescribeCacheSubnetGroupsResult response and response metadata.

DescribeCacheSubnetGroupsResult

Represents the output from a DescribeCacheSubnetGroups action.


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.

Returns events related to Cache Clusters, Cache Security Groups, and Cache Parameter Groups for the past 14 days. Events specific to a particular Cache Cluster, Cache Security Group, or Cache Parameter Group can be obtained by providing the name as a parameter. By default, the past hour of events are returned.


DescribeEventsResponse
Returns information about the DescribeEventsResult response and response metadata.

DescribeEventsResult

Contains a list of Events.


DescribeReservedCacheNodesOfferingsRequest
Container for the parameters to the DescribeReservedCacheNodesOfferings operation.

Lists available reserved Cache Node offerings.


DescribeReservedCacheNodesOfferingsResponse
Returns information about the DescribeReservedCacheNodesOfferingsResult response and response metadata.

DescribeReservedCacheNodesOfferingsResult

Contains the result of a successful invocation of the DescribeReservedCacheNodesOfferings action.


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

DescribeReservedCacheNodesResult

Contains the result of a successful invocation of the DescribeReservedCacheNodes action.


EC2SecurityGroup

Specifies the current state of this Cache Node.


Endpoint

An endpoint completely specifies enough information to connect to a Cache Node.


EngineDefaults

The default Parameters and CacheNodeTypeSpecificParameters for a CacheParameterGroupFamily.


Event

An event represents something interesting that has happened in the system.


InsufficientCacheClusterCapacityException
AmazonElastiCache exception

InvalidCacheClusterStateException
AmazonElastiCache exception

InvalidCacheParameterGroupStateException
AmazonElastiCache exception

InvalidCacheSecurityGroupStateException
AmazonElastiCache exception

InvalidParameterCombinationException
AmazonElastiCache exception

InvalidParameterValueException
AmazonElastiCache exception

InvalidSubnetException
AmazonElastiCache exception

InvalidVPCNetworkStateException
AmazonElastiCache exception

ModifyCacheClusterRequest
Container for the parameters to the ModifyCacheCluster operation.

Modifies the Cache Cluster settings. You can change one or more Cache Cluster configuration parameters by specifying the parameters and the new values in the request.


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.

Modifies the parameters of a CacheParameterGroup. To modify more than one parameter, submit a list of ParameterName and ParameterValue parameters. A maximum of 20 parameters can be modified in a single request.


ModifyCacheParameterGroupResponse
Returns information about the ModifyCacheParameterGroupResult response and response metadata.

ModifyCacheParameterGroupResult

Contains the name of a Cache Parameter Group.


ModifyCacheSubnetGroupRequest
Container for the parameters to 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.

NodeQuotaForClusterExceededException
AmazonElastiCache exception

NodeQuotaForCustomerExceededException
AmazonElastiCache exception

NotificationConfiguration

Contains pair of Topic and Topic Status.


Parameter

A setting controlling some apsect of the service's behavior.


ParameterNameValue

A name and value pair used to update the value of a Parameter.


PendingModifiedValues

Contains values that will be applied to the Cache Cluster in the future.


PurchaseReservedCacheNodesOfferingRequest
Container for the parameters to the PurchaseReservedCacheNodesOffering operation.

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

Reboots some (or all) of the cache cluster nodes within a previously provisioned ElastiCache cluster. This API results in the application of modified CacheParameterGroup parameters to the cache cluster. This action is taken as soon as possible, and results in a momentary outage to the cache cluster during which the cache cluster status is set to rebooting. During that momentary outage, the contents of the cache (for each cache cluster node being rebooted) are lost. A CacheCluster event is created when the reboot is completed.


RebootCacheClusterResponse
Returns information about the RebootCacheCluster response and response metadata.

RebootCacheClusterResult
The results from the RebootCacheCluster action.

RecurringCharge

This data type is used as a response element in the DescribeReservedCacheNodes and DescribeReservedCacheNodesOfferings actions.


ReservedCacheNode

This data type is used as a response element in the DescribeReservedCacheNodes and PurchaseReservedCacheNodesOffering actions.


ReservedCacheNodeAlreadyExistsException
AmazonElastiCache exception

ReservedCacheNodeNotFoundException
AmazonElastiCache exception

ReservedCacheNodeQuotaExceededException
AmazonElastiCache exception

ReservedCacheNodesOffering

This data type is used as a response element in the DescribeReservedCacheNodesOfferings action.


ReservedCacheNodesOfferingNotFoundException
AmazonElastiCache exception

ResetCacheParameterGroupRequest
Container for the parameters to the ResetCacheParameterGroup operation.

Modifies the parameters of a CacheParameterGroup to the engine or system default value. To reset specific parameters submit a list of the parameter names. To reset the entire CacheParameterGroup, specify the CacheParameterGroup name and ResetAllParameters parameters.


ResetCacheParameterGroupResponse
Returns information about the ResetCacheParameterGroupResult response and response metadata.

ResetCacheParameterGroupResult

Contains the name of a Cache Parameter Group.


RevokeCacheSecurityGroupIngressRequest
Container for the parameters to the RevokeCacheSecurityGroupIngress operation.

Revokes ingress from a CacheSecurityGroup for previously authorized EC2 Security Groups.


RevokeCacheSecurityGroupIngressResponse
Returns information about the RevokeCacheSecurityGroupIngress response and response metadata.

RevokeCacheSecurityGroupIngressResult
The results from the RevokeCacheSecurityGroupIngress action.

SecurityGroupMembership

Represents one or more Cache Security Groups to which a Cache Cluster belongs.


Subnet

Network Subnet associated with a Cache Cluster


SubnetInUseException
AmazonElastiCache exception