elasticache

package
v0.24.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jul 22, 2020 License: Apache-2.0 Imports: 9 Imported by: 97

Documentation

Overview

Package elasticache provides the client and types for making API requests to 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.

See https://docs.aws.amazon.com/goto/WebAPI/elasticache-2015-02-02 for more information on this service.

See elasticache package documentation for more information. https://docs.aws.amazon.com/sdk-for-go/api/service/elasticache/

Using the Client

To use Amazon ElastiCache with the SDK use the New function to create a new service client. With that client you can make API requests to the service. These clients are safe to use concurrently.

See the SDK's documentation for more information on how to use the SDK. https://docs.aws.amazon.com/sdk-for-go/api/

See aws.Config documentation for more information on configuring SDK clients. https://docs.aws.amazon.com/sdk-for-go/api/aws/#Config

See the Amazon ElastiCache client for more information on creating client for this service. https://docs.aws.amazon.com/sdk-for-go/api/service/elasticache/#New

Index

Examples

Constants

View Source
const (
	ServiceName = "Amazon ElastiCache" // Service's name
	ServiceID   = "ElastiCache"        // Service's identifier
	EndpointsID = "elasticache"        // Service's Endpoint identifier
)
View Source
const (

	// ErrCodeAPICallRateForCustomerExceededFault for service response error code
	// "APICallRateForCustomerExceeded".
	//
	// The customer has exceeded the allowed rate of API calls.
	ErrCodeAPICallRateForCustomerExceededFault = "APICallRateForCustomerExceeded"

	// ErrCodeAuthorizationAlreadyExistsFault for service response error code
	// "AuthorizationAlreadyExists".
	//
	// The specified Amazon EC2 security group is already authorized for the specified
	// cache security group.
	ErrCodeAuthorizationAlreadyExistsFault = "AuthorizationAlreadyExists"

	// ErrCodeAuthorizationNotFoundFault for service response error code
	// "AuthorizationNotFound".
	//
	// The specified Amazon EC2 security group is not authorized for the specified
	// cache security group.
	ErrCodeAuthorizationNotFoundFault = "AuthorizationNotFound"

	// ErrCodeCacheClusterAlreadyExistsFault for service response error code
	// "CacheClusterAlreadyExists".
	//
	// You already have a cluster with the given identifier.
	ErrCodeCacheClusterAlreadyExistsFault = "CacheClusterAlreadyExists"

	// ErrCodeCacheClusterNotFoundFault for service response error code
	// "CacheClusterNotFound".
	//
	// The requested cluster ID does not refer to an existing cluster.
	ErrCodeCacheClusterNotFoundFault = "CacheClusterNotFound"

	// ErrCodeCacheParameterGroupAlreadyExistsFault for service response error code
	// "CacheParameterGroupAlreadyExists".
	//
	// A cache parameter group with the requested name already exists.
	ErrCodeCacheParameterGroupAlreadyExistsFault = "CacheParameterGroupAlreadyExists"

	// ErrCodeCacheParameterGroupNotFoundFault for service response error code
	// "CacheParameterGroupNotFound".
	//
	// The requested cache parameter group name does not refer to an existing cache
	// parameter group.
	ErrCodeCacheParameterGroupNotFoundFault = "CacheParameterGroupNotFound"

	// ErrCodeCacheParameterGroupQuotaExceededFault for service response error code
	// "CacheParameterGroupQuotaExceeded".
	//
	// The request cannot be processed because it would exceed the maximum number
	// of cache security groups.
	ErrCodeCacheParameterGroupQuotaExceededFault = "CacheParameterGroupQuotaExceeded"

	// ErrCodeCacheSecurityGroupAlreadyExistsFault for service response error code
	// "CacheSecurityGroupAlreadyExists".
	//
	// A cache security group with the specified name already exists.
	ErrCodeCacheSecurityGroupAlreadyExistsFault = "CacheSecurityGroupAlreadyExists"

	// ErrCodeCacheSecurityGroupNotFoundFault for service response error code
	// "CacheSecurityGroupNotFound".
	//
	// The requested cache security group name does not refer to an existing cache
	// security group.
	ErrCodeCacheSecurityGroupNotFoundFault = "CacheSecurityGroupNotFound"

	// ErrCodeCacheSecurityGroupQuotaExceededFault for service response error code
	// "QuotaExceeded.CacheSecurityGroup".
	//
	// The request cannot be processed because it would exceed the allowed number
	// of cache security groups.
	ErrCodeCacheSecurityGroupQuotaExceededFault = "QuotaExceeded.CacheSecurityGroup"

	// ErrCodeCacheSubnetGroupAlreadyExistsFault for service response error code
	// "CacheSubnetGroupAlreadyExists".
	//
	// The requested cache subnet group name is already in use by an existing cache
	// subnet group.
	ErrCodeCacheSubnetGroupAlreadyExistsFault = "CacheSubnetGroupAlreadyExists"

	// ErrCodeCacheSubnetGroupInUse for service response error code
	// "CacheSubnetGroupInUse".
	//
	// The requested cache subnet group is currently in use.
	ErrCodeCacheSubnetGroupInUse = "CacheSubnetGroupInUse"

	// ErrCodeCacheSubnetGroupNotFoundFault for service response error code
	// "CacheSubnetGroupNotFoundFault".
	//
	// The requested cache subnet group name does not refer to an existing cache
	// subnet group.
	ErrCodeCacheSubnetGroupNotFoundFault = "CacheSubnetGroupNotFoundFault"

	// ErrCodeCacheSubnetGroupQuotaExceededFault for service response error code
	// "CacheSubnetGroupQuotaExceeded".
	//
	// The request cannot be processed because it would exceed the allowed number
	// of cache subnet groups.
	ErrCodeCacheSubnetGroupQuotaExceededFault = "CacheSubnetGroupQuotaExceeded"

	// ErrCodeCacheSubnetQuotaExceededFault for service response error code
	// "CacheSubnetQuotaExceededFault".
	//
	// The request cannot be processed because it would exceed the allowed number
	// of subnets in a cache subnet group.
	ErrCodeCacheSubnetQuotaExceededFault = "CacheSubnetQuotaExceededFault"

	// ErrCodeClusterQuotaForCustomerExceededFault for service response error code
	// "ClusterQuotaForCustomerExceeded".
	//
	// The request cannot be processed because it would exceed the allowed number
	// of clusters per customer.
	ErrCodeClusterQuotaForCustomerExceededFault = "ClusterQuotaForCustomerExceeded"

	// ErrCodeGlobalReplicationGroupAlreadyExistsFault for service response error code
	// "GlobalReplicationGroupAlreadyExistsFault".
	//
	// The Global Datastore name already exists.
	ErrCodeGlobalReplicationGroupAlreadyExistsFault = "GlobalReplicationGroupAlreadyExistsFault"

	// ErrCodeGlobalReplicationGroupNotFoundFault for service response error code
	// "GlobalReplicationGroupNotFoundFault".
	//
	// The Global Datastore does not exist
	ErrCodeGlobalReplicationGroupNotFoundFault = "GlobalReplicationGroupNotFoundFault"

	// ErrCodeInsufficientCacheClusterCapacityFault for service response error code
	// "InsufficientCacheClusterCapacity".
	//
	// The requested cache node type is not available in the specified Availability
	// Zone. For more information, see InsufficientCacheClusterCapacity (http://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/ErrorMessages.html#ErrorMessages.INSUFFICIENT_CACHE_CLUSTER_CAPACITY)
	// in the ElastiCache User Guide.
	ErrCodeInsufficientCacheClusterCapacityFault = "InsufficientCacheClusterCapacity"

	// ErrCodeInvalidARNFault for service response error code
	// "InvalidARN".
	//
	// The requested Amazon Resource Name (ARN) does not refer to an existing resource.
	ErrCodeInvalidARNFault = "InvalidARN"

	// ErrCodeInvalidCacheClusterStateFault for service response error code
	// "InvalidCacheClusterState".
	//
	// The requested cluster is not in the available state.
	ErrCodeInvalidCacheClusterStateFault = "InvalidCacheClusterState"

	// ErrCodeInvalidCacheParameterGroupStateFault for service response error code
	// "InvalidCacheParameterGroupState".
	//
	// The current state of the cache parameter group does not allow the requested
	// operation to occur.
	ErrCodeInvalidCacheParameterGroupStateFault = "InvalidCacheParameterGroupState"

	// ErrCodeInvalidCacheSecurityGroupStateFault for service response error code
	// "InvalidCacheSecurityGroupState".
	//
	// The current state of the cache security group does not allow deletion.
	ErrCodeInvalidCacheSecurityGroupStateFault = "InvalidCacheSecurityGroupState"

	// ErrCodeInvalidGlobalReplicationGroupStateFault for service response error code
	// "InvalidGlobalReplicationGroupState".
	//
	// The Global Datastore is not available or in primary-only state.
	ErrCodeInvalidGlobalReplicationGroupStateFault = "InvalidGlobalReplicationGroupState"

	// ErrCodeInvalidKMSKeyFault for service response error code
	// "InvalidKMSKeyFault".
	//
	// The KMS key supplied is not valid.
	ErrCodeInvalidKMSKeyFault = "InvalidKMSKeyFault"

	// ErrCodeInvalidParameterCombinationException for service response error code
	// "InvalidParameterCombination".
	//
	// Two or more incompatible parameters were specified.
	ErrCodeInvalidParameterCombinationException = "InvalidParameterCombination"

	// ErrCodeInvalidParameterValueException for service response error code
	// "InvalidParameterValue".
	//
	// The value for a parameter is invalid.
	ErrCodeInvalidParameterValueException = "InvalidParameterValue"

	// ErrCodeInvalidReplicationGroupStateFault for service response error code
	// "InvalidReplicationGroupState".
	//
	// The requested replication group is not in the available state.
	ErrCodeInvalidReplicationGroupStateFault = "InvalidReplicationGroupState"

	// ErrCodeInvalidSnapshotStateFault for service response error code
	// "InvalidSnapshotState".
	//
	// The current state of the snapshot does not allow the requested operation
	// to occur.
	ErrCodeInvalidSnapshotStateFault = "InvalidSnapshotState"

	// ErrCodeInvalidSubnet for service response error code
	// "InvalidSubnet".
	//
	// An invalid subnet identifier was specified.
	ErrCodeInvalidSubnet = "InvalidSubnet"

	// ErrCodeInvalidVPCNetworkStateFault for service response error code
	// "InvalidVPCNetworkStateFault".
	//
	// The VPC network is in an invalid state.
	ErrCodeInvalidVPCNetworkStateFault = "InvalidVPCNetworkStateFault"

	// ErrCodeNoOperationFault for service response error code
	// "NoOperationFault".
	//
	// The operation was not performed because no changes were required.
	ErrCodeNoOperationFault = "NoOperationFault"

	// ErrCodeNodeGroupNotFoundFault for service response error code
	// "NodeGroupNotFoundFault".
	//
	// 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.
	ErrCodeNodeGroupNotFoundFault = "NodeGroupNotFoundFault"

	// ErrCodeNodeGroupsPerReplicationGroupQuotaExceededFault for service response error code
	// "NodeGroupsPerReplicationGroupQuotaExceeded".
	//
	// 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 90
	ErrCodeNodeGroupsPerReplicationGroupQuotaExceededFault = "NodeGroupsPerReplicationGroupQuotaExceeded"

	// ErrCodeNodeQuotaForClusterExceededFault for service response error code
	// "NodeQuotaForClusterExceeded".
	//
	// The request cannot be processed because it would exceed the allowed number
	// of cache nodes in a single cluster.
	ErrCodeNodeQuotaForClusterExceededFault = "NodeQuotaForClusterExceeded"

	// ErrCodeNodeQuotaForCustomerExceededFault for service response error code
	// "NodeQuotaForCustomerExceeded".
	//
	// The request cannot be processed because it would exceed the allowed number
	// of cache nodes per customer.
	ErrCodeNodeQuotaForCustomerExceededFault = "NodeQuotaForCustomerExceeded"

	// ErrCodeReplicationGroupAlreadyExistsFault for service response error code
	// "ReplicationGroupAlreadyExists".
	//
	// The specified replication group already exists.
	ErrCodeReplicationGroupAlreadyExistsFault = "ReplicationGroupAlreadyExists"

	// ErrCodeReplicationGroupAlreadyUnderMigrationFault for service response error code
	// "ReplicationGroupAlreadyUnderMigrationFault".
	//
	// The targeted replication group is not available.
	ErrCodeReplicationGroupAlreadyUnderMigrationFault = "ReplicationGroupAlreadyUnderMigrationFault"

	// ErrCodeReplicationGroupNotFoundFault for service response error code
	// "ReplicationGroupNotFoundFault".
	//
	// The specified replication group does not exist.
	ErrCodeReplicationGroupNotFoundFault = "ReplicationGroupNotFoundFault"

	// ErrCodeReplicationGroupNotUnderMigrationFault for service response error code
	// "ReplicationGroupNotUnderMigrationFault".
	//
	// The designated replication group is not available for data migration.
	ErrCodeReplicationGroupNotUnderMigrationFault = "ReplicationGroupNotUnderMigrationFault"

	// ErrCodeReservedCacheNodeAlreadyExistsFault for service response error code
	// "ReservedCacheNodeAlreadyExists".
	//
	// You already have a reservation with the given identifier.
	ErrCodeReservedCacheNodeAlreadyExistsFault = "ReservedCacheNodeAlreadyExists"

	// ErrCodeReservedCacheNodeNotFoundFault for service response error code
	// "ReservedCacheNodeNotFound".
	//
	// The requested reserved cache node was not found.
	ErrCodeReservedCacheNodeNotFoundFault = "ReservedCacheNodeNotFound"

	// ErrCodeReservedCacheNodeQuotaExceededFault for service response error code
	// "ReservedCacheNodeQuotaExceeded".
	//
	// The request cannot be processed because it would exceed the user's cache
	// node quota.
	ErrCodeReservedCacheNodeQuotaExceededFault = "ReservedCacheNodeQuotaExceeded"

	// ErrCodeReservedCacheNodesOfferingNotFoundFault for service response error code
	// "ReservedCacheNodesOfferingNotFound".
	//
	// The requested cache node offering does not exist.
	ErrCodeReservedCacheNodesOfferingNotFoundFault = "ReservedCacheNodesOfferingNotFound"

	// ErrCodeServiceLinkedRoleNotFoundFault for service response error code
	// "ServiceLinkedRoleNotFoundFault".
	//
	// The specified service linked role (SLR) was not found.
	ErrCodeServiceLinkedRoleNotFoundFault = "ServiceLinkedRoleNotFoundFault"

	// ErrCodeServiceUpdateNotFoundFault for service response error code
	// "ServiceUpdateNotFoundFault".
	//
	// The service update doesn't exist
	ErrCodeServiceUpdateNotFoundFault = "ServiceUpdateNotFoundFault"

	// ErrCodeSnapshotAlreadyExistsFault for service response error code
	// "SnapshotAlreadyExistsFault".
	//
	// You already have a snapshot with the given name.
	ErrCodeSnapshotAlreadyExistsFault = "SnapshotAlreadyExistsFault"

	// ErrCodeSnapshotFeatureNotSupportedFault for service response error code
	// "SnapshotFeatureNotSupportedFault".
	//
	// You attempted one of the following operations:
	//
	//    * Creating a snapshot of a Redis cluster running on a cache.t1.micro cache
	//    node.
	//
	//    * Creating a snapshot of a cluster that is running Memcached rather than
	//    Redis.
	//
	// Neither of these are supported by ElastiCache.
	ErrCodeSnapshotFeatureNotSupportedFault = "SnapshotFeatureNotSupportedFault"

	// ErrCodeSnapshotNotFoundFault for service response error code
	// "SnapshotNotFoundFault".
	//
	// The requested snapshot name does not refer to an existing snapshot.
	ErrCodeSnapshotNotFoundFault = "SnapshotNotFoundFault"

	// ErrCodeSnapshotQuotaExceededFault for service response error code
	// "SnapshotQuotaExceededFault".
	//
	// The request cannot be processed because it would exceed the maximum number
	// of snapshots.
	ErrCodeSnapshotQuotaExceededFault = "SnapshotQuotaExceededFault"

	// ErrCodeSubnetInUse for service response error code
	// "SubnetInUse".
	//
	// The requested subnet is being used by another cache subnet group.
	ErrCodeSubnetInUse = "SubnetInUse"

	// ErrCodeTagNotFoundFault for service response error code
	// "TagNotFound".
	//
	// The requested tag was not found on this resource.
	ErrCodeTagNotFoundFault = "TagNotFound"

	// ErrCodeTagQuotaPerResourceExceeded for service response error code
	// "TagQuotaPerResourceExceeded".
	//
	// The request cannot be processed because it would cause the resource to have
	// more than the allowed number of tags. The maximum number of tags permitted
	// on a resource is 50.
	ErrCodeTagQuotaPerResourceExceeded = "TagQuotaPerResourceExceeded"

	// ErrCodeTestFailoverNotAvailableFault for service response error code
	// "TestFailoverNotAvailableFault".
	//
	// The TestFailover action is not available.
	ErrCodeTestFailoverNotAvailableFault = "TestFailoverNotAvailableFault"
)

Variables

This section is empty.

Functions

This section is empty.

Types

type AZMode

type AZMode string
const (
	AZModeSingleAz AZMode = "single-az"
	AZModeCrossAz  AZMode = "cross-az"
)

Enum values for AZMode

func (AZMode) MarshalValue added in v0.3.0

func (enum AZMode) MarshalValue() (string, error)

func (AZMode) MarshalValueBuf added in v0.3.0

func (enum AZMode) MarshalValueBuf(b []byte) ([]byte, error)

type AddTagsToResourceInput

type AddTagsToResourceInput struct {

	// The Amazon Resource Name (ARN) of the resource to which the tags are to be
	// added, for example arn:aws:elasticache:us-west-2:0123456789:cluster:myCluster
	// or arn:aws:elasticache:us-west-2:0123456789:snapshot:mySnapshot. ElastiCache
	// resources are cluster and snapshot.
	//
	// For more information about ARNs, see Amazon Resource Names (ARNs) and AWS
	// Service Namespaces (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html).
	//
	// ResourceName is a required field
	ResourceName *string `type:"string" required:"true"`

	// A list of cost allocation tags to be added to this resource. A tag is a key-value
	// pair. A tag key must be accompanied by a tag value.
	//
	// Tags is a required field
	Tags []Tag `locationNameList:"Tag" type:"list" required:"true"`
	// contains filtered or unexported fields
}

Represents the input of an AddTagsToResource operation.

func (AddTagsToResourceInput) String

func (s AddTagsToResourceInput) String() string

String returns the string representation

func (*AddTagsToResourceInput) Validate

func (s *AddTagsToResourceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type AddTagsToResourceOutput added in v0.9.0

type AddTagsToResourceOutput struct {

	// A list of cost allocation tags as key-value pairs.
	TagList []Tag `locationNameList:"Tag" type:"list"`
	// contains filtered or unexported fields
}

Represents the output from the AddTagsToResource, ListTagsForResource, and RemoveTagsFromResource operations.

func (AddTagsToResourceOutput) String added in v0.9.0

func (s AddTagsToResourceOutput) String() string

String returns the string representation

type AddTagsToResourceRequest

type AddTagsToResourceRequest struct {
	*aws.Request
	Input *AddTagsToResourceInput
	Copy  func(*AddTagsToResourceInput) AddTagsToResourceRequest
}

AddTagsToResourceRequest is the request type for the AddTagsToResource API operation.

func (AddTagsToResourceRequest) Send

Send marshals and sends the AddTagsToResource API request.

type AddTagsToResourceResponse added in v0.9.0

type AddTagsToResourceResponse struct {
	*AddTagsToResourceOutput
	// contains filtered or unexported fields
}

AddTagsToResourceResponse is the response type for the AddTagsToResource API operation.

func (*AddTagsToResourceResponse) SDKResponseMetdata added in v0.9.0

func (r *AddTagsToResourceResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the AddTagsToResource request.

type AuthTokenUpdateStatus added in v0.16.0

type AuthTokenUpdateStatus string
const (
	AuthTokenUpdateStatusSetting  AuthTokenUpdateStatus = "SETTING"
	AuthTokenUpdateStatusRotating AuthTokenUpdateStatus = "ROTATING"
)

Enum values for AuthTokenUpdateStatus

func (AuthTokenUpdateStatus) MarshalValue added in v0.16.0

func (enum AuthTokenUpdateStatus) MarshalValue() (string, error)

func (AuthTokenUpdateStatus) MarshalValueBuf added in v0.16.0

func (enum AuthTokenUpdateStatus) MarshalValueBuf(b []byte) ([]byte, error)

type AuthTokenUpdateStrategyType added in v0.16.0

type AuthTokenUpdateStrategyType string
const (
	AuthTokenUpdateStrategyTypeSet    AuthTokenUpdateStrategyType = "SET"
	AuthTokenUpdateStrategyTypeRotate AuthTokenUpdateStrategyType = "ROTATE"
)

Enum values for AuthTokenUpdateStrategyType

func (AuthTokenUpdateStrategyType) MarshalValue added in v0.16.0

func (enum AuthTokenUpdateStrategyType) MarshalValue() (string, error)

func (AuthTokenUpdateStrategyType) MarshalValueBuf added in v0.16.0

func (enum AuthTokenUpdateStrategyType) MarshalValueBuf(b []byte) ([]byte, error)

type AuthorizeCacheSecurityGroupIngressInput

type AuthorizeCacheSecurityGroupIngressInput struct {

	// The cache security group that allows network ingress.
	//
	// CacheSecurityGroupName is a required field
	CacheSecurityGroupName *string `type:"string" required:"true"`

	// The Amazon EC2 security group to be authorized for ingress to the cache security
	// group.
	//
	// EC2SecurityGroupName is a required field
	EC2SecurityGroupName *string `type:"string" required:"true"`

	// The AWS account number of the Amazon EC2 security group owner. Note that
	// this is not the same thing as an AWS access key ID - you must provide a valid
	// AWS account number for this parameter.
	//
	// EC2SecurityGroupOwnerId is a required field
	EC2SecurityGroupOwnerId *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

Represents the input of an AuthorizeCacheSecurityGroupIngress operation.

func (AuthorizeCacheSecurityGroupIngressInput) String

String returns the string representation

func (*AuthorizeCacheSecurityGroupIngressInput) Validate

Validate inspects the fields of the type to determine if they are valid.

type AuthorizeCacheSecurityGroupIngressOutput

type AuthorizeCacheSecurityGroupIngressOutput struct {

	// Represents the output of one of the following operations:
	//
	//    * AuthorizeCacheSecurityGroupIngress
	//
	//    * CreateCacheSecurityGroup
	//
	//    * RevokeCacheSecurityGroupIngress
	CacheSecurityGroup *CacheSecurityGroup `type:"structure"`
	// contains filtered or unexported fields
}

func (AuthorizeCacheSecurityGroupIngressOutput) String

String returns the string representation

type AuthorizeCacheSecurityGroupIngressRequest

AuthorizeCacheSecurityGroupIngressRequest is the request type for the AuthorizeCacheSecurityGroupIngress API operation.

func (AuthorizeCacheSecurityGroupIngressRequest) Send

Send marshals and sends the AuthorizeCacheSecurityGroupIngress API request.

type AuthorizeCacheSecurityGroupIngressResponse added in v0.9.0

type AuthorizeCacheSecurityGroupIngressResponse struct {
	*AuthorizeCacheSecurityGroupIngressOutput
	// contains filtered or unexported fields
}

AuthorizeCacheSecurityGroupIngressResponse is the response type for the AuthorizeCacheSecurityGroupIngress API operation.

func (*AuthorizeCacheSecurityGroupIngressResponse) SDKResponseMetdata added in v0.9.0

func (r *AuthorizeCacheSecurityGroupIngressResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the AuthorizeCacheSecurityGroupIngress request.

type AutomaticFailoverStatus

type AutomaticFailoverStatus string
const (
	AutomaticFailoverStatusEnabled   AutomaticFailoverStatus = "enabled"
	AutomaticFailoverStatusDisabled  AutomaticFailoverStatus = "disabled"
	AutomaticFailoverStatusEnabling  AutomaticFailoverStatus = "enabling"
	AutomaticFailoverStatusDisabling AutomaticFailoverStatus = "disabling"
)

Enum values for AutomaticFailoverStatus

func (AutomaticFailoverStatus) MarshalValue added in v0.3.0

func (enum AutomaticFailoverStatus) MarshalValue() (string, error)

func (AutomaticFailoverStatus) MarshalValueBuf added in v0.3.0

func (enum AutomaticFailoverStatus) MarshalValueBuf(b []byte) ([]byte, error)

type AvailabilityZone

type AvailabilityZone struct {

	// The name of the Availability Zone.
	Name *string `type:"string"`
	// contains filtered or unexported fields
}

Describes an Availability Zone in which the cluster is launched.

func (AvailabilityZone) String

func (s AvailabilityZone) String() string

String returns the string representation

type BatchApplyUpdateActionInput added in v0.10.0

type BatchApplyUpdateActionInput struct {

	// The cache cluster IDs
	CacheClusterIds []string `type:"list"`

	// The replication group IDs
	ReplicationGroupIds []string `type:"list"`

	// The unique ID of the service update
	//
	// ServiceUpdateName is a required field
	ServiceUpdateName *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (BatchApplyUpdateActionInput) String added in v0.10.0

String returns the string representation

func (*BatchApplyUpdateActionInput) Validate added in v0.10.0

func (s *BatchApplyUpdateActionInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type BatchApplyUpdateActionOutput added in v0.10.0

type BatchApplyUpdateActionOutput struct {

	// Update actions that have been processed successfully
	ProcessedUpdateActions []ProcessedUpdateAction `locationNameList:"ProcessedUpdateAction" type:"list"`

	// Update actions that haven't been processed successfully
	UnprocessedUpdateActions []UnprocessedUpdateAction `locationNameList:"UnprocessedUpdateAction" type:"list"`
	// contains filtered or unexported fields
}

func (BatchApplyUpdateActionOutput) String added in v0.10.0

String returns the string representation

type BatchApplyUpdateActionRequest added in v0.10.0

type BatchApplyUpdateActionRequest struct {
	*aws.Request
	Input *BatchApplyUpdateActionInput
	Copy  func(*BatchApplyUpdateActionInput) BatchApplyUpdateActionRequest
}

BatchApplyUpdateActionRequest is the request type for the BatchApplyUpdateAction API operation.

func (BatchApplyUpdateActionRequest) Send added in v0.10.0

Send marshals and sends the BatchApplyUpdateAction API request.

type BatchApplyUpdateActionResponse added in v0.10.0

type BatchApplyUpdateActionResponse struct {
	*BatchApplyUpdateActionOutput
	// contains filtered or unexported fields
}

BatchApplyUpdateActionResponse is the response type for the BatchApplyUpdateAction API operation.

func (*BatchApplyUpdateActionResponse) SDKResponseMetdata added in v0.10.0

func (r *BatchApplyUpdateActionResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the BatchApplyUpdateAction request.

type BatchStopUpdateActionInput added in v0.10.0

type BatchStopUpdateActionInput struct {

	// The cache cluster IDs
	CacheClusterIds []string `type:"list"`

	// The replication group IDs
	ReplicationGroupIds []string `type:"list"`

	// The unique ID of the service update
	//
	// ServiceUpdateName is a required field
	ServiceUpdateName *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (BatchStopUpdateActionInput) String added in v0.10.0

String returns the string representation

func (*BatchStopUpdateActionInput) Validate added in v0.10.0

func (s *BatchStopUpdateActionInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type BatchStopUpdateActionOutput added in v0.10.0

type BatchStopUpdateActionOutput struct {

	// Update actions that have been processed successfully
	ProcessedUpdateActions []ProcessedUpdateAction `locationNameList:"ProcessedUpdateAction" type:"list"`

	// Update actions that haven't been processed successfully
	UnprocessedUpdateActions []UnprocessedUpdateAction `locationNameList:"UnprocessedUpdateAction" type:"list"`
	// contains filtered or unexported fields
}

func (BatchStopUpdateActionOutput) String added in v0.10.0

String returns the string representation

type BatchStopUpdateActionRequest added in v0.10.0

type BatchStopUpdateActionRequest struct {
	*aws.Request
	Input *BatchStopUpdateActionInput
	Copy  func(*BatchStopUpdateActionInput) BatchStopUpdateActionRequest
}

BatchStopUpdateActionRequest is the request type for the BatchStopUpdateAction API operation.

func (BatchStopUpdateActionRequest) Send added in v0.10.0

Send marshals and sends the BatchStopUpdateAction API request.

type BatchStopUpdateActionResponse added in v0.10.0

type BatchStopUpdateActionResponse struct {
	*BatchStopUpdateActionOutput
	// contains filtered or unexported fields
}

BatchStopUpdateActionResponse is the response type for the BatchStopUpdateAction API operation.

func (*BatchStopUpdateActionResponse) SDKResponseMetdata added in v0.10.0

func (r *BatchStopUpdateActionResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the BatchStopUpdateAction request.

type CacheCluster

type CacheCluster struct {

	// The ARN (Amazon Resource Name) of the cache cluster.
	ARN *string `type:"string"`

	// A flag that enables encryption at-rest when set to true.
	//
	// You cannot modify the value of AtRestEncryptionEnabled after the cluster
	// is created. To enable at-rest encryption on a cluster you must set AtRestEncryptionEnabled
	// to true when you create a cluster.
	//
	// Required: Only available when creating a replication group in an Amazon VPC
	// using redis version 3.2.6, 4.x or later.
	//
	// Default: false
	AtRestEncryptionEnabled *bool `type:"boolean"`

	// A flag that enables using an AuthToken (password) when issuing Redis commands.
	//
	// Default: false
	AuthTokenEnabled *bool `type:"boolean"`

	// The date the auth token was last modified
	AuthTokenLastModifiedDate *time.Time `type:"timestamp"`

	// This parameter is currently disabled.
	AutoMinorVersionUpgrade *bool `type:"boolean"`

	// The date and time when the cluster was created.
	CacheClusterCreateTime *time.Time `type:"timestamp"`

	// The user-supplied identifier of the cluster. This identifier is a unique
	// key that identifies a cluster.
	CacheClusterId *string `type:"string"`

	// The current state of this cluster, one of the following values: available,
	// creating, deleted, deleting, incompatible-network, modifying, rebooting cluster
	// nodes, restore-failed, or snapshotting.
	CacheClusterStatus *string `type:"string"`

	// The name of the compute and memory capacity node type for the cluster.
	//
	// 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: M5 node types: cache.m5.large,
	//    cache.m5.xlarge, cache.m5.2xlarge, cache.m5.4xlarge, cache.m5.12xlarge,
	//    cache.m5.24xlarge M4 node types: cache.m4.large, cache.m4.xlarge, cache.m4.2xlarge,
	//    cache.m4.4xlarge, cache.m4.10xlarge T3 node types: cache.t3.micro, cache.t3.small,
	//    cache.t3.medium T2 node types: cache.t2.micro, cache.t2.small, cache.t2.medium
	//    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
	//    M3 node types: cache.m3.medium, cache.m3.large, cache.m3.xlarge, cache.m3.2xlarge
	//
	//    * Compute optimized: Previous generation: (not recommended) C1 node types:
	//    cache.c1.xlarge
	//
	//    * Memory optimized: Current generation: R5 node types: cache.r5.large,
	//    cache.r5.xlarge, cache.r5.2xlarge, cache.r5.4xlarge, cache.r5.12xlarge,
	//    cache.r5.24xlarge R4 node types: cache.r4.large, cache.r4.xlarge, cache.r4.2xlarge,
	//    cache.r4.4xlarge, cache.r4.8xlarge, cache.r4.16xlarge Previous generation:
	//    (not recommended) M2 node types: cache.m2.xlarge, cache.m2.2xlarge, cache.m2.4xlarge
	//    R3 node types: cache.r3.large, cache.r3.xlarge, cache.r3.2xlarge, cache.r3.4xlarge,
	//    cache.r3.8xlarge
	//
	// Additional node type info
	//
	//    * All current generation instance types are created in Amazon VPC by default.
	//
	//    * Redis append-only files (AOF) are not supported for T1 or T2 instances.
	//
	//    * Redis Multi-AZ with automatic failover is not supported on T1 instances.
	//
	//    * Redis configuration variables appendonly and appendfsync are not supported
	//    on Redis version 2.8.22 and later.
	CacheNodeType *string `type:"string"`

	// A list of cache nodes that are members of the cluster.
	CacheNodes []CacheNode `locationNameList:"CacheNode" type:"list"`

	// Status of the cache parameter group.
	CacheParameterGroup *CacheParameterGroupStatus `type:"structure"`

	// A list of cache security group elements, composed of name and status sub-elements.
	CacheSecurityGroups []CacheSecurityGroupMembership `locationNameList:"CacheSecurityGroup" type:"list"`

	// The name of the cache subnet group associated with the cluster.
	CacheSubnetGroupName *string `type:"string"`

	// The URL of the web page where you can download the latest ElastiCache client
	// library.
	ClientDownloadLandingPage *string `type:"string"`

	// Represents a Memcached cluster endpoint which, if Automatic Discovery is
	// enabled on the cluster, can be used by an application to connect to any node
	// in the cluster. The configuration endpoint will always have .cfg in it.
	//
	// Example: mem-3.9dvc4r.cfg.usw2.cache.amazonaws.com:11211
	ConfigurationEndpoint *Endpoint `type:"structure"`

	// The name of the cache engine (memcached or redis) to be used for this cluster.
	Engine *string `type:"string"`

	// The version of the cache engine that is used in this cluster.
	EngineVersion *string `type:"string"`

	// Describes a notification topic and its status. Notification topics are used
	// for publishing ElastiCache events to subscribers using Amazon Simple Notification
	// Service (SNS).
	NotificationConfiguration *NotificationConfiguration `type:"structure"`

	// The number of cache nodes in the cluster.
	//
	// For clusters running Redis, this value must be 1. For clusters running Memcached,
	// this value must be between 1 and 20.
	NumCacheNodes *int64 `type:"integer"`

	// A group of settings that are applied to the cluster in the future, or that
	// are currently being applied.
	PendingModifiedValues *PendingModifiedValues `type:"structure"`

	// The name of the Availability Zone in which the cluster is located or "Multiple"
	// if the cache nodes are located in different Availability Zones.
	PreferredAvailabilityZone *string `type:"string"`

	// Specifies the weekly time range during which maintenance on the cluster is
	// performed. It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi
	// (24H Clock UTC). The minimum maintenance window is a 60 minute period.
	//
	// Valid values for ddd are:
	//
	//    * sun
	//
	//    * mon
	//
	//    * tue
	//
	//    * wed
	//
	//    * thu
	//
	//    * fri
	//
	//    * sat
	//
	// Example: sun:23:00-mon:01:30
	PreferredMaintenanceWindow *string `type:"string"`

	// The replication group to which this cluster belongs. If this field is empty,
	// the cluster is not associated with any replication group.
	ReplicationGroupId *string `type:"string"`

	// A list of VPC Security Groups associated with the cluster.
	SecurityGroups []SecurityGroupMembership `type:"list"`

	// The number of days for which ElastiCache retains automatic cluster snapshots
	// before deleting them. For example, if you set SnapshotRetentionLimit to 5,
	// a snapshot that was taken today is retained for 5 days before being deleted.
	//
	// If the value of SnapshotRetentionLimit is set to zero (0), backups are turned
	// off.
	SnapshotRetentionLimit *int64 `type:"integer"`

	// The daily time range (in UTC) during which ElastiCache begins taking a daily
	// snapshot of your cluster.
	//
	// Example: 05:00-09:00
	SnapshotWindow *string `type:"string"`

	// A flag that enables in-transit encryption when set to true.
	//
	// You cannot modify the value of TransitEncryptionEnabled after the cluster
	// is created. To enable in-transit encryption on a cluster you must set TransitEncryptionEnabled
	// to true when you create a cluster.
	//
	// Required: Only available when creating a replication group in an Amazon VPC
	// using redis version 3.2.6, 4.x or later.
	//
	// Default: false
	TransitEncryptionEnabled *bool `type:"boolean"`
	// contains filtered or unexported fields
}

Contains all of the attributes of a specific cluster.

func (CacheCluster) String

func (s CacheCluster) String() string

String returns the string representation

type CacheEngineVersion

type CacheEngineVersion struct {

	// The description of the cache engine.
	CacheEngineDescription *string `type:"string"`

	// The description of the cache engine version.
	CacheEngineVersionDescription *string `type:"string"`

	// The name of the cache parameter group family associated with this cache engine.
	//
	// Valid values are: memcached1.4 | memcached1.5 | redis2.6 | redis2.8 | redis3.2
	// | redis4.0 | redis5.0 |
	CacheParameterGroupFamily *string `type:"string"`

	// The name of the cache engine.
	Engine *string `type:"string"`

	// The version number of the cache engine.
	EngineVersion *string `type:"string"`
	// contains filtered or unexported fields
}

Provides all of the details about a particular cache engine version.

func (CacheEngineVersion) String

func (s CacheEngineVersion) String() string

String returns the string representation

type CacheNode

type CacheNode struct {

	// The date and time when the cache node was created.
	CacheNodeCreateTime *time.Time `type:"timestamp"`

	// The cache node identifier. A node ID is a numeric identifier (0001, 0002,
	// etc.). The combination of cluster ID and node ID uniquely identifies every
	// cache node used in a customer's AWS account.
	CacheNodeId *string `type:"string"`

	// The current state of this cache node, one of the following values: available,
	// creating, rebooting, or deleting.
	CacheNodeStatus *string `type:"string"`

	// The Availability Zone where this node was created and now resides.
	CustomerAvailabilityZone *string `type:"string"`

	// The hostname for connecting to this cache node.
	Endpoint *Endpoint `type:"structure"`

	// The status of the parameter group applied to this cache node.
	ParameterGroupStatus *string `type:"string"`

	// The ID of the primary node to which this read replica node is synchronized.
	// If this field is empty, this node is not associated with a primary cluster.
	SourceCacheNodeId *string `type:"string"`
	// contains filtered or unexported fields
}

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: M5 node types: cache.m5.large, cache.m5.xlarge, cache.m5.2xlarge, cache.m5.4xlarge, cache.m5.12xlarge, cache.m5.24xlarge M4 node types: cache.m4.large, cache.m4.xlarge, cache.m4.2xlarge, cache.m4.4xlarge, cache.m4.10xlarge T3 node types: cache.t3.micro, cache.t3.small, cache.t3.medium T2 node types: cache.t2.micro, cache.t2.small, cache.t2.medium 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 M3 node types: cache.m3.medium, cache.m3.large, cache.m3.xlarge, cache.m3.2xlarge

  • Compute optimized: Previous generation: (not recommended) C1 node types: cache.c1.xlarge

  • Memory optimized: Current generation: R5 node types: cache.r5.large, cache.r5.xlarge, cache.r5.2xlarge, cache.r5.4xlarge, cache.r5.12xlarge, cache.r5.24xlarge R4 node types: cache.r4.large, cache.r4.xlarge, cache.r4.2xlarge, cache.r4.4xlarge, cache.r4.8xlarge, cache.r4.16xlarge Previous generation: (not recommended) M2 node types: cache.m2.xlarge, cache.m2.2xlarge, cache.m2.4xlarge R3 node types: cache.r3.large, cache.r3.xlarge, cache.r3.2xlarge, cache.r3.4xlarge, cache.r3.8xlarge

Additional node type info

  • All current generation instance types are created in Amazon VPC by default.

  • Redis append-only files (AOF) are not supported for T1 or T2 instances.

  • Redis Multi-AZ with automatic failover is not supported on T1 instances.

  • Redis configuration variables appendonly and appendfsync are not supported on Redis version 2.8.22 and later.

func (CacheNode) String

func (s CacheNode) String() string

String returns the string representation

type CacheNodeTypeSpecificParameter

type CacheNodeTypeSpecificParameter struct {

	// The valid range of values for the parameter.
	AllowedValues *string `type:"string"`

	// A list of cache node types and their corresponding values for this parameter.
	CacheNodeTypeSpecificValues []CacheNodeTypeSpecificValue `locationNameList:"CacheNodeTypeSpecificValue" type:"list"`

	// Indicates whether a change to the parameter is applied immediately or requires
	// a reboot for the change to be applied. You can force a reboot or wait until
	// the next maintenance window's reboot. For more information, see Rebooting
	// a Cluster (https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/Clusters.Rebooting.html).
	ChangeType ChangeType `type:"string" enum:"true"`

	// The valid data type for the parameter.
	DataType *string `type:"string"`

	// A description of the parameter.
	Description *string `type:"string"`

	// Indicates whether (true) or not (false) the parameter can be modified. Some
	// parameters have security or operational implications that prevent them from
	// being changed.
	IsModifiable *bool `type:"boolean"`

	// The earliest cache engine version to which the parameter can apply.
	MinimumEngineVersion *string `type:"string"`

	// The name of the parameter.
	ParameterName *string `type:"string"`

	// The source of the parameter value.
	Source *string `type:"string"`
	// contains filtered or unexported fields
}

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.

func (CacheNodeTypeSpecificParameter) String

String returns the string representation

type CacheNodeTypeSpecificValue

type CacheNodeTypeSpecificValue struct {

	// The cache node type for which this value applies.
	CacheNodeType *string `type:"string"`

	// The value for the cache node type.
	Value *string `type:"string"`
	// contains filtered or unexported fields
}

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

func (CacheNodeTypeSpecificValue) String

String returns the string representation

type CacheNodeUpdateStatus added in v0.15.0

type CacheNodeUpdateStatus struct {

	// The node ID of the cache cluster
	CacheNodeId *string `type:"string"`

	// The deletion date of the node
	NodeDeletionDate *time.Time `type:"timestamp"`

	// The end date of the update for a node
	NodeUpdateEndDate *time.Time `type:"timestamp"`

	// Reflects whether the update was initiated by the customer or automatically
	// applied
	NodeUpdateInitiatedBy NodeUpdateInitiatedBy `type:"string" enum:"true"`

	// The date when the update is triggered
	NodeUpdateInitiatedDate *time.Time `type:"timestamp"`

	// The start date of the update for a node
	NodeUpdateStartDate *time.Time `type:"timestamp"`

	// The update status of the node
	NodeUpdateStatus NodeUpdateStatus `type:"string" enum:"true"`

	// The date when the NodeUpdateStatus was last modified>
	NodeUpdateStatusModifiedDate *time.Time `type:"timestamp"`
	// contains filtered or unexported fields
}

The status of the service update on the cache node

func (CacheNodeUpdateStatus) String added in v0.15.0

func (s CacheNodeUpdateStatus) String() string

String returns the string representation

type CacheParameterGroup

type CacheParameterGroup struct {

	// The ARN (Amazon Resource Name) of the cache parameter group.
	ARN *string `type:"string"`

	// The name of the cache parameter group family that this cache parameter group
	// is compatible with.
	//
	// Valid values are: memcached1.4 | memcached1.5 | redis2.6 | redis2.8 | redis3.2
	// | redis4.0 | redis5.0 |
	CacheParameterGroupFamily *string `type:"string"`

	// The name of the cache parameter group.
	CacheParameterGroupName *string `type:"string"`

	// The description for this cache parameter group.
	Description *string `type:"string"`

	// Indicates whether the parameter group is associated with a Global Datastore
	IsGlobal *bool `type:"boolean"`
	// contains filtered or unexported fields
}

Represents the output of a CreateCacheParameterGroup operation.

func (CacheParameterGroup) String

func (s CacheParameterGroup) String() string

String returns the string representation

type CacheParameterGroupStatus

type CacheParameterGroupStatus struct {

	// A list of the cache node IDs which need to be rebooted for parameter changes
	// to be applied. A node ID is a numeric identifier (0001, 0002, etc.).
	CacheNodeIdsToReboot []string `locationNameList:"CacheNodeId" type:"list"`

	// The name of the cache parameter group.
	CacheParameterGroupName *string `type:"string"`

	// The status of parameter updates.
	ParameterApplyStatus *string `type:"string"`
	// contains filtered or unexported fields
}

Status of the cache parameter group.

func (CacheParameterGroupStatus) String

func (s CacheParameterGroupStatus) String() string

String returns the string representation

type CacheSecurityGroup

type CacheSecurityGroup struct {

	// The ARN (Amazon Resource Name) of the cache security group.
	ARN *string `type:"string"`

	// The name of the cache security group.
	CacheSecurityGroupName *string `type:"string"`

	// The description of the cache security group.
	Description *string `type:"string"`

	// A list of Amazon EC2 security groups that are associated with this cache
	// security group.
	EC2SecurityGroups []EC2SecurityGroup `locationNameList:"EC2SecurityGroup" type:"list"`

	// The AWS account ID of the cache security group owner.
	OwnerId *string `type:"string"`
	// contains filtered or unexported fields
}

Represents the output of one of the following operations:

  • AuthorizeCacheSecurityGroupIngress

  • CreateCacheSecurityGroup

  • RevokeCacheSecurityGroupIngress

func (CacheSecurityGroup) String

func (s CacheSecurityGroup) String() string

String returns the string representation

type CacheSecurityGroupMembership

type CacheSecurityGroupMembership struct {

	// The name of the cache security group.
	CacheSecurityGroupName *string `type:"string"`

	// The membership status in the cache security group. The status changes when
	// a cache security group is modified, or when the cache security groups assigned
	// to a cluster are modified.
	Status *string `type:"string"`
	// contains filtered or unexported fields
}

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

func (CacheSecurityGroupMembership) String

String returns the string representation

type CacheSubnetGroup

type CacheSubnetGroup struct {

	// The ARN (Amazon Resource Name) of the cache subnet group.
	ARN *string `type:"string"`

	// The description of the cache subnet group.
	CacheSubnetGroupDescription *string `type:"string"`

	// The name of the cache subnet group.
	CacheSubnetGroupName *string `type:"string"`

	// A list of subnets associated with the cache subnet group.
	Subnets []Subnet `locationNameList:"Subnet" type:"list"`

	// The Amazon Virtual Private Cloud identifier (VPC ID) of the cache subnet
	// group.
	VpcId *string `type:"string"`
	// contains filtered or unexported fields
}

Represents the output of one of the following operations:

  • CreateCacheSubnetGroup

  • ModifyCacheSubnetGroup

func (CacheSubnetGroup) String

func (s CacheSubnetGroup) String() string

String returns the string representation

type ChangeType

type ChangeType string
const (
	ChangeTypeImmediate      ChangeType = "immediate"
	ChangeTypeRequiresReboot ChangeType = "requires-reboot"
)

Enum values for ChangeType

func (ChangeType) MarshalValue added in v0.3.0

func (enum ChangeType) MarshalValue() (string, error)

func (ChangeType) MarshalValueBuf added in v0.3.0

func (enum ChangeType) MarshalValueBuf(b []byte) ([]byte, error)

type Client added in v0.9.0

type Client struct {
	*aws.Client
}

Client provides the API operation methods for making requests to Amazon ElastiCache. See this package's package overview docs for details on the service.

The client's methods are safe to use concurrently. It is not safe to modify mutate any of the struct's properties though.

func New

func New(config aws.Config) *Client

New creates a new instance of the client from the provided Config.

Example:

// Create a client from just a config.
svc := elasticache.New(myConfig)

func (*Client) AddTagsToResourceRequest added in v0.9.0

func (c *Client) AddTagsToResourceRequest(input *AddTagsToResourceInput) AddTagsToResourceRequest

AddTagsToResourceRequest returns a request value for making API operation for Amazon ElastiCache.

Adds up to 50 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 (https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/Tagging.html) in the ElastiCache User Guide.

// Example sending a request using AddTagsToResourceRequest.
req := client.AddTagsToResourceRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/elasticache-2015-02-02/AddTagsToResource

Example (Shared00)

AddTagsToResource

Adds up to 10 tags, key/value pairs, to a cluster or snapshot resource.

package main

import (
	"context"
	"fmt"

	"github.com/aws/aws-sdk-go-v2/aws"
	"github.com/aws/aws-sdk-go-v2/aws/awserr"
	"github.com/aws/aws-sdk-go-v2/aws/external"
	"github.com/aws/aws-sdk-go-v2/service/elasticache"
)

func main() {
	cfg, err := external.LoadDefaultAWSConfig()
	if err != nil {
		panic("failed to load config, " + err.Error())
	}

	svc := elasticache.New(cfg)
	input := &elasticache.AddTagsToResourceInput{
		ResourceName: aws.String("arn:aws:elasticache:us-east-1:1234567890:cluster:my-mem-cluster"),
		Tags: []elasticache.Tag{
			{
				Key:   aws.String("APIVersion"),
				Value: aws.String("20150202"),
			},
			{
				Key:   aws.String("Service"),
				Value: aws.String("ElastiCache"),
			},
		},
	}

	req := svc.AddTagsToResourceRequest(input)
	result, err := req.Send(context.Background())
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case elasticache.ErrCodeCacheClusterNotFoundFault:
				fmt.Println(elasticache.ErrCodeCacheClusterNotFoundFault, aerr.Error())
			case elasticache.ErrCodeSnapshotNotFoundFault:
				fmt.Println(elasticache.ErrCodeSnapshotNotFoundFault, aerr.Error())
			case elasticache.ErrCodeTagQuotaPerResourceExceeded:
				fmt.Println(elasticache.ErrCodeTagQuotaPerResourceExceeded, aerr.Error())
			case elasticache.ErrCodeInvalidARNFault:
				fmt.Println(elasticache.ErrCodeInvalidARNFault, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*Client) AuthorizeCacheSecurityGroupIngressRequest added in v0.9.0

func (c *Client) AuthorizeCacheSecurityGroupIngressRequest(input *AuthorizeCacheSecurityGroupIngressInput) AuthorizeCacheSecurityGroupIngressRequest

AuthorizeCacheSecurityGroupIngressRequest returns a request value for making API operation for Amazon ElastiCache.

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.

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

// Example sending a request using AuthorizeCacheSecurityGroupIngressRequest.
req := client.AuthorizeCacheSecurityGroupIngressRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/elasticache-2015-02-02/AuthorizeCacheSecurityGroupIngress

Example (Shared00)

AuthorizeCacheCacheSecurityGroupIngress

Allows network ingress to a cache security group. Applications using ElastiCache must be running on Amazon EC2. Amazon EC2 security groups are used as the authorization mechanism.

package main

import (
	"context"
	"fmt"

	"github.com/aws/aws-sdk-go-v2/aws"
	"github.com/aws/aws-sdk-go-v2/aws/awserr"
	"github.com/aws/aws-sdk-go-v2/aws/external"
	"github.com/aws/aws-sdk-go-v2/service/elasticache"
)

func main() {
	cfg, err := external.LoadDefaultAWSConfig()
	if err != nil {
		panic("failed to load config, " + err.Error())
	}

	svc := elasticache.New(cfg)
	input := &elasticache.AuthorizeCacheSecurityGroupIngressInput{
		CacheSecurityGroupName:  aws.String("my-sec-grp"),
		EC2SecurityGroupName:    aws.String("my-ec2-sec-grp"),
		EC2SecurityGroupOwnerId: aws.String("1234567890"),
	}

	req := svc.AuthorizeCacheSecurityGroupIngressRequest(input)
	result, err := req.Send(context.Background())
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case elasticache.ErrCodeCacheSecurityGroupNotFoundFault:
				fmt.Println(elasticache.ErrCodeCacheSecurityGroupNotFoundFault, aerr.Error())
			case elasticache.ErrCodeInvalidCacheSecurityGroupStateFault:
				fmt.Println(elasticache.ErrCodeInvalidCacheSecurityGroupStateFault, aerr.Error())
			case elasticache.ErrCodeAuthorizationAlreadyExistsFault:
				fmt.Println(elasticache.ErrCodeAuthorizationAlreadyExistsFault, aerr.Error())
			case elasticache.ErrCodeInvalidParameterValueException:
				fmt.Println(elasticache.ErrCodeInvalidParameterValueException, aerr.Error())
			case elasticache.ErrCodeInvalidParameterCombinationException:
				fmt.Println(elasticache.ErrCodeInvalidParameterCombinationException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*Client) BatchApplyUpdateActionRequest added in v0.10.0

func (c *Client) BatchApplyUpdateActionRequest(input *BatchApplyUpdateActionInput) BatchApplyUpdateActionRequest

BatchApplyUpdateActionRequest returns a request value for making API operation for Amazon ElastiCache.

Apply the service update. For more information on service updates and applying them, see Applying Service Updates (https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/applying-updates.html).

// Example sending a request using BatchApplyUpdateActionRequest.
req := client.BatchApplyUpdateActionRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/elasticache-2015-02-02/BatchApplyUpdateAction

func (*Client) BatchStopUpdateActionRequest added in v0.10.0

func (c *Client) BatchStopUpdateActionRequest(input *BatchStopUpdateActionInput) BatchStopUpdateActionRequest

BatchStopUpdateActionRequest returns a request value for making API operation for Amazon ElastiCache.

Stop the service update. For more information on service updates and stopping them, see Stopping Service Updates (https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/stopping-self-service-updates.html).

// Example sending a request using BatchStopUpdateActionRequest.
req := client.BatchStopUpdateActionRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/elasticache-2015-02-02/BatchStopUpdateAction

func (*Client) CompleteMigrationRequest added in v0.16.0

func (c *Client) CompleteMigrationRequest(input *CompleteMigrationInput) CompleteMigrationRequest

CompleteMigrationRequest returns a request value for making API operation for Amazon ElastiCache.

Complete the migration of data.

// Example sending a request using CompleteMigrationRequest.
req := client.CompleteMigrationRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/elasticache-2015-02-02/CompleteMigration

func (*Client) CopySnapshotRequest added in v0.9.0

func (c *Client) CopySnapshotRequest(input *CopySnapshotInput) CopySnapshotRequest

CopySnapshotRequest returns a request value for making API operation for Amazon ElastiCache.

Makes a copy of an existing snapshot.

This operation is valid for Redis only.

Users or groups that have permissions to use the CopySnapshot operation can create their own Amazon S3 buckets and copy snapshots to it. To control access to your snapshots, use an IAM policy to control who has the ability to use the CopySnapshot operation. For more information about using IAM to control the use of ElastiCache operations, see Exporting Snapshots (https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/backups-exporting.html) and Authentication & Access Control (https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/IAM.html).

You could receive the following error messages.

Error Messages

Please also see https://docs.aws.amazon.com/goto/WebAPI/elasticache-2015-02-02/CopySnapshot

Example (Shared00)

CopySnapshot

Copies a snapshot to a specified name.

package main

import (
	"context"
	"fmt"

	"github.com/aws/aws-sdk-go-v2/aws"
	"github.com/aws/aws-sdk-go-v2/aws/awserr"
	"github.com/aws/aws-sdk-go-v2/aws/external"
	"github.com/aws/aws-sdk-go-v2/service/elasticache"
)

func main() {
	cfg, err := external.LoadDefaultAWSConfig()
	if err != nil {
		panic("failed to load config, " + err.Error())
	}

	svc := elasticache.New(cfg)
	input := &elasticache.CopySnapshotInput{
		SourceSnapshotName: aws.String("my-snapshot"),
		TargetBucket:       aws.String(""),
		TargetSnapshotName: aws.String("my-snapshot-copy"),
	}

	req := svc.CopySnapshotRequest(input)
	result, err := req.Send(context.Background())
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case elasticache.ErrCodeSnapshotAlreadyExistsFault:
				fmt.Println(elasticache.ErrCodeSnapshotAlreadyExistsFault, aerr.Error())
			case elasticache.ErrCodeSnapshotNotFoundFault:
				fmt.Println(elasticache.ErrCodeSnapshotNotFoundFault, aerr.Error())
			case elasticache.ErrCodeSnapshotQuotaExceededFault:
				fmt.Println(elasticache.ErrCodeSnapshotQuotaExceededFault, aerr.Error())
			case elasticache.ErrCodeInvalidSnapshotStateFault:
				fmt.Println(elasticache.ErrCodeInvalidSnapshotStateFault, aerr.Error())
			case elasticache.ErrCodeInvalidParameterValueException:
				fmt.Println(elasticache.ErrCodeInvalidParameterValueException, aerr.Error())
			case elasticache.ErrCodeInvalidParameterCombinationException:
				fmt.Println(elasticache.ErrCodeInvalidParameterCombinationException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*Client) CreateCacheClusterRequest added in v0.9.0

func (c *Client) CreateCacheClusterRequest(input *CreateCacheClusterInput) CreateCacheClusterRequest

CreateCacheClusterRequest returns a request value for making API operation for Amazon ElastiCache.

Creates a cluster. All nodes in the cluster run the same protocol-compliant cache engine software, either Memcached or Redis.

This operation is not supported for Redis (cluster mode enabled) clusters.

// Example sending a request using CreateCacheClusterRequest.
req := client.CreateCacheClusterRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/elasticache-2015-02-02/CreateCacheCluster

Example (Shared00)

CreateCacheCluster

Creates a Memcached cluster with 2 nodes.

package main

import (
	"context"
	"fmt"

	"github.com/aws/aws-sdk-go-v2/aws"
	"github.com/aws/aws-sdk-go-v2/aws/awserr"
	"github.com/aws/aws-sdk-go-v2/aws/external"
	"github.com/aws/aws-sdk-go-v2/service/elasticache"
)

func main() {
	cfg, err := external.LoadDefaultAWSConfig()
	if err != nil {
		panic("failed to load config, " + err.Error())
	}

	svc := elasticache.New(cfg)
	input := &elasticache.CreateCacheClusterInput{
		AZMode:               elasticache.AZModeCrossAz,
		CacheClusterId:       aws.String("my-memcached-cluster"),
		CacheNodeType:        aws.String("cache.r3.large"),
		CacheSubnetGroupName: aws.String("default"),
		Engine:               aws.String("memcached"),
		EngineVersion:        aws.String("1.4.24"),
		NumCacheNodes:        aws.Int64(2),
		Port:                 aws.Int64(11211),
	}

	req := svc.CreateCacheClusterRequest(input)
	result, err := req.Send(context.Background())
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case elasticache.ErrCodeReplicationGroupNotFoundFault:
				fmt.Println(elasticache.ErrCodeReplicationGroupNotFoundFault, aerr.Error())
			case elasticache.ErrCodeInvalidReplicationGroupStateFault:
				fmt.Println(elasticache.ErrCodeInvalidReplicationGroupStateFault, aerr.Error())
			case elasticache.ErrCodeCacheClusterAlreadyExistsFault:
				fmt.Println(elasticache.ErrCodeCacheClusterAlreadyExistsFault, aerr.Error())
			case elasticache.ErrCodeInsufficientCacheClusterCapacityFault:
				fmt.Println(elasticache.ErrCodeInsufficientCacheClusterCapacityFault, aerr.Error())
			case elasticache.ErrCodeCacheSecurityGroupNotFoundFault:
				fmt.Println(elasticache.ErrCodeCacheSecurityGroupNotFoundFault, aerr.Error())
			case elasticache.ErrCodeCacheSubnetGroupNotFoundFault:
				fmt.Println(elasticache.ErrCodeCacheSubnetGroupNotFoundFault, aerr.Error())
			case elasticache.ErrCodeClusterQuotaForCustomerExceededFault:
				fmt.Println(elasticache.ErrCodeClusterQuotaForCustomerExceededFault, aerr.Error())
			case elasticache.ErrCodeNodeQuotaForClusterExceededFault:
				fmt.Println(elasticache.ErrCodeNodeQuotaForClusterExceededFault, aerr.Error())
			case elasticache.ErrCodeNodeQuotaForCustomerExceededFault:
				fmt.Println(elasticache.ErrCodeNodeQuotaForCustomerExceededFault, aerr.Error())
			case elasticache.ErrCodeCacheParameterGroupNotFoundFault:
				fmt.Println(elasticache.ErrCodeCacheParameterGroupNotFoundFault, aerr.Error())
			case elasticache.ErrCodeInvalidVPCNetworkStateFault:
				fmt.Println(elasticache.ErrCodeInvalidVPCNetworkStateFault, aerr.Error())
			case elasticache.ErrCodeTagQuotaPerResourceExceeded:
				fmt.Println(elasticache.ErrCodeTagQuotaPerResourceExceeded, aerr.Error())
			case elasticache.ErrCodeInvalidParameterValueException:
				fmt.Println(elasticache.ErrCodeInvalidParameterValueException, aerr.Error())
			case elasticache.ErrCodeInvalidParameterCombinationException:
				fmt.Println(elasticache.ErrCodeInvalidParameterCombinationException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

Example (Shared01)

CreateCacheCluster

Creates a Redis cluster with 1 node.

package main

import (
	"context"
	"fmt"

	"github.com/aws/aws-sdk-go-v2/aws"
	"github.com/aws/aws-sdk-go-v2/aws/awserr"
	"github.com/aws/aws-sdk-go-v2/aws/external"
	"github.com/aws/aws-sdk-go-v2/service/elasticache"
)

func main() {
	cfg, err := external.LoadDefaultAWSConfig()
	if err != nil {
		panic("failed to load config, " + err.Error())
	}

	svc := elasticache.New(cfg)
	input := &elasticache.CreateCacheClusterInput{
		AutoMinorVersionUpgrade:   aws.Bool(true),
		CacheClusterId:            aws.String("my-redis"),
		CacheNodeType:             aws.String("cache.r3.larage"),
		CacheSubnetGroupName:      aws.String("default"),
		Engine:                    aws.String("redis"),
		EngineVersion:             aws.String("3.2.4"),
		NumCacheNodes:             aws.Int64(1),
		Port:                      aws.Int64(6379),
		PreferredAvailabilityZone: aws.String("us-east-1c"),
		SnapshotRetentionLimit:    aws.Int64(7),
	}

	req := svc.CreateCacheClusterRequest(input)
	result, err := req.Send(context.Background())
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case elasticache.ErrCodeReplicationGroupNotFoundFault:
				fmt.Println(elasticache.ErrCodeReplicationGroupNotFoundFault, aerr.Error())
			case elasticache.ErrCodeInvalidReplicationGroupStateFault:
				fmt.Println(elasticache.ErrCodeInvalidReplicationGroupStateFault, aerr.Error())
			case elasticache.ErrCodeCacheClusterAlreadyExistsFault:
				fmt.Println(elasticache.ErrCodeCacheClusterAlreadyExistsFault, aerr.Error())
			case elasticache.ErrCodeInsufficientCacheClusterCapacityFault:
				fmt.Println(elasticache.ErrCodeInsufficientCacheClusterCapacityFault, aerr.Error())
			case elasticache.ErrCodeCacheSecurityGroupNotFoundFault:
				fmt.Println(elasticache.ErrCodeCacheSecurityGroupNotFoundFault, aerr.Error())
			case elasticache.ErrCodeCacheSubnetGroupNotFoundFault:
				fmt.Println(elasticache.ErrCodeCacheSubnetGroupNotFoundFault, aerr.Error())
			case elasticache.ErrCodeClusterQuotaForCustomerExceededFault:
				fmt.Println(elasticache.ErrCodeClusterQuotaForCustomerExceededFault, aerr.Error())
			case elasticache.ErrCodeNodeQuotaForClusterExceededFault:
				fmt.Println(elasticache.ErrCodeNodeQuotaForClusterExceededFault, aerr.Error())
			case elasticache.ErrCodeNodeQuotaForCustomerExceededFault:
				fmt.Println(elasticache.ErrCodeNodeQuotaForCustomerExceededFault, aerr.Error())
			case elasticache.ErrCodeCacheParameterGroupNotFoundFault:
				fmt.Println(elasticache.ErrCodeCacheParameterGroupNotFoundFault, aerr.Error())
			case elasticache.ErrCodeInvalidVPCNetworkStateFault:
				fmt.Println(elasticache.ErrCodeInvalidVPCNetworkStateFault, aerr.Error())
			case elasticache.ErrCodeTagQuotaPerResourceExceeded:
				fmt.Println(elasticache.ErrCodeTagQuotaPerResourceExceeded, aerr.Error())
			case elasticache.ErrCodeInvalidParameterValueException:
				fmt.Println(elasticache.ErrCodeInvalidParameterValueException, aerr.Error())
			case elasticache.ErrCodeInvalidParameterCombinationException:
				fmt.Println(elasticache.ErrCodeInvalidParameterCombinationException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*Client) CreateCacheParameterGroupRequest added in v0.9.0

func (c *Client) CreateCacheParameterGroupRequest(input *CreateCacheParameterGroupInput) CreateCacheParameterGroupRequest

CreateCacheParameterGroupRequest returns a request value for making API operation for Amazon ElastiCache.

Creates a new Amazon ElastiCache cache parameter group. An ElastiCache cache parameter group is a collection of parameters and their values that are applied to all of the nodes in any cluster or replication group using the CacheParameterGroup.

A newly created CacheParameterGroup is an exact duplicate of the default parameter group for the CacheParameterGroupFamily. To customize the newly created CacheParameterGroup you can change the values of specific parameters. For more information, see:

Please also see https://docs.aws.amazon.com/goto/WebAPI/elasticache-2015-02-02/CreateCacheParameterGroup

Example (Shared00)

CreateCacheParameterGroup

Creates the Amazon ElastiCache parameter group custom-redis2-8.

package main

import (
	"context"
	"fmt"

	"github.com/aws/aws-sdk-go-v2/aws"
	"github.com/aws/aws-sdk-go-v2/aws/awserr"
	"github.com/aws/aws-sdk-go-v2/aws/external"
	"github.com/aws/aws-sdk-go-v2/service/elasticache"
)

func main() {
	cfg, err := external.LoadDefaultAWSConfig()
	if err != nil {
		panic("failed to load config, " + err.Error())
	}

	svc := elasticache.New(cfg)
	input := &elasticache.CreateCacheParameterGroupInput{
		CacheParameterGroupFamily: aws.String("redis2.8"),
		CacheParameterGroupName:   aws.String("custom-redis2-8"),
		Description:               aws.String("Custom Redis 2.8 parameter group."),
	}

	req := svc.CreateCacheParameterGroupRequest(input)
	result, err := req.Send(context.Background())
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case elasticache.ErrCodeCacheParameterGroupQuotaExceededFault:
				fmt.Println(elasticache.ErrCodeCacheParameterGroupQuotaExceededFault, aerr.Error())
			case elasticache.ErrCodeCacheParameterGroupAlreadyExistsFault:
				fmt.Println(elasticache.ErrCodeCacheParameterGroupAlreadyExistsFault, aerr.Error())
			case elasticache.ErrCodeInvalidCacheParameterGroupStateFault:
				fmt.Println(elasticache.ErrCodeInvalidCacheParameterGroupStateFault, aerr.Error())
			case elasticache.ErrCodeInvalidParameterValueException:
				fmt.Println(elasticache.ErrCodeInvalidParameterValueException, aerr.Error())
			case elasticache.ErrCodeInvalidParameterCombinationException:
				fmt.Println(elasticache.ErrCodeInvalidParameterCombinationException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*Client) CreateCacheSecurityGroupRequest added in v0.9.0

func (c *Client) CreateCacheSecurityGroupRequest(input *CreateCacheSecurityGroupInput) CreateCacheSecurityGroupRequest

CreateCacheSecurityGroupRequest returns a request value for making API operation for Amazon ElastiCache.

Creates a new cache security group. Use a cache security group to control access to one or more clusters.

Cache security groups are only used when you are creating a cluster outside of an Amazon Virtual Private Cloud (Amazon VPC). If you are creating a cluster inside of a VPC, use a cache subnet group instead. For more information, see CreateCacheSubnetGroup (https://docs.aws.amazon.com/AmazonElastiCache/latest/APIReference/API_CreateCacheSubnetGroup.html).

// Example sending a request using CreateCacheSecurityGroupRequest.
req := client.CreateCacheSecurityGroupRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/elasticache-2015-02-02/CreateCacheSecurityGroup

Example (Shared00)

CreateCacheSecurityGroup

Creates an ElastiCache security group. ElastiCache security groups are only for clusters not running in an AWS VPC.

package main

import (
	"context"
	"fmt"

	"github.com/aws/aws-sdk-go-v2/aws"
	"github.com/aws/aws-sdk-go-v2/aws/awserr"
	"github.com/aws/aws-sdk-go-v2/aws/external"
	"github.com/aws/aws-sdk-go-v2/service/elasticache"
)

func main() {
	cfg, err := external.LoadDefaultAWSConfig()
	if err != nil {
		panic("failed to load config, " + err.Error())
	}

	svc := elasticache.New(cfg)
	input := &elasticache.CreateCacheSecurityGroupInput{
		CacheSecurityGroupName: aws.String("my-cache-sec-grp"),
		Description:            aws.String("Example ElastiCache security group."),
	}

	req := svc.CreateCacheSecurityGroupRequest(input)
	result, err := req.Send(context.Background())
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case elasticache.ErrCodeCacheSecurityGroupAlreadyExistsFault:
				fmt.Println(elasticache.ErrCodeCacheSecurityGroupAlreadyExistsFault, aerr.Error())
			case elasticache.ErrCodeCacheSecurityGroupQuotaExceededFault:
				fmt.Println(elasticache.ErrCodeCacheSecurityGroupQuotaExceededFault, aerr.Error())
			case elasticache.ErrCodeInvalidParameterValueException:
				fmt.Println(elasticache.ErrCodeInvalidParameterValueException, aerr.Error())
			case elasticache.ErrCodeInvalidParameterCombinationException:
				fmt.Println(elasticache.ErrCodeInvalidParameterCombinationException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*Client) CreateCacheSubnetGroupRequest added in v0.9.0

func (c *Client) CreateCacheSubnetGroupRequest(input *CreateCacheSubnetGroupInput) CreateCacheSubnetGroupRequest

CreateCacheSubnetGroupRequest returns a request value for making API operation for Amazon ElastiCache.

Creates a new cache subnet group.

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

// Example sending a request using CreateCacheSubnetGroupRequest.
req := client.CreateCacheSubnetGroupRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/elasticache-2015-02-02/CreateCacheSubnetGroup

Example (Shared00)

CreateCacheSubnet

Creates a new cache subnet group.

package main

import (
	"context"
	"fmt"

	"github.com/aws/aws-sdk-go-v2/aws"
	"github.com/aws/aws-sdk-go-v2/aws/awserr"
	"github.com/aws/aws-sdk-go-v2/aws/external"
	"github.com/aws/aws-sdk-go-v2/service/elasticache"
)

func main() {
	cfg, err := external.LoadDefaultAWSConfig()
	if err != nil {
		panic("failed to load config, " + err.Error())
	}

	svc := elasticache.New(cfg)
	input := &elasticache.CreateCacheSubnetGroupInput{
		CacheSubnetGroupDescription: aws.String("Sample subnet group"),
		CacheSubnetGroupName:        aws.String("my-sn-grp2"),
		SubnetIds: []string{
			"subnet-6f28c982",
			"subnet-bcd382f3",
			"subnet-845b3e7c0",
		},
	}

	req := svc.CreateCacheSubnetGroupRequest(input)
	result, err := req.Send(context.Background())
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case elasticache.ErrCodeCacheSubnetGroupAlreadyExistsFault:
				fmt.Println(elasticache.ErrCodeCacheSubnetGroupAlreadyExistsFault, aerr.Error())
			case elasticache.ErrCodeCacheSubnetGroupQuotaExceededFault:
				fmt.Println(elasticache.ErrCodeCacheSubnetGroupQuotaExceededFault, aerr.Error())
			case elasticache.ErrCodeCacheSubnetQuotaExceededFault:
				fmt.Println(elasticache.ErrCodeCacheSubnetQuotaExceededFault, aerr.Error())
			case elasticache.ErrCodeInvalidSubnet:
				fmt.Println(elasticache.ErrCodeInvalidSubnet, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*Client) CreateGlobalReplicationGroupRequest added in v0.20.0

func (c *Client) CreateGlobalReplicationGroupRequest(input *CreateGlobalReplicationGroupInput) CreateGlobalReplicationGroupRequest

CreateGlobalReplicationGroupRequest returns a request value for making API operation for Amazon ElastiCache.

Global Datastore for Redis offers fully managed, fast, reliable and secure cross-region replication. Using Global Datastore for Redis, you can create cross-region read replica clusters for ElastiCache for Redis to enable low-latency reads and disaster recovery across regions. For more information, see Replication Across Regions Using Global Datastore (/AmazonElastiCache/latest/red-ug/Redis-Global-Clusters.html).

  • The GlobalReplicationGroupIdSuffix is the name of the Global Datastore.

  • The PrimaryReplicationGroupId represents the name of the primary cluster that accepts writes and will replicate updates to the secondary cluster.

    // Example sending a request using CreateGlobalReplicationGroupRequest. req := client.CreateGlobalReplicationGroupRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }

Please also see https://docs.aws.amazon.com/goto/WebAPI/elasticache-2015-02-02/CreateGlobalReplicationGroup

func (*Client) CreateReplicationGroupRequest added in v0.9.0

func (c *Client) CreateReplicationGroupRequest(input *CreateReplicationGroupInput) CreateReplicationGroupRequest

CreateReplicationGroupRequest returns a request value for making API operation for Amazon ElastiCache.

Creates a Redis (cluster mode disabled) or a Redis (cluster mode enabled) replication group.

This API can be used to create a standalone regional replication group or a secondary replication group associated with a Global Datastore.

A Redis (cluster mode disabled) replication group is a collection of clusters, where one of the 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 90 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. If you need to increase or decrease the number of node groups (console: shards), you can avail yourself of ElastiCache for Redis' scaling. For more information, see Scaling ElastiCache for Redis Clusters (https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/Scaling.html) in the ElastiCache User Guide.

This operation is valid for Redis only.

// Example sending a request using CreateReplicationGroupRequest.
req := client.CreateReplicationGroupRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/elasticache-2015-02-02/CreateReplicationGroup

Example (Shared00)

CreateCacheReplicationGroup

Creates a Redis replication group with 3 nodes.

package main

import (
	"context"
	"fmt"

	"github.com/aws/aws-sdk-go-v2/aws"
	"github.com/aws/aws-sdk-go-v2/aws/awserr"
	"github.com/aws/aws-sdk-go-v2/aws/external"
	"github.com/aws/aws-sdk-go-v2/service/elasticache"
)

func main() {
	cfg, err := external.LoadDefaultAWSConfig()
	if err != nil {
		panic("failed to load config, " + err.Error())
	}

	svc := elasticache.New(cfg)
	input := &elasticache.CreateReplicationGroupInput{
		AutomaticFailoverEnabled:    aws.Bool(true),
		CacheNodeType:               aws.String("cache.m3.medium"),
		Engine:                      aws.String("redis"),
		EngineVersion:               aws.String("2.8.24"),
		NumCacheClusters:            aws.Int64(3),
		ReplicationGroupDescription: aws.String("A Redis replication group."),
		ReplicationGroupId:          aws.String("my-redis-rg"),
		SnapshotRetentionLimit:      aws.Int64(30),
	}

	req := svc.CreateReplicationGroupRequest(input)
	result, err := req.Send(context.Background())
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case elasticache.ErrCodeCacheClusterNotFoundFault:
				fmt.Println(elasticache.ErrCodeCacheClusterNotFoundFault, aerr.Error())
			case elasticache.ErrCodeInvalidCacheClusterStateFault:
				fmt.Println(elasticache.ErrCodeInvalidCacheClusterStateFault, aerr.Error())
			case elasticache.ErrCodeReplicationGroupAlreadyExistsFault:
				fmt.Println(elasticache.ErrCodeReplicationGroupAlreadyExistsFault, aerr.Error())
			case elasticache.ErrCodeInsufficientCacheClusterCapacityFault:
				fmt.Println(elasticache.ErrCodeInsufficientCacheClusterCapacityFault, aerr.Error())
			case elasticache.ErrCodeCacheSecurityGroupNotFoundFault:
				fmt.Println(elasticache.ErrCodeCacheSecurityGroupNotFoundFault, aerr.Error())
			case elasticache.ErrCodeCacheSubnetGroupNotFoundFault:
				fmt.Println(elasticache.ErrCodeCacheSubnetGroupNotFoundFault, aerr.Error())
			case elasticache.ErrCodeClusterQuotaForCustomerExceededFault:
				fmt.Println(elasticache.ErrCodeClusterQuotaForCustomerExceededFault, aerr.Error())
			case elasticache.ErrCodeNodeQuotaForClusterExceededFault:
				fmt.Println(elasticache.ErrCodeNodeQuotaForClusterExceededFault, aerr.Error())
			case elasticache.ErrCodeNodeQuotaForCustomerExceededFault:
				fmt.Println(elasticache.ErrCodeNodeQuotaForCustomerExceededFault, aerr.Error())
			case elasticache.ErrCodeCacheParameterGroupNotFoundFault:
				fmt.Println(elasticache.ErrCodeCacheParameterGroupNotFoundFault, aerr.Error())
			case elasticache.ErrCodeInvalidVPCNetworkStateFault:
				fmt.Println(elasticache.ErrCodeInvalidVPCNetworkStateFault, aerr.Error())
			case elasticache.ErrCodeTagQuotaPerResourceExceeded:
				fmt.Println(elasticache.ErrCodeTagQuotaPerResourceExceeded, aerr.Error())
			case elasticache.ErrCodeNodeGroupsPerReplicationGroupQuotaExceededFault:
				fmt.Println(elasticache.ErrCodeNodeGroupsPerReplicationGroupQuotaExceededFault, aerr.Error())
			case elasticache.ErrCodeGlobalReplicationGroupNotFoundFault:
				fmt.Println(elasticache.ErrCodeGlobalReplicationGroupNotFoundFault, aerr.Error())
			case elasticache.ErrCodeInvalidGlobalReplicationGroupStateFault:
				fmt.Println(elasticache.ErrCodeInvalidGlobalReplicationGroupStateFault, aerr.Error())
			case elasticache.ErrCodeInvalidParameterValueException:
				fmt.Println(elasticache.ErrCodeInvalidParameterValueException, aerr.Error())
			case elasticache.ErrCodeInvalidParameterCombinationException:
				fmt.Println(elasticache.ErrCodeInvalidParameterCombinationException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

Example (Shared01)

CreateReplicationGroup

Creates a Redis (cluster mode enabled) replication group with two shards. One shard has one read replica node and the other shard has two read replicas.

package main

import (
	"context"
	"fmt"

	"github.com/aws/aws-sdk-go-v2/aws"
	"github.com/aws/aws-sdk-go-v2/aws/awserr"
	"github.com/aws/aws-sdk-go-v2/aws/external"
	"github.com/aws/aws-sdk-go-v2/service/elasticache"
)

func main() {
	cfg, err := external.LoadDefaultAWSConfig()
	if err != nil {
		panic("failed to load config, " + err.Error())
	}

	svc := elasticache.New(cfg)
	input := &elasticache.CreateReplicationGroupInput{
		AutoMinorVersionUpgrade: aws.Bool(true),
		CacheNodeType:           aws.String("cache.m3.medium"),
		CacheParameterGroupName: aws.String("default.redis3.2.cluster.on"),
		Engine:                  aws.String("redis"),
		EngineVersion:           aws.String("3.2.4"),
		NodeGroupConfiguration: []elasticache.NodeGroupConfiguration{
			{
				PrimaryAvailabilityZone: aws.String("us-east-1c"),
				ReplicaAvailabilityZones: []string{
					"us-east-1b",
				},
				ReplicaCount: aws.Int64(1),
				Slots:        aws.String("0-8999"),
			},
			{
				PrimaryAvailabilityZone: aws.String("us-east-1a"),
				ReplicaAvailabilityZones: []string{
					"us-east-1a",
					"us-east-1c",
				},
				ReplicaCount: aws.Int64(2),
				Slots:        aws.String("9000-16383"),
			},
		},
		NumNodeGroups:               aws.Int64(2),
		ReplicationGroupDescription: aws.String("A multi-sharded replication group"),
		ReplicationGroupId:          aws.String("clustered-redis-rg"),
		SnapshotRetentionLimit:      aws.Int64(8),
	}

	req := svc.CreateReplicationGroupRequest(input)
	result, err := req.Send(context.Background())
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case elasticache.ErrCodeCacheClusterNotFoundFault:
				fmt.Println(elasticache.ErrCodeCacheClusterNotFoundFault, aerr.Error())
			case elasticache.ErrCodeInvalidCacheClusterStateFault:
				fmt.Println(elasticache.ErrCodeInvalidCacheClusterStateFault, aerr.Error())
			case elasticache.ErrCodeReplicationGroupAlreadyExistsFault:
				fmt.Println(elasticache.ErrCodeReplicationGroupAlreadyExistsFault, aerr.Error())
			case elasticache.ErrCodeInsufficientCacheClusterCapacityFault:
				fmt.Println(elasticache.ErrCodeInsufficientCacheClusterCapacityFault, aerr.Error())
			case elasticache.ErrCodeCacheSecurityGroupNotFoundFault:
				fmt.Println(elasticache.ErrCodeCacheSecurityGroupNotFoundFault, aerr.Error())
			case elasticache.ErrCodeCacheSubnetGroupNotFoundFault:
				fmt.Println(elasticache.ErrCodeCacheSubnetGroupNotFoundFault, aerr.Error())
			case elasticache.ErrCodeClusterQuotaForCustomerExceededFault:
				fmt.Println(elasticache.ErrCodeClusterQuotaForCustomerExceededFault, aerr.Error())
			case elasticache.ErrCodeNodeQuotaForClusterExceededFault:
				fmt.Println(elasticache.ErrCodeNodeQuotaForClusterExceededFault, aerr.Error())
			case elasticache.ErrCodeNodeQuotaForCustomerExceededFault:
				fmt.Println(elasticache.ErrCodeNodeQuotaForCustomerExceededFault, aerr.Error())
			case elasticache.ErrCodeCacheParameterGroupNotFoundFault:
				fmt.Println(elasticache.ErrCodeCacheParameterGroupNotFoundFault, aerr.Error())
			case elasticache.ErrCodeInvalidVPCNetworkStateFault:
				fmt.Println(elasticache.ErrCodeInvalidVPCNetworkStateFault, aerr.Error())
			case elasticache.ErrCodeTagQuotaPerResourceExceeded:
				fmt.Println(elasticache.ErrCodeTagQuotaPerResourceExceeded, aerr.Error())
			case elasticache.ErrCodeNodeGroupsPerReplicationGroupQuotaExceededFault:
				fmt.Println(elasticache.ErrCodeNodeGroupsPerReplicationGroupQuotaExceededFault, aerr.Error())
			case elasticache.ErrCodeGlobalReplicationGroupNotFoundFault:
				fmt.Println(elasticache.ErrCodeGlobalReplicationGroupNotFoundFault, aerr.Error())
			case elasticache.ErrCodeInvalidGlobalReplicationGroupStateFault:
				fmt.Println(elasticache.ErrCodeInvalidGlobalReplicationGroupStateFault, aerr.Error())
			case elasticache.ErrCodeInvalidParameterValueException:
				fmt.Println(elasticache.ErrCodeInvalidParameterValueException, aerr.Error())
			case elasticache.ErrCodeInvalidParameterCombinationException:
				fmt.Println(elasticache.ErrCodeInvalidParameterCombinationException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*Client) CreateSnapshotRequest added in v0.9.0

func (c *Client) CreateSnapshotRequest(input *CreateSnapshotInput) CreateSnapshotRequest

CreateSnapshotRequest returns a request value for making API operation for Amazon ElastiCache.

Creates a copy of an entire cluster or replication group at a specific moment in time.

This operation is valid for Redis only.

// Example sending a request using CreateSnapshotRequest.
req := client.CreateSnapshotRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/elasticache-2015-02-02/CreateSnapshot

Example (Shared00)

CreateSnapshot - NonClustered Redis, no read-replicas

Creates a snapshot of a non-clustered Redis cluster that has only one node.

package main

import (
	"context"
	"fmt"

	"github.com/aws/aws-sdk-go-v2/aws"
	"github.com/aws/aws-sdk-go-v2/aws/awserr"
	"github.com/aws/aws-sdk-go-v2/aws/external"
	"github.com/aws/aws-sdk-go-v2/service/elasticache"
)

func main() {
	cfg, err := external.LoadDefaultAWSConfig()
	if err != nil {
		panic("failed to load config, " + err.Error())
	}

	svc := elasticache.New(cfg)
	input := &elasticache.CreateSnapshotInput{
		CacheClusterId: aws.String("onenoderedis"),
		SnapshotName:   aws.String("snapshot-1"),
	}

	req := svc.CreateSnapshotRequest(input)
	result, err := req.Send(context.Background())
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case elasticache.ErrCodeSnapshotAlreadyExistsFault:
				fmt.Println(elasticache.ErrCodeSnapshotAlreadyExistsFault, aerr.Error())
			case elasticache.ErrCodeCacheClusterNotFoundFault:
				fmt.Println(elasticache.ErrCodeCacheClusterNotFoundFault, aerr.Error())
			case elasticache.ErrCodeReplicationGroupNotFoundFault:
				fmt.Println(elasticache.ErrCodeReplicationGroupNotFoundFault, aerr.Error())
			case elasticache.ErrCodeInvalidCacheClusterStateFault:
				fmt.Println(elasticache.ErrCodeInvalidCacheClusterStateFault, aerr.Error())
			case elasticache.ErrCodeInvalidReplicationGroupStateFault:
				fmt.Println(elasticache.ErrCodeInvalidReplicationGroupStateFault, aerr.Error())
			case elasticache.ErrCodeSnapshotQuotaExceededFault:
				fmt.Println(elasticache.ErrCodeSnapshotQuotaExceededFault, aerr.Error())
			case elasticache.ErrCodeSnapshotFeatureNotSupportedFault:
				fmt.Println(elasticache.ErrCodeSnapshotFeatureNotSupportedFault, aerr.Error())
			case elasticache.ErrCodeInvalidParameterCombinationException:
				fmt.Println(elasticache.ErrCodeInvalidParameterCombinationException, aerr.Error())
			case elasticache.ErrCodeInvalidParameterValueException:
				fmt.Println(elasticache.ErrCodeInvalidParameterValueException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

Example (Shared01)

CreateSnapshot - NonClustered Redis, 2 read-replicas

Creates a snapshot of a non-clustered Redis cluster that has only three nodes, primary and two read-replicas. CacheClusterId must be a specific node in the cluster.

package main

import (
	"context"
	"fmt"

	"github.com/aws/aws-sdk-go-v2/aws"
	"github.com/aws/aws-sdk-go-v2/aws/awserr"
	"github.com/aws/aws-sdk-go-v2/aws/external"
	"github.com/aws/aws-sdk-go-v2/service/elasticache"
)

func main() {
	cfg, err := external.LoadDefaultAWSConfig()
	if err != nil {
		panic("failed to load config, " + err.Error())
	}

	svc := elasticache.New(cfg)
	input := &elasticache.CreateSnapshotInput{
		CacheClusterId: aws.String("threenoderedis-001"),
		SnapshotName:   aws.String("snapshot-2"),
	}

	req := svc.CreateSnapshotRequest(input)
	result, err := req.Send(context.Background())
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case elasticache.ErrCodeSnapshotAlreadyExistsFault:
				fmt.Println(elasticache.ErrCodeSnapshotAlreadyExistsFault, aerr.Error())
			case elasticache.ErrCodeCacheClusterNotFoundFault:
				fmt.Println(elasticache.ErrCodeCacheClusterNotFoundFault, aerr.Error())
			case elasticache.ErrCodeReplicationGroupNotFoundFault:
				fmt.Println(elasticache.ErrCodeReplicationGroupNotFoundFault, aerr.Error())
			case elasticache.ErrCodeInvalidCacheClusterStateFault:
				fmt.Println(elasticache.ErrCodeInvalidCacheClusterStateFault, aerr.Error())
			case elasticache.ErrCodeInvalidReplicationGroupStateFault:
				fmt.Println(elasticache.ErrCodeInvalidReplicationGroupStateFault, aerr.Error())
			case elasticache.ErrCodeSnapshotQuotaExceededFault:
				fmt.Println(elasticache.ErrCodeSnapshotQuotaExceededFault, aerr.Error())
			case elasticache.ErrCodeSnapshotFeatureNotSupportedFault:
				fmt.Println(elasticache.ErrCodeSnapshotFeatureNotSupportedFault, aerr.Error())
			case elasticache.ErrCodeInvalidParameterCombinationException:
				fmt.Println(elasticache.ErrCodeInvalidParameterCombinationException, aerr.Error())
			case elasticache.ErrCodeInvalidParameterValueException:
				fmt.Println(elasticache.ErrCodeInvalidParameterValueException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

Example (Shared02)

CreateSnapshot-clustered Redis

Creates a snapshot of a clustered Redis cluster that has 2 shards, each with a primary and 4 read-replicas.

package main

import (
	"context"
	"fmt"

	"github.com/aws/aws-sdk-go-v2/aws"
	"github.com/aws/aws-sdk-go-v2/aws/awserr"
	"github.com/aws/aws-sdk-go-v2/aws/external"
	"github.com/aws/aws-sdk-go-v2/service/elasticache"
)

func main() {
	cfg, err := external.LoadDefaultAWSConfig()
	if err != nil {
		panic("failed to load config, " + err.Error())
	}

	svc := elasticache.New(cfg)
	input := &elasticache.CreateSnapshotInput{
		ReplicationGroupId: aws.String("clusteredredis"),
		SnapshotName:       aws.String("snapshot-2x5"),
	}

	req := svc.CreateSnapshotRequest(input)
	result, err := req.Send(context.Background())
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case elasticache.ErrCodeSnapshotAlreadyExistsFault:
				fmt.Println(elasticache.ErrCodeSnapshotAlreadyExistsFault, aerr.Error())
			case elasticache.ErrCodeCacheClusterNotFoundFault:
				fmt.Println(elasticache.ErrCodeCacheClusterNotFoundFault, aerr.Error())
			case elasticache.ErrCodeReplicationGroupNotFoundFault:
				fmt.Println(elasticache.ErrCodeReplicationGroupNotFoundFault, aerr.Error())
			case elasticache.ErrCodeInvalidCacheClusterStateFault:
				fmt.Println(elasticache.ErrCodeInvalidCacheClusterStateFault, aerr.Error())
			case elasticache.ErrCodeInvalidReplicationGroupStateFault:
				fmt.Println(elasticache.ErrCodeInvalidReplicationGroupStateFault, aerr.Error())
			case elasticache.ErrCodeSnapshotQuotaExceededFault:
				fmt.Println(elasticache.ErrCodeSnapshotQuotaExceededFault, aerr.Error())
			case elasticache.ErrCodeSnapshotFeatureNotSupportedFault:
				fmt.Println(elasticache.ErrCodeSnapshotFeatureNotSupportedFault, aerr.Error())
			case elasticache.ErrCodeInvalidParameterCombinationException:
				fmt.Println(elasticache.ErrCodeInvalidParameterCombinationException, aerr.Error())
			case elasticache.ErrCodeInvalidParameterValueException:
				fmt.Println(elasticache.ErrCodeInvalidParameterValueException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*Client) DecreaseNodeGroupsInGlobalReplicationGroupRequest added in v0.20.0

func (c *Client) DecreaseNodeGroupsInGlobalReplicationGroupRequest(input *DecreaseNodeGroupsInGlobalReplicationGroupInput) DecreaseNodeGroupsInGlobalReplicationGroupRequest

DecreaseNodeGroupsInGlobalReplicationGroupRequest returns a request value for making API operation for Amazon ElastiCache.

Decreases the number of node groups in a Global Datastore

// Example sending a request using DecreaseNodeGroupsInGlobalReplicationGroupRequest.
req := client.DecreaseNodeGroupsInGlobalReplicationGroupRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/elasticache-2015-02-02/DecreaseNodeGroupsInGlobalReplicationGroup

func (*Client) DecreaseReplicaCountRequest added in v0.9.0

func (c *Client) DecreaseReplicaCountRequest(input *DecreaseReplicaCountInput) DecreaseReplicaCountRequest

DecreaseReplicaCountRequest returns a request value for making API operation for Amazon ElastiCache.

Dynamically decreases the number of replicas in a Redis (cluster mode disabled) replication group or the number of replica nodes in one or more node groups (shards) of a Redis (cluster mode enabled) replication group. This operation is performed with no cluster down time.

// Example sending a request using DecreaseReplicaCountRequest.
req := client.DecreaseReplicaCountRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/elasticache-2015-02-02/DecreaseReplicaCount

func (*Client) DeleteCacheClusterRequest added in v0.9.0

func (c *Client) DeleteCacheClusterRequest(input *DeleteCacheClusterInput) DeleteCacheClusterRequest

DeleteCacheClusterRequest returns a request value for making API operation for Amazon ElastiCache.

Deletes a previously provisioned cluster. DeleteCacheCluster deletes all associated cache nodes, node endpoints and the cluster itself. When you receive a successful response from this operation, Amazon ElastiCache immediately begins deleting the cluster; you cannot cancel or revert this operation.

This operation is not valid for:

  • Redis (cluster mode enabled) clusters

  • A cluster that is the last read replica of a replication group

  • A node group (shard) that has Multi-AZ mode enabled

  • A cluster from a Redis (cluster mode enabled) replication group

  • A cluster that is not in the available state

    // Example sending a request using DeleteCacheClusterRequest. req := client.DeleteCacheClusterRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }

Please also see https://docs.aws.amazon.com/goto/WebAPI/elasticache-2015-02-02/DeleteCacheCluster

Example (Shared00)

DeleteCacheCluster

Deletes an Amazon ElastiCache cluster.

package main

import (
	"context"
	"fmt"

	"github.com/aws/aws-sdk-go-v2/aws"
	"github.com/aws/aws-sdk-go-v2/aws/awserr"
	"github.com/aws/aws-sdk-go-v2/aws/external"
	"github.com/aws/aws-sdk-go-v2/service/elasticache"
)

func main() {
	cfg, err := external.LoadDefaultAWSConfig()
	if err != nil {
		panic("failed to load config, " + err.Error())
	}

	svc := elasticache.New(cfg)
	input := &elasticache.DeleteCacheClusterInput{
		CacheClusterId: aws.String("my-memcached"),
	}

	req := svc.DeleteCacheClusterRequest(input)
	result, err := req.Send(context.Background())
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case elasticache.ErrCodeCacheClusterNotFoundFault:
				fmt.Println(elasticache.ErrCodeCacheClusterNotFoundFault, aerr.Error())
			case elasticache.ErrCodeInvalidCacheClusterStateFault:
				fmt.Println(elasticache.ErrCodeInvalidCacheClusterStateFault, aerr.Error())
			case elasticache.ErrCodeSnapshotAlreadyExistsFault:
				fmt.Println(elasticache.ErrCodeSnapshotAlreadyExistsFault, aerr.Error())
			case elasticache.ErrCodeSnapshotFeatureNotSupportedFault:
				fmt.Println(elasticache.ErrCodeSnapshotFeatureNotSupportedFault, aerr.Error())
			case elasticache.ErrCodeSnapshotQuotaExceededFault:
				fmt.Println(elasticache.ErrCodeSnapshotQuotaExceededFault, aerr.Error())
			case elasticache.ErrCodeInvalidParameterValueException:
				fmt.Println(elasticache.ErrCodeInvalidParameterValueException, aerr.Error())
			case elasticache.ErrCodeInvalidParameterCombinationException:
				fmt.Println(elasticache.ErrCodeInvalidParameterCombinationException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*Client) DeleteCacheParameterGroupRequest added in v0.9.0

func (c *Client) DeleteCacheParameterGroupRequest(input *DeleteCacheParameterGroupInput) DeleteCacheParameterGroupRequest

DeleteCacheParameterGroupRequest returns a request value for making API operation for Amazon ElastiCache.

Deletes the specified cache parameter group. You cannot delete a cache parameter group if it is associated with any cache clusters.

// Example sending a request using DeleteCacheParameterGroupRequest.
req := client.DeleteCacheParameterGroupRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/elasticache-2015-02-02/DeleteCacheParameterGroup

Example (Shared00)

DeleteCacheParameterGroup

Deletes the Amazon ElastiCache parameter group custom-mem1-4.

package main

import (
	"context"
	"fmt"

	"github.com/aws/aws-sdk-go-v2/aws"
	"github.com/aws/aws-sdk-go-v2/aws/awserr"
	"github.com/aws/aws-sdk-go-v2/aws/external"
	"github.com/aws/aws-sdk-go-v2/service/elasticache"
)

func main() {
	cfg, err := external.LoadDefaultAWSConfig()
	if err != nil {
		panic("failed to load config, " + err.Error())
	}

	svc := elasticache.New(cfg)
	input := &elasticache.DeleteCacheParameterGroupInput{
		CacheParameterGroupName: aws.String("custom-mem1-4"),
	}

	req := svc.DeleteCacheParameterGroupRequest(input)
	result, err := req.Send(context.Background())
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case elasticache.ErrCodeInvalidCacheParameterGroupStateFault:
				fmt.Println(elasticache.ErrCodeInvalidCacheParameterGroupStateFault, aerr.Error())
			case elasticache.ErrCodeCacheParameterGroupNotFoundFault:
				fmt.Println(elasticache.ErrCodeCacheParameterGroupNotFoundFault, aerr.Error())
			case elasticache.ErrCodeInvalidParameterValueException:
				fmt.Println(elasticache.ErrCodeInvalidParameterValueException, aerr.Error())
			case elasticache.ErrCodeInvalidParameterCombinationException:
				fmt.Println(elasticache.ErrCodeInvalidParameterCombinationException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*Client) DeleteCacheSecurityGroupRequest added in v0.9.0

func (c *Client) DeleteCacheSecurityGroupRequest(input *DeleteCacheSecurityGroupInput) DeleteCacheSecurityGroupRequest

DeleteCacheSecurityGroupRequest returns a request value for making API operation for Amazon ElastiCache.

Deletes a cache security group.

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

// Example sending a request using DeleteCacheSecurityGroupRequest.
req := client.DeleteCacheSecurityGroupRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/elasticache-2015-02-02/DeleteCacheSecurityGroup

Example (Shared00)

DeleteCacheSecurityGroup

Deletes a cache security group.

package main

import (
	"context"
	"fmt"

	"github.com/aws/aws-sdk-go-v2/aws"
	"github.com/aws/aws-sdk-go-v2/aws/awserr"
	"github.com/aws/aws-sdk-go-v2/aws/external"
	"github.com/aws/aws-sdk-go-v2/service/elasticache"
)

func main() {
	cfg, err := external.LoadDefaultAWSConfig()
	if err != nil {
		panic("failed to load config, " + err.Error())
	}

	svc := elasticache.New(cfg)
	input := &elasticache.DeleteCacheSecurityGroupInput{
		CacheSecurityGroupName: aws.String("my-sec-group"),
	}

	req := svc.DeleteCacheSecurityGroupRequest(input)
	result, err := req.Send(context.Background())
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case elasticache.ErrCodeInvalidCacheSecurityGroupStateFault:
				fmt.Println(elasticache.ErrCodeInvalidCacheSecurityGroupStateFault, aerr.Error())
			case elasticache.ErrCodeCacheSecurityGroupNotFoundFault:
				fmt.Println(elasticache.ErrCodeCacheSecurityGroupNotFoundFault, aerr.Error())
			case elasticache.ErrCodeInvalidParameterValueException:
				fmt.Println(elasticache.ErrCodeInvalidParameterValueException, aerr.Error())
			case elasticache.ErrCodeInvalidParameterCombinationException:
				fmt.Println(elasticache.ErrCodeInvalidParameterCombinationException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*Client) DeleteCacheSubnetGroupRequest added in v0.9.0

func (c *Client) DeleteCacheSubnetGroupRequest(input *DeleteCacheSubnetGroupInput) DeleteCacheSubnetGroupRequest

DeleteCacheSubnetGroupRequest returns a request value for making API operation for Amazon ElastiCache.

Deletes a cache subnet group.

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

// Example sending a request using DeleteCacheSubnetGroupRequest.
req := client.DeleteCacheSubnetGroupRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/elasticache-2015-02-02/DeleteCacheSubnetGroup

Example (Shared00)

DeleteCacheSubnetGroup

Deletes the Amazon ElastiCache subnet group my-subnet-group.

package main

import (
	"context"
	"fmt"

	"github.com/aws/aws-sdk-go-v2/aws"
	"github.com/aws/aws-sdk-go-v2/aws/awserr"
	"github.com/aws/aws-sdk-go-v2/aws/external"
	"github.com/aws/aws-sdk-go-v2/service/elasticache"
)

func main() {
	cfg, err := external.LoadDefaultAWSConfig()
	if err != nil {
		panic("failed to load config, " + err.Error())
	}

	svc := elasticache.New(cfg)
	input := &elasticache.DeleteCacheSubnetGroupInput{
		CacheSubnetGroupName: aws.String("my-subnet-group"),
	}

	req := svc.DeleteCacheSubnetGroupRequest(input)
	result, err := req.Send(context.Background())
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case elasticache.ErrCodeCacheSubnetGroupInUse:
				fmt.Println(elasticache.ErrCodeCacheSubnetGroupInUse, aerr.Error())
			case elasticache.ErrCodeCacheSubnetGroupNotFoundFault:
				fmt.Println(elasticache.ErrCodeCacheSubnetGroupNotFoundFault, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*Client) DeleteGlobalReplicationGroupRequest added in v0.20.0

func (c *Client) DeleteGlobalReplicationGroupRequest(input *DeleteGlobalReplicationGroupInput) DeleteGlobalReplicationGroupRequest

DeleteGlobalReplicationGroupRequest returns a request value for making API operation for Amazon ElastiCache.

Deleting a Global Datastore is a two-step process:

  • First, you must DisassociateGlobalReplicationGroup to remove the secondary clusters in the Global Datastore.

  • Once the Global Datastore contains only the primary cluster, you can use DeleteGlobalReplicationGroup API to delete the Global Datastore while retainining the primary cluster using Retain…= true.

Since the Global Datastore has only a primary cluster, you can delete the Global Datastore 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.

// Example sending a request using DeleteGlobalReplicationGroupRequest.
req := client.DeleteGlobalReplicationGroupRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/elasticache-2015-02-02/DeleteGlobalReplicationGroup

func (*Client) DeleteReplicationGroupRequest added in v0.9.0

func (c *Client) DeleteReplicationGroupRequest(input *DeleteReplicationGroupInput) DeleteReplicationGroupRequest

DeleteReplicationGroupRequest returns a request value for making API operation for Amazon ElastiCache.

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.

// Example sending a request using DeleteReplicationGroupRequest.
req := client.DeleteReplicationGroupRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/elasticache-2015-02-02/DeleteReplicationGroup

Example (Shared00)

DeleteReplicationGroup

Deletes the Amazon ElastiCache replication group my-redis-rg.

package main

import (
	"context"
	"fmt"

	"github.com/aws/aws-sdk-go-v2/aws"
	"github.com/aws/aws-sdk-go-v2/aws/awserr"
	"github.com/aws/aws-sdk-go-v2/aws/external"
	"github.com/aws/aws-sdk-go-v2/service/elasticache"
)

func main() {
	cfg, err := external.LoadDefaultAWSConfig()
	if err != nil {
		panic("failed to load config, " + err.Error())
	}

	svc := elasticache.New(cfg)
	input := &elasticache.DeleteReplicationGroupInput{
		ReplicationGroupId:   aws.String("my-redis-rg"),
		RetainPrimaryCluster: aws.Bool(false),
	}

	req := svc.DeleteReplicationGroupRequest(input)
	result, err := req.Send(context.Background())
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case elasticache.ErrCodeReplicationGroupNotFoundFault:
				fmt.Println(elasticache.ErrCodeReplicationGroupNotFoundFault, aerr.Error())
			case elasticache.ErrCodeInvalidReplicationGroupStateFault:
				fmt.Println(elasticache.ErrCodeInvalidReplicationGroupStateFault, aerr.Error())
			case elasticache.ErrCodeSnapshotAlreadyExistsFault:
				fmt.Println(elasticache.ErrCodeSnapshotAlreadyExistsFault, aerr.Error())
			case elasticache.ErrCodeSnapshotFeatureNotSupportedFault:
				fmt.Println(elasticache.ErrCodeSnapshotFeatureNotSupportedFault, aerr.Error())
			case elasticache.ErrCodeSnapshotQuotaExceededFault:
				fmt.Println(elasticache.ErrCodeSnapshotQuotaExceededFault, aerr.Error())
			case elasticache.ErrCodeInvalidParameterValueException:
				fmt.Println(elasticache.ErrCodeInvalidParameterValueException, aerr.Error())
			case elasticache.ErrCodeInvalidParameterCombinationException:
				fmt.Println(elasticache.ErrCodeInvalidParameterCombinationException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*Client) DeleteSnapshotRequest added in v0.9.0

func (c *Client) DeleteSnapshotRequest(input *DeleteSnapshotInput) DeleteSnapshotRequest

DeleteSnapshotRequest returns a request value for making API operation for Amazon ElastiCache.

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.

This operation is valid for Redis only.

// Example sending a request using DeleteSnapshotRequest.
req := client.DeleteSnapshotRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/elasticache-2015-02-02/DeleteSnapshot

Example (Shared00)

DeleteSnapshot

Deletes the Redis snapshot snapshot-20160822.

package main

import (
	"context"
	"fmt"

	"github.com/aws/aws-sdk-go-v2/aws"
	"github.com/aws/aws-sdk-go-v2/aws/awserr"
	"github.com/aws/aws-sdk-go-v2/aws/external"
	"github.com/aws/aws-sdk-go-v2/service/elasticache"
)

func main() {
	cfg, err := external.LoadDefaultAWSConfig()
	if err != nil {
		panic("failed to load config, " + err.Error())
	}

	svc := elasticache.New(cfg)
	input := &elasticache.DeleteSnapshotInput{
		SnapshotName: aws.String("snapshot-20161212"),
	}

	req := svc.DeleteSnapshotRequest(input)
	result, err := req.Send(context.Background())
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case elasticache.ErrCodeSnapshotNotFoundFault:
				fmt.Println(elasticache.ErrCodeSnapshotNotFoundFault, aerr.Error())
			case elasticache.ErrCodeInvalidSnapshotStateFault:
				fmt.Println(elasticache.ErrCodeInvalidSnapshotStateFault, aerr.Error())
			case elasticache.ErrCodeInvalidParameterValueException:
				fmt.Println(elasticache.ErrCodeInvalidParameterValueException, aerr.Error())
			case elasticache.ErrCodeInvalidParameterCombinationException:
				fmt.Println(elasticache.ErrCodeInvalidParameterCombinationException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*Client) DescribeCacheClustersRequest added in v0.9.0

func (c *Client) DescribeCacheClustersRequest(input *DescribeCacheClustersInput) DescribeCacheClustersRequest

DescribeCacheClustersRequest returns a request value for making API operation for Amazon ElastiCache.

Returns information about all provisioned clusters if no cluster identifier is specified, or about a specific cache cluster if a cluster identifier is supplied.

By default, abbreviated information about the clusters is returned. You can use the optional ShowCacheNodeInfo flag to retrieve detailed information about the cache nodes associated with the 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 is displayed until all of the nodes are successfully provisioned.

If the cluster is in the deleting state, only cluster-level information is displayed.

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

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

// Example sending a request using DescribeCacheClustersRequest.
req := client.DescribeCacheClustersRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/elasticache-2015-02-02/DescribeCacheClusters

Example (Shared00)

DescribeCacheClusters

Lists the details for up to 50 cache clusters.

package main

import (
	"context"
	"fmt"

	"github.com/aws/aws-sdk-go-v2/aws"
	"github.com/aws/aws-sdk-go-v2/aws/awserr"
	"github.com/aws/aws-sdk-go-v2/aws/external"
	"github.com/aws/aws-sdk-go-v2/service/elasticache"
)

func main() {
	cfg, err := external.LoadDefaultAWSConfig()
	if err != nil {
		panic("failed to load config, " + err.Error())
	}

	svc := elasticache.New(cfg)
	input := &elasticache.DescribeCacheClustersInput{
		CacheClusterId: aws.String("my-mem-cluster"),
	}

	req := svc.DescribeCacheClustersRequest(input)
	result, err := req.Send(context.Background())
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case elasticache.ErrCodeCacheClusterNotFoundFault:
				fmt.Println(elasticache.ErrCodeCacheClusterNotFoundFault, aerr.Error())
			case elasticache.ErrCodeInvalidParameterValueException:
				fmt.Println(elasticache.ErrCodeInvalidParameterValueException, aerr.Error())
			case elasticache.ErrCodeInvalidParameterCombinationException:
				fmt.Println(elasticache.ErrCodeInvalidParameterCombinationException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

Example (Shared01)

DescribeCacheClusters

Lists the details for the cache cluster my-mem-cluster.

package main

import (
	"context"
	"fmt"

	"github.com/aws/aws-sdk-go-v2/aws"
	"github.com/aws/aws-sdk-go-v2/aws/awserr"
	"github.com/aws/aws-sdk-go-v2/aws/external"
	"github.com/aws/aws-sdk-go-v2/service/elasticache"
)

func main() {
	cfg, err := external.LoadDefaultAWSConfig()
	if err != nil {
		panic("failed to load config, " + err.Error())
	}

	svc := elasticache.New(cfg)
	input := &elasticache.DescribeCacheClustersInput{
		CacheClusterId:    aws.String("my-mem-cluster"),
		ShowCacheNodeInfo: aws.Bool(true),
	}

	req := svc.DescribeCacheClustersRequest(input)
	result, err := req.Send(context.Background())
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case elasticache.ErrCodeCacheClusterNotFoundFault:
				fmt.Println(elasticache.ErrCodeCacheClusterNotFoundFault, aerr.Error())
			case elasticache.ErrCodeInvalidParameterValueException:
				fmt.Println(elasticache.ErrCodeInvalidParameterValueException, aerr.Error())
			case elasticache.ErrCodeInvalidParameterCombinationException:
				fmt.Println(elasticache.ErrCodeInvalidParameterCombinationException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*Client) DescribeCacheEngineVersionsRequest added in v0.9.0

func (c *Client) DescribeCacheEngineVersionsRequest(input *DescribeCacheEngineVersionsInput) DescribeCacheEngineVersionsRequest

DescribeCacheEngineVersionsRequest returns a request value for making API operation for Amazon ElastiCache.

Returns a list of the available cache engines and their versions.

// Example sending a request using DescribeCacheEngineVersionsRequest.
req := client.DescribeCacheEngineVersionsRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/elasticache-2015-02-02/DescribeCacheEngineVersions

Example (Shared00)

DescribeCacheEngineVersions

Lists the details for up to 25 Memcached and Redis cache engine versions.

package main

import (
	"context"
	"fmt"

	"github.com/aws/aws-sdk-go-v2/aws/awserr"
	"github.com/aws/aws-sdk-go-v2/aws/external"
	"github.com/aws/aws-sdk-go-v2/service/elasticache"
)

func main() {
	cfg, err := external.LoadDefaultAWSConfig()
	if err != nil {
		panic("failed to load config, " + err.Error())
	}

	svc := elasticache.New(cfg)
	input := &elasticache.DescribeCacheEngineVersionsInput{}

	req := svc.DescribeCacheEngineVersionsRequest(input)
	result, err := req.Send(context.Background())
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

Example (Shared01)

DescribeCacheEngineVersions

Lists the details for up to 50 Redis cache engine versions.

package main

import (
	"context"
	"fmt"

	"github.com/aws/aws-sdk-go-v2/aws"
	"github.com/aws/aws-sdk-go-v2/aws/awserr"
	"github.com/aws/aws-sdk-go-v2/aws/external"
	"github.com/aws/aws-sdk-go-v2/service/elasticache"
)

func main() {
	cfg, err := external.LoadDefaultAWSConfig()
	if err != nil {
		panic("failed to load config, " + err.Error())
	}

	svc := elasticache.New(cfg)
	input := &elasticache.DescribeCacheEngineVersionsInput{
		DefaultOnly: aws.Bool(false),
		Engine:      aws.String("redis"),
		MaxRecords:  aws.Int64(50),
	}

	req := svc.DescribeCacheEngineVersionsRequest(input)
	result, err := req.Send(context.Background())
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*Client) DescribeCacheParameterGroupsRequest added in v0.9.0

func (c *Client) DescribeCacheParameterGroupsRequest(input *DescribeCacheParameterGroupsInput) DescribeCacheParameterGroupsRequest

DescribeCacheParameterGroupsRequest returns a request value for making API operation for Amazon ElastiCache.

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.

// Example sending a request using DescribeCacheParameterGroupsRequest.
req := client.DescribeCacheParameterGroupsRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/elasticache-2015-02-02/DescribeCacheParameterGroups

Example (Shared00)

DescribeCacheParameterGroups

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.

package main

import (
	"context"
	"fmt"

	"github.com/aws/aws-sdk-go-v2/aws"
	"github.com/aws/aws-sdk-go-v2/aws/awserr"
	"github.com/aws/aws-sdk-go-v2/aws/external"
	"github.com/aws/aws-sdk-go-v2/service/elasticache"
)

func main() {
	cfg, err := external.LoadDefaultAWSConfig()
	if err != nil {
		panic("failed to load config, " + err.Error())
	}

	svc := elasticache.New(cfg)
	input := &elasticache.DescribeCacheParameterGroupsInput{
		CacheParameterGroupName: aws.String("custom-mem1-4"),
	}

	req := svc.DescribeCacheParameterGroupsRequest(input)
	result, err := req.Send(context.Background())
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case elasticache.ErrCodeCacheParameterGroupNotFoundFault:
				fmt.Println(elasticache.ErrCodeCacheParameterGroupNotFoundFault, aerr.Error())
			case elasticache.ErrCodeInvalidParameterValueException:
				fmt.Println(elasticache.ErrCodeInvalidParameterValueException, aerr.Error())
			case elasticache.ErrCodeInvalidParameterCombinationException:
				fmt.Println(elasticache.ErrCodeInvalidParameterCombinationException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*Client) DescribeCacheParametersRequest added in v0.9.0

func (c *Client) DescribeCacheParametersRequest(input *DescribeCacheParametersInput) DescribeCacheParametersRequest

DescribeCacheParametersRequest returns a request value for making API operation for Amazon ElastiCache.

Returns the detailed parameter list for a particular cache parameter group.

// Example sending a request using DescribeCacheParametersRequest.
req := client.DescribeCacheParametersRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/elasticache-2015-02-02/DescribeCacheParameters

Example (Shared00)

DescribeCacheParameters

Lists up to 100 user parameter values for the parameter group custom.redis2.8.

package main

import (
	"context"
	"fmt"

	"github.com/aws/aws-sdk-go-v2/aws"
	"github.com/aws/aws-sdk-go-v2/aws/awserr"
	"github.com/aws/aws-sdk-go-v2/aws/external"
	"github.com/aws/aws-sdk-go-v2/service/elasticache"
)

func main() {
	cfg, err := external.LoadDefaultAWSConfig()
	if err != nil {
		panic("failed to load config, " + err.Error())
	}

	svc := elasticache.New(cfg)
	input := &elasticache.DescribeCacheParametersInput{
		CacheParameterGroupName: aws.String("custom-redis2-8"),
		MaxRecords:              aws.Int64(100),
		Source:                  aws.String("user"),
	}

	req := svc.DescribeCacheParametersRequest(input)
	result, err := req.Send(context.Background())
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case elasticache.ErrCodeCacheParameterGroupNotFoundFault:
				fmt.Println(elasticache.ErrCodeCacheParameterGroupNotFoundFault, aerr.Error())
			case elasticache.ErrCodeInvalidParameterValueException:
				fmt.Println(elasticache.ErrCodeInvalidParameterValueException, aerr.Error())
			case elasticache.ErrCodeInvalidParameterCombinationException:
				fmt.Println(elasticache.ErrCodeInvalidParameterCombinationException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*Client) DescribeCacheSecurityGroupsRequest added in v0.9.0

func (c *Client) DescribeCacheSecurityGroupsRequest(input *DescribeCacheSecurityGroupsInput) DescribeCacheSecurityGroupsRequest

DescribeCacheSecurityGroupsRequest returns a request value for making API operation for Amazon ElastiCache.

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. This applicable only when you have ElastiCache in Classic setup

// Example sending a request using DescribeCacheSecurityGroupsRequest.
req := client.DescribeCacheSecurityGroupsRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/elasticache-2015-02-02/DescribeCacheSecurityGroups

Example (Shared00)

DescribeCacheSecurityGroups

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.

package main

import (
	"context"
	"fmt"

	"github.com/aws/aws-sdk-go-v2/aws"
	"github.com/aws/aws-sdk-go-v2/aws/awserr"
	"github.com/aws/aws-sdk-go-v2/aws/external"
	"github.com/aws/aws-sdk-go-v2/service/elasticache"
)

func main() {
	cfg, err := external.LoadDefaultAWSConfig()
	if err != nil {
		panic("failed to load config, " + err.Error())
	}

	svc := elasticache.New(cfg)
	input := &elasticache.DescribeCacheSecurityGroupsInput{
		CacheSecurityGroupName: aws.String("my-sec-group"),
	}

	req := svc.DescribeCacheSecurityGroupsRequest(input)
	result, err := req.Send(context.Background())
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case elasticache.ErrCodeCacheSecurityGroupNotFoundFault:
				fmt.Println(elasticache.ErrCodeCacheSecurityGroupNotFoundFault, aerr.Error())
			case elasticache.ErrCodeInvalidParameterValueException:
				fmt.Println(elasticache.ErrCodeInvalidParameterValueException, aerr.Error())
			case elasticache.ErrCodeInvalidParameterCombinationException:
				fmt.Println(elasticache.ErrCodeInvalidParameterCombinationException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*Client) DescribeCacheSubnetGroupsRequest added in v0.9.0

func (c *Client) DescribeCacheSubnetGroupsRequest(input *DescribeCacheSubnetGroupsInput) DescribeCacheSubnetGroupsRequest

DescribeCacheSubnetGroupsRequest returns a request value for making API operation for Amazon ElastiCache.

Returns a list of cache subnet group descriptions. If a subnet group name is specified, the list contains only the description of that group. This is applicable only when you have ElastiCache in VPC setup. All ElastiCache clusters now launch in VPC by default.

// Example sending a request using DescribeCacheSubnetGroupsRequest.
req := client.DescribeCacheSubnetGroupsRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/elasticache-2015-02-02/DescribeCacheSubnetGroups

Example (Shared00)

DescribeCacheSubnetGroups

Describes up to 25 cache subnet groups.

package main

import (
	"context"
	"fmt"

	"github.com/aws/aws-sdk-go-v2/aws"
	"github.com/aws/aws-sdk-go-v2/aws/awserr"
	"github.com/aws/aws-sdk-go-v2/aws/external"
	"github.com/aws/aws-sdk-go-v2/service/elasticache"
)

func main() {
	cfg, err := external.LoadDefaultAWSConfig()
	if err != nil {
		panic("failed to load config, " + err.Error())
	}

	svc := elasticache.New(cfg)
	input := &elasticache.DescribeCacheSubnetGroupsInput{
		MaxRecords: aws.Int64(25),
	}

	req := svc.DescribeCacheSubnetGroupsRequest(input)
	result, err := req.Send(context.Background())
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case elasticache.ErrCodeCacheSubnetGroupNotFoundFault:
				fmt.Println(elasticache.ErrCodeCacheSubnetGroupNotFoundFault, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*Client) DescribeEngineDefaultParametersRequest added in v0.9.0

func (c *Client) DescribeEngineDefaultParametersRequest(input *DescribeEngineDefaultParametersInput) DescribeEngineDefaultParametersRequest

DescribeEngineDefaultParametersRequest returns a request value for making API operation for Amazon ElastiCache.

Returns the default engine and system parameter information for the specified cache engine.

// Example sending a request using DescribeEngineDefaultParametersRequest.
req := client.DescribeEngineDefaultParametersRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/elasticache-2015-02-02/DescribeEngineDefaultParameters

Example (Shared00)

DescribeEngineDefaultParameters

Returns the default engine and system parameter information for the specified cache engine.

package main

import (
	"context"
	"fmt"

	"github.com/aws/aws-sdk-go-v2/aws"
	"github.com/aws/aws-sdk-go-v2/aws/awserr"
	"github.com/aws/aws-sdk-go-v2/aws/external"
	"github.com/aws/aws-sdk-go-v2/service/elasticache"
)

func main() {
	cfg, err := external.LoadDefaultAWSConfig()
	if err != nil {
		panic("failed to load config, " + err.Error())
	}

	svc := elasticache.New(cfg)
	input := &elasticache.DescribeEngineDefaultParametersInput{
		CacheParameterGroupFamily: aws.String("redis2.8"),
		MaxRecords:                aws.Int64(25),
	}

	req := svc.DescribeEngineDefaultParametersRequest(input)
	result, err := req.Send(context.Background())
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case elasticache.ErrCodeInvalidParameterValueException:
				fmt.Println(elasticache.ErrCodeInvalidParameterValueException, aerr.Error())
			case elasticache.ErrCodeInvalidParameterCombinationException:
				fmt.Println(elasticache.ErrCodeInvalidParameterCombinationException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*Client) DescribeEventsRequest added in v0.9.0

func (c *Client) DescribeEventsRequest(input *DescribeEventsInput) DescribeEventsRequest

DescribeEventsRequest returns a request value for making API operation for Amazon ElastiCache.

Returns events related to clusters, cache security groups, and cache parameter groups. You can obtain events specific to a particular 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.

// Example sending a request using DescribeEventsRequest.
req := client.DescribeEventsRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/elasticache-2015-02-02/DescribeEvents

Example (Shared00)

DescribeEvents

Describes all the cache-cluster events for the past 120 minutes.

package main

import (
	"context"
	"fmt"

	"github.com/aws/aws-sdk-go-v2/aws"
	"github.com/aws/aws-sdk-go-v2/aws/awserr"
	"github.com/aws/aws-sdk-go-v2/aws/external"
	"github.com/aws/aws-sdk-go-v2/service/elasticache"
)

func main() {
	cfg, err := external.LoadDefaultAWSConfig()
	if err != nil {
		panic("failed to load config, " + err.Error())
	}

	svc := elasticache.New(cfg)
	input := &elasticache.DescribeEventsInput{
		Duration:   aws.Int64(360),
		SourceType: elasticache.SourceTypeCacheCluster,
	}

	req := svc.DescribeEventsRequest(input)
	result, err := req.Send(context.Background())
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case elasticache.ErrCodeInvalidParameterValueException:
				fmt.Println(elasticache.ErrCodeInvalidParameterValueException, aerr.Error())
			case elasticache.ErrCodeInvalidParameterCombinationException:
				fmt.Println(elasticache.ErrCodeInvalidParameterCombinationException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

Example (Shared01)

DescribeEvents

Describes all the replication-group events from 3:00P to 5:00P on November 11, 2016.

package main

import (
	"context"
	"fmt"
	"time"

	"github.com/aws/aws-sdk-go-v2/aws"
	"github.com/aws/aws-sdk-go-v2/aws/awserr"
	"github.com/aws/aws-sdk-go-v2/aws/external"
	"github.com/aws/aws-sdk-go-v2/service/elasticache"
)

func parseTime(layout, value string) time.Time {
	t, err := time.Parse(layout, value)
	if err != nil {
		panic(err)
	}
	return t
}

func main() {
	cfg, err := external.LoadDefaultAWSConfig()
	if err != nil {
		panic("failed to load config, " + err.Error())
	}

	svc := elasticache.New(cfg)
	input := &elasticache.DescribeEventsInput{
		StartTime: aws.Time(parseTime("2006-01-02T15:04:05Z", "2016-12-22T15:00:00.000Z")),
	}

	req := svc.DescribeEventsRequest(input)
	result, err := req.Send(context.Background())
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case elasticache.ErrCodeInvalidParameterValueException:
				fmt.Println(elasticache.ErrCodeInvalidParameterValueException, aerr.Error())
			case elasticache.ErrCodeInvalidParameterCombinationException:
				fmt.Println(elasticache.ErrCodeInvalidParameterCombinationException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*Client) DescribeGlobalReplicationGroupsRequest added in v0.20.0

func (c *Client) DescribeGlobalReplicationGroupsRequest(input *DescribeGlobalReplicationGroupsInput) DescribeGlobalReplicationGroupsRequest

DescribeGlobalReplicationGroupsRequest returns a request value for making API operation for Amazon ElastiCache.

Returns information about a particular global replication group. If no identifier is specified, returns information about all Global Datastores.

// Example sending a request using DescribeGlobalReplicationGroupsRequest.
req := client.DescribeGlobalReplicationGroupsRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/elasticache-2015-02-02/DescribeGlobalReplicationGroups

func (*Client) DescribeReplicationGroupsRequest added in v0.9.0

func (c *Client) DescribeReplicationGroupsRequest(input *DescribeReplicationGroupsInput) DescribeReplicationGroupsRequest

DescribeReplicationGroupsRequest returns a request value for making API operation for Amazon ElastiCache.

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

This operation is valid for Redis only.

// Example sending a request using DescribeReplicationGroupsRequest.
req := client.DescribeReplicationGroupsRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/elasticache-2015-02-02/DescribeReplicationGroups

Example (Shared00)

DescribeReplicationGroups

Returns information about the replication group myreplgroup.

package main

import (
	"context"
	"fmt"

	"github.com/aws/aws-sdk-go-v2/aws/awserr"
	"github.com/aws/aws-sdk-go-v2/aws/external"
	"github.com/aws/aws-sdk-go-v2/service/elasticache"
)

func main() {
	cfg, err := external.LoadDefaultAWSConfig()
	if err != nil {
		panic("failed to load config, " + err.Error())
	}

	svc := elasticache.New(cfg)
	input := &elasticache.DescribeReplicationGroupsInput{}

	req := svc.DescribeReplicationGroupsRequest(input)
	result, err := req.Send(context.Background())
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case elasticache.ErrCodeReplicationGroupNotFoundFault:
				fmt.Println(elasticache.ErrCodeReplicationGroupNotFoundFault, aerr.Error())
			case elasticache.ErrCodeInvalidParameterValueException:
				fmt.Println(elasticache.ErrCodeInvalidParameterValueException, aerr.Error())
			case elasticache.ErrCodeInvalidParameterCombinationException:
				fmt.Println(elasticache.ErrCodeInvalidParameterCombinationException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*Client) DescribeReservedCacheNodesOfferingsRequest added in v0.9.0

func (c *Client) DescribeReservedCacheNodesOfferingsRequest(input *DescribeReservedCacheNodesOfferingsInput) DescribeReservedCacheNodesOfferingsRequest

DescribeReservedCacheNodesOfferingsRequest returns a request value for making API operation for Amazon ElastiCache.

Lists available reserved cache node offerings.

// Example sending a request using DescribeReservedCacheNodesOfferingsRequest.
req := client.DescribeReservedCacheNodesOfferingsRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/elasticache-2015-02-02/DescribeReservedCacheNodesOfferings

Example (Shared00)

DescribeReseredCacheNodeOfferings

Lists available reserved cache node offerings.

package main

import (
	"context"
	"fmt"

	"github.com/aws/aws-sdk-go-v2/aws"
	"github.com/aws/aws-sdk-go-v2/aws/awserr"
	"github.com/aws/aws-sdk-go-v2/aws/external"
	"github.com/aws/aws-sdk-go-v2/service/elasticache"
)

func main() {
	cfg, err := external.LoadDefaultAWSConfig()
	if err != nil {
		panic("failed to load config, " + err.Error())
	}

	svc := elasticache.New(cfg)
	input := &elasticache.DescribeReservedCacheNodesOfferingsInput{
		MaxRecords: aws.Int64(20),
	}

	req := svc.DescribeReservedCacheNodesOfferingsRequest(input)
	result, err := req.Send(context.Background())
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case elasticache.ErrCodeReservedCacheNodesOfferingNotFoundFault:
				fmt.Println(elasticache.ErrCodeReservedCacheNodesOfferingNotFoundFault, aerr.Error())
			case elasticache.ErrCodeInvalidParameterValueException:
				fmt.Println(elasticache.ErrCodeInvalidParameterValueException, aerr.Error())
			case elasticache.ErrCodeInvalidParameterCombinationException:
				fmt.Println(elasticache.ErrCodeInvalidParameterCombinationException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

Example (Shared01)

DescribeReseredCacheNodeOfferings

Lists available reserved cache node offerings for cache.r3.large nodes with a 3 year commitment.

package main

import (
	"context"
	"fmt"

	"github.com/aws/aws-sdk-go-v2/aws"
	"github.com/aws/aws-sdk-go-v2/aws/awserr"
	"github.com/aws/aws-sdk-go-v2/aws/external"
	"github.com/aws/aws-sdk-go-v2/service/elasticache"
)

func main() {
	cfg, err := external.LoadDefaultAWSConfig()
	if err != nil {
		panic("failed to load config, " + err.Error())
	}

	svc := elasticache.New(cfg)
	input := &elasticache.DescribeReservedCacheNodesOfferingsInput{
		CacheNodeType:                aws.String("cache.r3.large"),
		Duration:                     aws.String("3"),
		MaxRecords:                   aws.Int64(25),
		OfferingType:                 aws.String("Light Utilization"),
		ReservedCacheNodesOfferingId: aws.String(""),
	}

	req := svc.DescribeReservedCacheNodesOfferingsRequest(input)
	result, err := req.Send(context.Background())
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case elasticache.ErrCodeReservedCacheNodesOfferingNotFoundFault:
				fmt.Println(elasticache.ErrCodeReservedCacheNodesOfferingNotFoundFault, aerr.Error())
			case elasticache.ErrCodeInvalidParameterValueException:
				fmt.Println(elasticache.ErrCodeInvalidParameterValueException, aerr.Error())
			case elasticache.ErrCodeInvalidParameterCombinationException:
				fmt.Println(elasticache.ErrCodeInvalidParameterCombinationException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

Example (Shared02)

DescribeReseredCacheNodeOfferings

Lists available reserved cache node offerings.

package main

import (
	"context"
	"fmt"

	"github.com/aws/aws-sdk-go-v2/aws"
	"github.com/aws/aws-sdk-go-v2/aws/awserr"
	"github.com/aws/aws-sdk-go-v2/aws/external"
	"github.com/aws/aws-sdk-go-v2/service/elasticache"
)

func main() {
	cfg, err := external.LoadDefaultAWSConfig()
	if err != nil {
		panic("failed to load config, " + err.Error())
	}

	svc := elasticache.New(cfg)
	input := &elasticache.DescribeReservedCacheNodesOfferingsInput{
		CacheNodeType:                aws.String(""),
		Duration:                     aws.String(""),
		Marker:                       aws.String(""),
		MaxRecords:                   aws.Int64(25),
		OfferingType:                 aws.String(""),
		ProductDescription:           aws.String(""),
		ReservedCacheNodesOfferingId: aws.String("438012d3-4052-4cc7-b2e3-8d3372e0e706"),
	}

	req := svc.DescribeReservedCacheNodesOfferingsRequest(input)
	result, err := req.Send(context.Background())
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case elasticache.ErrCodeReservedCacheNodesOfferingNotFoundFault:
				fmt.Println(elasticache.ErrCodeReservedCacheNodesOfferingNotFoundFault, aerr.Error())
			case elasticache.ErrCodeInvalidParameterValueException:
				fmt.Println(elasticache.ErrCodeInvalidParameterValueException, aerr.Error())
			case elasticache.ErrCodeInvalidParameterCombinationException:
				fmt.Println(elasticache.ErrCodeInvalidParameterCombinationException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*Client) DescribeReservedCacheNodesRequest added in v0.9.0

func (c *Client) DescribeReservedCacheNodesRequest(input *DescribeReservedCacheNodesInput) DescribeReservedCacheNodesRequest

DescribeReservedCacheNodesRequest returns a request value for making API operation for Amazon ElastiCache.

Returns information about reserved cache nodes for this account, or about a specified reserved cache node.

// Example sending a request using DescribeReservedCacheNodesRequest.
req := client.DescribeReservedCacheNodesRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/elasticache-2015-02-02/DescribeReservedCacheNodes

Example (Shared00)

DescribeReservedCacheNodes

Returns information about reserved cache nodes for this account, or about a specified reserved cache node. If the account has no reserved cache nodes, the operation returns an empty list, as shown here.

package main

import (
	"context"
	"fmt"

	"github.com/aws/aws-sdk-go-v2/aws"
	"github.com/aws/aws-sdk-go-v2/aws/awserr"
	"github.com/aws/aws-sdk-go-v2/aws/external"
	"github.com/aws/aws-sdk-go-v2/service/elasticache"
)

func main() {
	cfg, err := external.LoadDefaultAWSConfig()
	if err != nil {
		panic("failed to load config, " + err.Error())
	}

	svc := elasticache.New(cfg)
	input := &elasticache.DescribeReservedCacheNodesInput{
		MaxRecords: aws.Int64(25),
	}

	req := svc.DescribeReservedCacheNodesRequest(input)
	result, err := req.Send(context.Background())
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case elasticache.ErrCodeReservedCacheNodeNotFoundFault:
				fmt.Println(elasticache.ErrCodeReservedCacheNodeNotFoundFault, aerr.Error())
			case elasticache.ErrCodeInvalidParameterValueException:
				fmt.Println(elasticache.ErrCodeInvalidParameterValueException, aerr.Error())
			case elasticache.ErrCodeInvalidParameterCombinationException:
				fmt.Println(elasticache.ErrCodeInvalidParameterCombinationException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*Client) DescribeServiceUpdatesRequest added in v0.10.0

func (c *Client) DescribeServiceUpdatesRequest(input *DescribeServiceUpdatesInput) DescribeServiceUpdatesRequest

DescribeServiceUpdatesRequest returns a request value for making API operation for Amazon ElastiCache.

Returns details of the service updates

// Example sending a request using DescribeServiceUpdatesRequest.
req := client.DescribeServiceUpdatesRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/elasticache-2015-02-02/DescribeServiceUpdates

func (*Client) DescribeSnapshotsRequest added in v0.9.0

func (c *Client) DescribeSnapshotsRequest(input *DescribeSnapshotsInput) DescribeSnapshotsRequest

DescribeSnapshotsRequest returns a request value for making API operation for Amazon ElastiCache.

Returns information about cluster or replication group 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.

This operation is valid for Redis only.

// Example sending a request using DescribeSnapshotsRequest.
req := client.DescribeSnapshotsRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/elasticache-2015-02-02/DescribeSnapshots

Example (Shared00)

DescribeSnapshots

Returns information about the snapshot mysnapshot. By default.

package main

import (
	"context"
	"fmt"

	"github.com/aws/aws-sdk-go-v2/aws"
	"github.com/aws/aws-sdk-go-v2/aws/awserr"
	"github.com/aws/aws-sdk-go-v2/aws/external"
	"github.com/aws/aws-sdk-go-v2/service/elasticache"
)

func main() {
	cfg, err := external.LoadDefaultAWSConfig()
	if err != nil {
		panic("failed to load config, " + err.Error())
	}

	svc := elasticache.New(cfg)
	input := &elasticache.DescribeSnapshotsInput{
		SnapshotName: aws.String("snapshot-20161212"),
	}

	req := svc.DescribeSnapshotsRequest(input)
	result, err := req.Send(context.Background())
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case elasticache.ErrCodeCacheClusterNotFoundFault:
				fmt.Println(elasticache.ErrCodeCacheClusterNotFoundFault, aerr.Error())
			case elasticache.ErrCodeSnapshotNotFoundFault:
				fmt.Println(elasticache.ErrCodeSnapshotNotFoundFault, aerr.Error())
			case elasticache.ErrCodeInvalidParameterValueException:
				fmt.Println(elasticache.ErrCodeInvalidParameterValueException, aerr.Error())
			case elasticache.ErrCodeInvalidParameterCombinationException:
				fmt.Println(elasticache.ErrCodeInvalidParameterCombinationException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*Client) DescribeUpdateActionsRequest added in v0.10.0

func (c *Client) DescribeUpdateActionsRequest(input *DescribeUpdateActionsInput) DescribeUpdateActionsRequest

DescribeUpdateActionsRequest returns a request value for making API operation for Amazon ElastiCache.

Returns details of the update actions

// Example sending a request using DescribeUpdateActionsRequest.
req := client.DescribeUpdateActionsRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/elasticache-2015-02-02/DescribeUpdateActions

func (*Client) DisassociateGlobalReplicationGroupRequest added in v0.20.0

func (c *Client) DisassociateGlobalReplicationGroupRequest(input *DisassociateGlobalReplicationGroupInput) DisassociateGlobalReplicationGroupRequest

DisassociateGlobalReplicationGroupRequest returns a request value for making API operation for Amazon ElastiCache.

Remove a secondary cluster from the Global Datastore using the Global Datastore name. The secondary cluster will no longer receive updates from the primary cluster, but will remain as a standalone cluster in that AWS region.

// Example sending a request using DisassociateGlobalReplicationGroupRequest.
req := client.DisassociateGlobalReplicationGroupRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/elasticache-2015-02-02/DisassociateGlobalReplicationGroup

func (*Client) FailoverGlobalReplicationGroupRequest added in v0.20.0

func (c *Client) FailoverGlobalReplicationGroupRequest(input *FailoverGlobalReplicationGroupInput) FailoverGlobalReplicationGroupRequest

FailoverGlobalReplicationGroupRequest returns a request value for making API operation for Amazon ElastiCache.

Used to failover the primary region to a selected secondary region. The selected secondary region will become primary, and all other clusters will become secondary.

// Example sending a request using FailoverGlobalReplicationGroupRequest.
req := client.FailoverGlobalReplicationGroupRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/elasticache-2015-02-02/FailoverGlobalReplicationGroup

func (*Client) IncreaseNodeGroupsInGlobalReplicationGroupRequest added in v0.20.0

func (c *Client) IncreaseNodeGroupsInGlobalReplicationGroupRequest(input *IncreaseNodeGroupsInGlobalReplicationGroupInput) IncreaseNodeGroupsInGlobalReplicationGroupRequest

IncreaseNodeGroupsInGlobalReplicationGroupRequest returns a request value for making API operation for Amazon ElastiCache.

Increase the number of node groups in the Global Datastore

// Example sending a request using IncreaseNodeGroupsInGlobalReplicationGroupRequest.
req := client.IncreaseNodeGroupsInGlobalReplicationGroupRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/elasticache-2015-02-02/IncreaseNodeGroupsInGlobalReplicationGroup

func (*Client) IncreaseReplicaCountRequest added in v0.9.0

func (c *Client) IncreaseReplicaCountRequest(input *IncreaseReplicaCountInput) IncreaseReplicaCountRequest

IncreaseReplicaCountRequest returns a request value for making API operation for Amazon ElastiCache.

Dynamically increases the number of replics in a Redis (cluster mode disabled) replication group or the number of replica nodes in one or more node groups (shards) of a Redis (cluster mode enabled) replication group. This operation is performed with no cluster down time.

// Example sending a request using IncreaseReplicaCountRequest.
req := client.IncreaseReplicaCountRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/elasticache-2015-02-02/IncreaseReplicaCount

func (*Client) ListAllowedNodeTypeModificationsRequest added in v0.9.0

func (c *Client) ListAllowedNodeTypeModificationsRequest(input *ListAllowedNodeTypeModificationsInput) ListAllowedNodeTypeModificationsRequest

ListAllowedNodeTypeModificationsRequest returns a request value for making API operation for Amazon ElastiCache.

Lists all available node types that you can scale your Redis cluster's or replication group's current node type.

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

// Example sending a request using ListAllowedNodeTypeModificationsRequest.
req := client.ListAllowedNodeTypeModificationsRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/elasticache-2015-02-02/ListAllowedNodeTypeModifications

Example (Shared00)

ListAllowedNodeTypeModifications

Lists all available node types that you can scale your Redis cluster's or replication group's current node type up to.

package main

import (
	"context"
	"fmt"

	"github.com/aws/aws-sdk-go-v2/aws"
	"github.com/aws/aws-sdk-go-v2/aws/awserr"
	"github.com/aws/aws-sdk-go-v2/aws/external"
	"github.com/aws/aws-sdk-go-v2/service/elasticache"
)

func main() {
	cfg, err := external.LoadDefaultAWSConfig()
	if err != nil {
		panic("failed to load config, " + err.Error())
	}

	svc := elasticache.New(cfg)
	input := &elasticache.ListAllowedNodeTypeModificationsInput{
		ReplicationGroupId: aws.String("myreplgroup"),
	}

	req := svc.ListAllowedNodeTypeModificationsRequest(input)
	result, err := req.Send(context.Background())
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case elasticache.ErrCodeCacheClusterNotFoundFault:
				fmt.Println(elasticache.ErrCodeCacheClusterNotFoundFault, aerr.Error())
			case elasticache.ErrCodeReplicationGroupNotFoundFault:
				fmt.Println(elasticache.ErrCodeReplicationGroupNotFoundFault, aerr.Error())
			case elasticache.ErrCodeInvalidParameterCombinationException:
				fmt.Println(elasticache.ErrCodeInvalidParameterCombinationException, aerr.Error())
			case elasticache.ErrCodeInvalidParameterValueException:
				fmt.Println(elasticache.ErrCodeInvalidParameterValueException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

Example (Shared01)

ListAllowedNodeTypeModifications

Lists all available node types that you can scale your Redis cluster's or replication group's current node type up to.

package main

import (
	"context"
	"fmt"

	"github.com/aws/aws-sdk-go-v2/aws"
	"github.com/aws/aws-sdk-go-v2/aws/awserr"
	"github.com/aws/aws-sdk-go-v2/aws/external"
	"github.com/aws/aws-sdk-go-v2/service/elasticache"
)

func main() {
	cfg, err := external.LoadDefaultAWSConfig()
	if err != nil {
		panic("failed to load config, " + err.Error())
	}

	svc := elasticache.New(cfg)
	input := &elasticache.ListAllowedNodeTypeModificationsInput{
		CacheClusterId: aws.String("mycluster"),
	}

	req := svc.ListAllowedNodeTypeModificationsRequest(input)
	result, err := req.Send(context.Background())
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case elasticache.ErrCodeCacheClusterNotFoundFault:
				fmt.Println(elasticache.ErrCodeCacheClusterNotFoundFault, aerr.Error())
			case elasticache.ErrCodeReplicationGroupNotFoundFault:
				fmt.Println(elasticache.ErrCodeReplicationGroupNotFoundFault, aerr.Error())
			case elasticache.ErrCodeInvalidParameterCombinationException:
				fmt.Println(elasticache.ErrCodeInvalidParameterCombinationException, aerr.Error())
			case elasticache.ErrCodeInvalidParameterValueException:
				fmt.Println(elasticache.ErrCodeInvalidParameterValueException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*Client) ListTagsForResourceRequest added in v0.9.0

func (c *Client) ListTagsForResourceRequest(input *ListTagsForResourceInput) ListTagsForResourceRequest

ListTagsForResourceRequest returns a request value for making API operation for Amazon ElastiCache.

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.

If the cluster is not in the available state, ListTagsForResource returns an error.

You can have a maximum of 50 cost allocation tags on an ElastiCache resource. For more information, see Monitoring Costs with Tags (https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/Tagging.html).

// Example sending a request using ListTagsForResourceRequest.
req := client.ListTagsForResourceRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/elasticache-2015-02-02/ListTagsForResource

Example (Shared00)

ListTagsForResource

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.

package main

import (
	"context"
	"fmt"

	"github.com/aws/aws-sdk-go-v2/aws"
	"github.com/aws/aws-sdk-go-v2/aws/awserr"
	"github.com/aws/aws-sdk-go-v2/aws/external"
	"github.com/aws/aws-sdk-go-v2/service/elasticache"
)

func main() {
	cfg, err := external.LoadDefaultAWSConfig()
	if err != nil {
		panic("failed to load config, " + err.Error())
	}

	svc := elasticache.New(cfg)
	input := &elasticache.ListTagsForResourceInput{
		ResourceName: aws.String("arn:aws:elasticache:us-west-2:<my-account-id>:cluster:mycluster"),
	}

	req := svc.ListTagsForResourceRequest(input)
	result, err := req.Send(context.Background())
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case elasticache.ErrCodeCacheClusterNotFoundFault:
				fmt.Println(elasticache.ErrCodeCacheClusterNotFoundFault, aerr.Error())
			case elasticache.ErrCodeSnapshotNotFoundFault:
				fmt.Println(elasticache.ErrCodeSnapshotNotFoundFault, aerr.Error())
			case elasticache.ErrCodeInvalidARNFault:
				fmt.Println(elasticache.ErrCodeInvalidARNFault, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*Client) ModifyCacheClusterRequest added in v0.9.0

func (c *Client) ModifyCacheClusterRequest(input *ModifyCacheClusterInput) ModifyCacheClusterRequest

ModifyCacheClusterRequest returns a request value for making API operation for Amazon ElastiCache.

Modifies the settings for a cluster. You can use this operation to change one or more cluster configuration parameters by specifying the parameters and the new values.

// Example sending a request using ModifyCacheClusterRequest.
req := client.ModifyCacheClusterRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/elasticache-2015-02-02/ModifyCacheCluster

Example (Shared00)

ModifyCacheCluster

Copies a snapshot to a specified name.

package main

import (
	"context"
	"fmt"

	"github.com/aws/aws-sdk-go-v2/aws"
	"github.com/aws/aws-sdk-go-v2/aws/awserr"
	"github.com/aws/aws-sdk-go-v2/aws/external"
	"github.com/aws/aws-sdk-go-v2/service/elasticache"
)

func main() {
	cfg, err := external.LoadDefaultAWSConfig()
	if err != nil {
		panic("failed to load config, " + err.Error())
	}

	svc := elasticache.New(cfg)
	input := &elasticache.ModifyCacheClusterInput{
		ApplyImmediately:       aws.Bool(true),
		CacheClusterId:         aws.String("redis-cluster"),
		SnapshotRetentionLimit: aws.Int64(14),
	}

	req := svc.ModifyCacheClusterRequest(input)
	result, err := req.Send(context.Background())
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case elasticache.ErrCodeInvalidCacheClusterStateFault:
				fmt.Println(elasticache.ErrCodeInvalidCacheClusterStateFault, aerr.Error())
			case elasticache.ErrCodeInvalidCacheSecurityGroupStateFault:
				fmt.Println(elasticache.ErrCodeInvalidCacheSecurityGroupStateFault, aerr.Error())
			case elasticache.ErrCodeInsufficientCacheClusterCapacityFault:
				fmt.Println(elasticache.ErrCodeInsufficientCacheClusterCapacityFault, aerr.Error())
			case elasticache.ErrCodeCacheClusterNotFoundFault:
				fmt.Println(elasticache.ErrCodeCacheClusterNotFoundFault, aerr.Error())
			case elasticache.ErrCodeNodeQuotaForClusterExceededFault:
				fmt.Println(elasticache.ErrCodeNodeQuotaForClusterExceededFault, aerr.Error())
			case elasticache.ErrCodeNodeQuotaForCustomerExceededFault:
				fmt.Println(elasticache.ErrCodeNodeQuotaForCustomerExceededFault, aerr.Error())
			case elasticache.ErrCodeCacheSecurityGroupNotFoundFault:
				fmt.Println(elasticache.ErrCodeCacheSecurityGroupNotFoundFault, aerr.Error())
			case elasticache.ErrCodeCacheParameterGroupNotFoundFault:
				fmt.Println(elasticache.ErrCodeCacheParameterGroupNotFoundFault, aerr.Error())
			case elasticache.ErrCodeInvalidVPCNetworkStateFault:
				fmt.Println(elasticache.ErrCodeInvalidVPCNetworkStateFault, aerr.Error())
			case elasticache.ErrCodeInvalidParameterValueException:
				fmt.Println(elasticache.ErrCodeInvalidParameterValueException, aerr.Error())
			case elasticache.ErrCodeInvalidParameterCombinationException:
				fmt.Println(elasticache.ErrCodeInvalidParameterCombinationException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*Client) ModifyCacheParameterGroupRequest added in v0.9.0

func (c *Client) ModifyCacheParameterGroupRequest(input *ModifyCacheParameterGroupInput) ModifyCacheParameterGroupRequest

ModifyCacheParameterGroupRequest returns a request value for making API operation for Amazon ElastiCache.

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.

// Example sending a request using ModifyCacheParameterGroupRequest.
req := client.ModifyCacheParameterGroupRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/elasticache-2015-02-02/ModifyCacheParameterGroup

Example (Shared00)

ModifyCacheParameterGroup

Modifies one or more parameter values in the specified parameter group. You cannot modify any default parameter group.

package main

import (
	"context"
	"fmt"

	"github.com/aws/aws-sdk-go-v2/aws"
	"github.com/aws/aws-sdk-go-v2/aws/awserr"
	"github.com/aws/aws-sdk-go-v2/aws/external"
	"github.com/aws/aws-sdk-go-v2/service/elasticache"
)

func main() {
	cfg, err := external.LoadDefaultAWSConfig()
	if err != nil {
		panic("failed to load config, " + err.Error())
	}

	svc := elasticache.New(cfg)
	input := &elasticache.ModifyCacheParameterGroupInput{
		CacheParameterGroupName: aws.String("custom-mem1-4"),
		ParameterNameValues: []elasticache.ParameterNameValue{
			{
				ParameterName:  aws.String("binding_protocol"),
				ParameterValue: aws.String("ascii"),
			},
			{
				ParameterName:  aws.String("chunk_size"),
				ParameterValue: aws.String("96"),
			},
		},
	}

	req := svc.ModifyCacheParameterGroupRequest(input)
	result, err := req.Send(context.Background())
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case elasticache.ErrCodeCacheParameterGroupNotFoundFault:
				fmt.Println(elasticache.ErrCodeCacheParameterGroupNotFoundFault, aerr.Error())
			case elasticache.ErrCodeInvalidCacheParameterGroupStateFault:
				fmt.Println(elasticache.ErrCodeInvalidCacheParameterGroupStateFault, aerr.Error())
			case elasticache.ErrCodeInvalidParameterValueException:
				fmt.Println(elasticache.ErrCodeInvalidParameterValueException, aerr.Error())
			case elasticache.ErrCodeInvalidParameterCombinationException:
				fmt.Println(elasticache.ErrCodeInvalidParameterCombinationException, aerr.Error())
			case elasticache.ErrCodeInvalidGlobalReplicationGroupStateFault:
				fmt.Println(elasticache.ErrCodeInvalidGlobalReplicationGroupStateFault, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*Client) ModifyCacheSubnetGroupRequest added in v0.9.0

func (c *Client) ModifyCacheSubnetGroupRequest(input *ModifyCacheSubnetGroupInput) ModifyCacheSubnetGroupRequest

ModifyCacheSubnetGroupRequest returns a request value for making API operation for Amazon ElastiCache.

Modifies an existing cache subnet group.

// Example sending a request using ModifyCacheSubnetGroupRequest.
req := client.ModifyCacheSubnetGroupRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/elasticache-2015-02-02/ModifyCacheSubnetGroup

Example (Shared00)

ModifyCacheSubnetGroup

Modifies an existing ElastiCache subnet group.

package main

import (
	"context"
	"fmt"

	"github.com/aws/aws-sdk-go-v2/aws"
	"github.com/aws/aws-sdk-go-v2/aws/awserr"
	"github.com/aws/aws-sdk-go-v2/aws/external"
	"github.com/aws/aws-sdk-go-v2/service/elasticache"
)

func main() {
	cfg, err := external.LoadDefaultAWSConfig()
	if err != nil {
		panic("failed to load config, " + err.Error())
	}

	svc := elasticache.New(cfg)
	input := &elasticache.ModifyCacheSubnetGroupInput{
		CacheSubnetGroupName: aws.String("my-sn-grp"),
		SubnetIds: []string{
			"subnet-bcde2345",
		},
	}

	req := svc.ModifyCacheSubnetGroupRequest(input)
	result, err := req.Send(context.Background())
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case elasticache.ErrCodeCacheSubnetGroupNotFoundFault:
				fmt.Println(elasticache.ErrCodeCacheSubnetGroupNotFoundFault, aerr.Error())
			case elasticache.ErrCodeCacheSubnetQuotaExceededFault:
				fmt.Println(elasticache.ErrCodeCacheSubnetQuotaExceededFault, aerr.Error())
			case elasticache.ErrCodeSubnetInUse:
				fmt.Println(elasticache.ErrCodeSubnetInUse, aerr.Error())
			case elasticache.ErrCodeInvalidSubnet:
				fmt.Println(elasticache.ErrCodeInvalidSubnet, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*Client) ModifyGlobalReplicationGroupRequest added in v0.20.0

func (c *Client) ModifyGlobalReplicationGroupRequest(input *ModifyGlobalReplicationGroupInput) ModifyGlobalReplicationGroupRequest

ModifyGlobalReplicationGroupRequest returns a request value for making API operation for Amazon ElastiCache.

Modifies the settings for a Global Datastore.

// Example sending a request using ModifyGlobalReplicationGroupRequest.
req := client.ModifyGlobalReplicationGroupRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/elasticache-2015-02-02/ModifyGlobalReplicationGroup

func (*Client) ModifyReplicationGroupRequest added in v0.9.0

func (c *Client) ModifyReplicationGroupRequest(input *ModifyReplicationGroupInput) ModifyReplicationGroupRequest

ModifyReplicationGroupRequest returns a request value for making API operation for Amazon ElastiCache.

Modifies the settings for a replication group.

This operation is valid for Redis only.

// Example sending a request using ModifyReplicationGroupRequest.
req := client.ModifyReplicationGroupRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/elasticache-2015-02-02/ModifyReplicationGroup

Example (Shared00)
package main

import (
	"context"
	"fmt"

	"github.com/aws/aws-sdk-go-v2/aws"
	"github.com/aws/aws-sdk-go-v2/aws/awserr"
	"github.com/aws/aws-sdk-go-v2/aws/external"
	"github.com/aws/aws-sdk-go-v2/service/elasticache"
)

func main() {
	cfg, err := external.LoadDefaultAWSConfig()
	if err != nil {
		panic("failed to load config, " + err.Error())
	}

	svc := elasticache.New(cfg)
	input := &elasticache.ModifyReplicationGroupInput{
		ApplyImmediately:            aws.Bool(true),
		ReplicationGroupDescription: aws.String("Modified replication group"),
		ReplicationGroupId:          aws.String("my-redis-rg"),
		SnapshotRetentionLimit:      aws.Int64(30),
		SnapshottingClusterId:       aws.String("my-redis-rg-001"),
	}

	req := svc.ModifyReplicationGroupRequest(input)
	result, err := req.Send(context.Background())
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case elasticache.ErrCodeReplicationGroupNotFoundFault:
				fmt.Println(elasticache.ErrCodeReplicationGroupNotFoundFault, aerr.Error())
			case elasticache.ErrCodeInvalidReplicationGroupStateFault:
				fmt.Println(elasticache.ErrCodeInvalidReplicationGroupStateFault, aerr.Error())
			case elasticache.ErrCodeInvalidCacheClusterStateFault:
				fmt.Println(elasticache.ErrCodeInvalidCacheClusterStateFault, aerr.Error())
			case elasticache.ErrCodeInvalidCacheSecurityGroupStateFault:
				fmt.Println(elasticache.ErrCodeInvalidCacheSecurityGroupStateFault, aerr.Error())
			case elasticache.ErrCodeInsufficientCacheClusterCapacityFault:
				fmt.Println(elasticache.ErrCodeInsufficientCacheClusterCapacityFault, aerr.Error())
			case elasticache.ErrCodeCacheClusterNotFoundFault:
				fmt.Println(elasticache.ErrCodeCacheClusterNotFoundFault, aerr.Error())
			case elasticache.ErrCodeNodeQuotaForClusterExceededFault:
				fmt.Println(elasticache.ErrCodeNodeQuotaForClusterExceededFault, aerr.Error())
			case elasticache.ErrCodeNodeQuotaForCustomerExceededFault:
				fmt.Println(elasticache.ErrCodeNodeQuotaForCustomerExceededFault, aerr.Error())
			case elasticache.ErrCodeCacheSecurityGroupNotFoundFault:
				fmt.Println(elasticache.ErrCodeCacheSecurityGroupNotFoundFault, aerr.Error())
			case elasticache.ErrCodeCacheParameterGroupNotFoundFault:
				fmt.Println(elasticache.ErrCodeCacheParameterGroupNotFoundFault, aerr.Error())
			case elasticache.ErrCodeInvalidVPCNetworkStateFault:
				fmt.Println(elasticache.ErrCodeInvalidVPCNetworkStateFault, aerr.Error())
			case elasticache.ErrCodeInvalidKMSKeyFault:
				fmt.Println(elasticache.ErrCodeInvalidKMSKeyFault, aerr.Error())
			case elasticache.ErrCodeInvalidParameterValueException:
				fmt.Println(elasticache.ErrCodeInvalidParameterValueException, aerr.Error())
			case elasticache.ErrCodeInvalidParameterCombinationException:
				fmt.Println(elasticache.ErrCodeInvalidParameterCombinationException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*Client) ModifyReplicationGroupShardConfigurationRequest added in v0.9.0

func (c *Client) ModifyReplicationGroupShardConfigurationRequest(input *ModifyReplicationGroupShardConfigurationInput) ModifyReplicationGroupShardConfigurationRequest

ModifyReplicationGroupShardConfigurationRequest returns a request value for making API operation for Amazon ElastiCache.

Modifies a replication group's shards (node groups) by allowing you to add shards, remove shards, or rebalance the keyspaces among exisiting shards.

// Example sending a request using ModifyReplicationGroupShardConfigurationRequest.
req := client.ModifyReplicationGroupShardConfigurationRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/elasticache-2015-02-02/ModifyReplicationGroupShardConfiguration

func (*Client) PurchaseReservedCacheNodesOfferingRequest added in v0.9.0

func (c *Client) PurchaseReservedCacheNodesOfferingRequest(input *PurchaseReservedCacheNodesOfferingInput) PurchaseReservedCacheNodesOfferingRequest

PurchaseReservedCacheNodesOfferingRequest returns a request value for making API operation for Amazon ElastiCache.

Allows you to purchase a reserved cache node offering.

// Example sending a request using PurchaseReservedCacheNodesOfferingRequest.
req := client.PurchaseReservedCacheNodesOfferingRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/elasticache-2015-02-02/PurchaseReservedCacheNodesOffering

Example (Shared00)

PurchaseReservedCacheNodesOfferings

Allows you to purchase a reserved cache node offering.

package main

import (
	"context"
	"fmt"

	"github.com/aws/aws-sdk-go-v2/aws"
	"github.com/aws/aws-sdk-go-v2/aws/awserr"
	"github.com/aws/aws-sdk-go-v2/aws/external"
	"github.com/aws/aws-sdk-go-v2/service/elasticache"
)

func main() {
	cfg, err := external.LoadDefaultAWSConfig()
	if err != nil {
		panic("failed to load config, " + err.Error())
	}

	svc := elasticache.New(cfg)
	input := &elasticache.PurchaseReservedCacheNodesOfferingInput{
		ReservedCacheNodesOfferingId: aws.String("1ef01f5b-94ff-433f-a530-61a56bfc8e7a"),
	}

	req := svc.PurchaseReservedCacheNodesOfferingRequest(input)
	result, err := req.Send(context.Background())
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case elasticache.ErrCodeReservedCacheNodesOfferingNotFoundFault:
				fmt.Println(elasticache.ErrCodeReservedCacheNodesOfferingNotFoundFault, aerr.Error())
			case elasticache.ErrCodeReservedCacheNodeAlreadyExistsFault:
				fmt.Println(elasticache.ErrCodeReservedCacheNodeAlreadyExistsFault, aerr.Error())
			case elasticache.ErrCodeReservedCacheNodeQuotaExceededFault:
				fmt.Println(elasticache.ErrCodeReservedCacheNodeQuotaExceededFault, aerr.Error())
			case elasticache.ErrCodeInvalidParameterValueException:
				fmt.Println(elasticache.ErrCodeInvalidParameterValueException, aerr.Error())
			case elasticache.ErrCodeInvalidParameterCombinationException:
				fmt.Println(elasticache.ErrCodeInvalidParameterCombinationException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*Client) RebalanceSlotsInGlobalReplicationGroupRequest added in v0.20.0

func (c *Client) RebalanceSlotsInGlobalReplicationGroupRequest(input *RebalanceSlotsInGlobalReplicationGroupInput) RebalanceSlotsInGlobalReplicationGroupRequest

RebalanceSlotsInGlobalReplicationGroupRequest returns a request value for making API operation for Amazon ElastiCache.

Redistribute slots to ensure uniform distribution across existing shards in the cluster.

// Example sending a request using RebalanceSlotsInGlobalReplicationGroupRequest.
req := client.RebalanceSlotsInGlobalReplicationGroupRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/elasticache-2015-02-02/RebalanceSlotsInGlobalReplicationGroup

func (*Client) RebootCacheClusterRequest added in v0.9.0

func (c *Client) RebootCacheClusterRequest(input *RebootCacheClusterInput) RebootCacheClusterRequest

RebootCacheClusterRequest returns a request value for making API operation for Amazon ElastiCache.

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

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

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

Rebooting a cluster is currently supported on Memcached and Redis (cluster mode disabled) clusters. Rebooting is not supported on Redis (cluster mode enabled) clusters.

If you make changes to parameters that require a Redis (cluster mode enabled) cluster reboot for the changes to be applied, see Rebooting a Cluster (http://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/Clusters.Rebooting.html) for an alternate process.

// Example sending a request using RebootCacheClusterRequest.
req := client.RebootCacheClusterRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/elasticache-2015-02-02/RebootCacheCluster

Example (Shared00)

RebootCacheCluster

Reboots the specified nodes in the names cluster.

package main

import (
	"context"
	"fmt"

	"github.com/aws/aws-sdk-go-v2/aws"
	"github.com/aws/aws-sdk-go-v2/aws/awserr"
	"github.com/aws/aws-sdk-go-v2/aws/external"
	"github.com/aws/aws-sdk-go-v2/service/elasticache"
)

func main() {
	cfg, err := external.LoadDefaultAWSConfig()
	if err != nil {
		panic("failed to load config, " + err.Error())
	}

	svc := elasticache.New(cfg)
	input := &elasticache.RebootCacheClusterInput{
		CacheClusterId: aws.String("custom-mem1-4  "),
		CacheNodeIdsToReboot: []string{
			"0001",
			"0002",
		},
	}

	req := svc.RebootCacheClusterRequest(input)
	result, err := req.Send(context.Background())
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case elasticache.ErrCodeInvalidCacheClusterStateFault:
				fmt.Println(elasticache.ErrCodeInvalidCacheClusterStateFault, aerr.Error())
			case elasticache.ErrCodeCacheClusterNotFoundFault:
				fmt.Println(elasticache.ErrCodeCacheClusterNotFoundFault, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*Client) RemoveTagsFromResourceRequest added in v0.9.0

func (c *Client) RemoveTagsFromResourceRequest(input *RemoveTagsFromResourceInput) RemoveTagsFromResourceRequest

RemoveTagsFromResourceRequest returns a request value for making API operation for Amazon ElastiCache.

Removes the tags identified by the TagKeys list from the named resource.

// Example sending a request using RemoveTagsFromResourceRequest.
req := client.RemoveTagsFromResourceRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/elasticache-2015-02-02/RemoveTagsFromResource

Example (Shared00)

RemoveTagsFromResource

Removes tags identified by a list of tag keys from the list of tags on the specified resource.

package main

import (
	"context"
	"fmt"

	"github.com/aws/aws-sdk-go-v2/aws"
	"github.com/aws/aws-sdk-go-v2/aws/awserr"
	"github.com/aws/aws-sdk-go-v2/aws/external"
	"github.com/aws/aws-sdk-go-v2/service/elasticache"
)

func main() {
	cfg, err := external.LoadDefaultAWSConfig()
	if err != nil {
		panic("failed to load config, " + err.Error())
	}

	svc := elasticache.New(cfg)
	input := &elasticache.RemoveTagsFromResourceInput{
		ResourceName: aws.String("arn:aws:elasticache:us-east-1:1234567890:cluster:my-mem-cluster"),
		TagKeys: []string{
			"A",
			"C",
			"E",
		},
	}

	req := svc.RemoveTagsFromResourceRequest(input)
	result, err := req.Send(context.Background())
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case elasticache.ErrCodeCacheClusterNotFoundFault:
				fmt.Println(elasticache.ErrCodeCacheClusterNotFoundFault, aerr.Error())
			case elasticache.ErrCodeSnapshotNotFoundFault:
				fmt.Println(elasticache.ErrCodeSnapshotNotFoundFault, aerr.Error())
			case elasticache.ErrCodeInvalidARNFault:
				fmt.Println(elasticache.ErrCodeInvalidARNFault, aerr.Error())
			case elasticache.ErrCodeTagNotFoundFault:
				fmt.Println(elasticache.ErrCodeTagNotFoundFault, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*Client) ResetCacheParameterGroupRequest added in v0.9.0

func (c *Client) ResetCacheParameterGroupRequest(input *ResetCacheParameterGroupInput) ResetCacheParameterGroupRequest

ResetCacheParameterGroupRequest returns a request value for making API operation for Amazon ElastiCache.

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.

// Example sending a request using ResetCacheParameterGroupRequest.
req := client.ResetCacheParameterGroupRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/elasticache-2015-02-02/ResetCacheParameterGroup

Example (Shared00)

ResetCacheParameterGroup

Modifies the parameters of a cache parameter group to the engine or system default value.

package main

import (
	"context"
	"fmt"

	"github.com/aws/aws-sdk-go-v2/aws"
	"github.com/aws/aws-sdk-go-v2/aws/awserr"
	"github.com/aws/aws-sdk-go-v2/aws/external"
	"github.com/aws/aws-sdk-go-v2/service/elasticache"
)

func main() {
	cfg, err := external.LoadDefaultAWSConfig()
	if err != nil {
		panic("failed to load config, " + err.Error())
	}

	svc := elasticache.New(cfg)
	input := &elasticache.ResetCacheParameterGroupInput{
		CacheParameterGroupName: aws.String("custom-mem1-4"),
		ResetAllParameters:      aws.Bool(true),
	}

	req := svc.ResetCacheParameterGroupRequest(input)
	result, err := req.Send(context.Background())
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case elasticache.ErrCodeInvalidCacheParameterGroupStateFault:
				fmt.Println(elasticache.ErrCodeInvalidCacheParameterGroupStateFault, aerr.Error())
			case elasticache.ErrCodeCacheParameterGroupNotFoundFault:
				fmt.Println(elasticache.ErrCodeCacheParameterGroupNotFoundFault, aerr.Error())
			case elasticache.ErrCodeInvalidParameterValueException:
				fmt.Println(elasticache.ErrCodeInvalidParameterValueException, aerr.Error())
			case elasticache.ErrCodeInvalidParameterCombinationException:
				fmt.Println(elasticache.ErrCodeInvalidParameterCombinationException, aerr.Error())
			case elasticache.ErrCodeInvalidGlobalReplicationGroupStateFault:
				fmt.Println(elasticache.ErrCodeInvalidGlobalReplicationGroupStateFault, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*Client) RevokeCacheSecurityGroupIngressRequest added in v0.9.0

func (c *Client) RevokeCacheSecurityGroupIngressRequest(input *RevokeCacheSecurityGroupIngressInput) RevokeCacheSecurityGroupIngressRequest

RevokeCacheSecurityGroupIngressRequest returns a request value for making API operation for Amazon ElastiCache.

Revokes ingress from a cache security group. Use this operation to disallow access from an Amazon EC2 security group that had been previously authorized.

// Example sending a request using RevokeCacheSecurityGroupIngressRequest.
req := client.RevokeCacheSecurityGroupIngressRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/elasticache-2015-02-02/RevokeCacheSecurityGroupIngress

Example (Shared00)

DescribeCacheSecurityGroups

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.

package main

import (
	"context"
	"fmt"

	"github.com/aws/aws-sdk-go-v2/aws"
	"github.com/aws/aws-sdk-go-v2/aws/awserr"
	"github.com/aws/aws-sdk-go-v2/aws/external"
	"github.com/aws/aws-sdk-go-v2/service/elasticache"
)

func main() {
	cfg, err := external.LoadDefaultAWSConfig()
	if err != nil {
		panic("failed to load config, " + err.Error())
	}

	svc := elasticache.New(cfg)
	input := &elasticache.RevokeCacheSecurityGroupIngressInput{
		CacheSecurityGroupName:  aws.String("my-sec-grp"),
		EC2SecurityGroupName:    aws.String("my-ec2-sec-grp"),
		EC2SecurityGroupOwnerId: aws.String("1234567890"),
	}

	req := svc.RevokeCacheSecurityGroupIngressRequest(input)
	result, err := req.Send(context.Background())
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case elasticache.ErrCodeCacheSecurityGroupNotFoundFault:
				fmt.Println(elasticache.ErrCodeCacheSecurityGroupNotFoundFault, aerr.Error())
			case elasticache.ErrCodeAuthorizationNotFoundFault:
				fmt.Println(elasticache.ErrCodeAuthorizationNotFoundFault, aerr.Error())
			case elasticache.ErrCodeInvalidCacheSecurityGroupStateFault:
				fmt.Println(elasticache.ErrCodeInvalidCacheSecurityGroupStateFault, aerr.Error())
			case elasticache.ErrCodeInvalidParameterValueException:
				fmt.Println(elasticache.ErrCodeInvalidParameterValueException, aerr.Error())
			case elasticache.ErrCodeInvalidParameterCombinationException:
				fmt.Println(elasticache.ErrCodeInvalidParameterCombinationException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*Client) StartMigrationRequest added in v0.16.0

func (c *Client) StartMigrationRequest(input *StartMigrationInput) StartMigrationRequest

StartMigrationRequest returns a request value for making API operation for Amazon ElastiCache.

Start the migration of data.

// Example sending a request using StartMigrationRequest.
req := client.StartMigrationRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/elasticache-2015-02-02/StartMigration

func (*Client) TestFailoverRequest added in v0.9.0

func (c *Client) TestFailoverRequest(input *TestFailoverInput) TestFailoverRequest

TestFailoverRequest returns a request value for making API operation for Amazon ElastiCache.

Represents the input of a TestFailover operation which test automatic failover on a specified node group (called shard in the console) in a replication group (called cluster in the console).

Note the following

  • A customer can use this operation to test automatic failover on up to 5 shards (called node groups in the ElastiCache API and AWS CLI) in any rolling 24-hour period.

  • If calling this operation on shards in different clusters (called replication groups in the API and CLI), the calls can be made concurrently.

  • If calling this operation multiple times on different shards in the same Redis (cluster mode enabled) replication group, the first node replacement must complete before a subsequent call can be made.

  • To determine whether the node replacement is complete you can check Events using the Amazon ElastiCache console, the AWS CLI, or the ElastiCache API. Look for the following automatic failover related events, listed here in order of occurrance: Replication group message: Test Failover API called for node group <node-group-id> Cache cluster message: Failover from master node <primary-node-id> to replica node <node-id> completed Replication group message: Failover from master node <primary-node-id> to replica node <node-id> completed Cache cluster message: Recovering cache nodes <node-id> Cache cluster message: Finished recovery for cache nodes <node-id> For more information see: Viewing ElastiCache Events (https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/ECEvents.Viewing.html) in the ElastiCache User Guide DescribeEvents (https://docs.aws.amazon.com/AmazonElastiCache/latest/APIReference/API_DescribeEvents.html) in the ElastiCache API Reference

Also see, Testing Multi-AZ (https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/AutoFailover.html#auto-failover-test) in the ElastiCache User Guide.

// Example sending a request using TestFailoverRequest.
req := client.TestFailoverRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/elasticache-2015-02-02/TestFailover

func (*Client) WaitUntilCacheClusterAvailable added in v0.9.0

func (c *Client) WaitUntilCacheClusterAvailable(ctx context.Context, input *DescribeCacheClustersInput, opts ...aws.WaiterOption) error

WaitUntilCacheClusterAvailable uses the Amazon ElastiCache API operation DescribeCacheClusters to wait for a condition to be met before returning. If the condition is not met within the max attempt window, an error will be returned.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Client) WaitUntilCacheClusterDeleted added in v0.9.0

func (c *Client) WaitUntilCacheClusterDeleted(ctx context.Context, input *DescribeCacheClustersInput, opts ...aws.WaiterOption) error

WaitUntilCacheClusterDeleted uses the Amazon ElastiCache API operation DescribeCacheClusters to wait for a condition to be met before returning. If the condition is not met within the max attempt window, an error will be returned.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Client) WaitUntilReplicationGroupAvailable added in v0.9.0

func (c *Client) WaitUntilReplicationGroupAvailable(ctx context.Context, input *DescribeReplicationGroupsInput, opts ...aws.WaiterOption) error

WaitUntilReplicationGroupAvailable uses the Amazon ElastiCache API operation DescribeReplicationGroups to wait for a condition to be met before returning. If the condition is not met within the max attempt window, an error will be returned.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Client) WaitUntilReplicationGroupDeleted added in v0.9.0

func (c *Client) WaitUntilReplicationGroupDeleted(ctx context.Context, input *DescribeReplicationGroupsInput, opts ...aws.WaiterOption) error

WaitUntilReplicationGroupDeleted uses the Amazon ElastiCache API operation DescribeReplicationGroups to wait for a condition to be met before returning. If the condition is not met within the max attempt window, an error will be returned.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

type CompleteMigrationInput added in v0.16.0

type CompleteMigrationInput struct {

	// Forces the migration to stop without ensuring that data is in sync. It is
	// recommended to use this option only to abort the migration and not recommended
	// when application wants to continue migration to ElastiCache.
	Force *bool `type:"boolean"`

	// The ID of the replication group to which data is being migrated.
	//
	// ReplicationGroupId is a required field
	ReplicationGroupId *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (CompleteMigrationInput) String added in v0.16.0

func (s CompleteMigrationInput) String() string

String returns the string representation

func (*CompleteMigrationInput) Validate added in v0.16.0

func (s *CompleteMigrationInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CompleteMigrationOutput added in v0.16.0

type CompleteMigrationOutput struct {

	// Contains all of the attributes of a specific Redis replication group.
	ReplicationGroup *ReplicationGroup `type:"structure"`
	// contains filtered or unexported fields
}

func (CompleteMigrationOutput) String added in v0.16.0

func (s CompleteMigrationOutput) String() string

String returns the string representation

type CompleteMigrationRequest added in v0.16.0

type CompleteMigrationRequest struct {
	*aws.Request
	Input *CompleteMigrationInput
	Copy  func(*CompleteMigrationInput) CompleteMigrationRequest
}

CompleteMigrationRequest is the request type for the CompleteMigration API operation.

func (CompleteMigrationRequest) Send added in v0.16.0

Send marshals and sends the CompleteMigration API request.

type CompleteMigrationResponse added in v0.16.0

type CompleteMigrationResponse struct {
	*CompleteMigrationOutput
	// contains filtered or unexported fields
}

CompleteMigrationResponse is the response type for the CompleteMigration API operation.

func (*CompleteMigrationResponse) SDKResponseMetdata added in v0.16.0

func (r *CompleteMigrationResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the CompleteMigration request.

type ConfigureShard added in v0.5.0

type ConfigureShard struct {

	// The number of replicas you want in this node group at the end of this operation.
	// The maximum value for NewReplicaCount is 5. The minimum value depends upon
	// the type of Redis replication group you are working with.
	//
	// The minimum number of replicas in a shard or replication group is:
	//
	//    * Redis (cluster mode disabled) If Multi-AZ: 1 If Multi-AZ: 0
	//
	//    * Redis (cluster mode enabled): 0 (though you will not be able to failover
	//    to a replica if your primary node fails)
	//
	// NewReplicaCount is a required field
	NewReplicaCount *int64 `type:"integer" required:"true"`

	// The 4-digit id for the node group you are configuring. For Redis (cluster
	// mode disabled) replication groups, the node group id is always 0001. To find
	// a Redis (cluster mode enabled)'s node group's (shard's) id, see Finding a
	// Shard's Id (https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/shard-find-id.html).
	//
	// NodeGroupId is a required field
	NodeGroupId *string `min:"1" type:"string" required:"true"`

	// A list of PreferredAvailabilityZone strings that specify which availability
	// zones the replication group's nodes are to be in. The nummber of PreferredAvailabilityZone
	// values must equal the value of NewReplicaCount plus 1 to account for the
	// primary node. If this member of ReplicaConfiguration is omitted, ElastiCache
	// for Redis selects the availability zone for each of the replicas.
	PreferredAvailabilityZones []string `locationNameList:"PreferredAvailabilityZone" type:"list"`
	// contains filtered or unexported fields
}

Node group (shard) configuration options when adding or removing replicas. Each node group (shard) configuration has the following members: NodeGroupId, NewReplicaCount, and PreferredAvailabilityZones.

func (ConfigureShard) String added in v0.5.0

func (s ConfigureShard) String() string

String returns the string representation

func (*ConfigureShard) Validate added in v0.5.0

func (s *ConfigureShard) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CopySnapshotInput

type CopySnapshotInput struct {

	// The ID of the KMS key used to encrypt the target snapshot.
	KmsKeyId *string `type:"string"`

	// The name of an existing snapshot from which to make a copy.
	//
	// SourceSnapshotName is a required field
	SourceSnapshotName *string `type:"string" required:"true"`

	// The Amazon S3 bucket to which the snapshot is exported. This parameter is
	// used only when exporting a snapshot for external access.
	//
	// When using this parameter to export a snapshot, be sure Amazon ElastiCache
	// has the needed permissions to this S3 bucket. For more information, see Step
	// 2: Grant ElastiCache Access to Your Amazon S3 Bucket (https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/backups-exporting.html#backups-exporting-grant-access)
	// in the Amazon ElastiCache User Guide.
	//
	// For more information, see Exporting a Snapshot (https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/Snapshots.Exporting.html)
	// in the Amazon ElastiCache User Guide.
	TargetBucket *string `type:"string"`

	// A name for the snapshot copy. ElastiCache does not permit overwriting a snapshot,
	// therefore this name must be unique within its context - ElastiCache or an
	// Amazon S3 bucket if exporting.
	//
	// TargetSnapshotName is a required field
	TargetSnapshotName *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

Represents the input of a CopySnapshotMessage operation.

func (CopySnapshotInput) String

func (s CopySnapshotInput) String() string

String returns the string representation

func (*CopySnapshotInput) Validate

func (s *CopySnapshotInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CopySnapshotOutput

type CopySnapshotOutput struct {

	// Represents a copy of an entire Redis cluster as of the time when the snapshot
	// was taken.
	Snapshot *Snapshot `type:"structure"`
	// contains filtered or unexported fields
}

func (CopySnapshotOutput) String

func (s CopySnapshotOutput) String() string

String returns the string representation

type CopySnapshotRequest

type CopySnapshotRequest struct {
	*aws.Request
	Input *CopySnapshotInput
	Copy  func(*CopySnapshotInput) CopySnapshotRequest
}

CopySnapshotRequest is the request type for the CopySnapshot API operation.

func (CopySnapshotRequest) Send

Send marshals and sends the CopySnapshot API request.

type CopySnapshotResponse added in v0.9.0

type CopySnapshotResponse struct {
	*CopySnapshotOutput
	// contains filtered or unexported fields
}

CopySnapshotResponse is the response type for the CopySnapshot API operation.

func (*CopySnapshotResponse) SDKResponseMetdata added in v0.9.0

func (r *CopySnapshotResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the CopySnapshot request.

type CreateCacheClusterInput

type CreateCacheClusterInput struct {

	// Specifies whether the nodes in this Memcached cluster are created in a single
	// Availability Zone or created across multiple Availability Zones in the cluster's
	// region.
	//
	// This parameter is only supported for Memcached clusters.
	//
	// If the AZMode and PreferredAvailabilityZones are not specified, ElastiCache
	// assumes single-az mode.
	AZMode AZMode `type:"string" enum:"true"`

	// Reserved parameter. The password used to access a password protected server.
	//
	// Password constraints:
	//
	//    * Must be only printable ASCII characters.
	//
	//    * Must be at least 16 characters and no more than 128 characters in length.
	//
	//    * The only permitted printable special characters are !, &, #, $, ^, <,
	//    >, and -. Other printable special characters cannot be used in the AUTH
	//    token.
	//
	// For more information, see AUTH password (http://redis.io/commands/AUTH) at
	// http://redis.io/commands/AUTH.
	AuthToken *string `type:"string"`

	// This parameter is currently disabled.
	AutoMinorVersionUpgrade *bool `type:"boolean"`

	// The node group (shard) identifier. This parameter is stored as a lowercase
	// string.
	//
	// Constraints:
	//
	//    * A name must contain from 1 to 50 alphanumeric characters or hyphens.
	//
	//    * The first character must be a letter.
	//
	//    * A name cannot end with a hyphen or contain two consecutive hyphens.
	//
	// CacheClusterId is a required field
	CacheClusterId *string `type:"string" required:"true"`

	// The compute and memory capacity of the nodes in the node group (shard).
	//
	// 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: M5 node types: cache.m5.large,
	//    cache.m5.xlarge, cache.m5.2xlarge, cache.m5.4xlarge, cache.m5.12xlarge,
	//    cache.m5.24xlarge M4 node types: cache.m4.large, cache.m4.xlarge, cache.m4.2xlarge,
	//    cache.m4.4xlarge, cache.m4.10xlarge T3 node types: cache.t3.micro, cache.t3.small,
	//    cache.t3.medium T2 node types: cache.t2.micro, cache.t2.small, cache.t2.medium
	//    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
	//    M3 node types: cache.m3.medium, cache.m3.large, cache.m3.xlarge, cache.m3.2xlarge
	//
	//    * Compute optimized: Previous generation: (not recommended) C1 node types:
	//    cache.c1.xlarge
	//
	//    * Memory optimized: Current generation: R5 node types: cache.r5.large,
	//    cache.r5.xlarge, cache.r5.2xlarge, cache.r5.4xlarge, cache.r5.12xlarge,
	//    cache.r5.24xlarge R4 node types: cache.r4.large, cache.r4.xlarge, cache.r4.2xlarge,
	//    cache.r4.4xlarge, cache.r4.8xlarge, cache.r4.16xlarge Previous generation:
	//    (not recommended) M2 node types: cache.m2.xlarge, cache.m2.2xlarge, cache.m2.4xlarge
	//    R3 node types: cache.r3.large, cache.r3.xlarge, cache.r3.2xlarge, cache.r3.4xlarge,
	//    cache.r3.8xlarge
	//
	// Additional node type info
	//
	//    * All current generation instance types are created in Amazon VPC by default.
	//
	//    * Redis append-only files (AOF) are not supported for T1 or T2 instances.
	//
	//    * Redis Multi-AZ with automatic failover is not supported on T1 instances.
	//
	//    * Redis configuration variables appendonly and appendfsync are not supported
	//    on Redis version 2.8.22 and later.
	CacheNodeType *string `type:"string"`

	// The name of the parameter group to associate with this cluster. If this argument
	// is omitted, the default parameter group for the specified engine is used.
	// You cannot use any parameter group which has cluster-enabled='yes' when creating
	// a cluster.
	CacheParameterGroupName *string `type:"string"`

	// A list of security group names to associate with this cluster.
	//
	// Use this parameter only when you are creating a cluster outside of an Amazon
	// Virtual Private Cloud (Amazon VPC).
	CacheSecurityGroupNames []string `locationNameList:"CacheSecurityGroupName" type:"list"`

	// The name of the subnet group to be used for the cluster.
	//
	// Use this parameter only when you are creating a cluster in an Amazon Virtual
	// Private Cloud (Amazon VPC).
	//
	// If you're going to launch your cluster in an Amazon VPC, you need to create
	// a subnet group before you start creating a cluster. For more information,
	// see Subnets and Subnet Groups (https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/SubnetGroups.html).
	CacheSubnetGroupName *string `type:"string"`

	// The name of the cache engine to be used for this cluster.
	//
	// Valid values for this parameter are: memcached | redis
	Engine *string `type:"string"`

	// The version number of the cache engine to be used for this cluster. To view
	// the supported cache engine versions, use the DescribeCacheEngineVersions
	// operation.
	//
	// Important: You can upgrade to a newer engine version (see Selecting a Cache
	// Engine and Version (https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/SelectEngine.html#VersionManagement)),
	// but you cannot downgrade to an earlier engine version. If you want to use
	// an earlier engine version, you must delete the existing cluster or replication
	// group and create it anew with the earlier engine version.
	EngineVersion *string `type:"string"`

	// The Amazon Resource Name (ARN) of the Amazon Simple Notification Service
	// (SNS) topic to which notifications are sent.
	//
	// The Amazon SNS topic owner must be the same as the cluster owner.
	NotificationTopicArn *string `type:"string"`

	// The initial number of cache nodes that the cluster has.
	//
	// For clusters running Redis, this value must be 1. For clusters running Memcached,
	// this value must be between 1 and 20.
	//
	// If you need more than 20 nodes for your Memcached cluster, please fill out
	// the ElastiCache Limit Increase Request form at http://aws.amazon.com/contact-us/elasticache-node-limit-request/
	// (http://aws.amazon.com/contact-us/elasticache-node-limit-request/).
	NumCacheNodes *int64 `type:"integer"`

	// The port number on which each of the cache nodes accepts connections.
	Port *int64 `type:"integer"`

	// The EC2 Availability Zone in which the cluster is created.
	//
	// All nodes belonging to this cluster are placed in the preferred Availability
	// Zone. If you want to create your nodes across multiple Availability Zones,
	// use PreferredAvailabilityZones.
	//
	// Default: System chosen Availability Zone.
	PreferredAvailabilityZone *string `type:"string"`

	// A list of the Availability Zones in which cache nodes are created. The order
	// of the zones in the list is not important.
	//
	// This option is only supported on Memcached.
	//
	// If you are creating your cluster in an Amazon VPC (recommended) you can only
	// locate nodes in Availability Zones that are associated with the subnets in
	// the selected subnet group.
	//
	// The number of Availability Zones listed must equal the value of NumCacheNodes.
	//
	// If you want all the nodes in the same Availability Zone, use PreferredAvailabilityZone
	// instead, or repeat the Availability Zone multiple times in the list.
	//
	// Default: System chosen Availability Zones.
	PreferredAvailabilityZones []string `locationNameList:"PreferredAvailabilityZone" type:"list"`

	// Specifies the weekly time range during which maintenance on the cluster is
	// performed. It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi
	// (24H Clock UTC). The minimum maintenance window is a 60 minute period. Valid
	// values for ddd are:
	//
	// Specifies the weekly time range during which maintenance on the cluster is
	// performed. It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi
	// (24H Clock UTC). The minimum maintenance window is a 60 minute period.
	//
	// Valid values for ddd are:
	//
	//    * sun
	//
	//    * mon
	//
	//    * tue
	//
	//    * wed
	//
	//    * thu
	//
	//    * fri
	//
	//    * sat
	//
	// Example: sun:23:00-mon:01:30
	PreferredMaintenanceWindow *string `type:"string"`

	// The ID of the replication group to which this cluster should belong. If this
	// parameter is specified, the cluster is added to the specified replication
	// group as a read replica; otherwise, the cluster is a standalone primary that
	// is not part of any replication group.
	//
	// If the specified replication group is Multi-AZ enabled and the Availability
	// Zone is not specified, the cluster is created in Availability Zones that
	// provide the best spread of read replicas across Availability Zones.
	//
	// This parameter is only valid if the Engine parameter is redis.
	ReplicationGroupId *string `type:"string"`

	// One or more VPC security groups associated with the cluster.
	//
	// Use this parameter only when you are creating a cluster in an Amazon Virtual
	// Private Cloud (Amazon VPC).
	SecurityGroupIds []string `locationNameList:"SecurityGroupId" type:"list"`

	// A single-element string list containing an Amazon Resource Name (ARN) that
	// uniquely identifies a Redis RDB snapshot file stored in Amazon S3. The snapshot
	// file is used to populate the node group (shard). The Amazon S3 object name
	// in the ARN cannot contain any commas.
	//
	// This parameter is only valid if the Engine parameter is redis.
	//
	// Example of an Amazon S3 ARN: arn:aws:s3:::my_bucket/snapshot1.rdb
	SnapshotArns []string `locationNameList:"SnapshotArn" type:"list"`

	// The name of a Redis snapshot from which to restore data into the new node
	// group (shard). The snapshot status changes to restoring while the new node
	// group (shard) is being created.
	//
	// This parameter is only valid if the Engine parameter is redis.
	SnapshotName *string `type:"string"`

	// The number of days for which ElastiCache retains automatic snapshots before
	// deleting them. For example, if you set SnapshotRetentionLimit to 5, a snapshot
	// taken today is retained for 5 days before being deleted.
	//
	// This parameter is only valid if the Engine parameter is redis.
	//
	// Default: 0 (i.e., automatic backups are disabled for this cache cluster).
	SnapshotRetentionLimit *int64 `type:"integer"`

	// The daily time range (in UTC) during which ElastiCache begins taking a daily
	// snapshot of your node group (shard).
	//
	// Example: 05:00-09:00
	//
	// If you do not specify this parameter, ElastiCache automatically chooses an
	// appropriate time range.
	//
	// This parameter is only valid if the Engine parameter is redis.
	SnapshotWindow *string `type:"string"`

	// A list of cost allocation tags to be added to this resource.
	Tags []Tag `locationNameList:"Tag" type:"list"`
	// contains filtered or unexported fields
}

Represents the input of a CreateCacheCluster operation.

func (CreateCacheClusterInput) String

func (s CreateCacheClusterInput) String() string

String returns the string representation

func (*CreateCacheClusterInput) Validate

func (s *CreateCacheClusterInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateCacheClusterOutput

type CreateCacheClusterOutput struct {

	// Contains all of the attributes of a specific cluster.
	CacheCluster *CacheCluster `type:"structure"`
	// contains filtered or unexported fields
}

func (CreateCacheClusterOutput) String

func (s CreateCacheClusterOutput) String() string

String returns the string representation

type CreateCacheClusterRequest

type CreateCacheClusterRequest struct {
	*aws.Request
	Input *CreateCacheClusterInput
	Copy  func(*CreateCacheClusterInput) CreateCacheClusterRequest
}

CreateCacheClusterRequest is the request type for the CreateCacheCluster API operation.

func (CreateCacheClusterRequest) Send

Send marshals and sends the CreateCacheCluster API request.

type CreateCacheClusterResponse added in v0.9.0

type CreateCacheClusterResponse struct {
	*CreateCacheClusterOutput
	// contains filtered or unexported fields
}

CreateCacheClusterResponse is the response type for the CreateCacheCluster API operation.

func (*CreateCacheClusterResponse) SDKResponseMetdata added in v0.9.0

func (r *CreateCacheClusterResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the CreateCacheCluster request.

type CreateCacheParameterGroupInput

type CreateCacheParameterGroupInput struct {

	// The name of the cache parameter group family that the cache parameter group
	// can be used with.
	//
	// Valid values are: memcached1.4 | memcached1.5 | redis2.6 | redis2.8 | redis3.2
	// | redis4.0 | redis5.0 |
	//
	// CacheParameterGroupFamily is a required field
	CacheParameterGroupFamily *string `type:"string" required:"true"`

	// A user-specified name for the cache parameter group.
	//
	// CacheParameterGroupName is a required field
	CacheParameterGroupName *string `type:"string" required:"true"`

	// A user-specified description for the cache parameter group.
	//
	// Description is a required field
	Description *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

Represents the input of a CreateCacheParameterGroup operation.

func (CreateCacheParameterGroupInput) String

String returns the string representation

func (*CreateCacheParameterGroupInput) Validate

func (s *CreateCacheParameterGroupInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateCacheParameterGroupOutput

type CreateCacheParameterGroupOutput struct {

	// Represents the output of a CreateCacheParameterGroup operation.
	CacheParameterGroup *CacheParameterGroup `type:"structure"`
	// contains filtered or unexported fields
}

func (CreateCacheParameterGroupOutput) String

String returns the string representation

type CreateCacheParameterGroupRequest

type CreateCacheParameterGroupRequest struct {
	*aws.Request
	Input *CreateCacheParameterGroupInput
	Copy  func(*CreateCacheParameterGroupInput) CreateCacheParameterGroupRequest
}

CreateCacheParameterGroupRequest is the request type for the CreateCacheParameterGroup API operation.

func (CreateCacheParameterGroupRequest) Send

Send marshals and sends the CreateCacheParameterGroup API request.

type CreateCacheParameterGroupResponse added in v0.9.0

type CreateCacheParameterGroupResponse struct {
	*CreateCacheParameterGroupOutput
	// contains filtered or unexported fields
}

CreateCacheParameterGroupResponse is the response type for the CreateCacheParameterGroup API operation.

func (*CreateCacheParameterGroupResponse) SDKResponseMetdata added in v0.9.0

func (r *CreateCacheParameterGroupResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the CreateCacheParameterGroup request.

type CreateCacheSecurityGroupInput

type CreateCacheSecurityGroupInput struct {

	// A name for the cache security group. This value is stored as a lowercase
	// string.
	//
	// Constraints: Must contain no more than 255 alphanumeric characters. Cannot
	// be the word "Default".
	//
	// Example: mysecuritygroup
	//
	// CacheSecurityGroupName is a required field
	CacheSecurityGroupName *string `type:"string" required:"true"`

	// A description for the cache security group.
	//
	// Description is a required field
	Description *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

Represents the input of a CreateCacheSecurityGroup operation.

func (CreateCacheSecurityGroupInput) String

String returns the string representation

func (*CreateCacheSecurityGroupInput) Validate

func (s *CreateCacheSecurityGroupInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateCacheSecurityGroupOutput

type CreateCacheSecurityGroupOutput struct {

	// Represents the output of one of the following operations:
	//
	//    * AuthorizeCacheSecurityGroupIngress
	//
	//    * CreateCacheSecurityGroup
	//
	//    * RevokeCacheSecurityGroupIngress
	CacheSecurityGroup *CacheSecurityGroup `type:"structure"`
	// contains filtered or unexported fields
}

func (CreateCacheSecurityGroupOutput) String

String returns the string representation

type CreateCacheSecurityGroupRequest

type CreateCacheSecurityGroupRequest struct {
	*aws.Request
	Input *CreateCacheSecurityGroupInput
	Copy  func(*CreateCacheSecurityGroupInput) CreateCacheSecurityGroupRequest
}

CreateCacheSecurityGroupRequest is the request type for the CreateCacheSecurityGroup API operation.

func (CreateCacheSecurityGroupRequest) Send

Send marshals and sends the CreateCacheSecurityGroup API request.

type CreateCacheSecurityGroupResponse added in v0.9.0

type CreateCacheSecurityGroupResponse struct {
	*CreateCacheSecurityGroupOutput
	// contains filtered or unexported fields
}

CreateCacheSecurityGroupResponse is the response type for the CreateCacheSecurityGroup API operation.

func (*CreateCacheSecurityGroupResponse) SDKResponseMetdata added in v0.9.0

func (r *CreateCacheSecurityGroupResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the CreateCacheSecurityGroup request.

type CreateCacheSubnetGroupInput

type CreateCacheSubnetGroupInput struct {

	// A description for the cache subnet group.
	//
	// CacheSubnetGroupDescription is a required field
	CacheSubnetGroupDescription *string `type:"string" required:"true"`

	// A name for the cache subnet group. This value is stored as a lowercase string.
	//
	// Constraints: Must contain no more than 255 alphanumeric characters or hyphens.
	//
	// Example: mysubnetgroup
	//
	// CacheSubnetGroupName is a required field
	CacheSubnetGroupName *string `type:"string" required:"true"`

	// A list of VPC subnet IDs for the cache subnet group.
	//
	// SubnetIds is a required field
	SubnetIds []string `locationNameList:"SubnetIdentifier" type:"list" required:"true"`
	// contains filtered or unexported fields
}

Represents the input of a CreateCacheSubnetGroup operation.

func (CreateCacheSubnetGroupInput) String

String returns the string representation

func (*CreateCacheSubnetGroupInput) Validate

func (s *CreateCacheSubnetGroupInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateCacheSubnetGroupOutput

type CreateCacheSubnetGroupOutput struct {

	// Represents the output of one of the following operations:
	//
	//    * CreateCacheSubnetGroup
	//
	//    * ModifyCacheSubnetGroup
	CacheSubnetGroup *CacheSubnetGroup `type:"structure"`
	// contains filtered or unexported fields
}

func (CreateCacheSubnetGroupOutput) String

String returns the string representation

type CreateCacheSubnetGroupRequest

type CreateCacheSubnetGroupRequest struct {
	*aws.Request
	Input *CreateCacheSubnetGroupInput
	Copy  func(*CreateCacheSubnetGroupInput) CreateCacheSubnetGroupRequest
}

CreateCacheSubnetGroupRequest is the request type for the CreateCacheSubnetGroup API operation.

func (CreateCacheSubnetGroupRequest) Send

Send marshals and sends the CreateCacheSubnetGroup API request.

type CreateCacheSubnetGroupResponse added in v0.9.0

type CreateCacheSubnetGroupResponse struct {
	*CreateCacheSubnetGroupOutput
	// contains filtered or unexported fields
}

CreateCacheSubnetGroupResponse is the response type for the CreateCacheSubnetGroup API operation.

func (*CreateCacheSubnetGroupResponse) SDKResponseMetdata added in v0.9.0

func (r *CreateCacheSubnetGroupResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the CreateCacheSubnetGroup request.

type CreateGlobalReplicationGroupInput added in v0.20.0

type CreateGlobalReplicationGroupInput struct {

	// Provides details of the Global Datastore
	GlobalReplicationGroupDescription *string `type:"string"`

	// The suffix name of a Global Datastore. The suffix guarantees uniqueness of
	// the Global Datastore name across multiple regions.
	//
	// GlobalReplicationGroupIdSuffix is a required field
	GlobalReplicationGroupIdSuffix *string `type:"string" required:"true"`

	// The name of the primary cluster that accepts writes and will replicate updates
	// to the secondary cluster.
	//
	// PrimaryReplicationGroupId is a required field
	PrimaryReplicationGroupId *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (CreateGlobalReplicationGroupInput) String added in v0.20.0

String returns the string representation

func (*CreateGlobalReplicationGroupInput) Validate added in v0.20.0

Validate inspects the fields of the type to determine if they are valid.

type CreateGlobalReplicationGroupOutput added in v0.20.0

type CreateGlobalReplicationGroupOutput struct {

	// Consists of a primary cluster that accepts writes and an associated secondary
	// cluster that resides in a different AWS region. The secondary cluster accepts
	// only reads. The primary cluster automatically replicates updates to the secondary
	// cluster.
	//
	//    * The GlobalReplicationGroupIdSuffix represents the name of the Global
	//    Datastore, which is what you use to associate a secondary cluster.
	GlobalReplicationGroup *GlobalReplicationGroup `type:"structure"`
	// contains filtered or unexported fields
}

func (CreateGlobalReplicationGroupOutput) String added in v0.20.0

String returns the string representation

type CreateGlobalReplicationGroupRequest added in v0.20.0

type CreateGlobalReplicationGroupRequest struct {
	*aws.Request
	Input *CreateGlobalReplicationGroupInput
	Copy  func(*CreateGlobalReplicationGroupInput) CreateGlobalReplicationGroupRequest
}

CreateGlobalReplicationGroupRequest is the request type for the CreateGlobalReplicationGroup API operation.

func (CreateGlobalReplicationGroupRequest) Send added in v0.20.0

Send marshals and sends the CreateGlobalReplicationGroup API request.

type CreateGlobalReplicationGroupResponse added in v0.20.0

type CreateGlobalReplicationGroupResponse struct {
	*CreateGlobalReplicationGroupOutput
	// contains filtered or unexported fields
}

CreateGlobalReplicationGroupResponse is the response type for the CreateGlobalReplicationGroup API operation.

func (*CreateGlobalReplicationGroupResponse) SDKResponseMetdata added in v0.20.0

func (r *CreateGlobalReplicationGroupResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the CreateGlobalReplicationGroup request.

type CreateReplicationGroupInput

type CreateReplicationGroupInput struct {

	// A flag that enables encryption at rest when set to true.
	//
	// You cannot modify the value of AtRestEncryptionEnabled after the replication
	// group is created. To enable encryption at rest on a replication group you
	// must set AtRestEncryptionEnabled to true when you create the replication
	// group.
	//
	// Required: Only available when creating a replication group in an Amazon VPC
	// using redis version 3.2.6, 4.x or later.
	//
	// Default: false
	AtRestEncryptionEnabled *bool `type:"boolean"`

	// Reserved parameter. The password used to access a password protected server.
	//
	// AuthToken can be specified only on replication groups where TransitEncryptionEnabled
	// is true.
	//
	// For HIPAA compliance, you must specify TransitEncryptionEnabled as true,
	// an AuthToken, and a CacheSubnetGroup.
	//
	// Password constraints:
	//
	//    * Must be only printable ASCII characters.
	//
	//    * Must be at least 16 characters and no more than 128 characters in length.
	//
	//    * The only permitted printable special characters are !, &, #, $, ^, <,
	//    >, and -. Other printable special characters cannot be used in the AUTH
	//    token.
	//
	// For more information, see AUTH password (http://redis.io/commands/AUTH) at
	// http://redis.io/commands/AUTH.
	AuthToken *string `type:"string"`

	// This parameter is currently disabled.
	AutoMinorVersionUpgrade *bool `type:"boolean"`

	// Specifies whether a read-only replica is automatically promoted to read/write
	// primary if the existing primary fails.
	//
	// AutomaticFailoverEnabled must be enabled for Redis (cluster mode enabled)
	// replication groups.
	//
	// Default: false
	AutomaticFailoverEnabled *bool `type:"boolean"`

	// The compute and memory capacity of the nodes in the node group (shard).
	//
	// 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: M5 node types: cache.m5.large,
	//    cache.m5.xlarge, cache.m5.2xlarge, cache.m5.4xlarge, cache.m5.12xlarge,
	//    cache.m5.24xlarge M4 node types: cache.m4.large, cache.m4.xlarge, cache.m4.2xlarge,
	//    cache.m4.4xlarge, cache.m4.10xlarge T3 node types: cache.t3.micro, cache.t3.small,
	//    cache.t3.medium T2 node types: cache.t2.micro, cache.t2.small, cache.t2.medium
	//    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
	//    M3 node types: cache.m3.medium, cache.m3.large, cache.m3.xlarge, cache.m3.2xlarge
	//
	//    * Compute optimized: Previous generation: (not recommended) C1 node types:
	//    cache.c1.xlarge
	//
	//    * Memory optimized: Current generation: R5 node types: cache.r5.large,
	//    cache.r5.xlarge, cache.r5.2xlarge, cache.r5.4xlarge, cache.r5.12xlarge,
	//    cache.r5.24xlarge R4 node types: cache.r4.large, cache.r4.xlarge, cache.r4.2xlarge,
	//    cache.r4.4xlarge, cache.r4.8xlarge, cache.r4.16xlarge Previous generation:
	//    (not recommended) M2 node types: cache.m2.xlarge, cache.m2.2xlarge, cache.m2.4xlarge
	//    R3 node types: cache.r3.large, cache.r3.xlarge, cache.r3.2xlarge, cache.r3.4xlarge,
	//    cache.r3.8xlarge
	//
	// Additional node type info
	//
	//    * All current generation instance types are created in Amazon VPC by default.
	//
	//    * Redis append-only files (AOF) are not supported for T1 or T2 instances.
	//
	//    * Redis Multi-AZ with automatic failover is not supported on T1 instances.
	//
	//    * Redis configuration variables appendonly and appendfsync are not supported
	//    on Redis version 2.8.22 and later.
	CacheNodeType *string `type:"string"`

	// The name of the parameter group to associate with this replication group.
	// If this argument is omitted, the default cache parameter group for the specified
	// engine is used.
	//
	// If you are restoring to an engine version that is different than the original,
	// you must specify the default version of that version. For example, CacheParameterGroupName=default.redis4.0.
	//
	// If you are running Redis version 3.2.4 or later, only one node group (shard),
	// and want to use a default parameter group, we recommend that you specify
	// the parameter group by name.
	//
	//    * To create a Redis (cluster mode disabled) replication group, use CacheParameterGroupName=default.redis3.2.
	//
	//    * To create a Redis (cluster mode enabled) replication group, use CacheParameterGroupName=default.redis3.2.cluster.on.
	CacheParameterGroupName *string `type:"string"`

	// A list of cache security group names to associate with this replication group.
	CacheSecurityGroupNames []string `locationNameList:"CacheSecurityGroupName" type:"list"`

	// The name of the cache subnet group to be used for the replication group.
	//
	// If you're going to launch your cluster in an Amazon VPC, you need to create
	// a subnet group before you start creating a cluster. For more information,
	// see Subnets and Subnet Groups (https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/SubnetGroups.html).
	CacheSubnetGroupName *string `type:"string"`

	// The name of the cache engine to be used for the clusters in this replication
	// group.
	Engine *string `type:"string"`

	// The version number of the cache engine to be used for the clusters in this
	// replication group. To view the supported cache engine versions, use the DescribeCacheEngineVersions
	// operation.
	//
	// Important: You can upgrade to a newer engine version (see Selecting a Cache
	// Engine and Version (https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/SelectEngine.html#VersionManagement))
	// in the ElastiCache User Guide, but you cannot downgrade to an earlier engine
	// version. If you want to use an earlier engine version, you must delete the
	// existing cluster or replication group and create it anew with the earlier
	// engine version.
	EngineVersion *string `type:"string"`

	// The name of the Global Datastore
	GlobalReplicationGroupId *string `type:"string"`

	// The ID of the KMS key used to encrypt the disk in the cluster.
	KmsKeyId *string `type:"string"`

	// A flag indicating if you have Multi-AZ enabled to enhance fault tolerance.
	// For more information, see Minimizing Downtime: Multi-AZ (http://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/AutoFailover.html).
	MultiAZEnabled *bool `type:"boolean"`

	// A list of node group (shard) configuration options. Each node group (shard)
	// configuration has the following members: PrimaryAvailabilityZone, ReplicaAvailabilityZones,
	// ReplicaCount, and Slots.
	//
	// If you're creating a Redis (cluster mode disabled) or a Redis (cluster mode
	// enabled) replication group, you can use this parameter to individually configure
	// each node group (shard), or you can omit this parameter. However, it is required
	// when seeding a Redis (cluster mode enabled) cluster from a S3 rdb file. You
	// must configure each node group (shard) using this parameter because you must
	// specify the slots for each node group.
	NodeGroupConfiguration []NodeGroupConfiguration `locationNameList:"NodeGroupConfiguration" type:"list"`

	// The Amazon Resource Name (ARN) of the Amazon Simple Notification Service
	// (SNS) topic to which notifications are sent.
	//
	// The Amazon SNS topic owner must be the same as the cluster owner.
	NotificationTopicArn *string `type:"string"`

	// The number of clusters this replication group initially has.
	//
	// This parameter is not used if there is more than one node group (shard).
	// You should use ReplicasPerNodeGroup instead.
	//
	// If AutomaticFailoverEnabled is true, the value of this parameter must be
	// at least 2. If AutomaticFailoverEnabled is false you can omit this parameter
	// (it will default to 1), or you can explicitly set it to a value between 2
	// and 6.
	//
	// The maximum permitted value for NumCacheClusters is 6 (1 primary plus 5 replicas).
	NumCacheClusters *int64 `type:"integer"`

	// An optional parameter that specifies the number of node groups (shards) for
	// this Redis (cluster mode enabled) replication group. For Redis (cluster mode
	// disabled) either omit this parameter or set it to 1.
	//
	// Default: 1
	NumNodeGroups *int64 `type:"integer"`

	// The port number on which each member of the replication group accepts connections.
	Port *int64 `type:"integer"`

	// A list of EC2 Availability Zones in which the replication group's clusters
	// are created. The order of the Availability Zones in the list is the order
	// in which clusters are allocated. The primary cluster is created in the first
	// AZ in the list.
	//
	// This parameter is not used if there is more than one node group (shard).
	// You should use NodeGroupConfiguration instead.
	//
	// If you are creating your replication group in an Amazon VPC (recommended),
	// you can only locate clusters in Availability Zones associated with the subnets
	// in the selected subnet group.
	//
	// The number of Availability Zones listed must equal the value of NumCacheClusters.
	//
	// Default: system chosen Availability Zones.
	PreferredCacheClusterAZs []string `locationNameList:"AvailabilityZone" type:"list"`

	// Specifies the weekly time range during which maintenance on the cluster is
	// performed. It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi
	// (24H Clock UTC). The minimum maintenance window is a 60 minute period. Valid
	// values for ddd are:
	//
	// Specifies the weekly time range during which maintenance on the cluster is
	// performed. It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi
	// (24H Clock UTC). The minimum maintenance window is a 60 minute period.
	//
	// Valid values for ddd are:
	//
	//    * sun
	//
	//    * mon
	//
	//    * tue
	//
	//    * wed
	//
	//    * thu
	//
	//    * fri
	//
	//    * sat
	//
	// Example: sun:23:00-mon:01:30
	PreferredMaintenanceWindow *string `type:"string"`

	// The identifier of the cluster that serves as the primary for this replication
	// group. This cluster must already exist and have a status of available.
	//
	// This parameter is not required if NumCacheClusters, NumNodeGroups, or ReplicasPerNodeGroup
	// is specified.
	PrimaryClusterId *string `type:"string"`

	// An optional parameter that specifies the number of replica nodes in each
	// node group (shard). Valid values are 0 to 5.
	ReplicasPerNodeGroup *int64 `type:"integer"`

	// A user-created description for the replication group.
	//
	// ReplicationGroupDescription is a required field
	ReplicationGroupDescription *string `type:"string" required:"true"`

	// The replication group identifier. This parameter is stored as a lowercase
	// string.
	//
	// Constraints:
	//
	//    * A name must contain from 1 to 40 alphanumeric characters or hyphens.
	//
	//    * The first character must be a letter.
	//
	//    * A name cannot end with a hyphen or contain two consecutive hyphens.
	//
	// ReplicationGroupId is a required field
	ReplicationGroupId *string `type:"string" required:"true"`

	// One or more Amazon VPC security groups associated with this replication group.
	//
	// Use this parameter only when you are creating a replication group in an Amazon
	// Virtual Private Cloud (Amazon VPC).
	SecurityGroupIds []string `locationNameList:"SecurityGroupId" type:"list"`

	// A list of Amazon Resource Names (ARN) that uniquely identify the Redis RDB
	// snapshot files stored in Amazon S3. The snapshot files are used to populate
	// the new replication group. The Amazon S3 object name in the ARN cannot contain
	// any commas. The new replication group will have the number of node groups
	// (console: shards) specified by the parameter NumNodeGroups or the number
	// of node groups configured by NodeGroupConfiguration regardless of the number
	// of ARNs specified here.
	//
	// Example of an Amazon S3 ARN: arn:aws:s3:::my_bucket/snapshot1.rdb
	SnapshotArns []string `locationNameList:"SnapshotArn" type:"list"`

	// The name of a snapshot from which to restore data into the new replication
	// group. The snapshot status changes to restoring while the new replication
	// group is being created.
	SnapshotName *string `type:"string"`

	// The number of days for which ElastiCache retains automatic snapshots before
	// deleting them. For example, if you set SnapshotRetentionLimit to 5, a snapshot
	// that was taken today is retained for 5 days before being deleted.
	//
	// Default: 0 (i.e., automatic backups are disabled for this cluster).
	SnapshotRetentionLimit *int64 `type:"integer"`

	// The daily time range (in UTC) during which ElastiCache begins taking a daily
	// snapshot of your node group (shard).
	//
	// Example: 05:00-09:00
	//
	// If you do not specify this parameter, ElastiCache automatically chooses an
	// appropriate time range.
	SnapshotWindow *string `type:"string"`

	// A list of cost allocation tags to be added to this resource. Tags are comma-separated
	// key,value pairs (e.g. Key=myKey, Value=myKeyValue. You can include multiple
	// tags as shown following: Key=myKey, Value=myKeyValue Key=mySecondKey, Value=mySecondKeyValue.
	Tags []Tag `locationNameList:"Tag" type:"list"`

	// A flag that enables in-transit encryption when set to true.
	//
	// You cannot modify the value of TransitEncryptionEnabled after the cluster
	// is created. To enable in-transit encryption on a cluster you must set TransitEncryptionEnabled
	// to true when you create a cluster.
	//
	// This parameter is valid only if the Engine parameter is redis, the EngineVersion
	// parameter is 3.2.6, 4.x or later, and the cluster is being created in an
	// Amazon VPC.
	//
	// If you enable in-transit encryption, you must also specify a value for CacheSubnetGroup.
	//
	// Required: Only available when creating a replication group in an Amazon VPC
	// using redis version 3.2.6, 4.x or later.
	//
	// Default: false
	//
	// For HIPAA compliance, you must specify TransitEncryptionEnabled as true,
	// an AuthToken, and a CacheSubnetGroup.
	TransitEncryptionEnabled *bool `type:"boolean"`
	// contains filtered or unexported fields
}

Represents the input of a CreateReplicationGroup operation.

func (CreateReplicationGroupInput) String

String returns the string representation

func (*CreateReplicationGroupInput) Validate

func (s *CreateReplicationGroupInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateReplicationGroupOutput

type CreateReplicationGroupOutput struct {

	// Contains all of the attributes of a specific Redis replication group.
	ReplicationGroup *ReplicationGroup `type:"structure"`
	// contains filtered or unexported fields
}

func (CreateReplicationGroupOutput) String

String returns the string representation

type CreateReplicationGroupRequest

type CreateReplicationGroupRequest struct {
	*aws.Request
	Input *CreateReplicationGroupInput
	Copy  func(*CreateReplicationGroupInput) CreateReplicationGroupRequest
}

CreateReplicationGroupRequest is the request type for the CreateReplicationGroup API operation.

func (CreateReplicationGroupRequest) Send

Send marshals and sends the CreateReplicationGroup API request.

type CreateReplicationGroupResponse added in v0.9.0

type CreateReplicationGroupResponse struct {
	*CreateReplicationGroupOutput
	// contains filtered or unexported fields
}

CreateReplicationGroupResponse is the response type for the CreateReplicationGroup API operation.

func (*CreateReplicationGroupResponse) SDKResponseMetdata added in v0.9.0

func (r *CreateReplicationGroupResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the CreateReplicationGroup request.

type CreateSnapshotInput

type CreateSnapshotInput struct {

	// The identifier of an existing cluster. The snapshot is created from this
	// cluster.
	CacheClusterId *string `type:"string"`

	// The ID of the KMS key used to encrypt the snapshot.
	KmsKeyId *string `type:"string"`

	// The identifier of an existing replication group. The snapshot is created
	// from this replication group.
	ReplicationGroupId *string `type:"string"`

	// A name for the snapshot being created.
	//
	// SnapshotName is a required field
	SnapshotName *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

Represents the input of a CreateSnapshot operation.

func (CreateSnapshotInput) String

func (s CreateSnapshotInput) String() string

String returns the string representation

func (*CreateSnapshotInput) Validate

func (s *CreateSnapshotInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateSnapshotOutput

type CreateSnapshotOutput struct {

	// Represents a copy of an entire Redis cluster as of the time when the snapshot
	// was taken.
	Snapshot *Snapshot `type:"structure"`
	// contains filtered or unexported fields
}

func (CreateSnapshotOutput) String

func (s CreateSnapshotOutput) String() string

String returns the string representation

type CreateSnapshotRequest

type CreateSnapshotRequest struct {
	*aws.Request
	Input *CreateSnapshotInput
	Copy  func(*CreateSnapshotInput) CreateSnapshotRequest
}

CreateSnapshotRequest is the request type for the CreateSnapshot API operation.

func (CreateSnapshotRequest) Send

Send marshals and sends the CreateSnapshot API request.

type CreateSnapshotResponse added in v0.9.0

type CreateSnapshotResponse struct {
	*CreateSnapshotOutput
	// contains filtered or unexported fields
}

CreateSnapshotResponse is the response type for the CreateSnapshot API operation.

func (*CreateSnapshotResponse) SDKResponseMetdata added in v0.9.0

func (r *CreateSnapshotResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the CreateSnapshot request.

type CustomerNodeEndpoint added in v0.16.0

type CustomerNodeEndpoint struct {

	// The address of the node endpoint
	Address *string `type:"string"`

	// The port of the node endpoint
	Port *int64 `type:"integer"`
	// contains filtered or unexported fields
}

The endpoint from which data should be migrated.

func (CustomerNodeEndpoint) String added in v0.16.0

func (s CustomerNodeEndpoint) String() string

String returns the string representation

type DecreaseNodeGroupsInGlobalReplicationGroupInput added in v0.20.0

type DecreaseNodeGroupsInGlobalReplicationGroupInput struct {

	// Indicates that the shard reconfiguration process begins immediately. At present,
	// the only permitted value for this parameter is true.
	//
	// ApplyImmediately is a required field
	ApplyImmediately *bool `type:"boolean" required:"true"`

	// If the value of NodeGroupCount is less than the current number of node groups
	// (shards), then either NodeGroupsToRemove or NodeGroupsToRetain is required.
	// NodeGroupsToRemove is a list of NodeGroupIds to remove from the cluster.
	// ElastiCache for Redis will attempt to remove all node groups listed by NodeGroupsToRemove
	// from the cluster.
	GlobalNodeGroupsToRemove []string `locationNameList:"GlobalNodeGroupId" type:"list"`

	// If the value of NodeGroupCount is less than the current number of node groups
	// (shards), then either NodeGroupsToRemove or NodeGroupsToRetain is required.
	// NodeGroupsToRemove is a list of NodeGroupIds to remove from the cluster.
	// ElastiCache for Redis will attempt to remove all node groups listed by NodeGroupsToRemove
	// from the cluster.
	GlobalNodeGroupsToRetain []string `locationNameList:"GlobalNodeGroupId" type:"list"`

	// The name of the Global Datastore
	//
	// GlobalReplicationGroupId is a required field
	GlobalReplicationGroupId *string `type:"string" required:"true"`

	// The number of node groups (shards) that results from the modification of
	// the shard configuration
	//
	// NodeGroupCount is a required field
	NodeGroupCount *int64 `type:"integer" required:"true"`
	// contains filtered or unexported fields
}

func (DecreaseNodeGroupsInGlobalReplicationGroupInput) String added in v0.20.0

String returns the string representation

func (*DecreaseNodeGroupsInGlobalReplicationGroupInput) Validate added in v0.20.0

Validate inspects the fields of the type to determine if they are valid.

type DecreaseNodeGroupsInGlobalReplicationGroupOutput added in v0.20.0

type DecreaseNodeGroupsInGlobalReplicationGroupOutput struct {

	// Consists of a primary cluster that accepts writes and an associated secondary
	// cluster that resides in a different AWS region. The secondary cluster accepts
	// only reads. The primary cluster automatically replicates updates to the secondary
	// cluster.
	//
	//    * The GlobalReplicationGroupIdSuffix represents the name of the Global
	//    Datastore, which is what you use to associate a secondary cluster.
	GlobalReplicationGroup *GlobalReplicationGroup `type:"structure"`
	// contains filtered or unexported fields
}

func (DecreaseNodeGroupsInGlobalReplicationGroupOutput) String added in v0.20.0

String returns the string representation

type DecreaseNodeGroupsInGlobalReplicationGroupRequest added in v0.20.0

DecreaseNodeGroupsInGlobalReplicationGroupRequest is the request type for the DecreaseNodeGroupsInGlobalReplicationGroup API operation.

func (DecreaseNodeGroupsInGlobalReplicationGroupRequest) Send added in v0.20.0

Send marshals and sends the DecreaseNodeGroupsInGlobalReplicationGroup API request.

type DecreaseNodeGroupsInGlobalReplicationGroupResponse added in v0.20.0

type DecreaseNodeGroupsInGlobalReplicationGroupResponse struct {
	*DecreaseNodeGroupsInGlobalReplicationGroupOutput
	// contains filtered or unexported fields
}

DecreaseNodeGroupsInGlobalReplicationGroupResponse is the response type for the DecreaseNodeGroupsInGlobalReplicationGroup API operation.

func (*DecreaseNodeGroupsInGlobalReplicationGroupResponse) SDKResponseMetdata added in v0.20.0

SDKResponseMetdata returns the response metadata for the DecreaseNodeGroupsInGlobalReplicationGroup request.

type DecreaseReplicaCountInput added in v0.5.0

type DecreaseReplicaCountInput struct {

	// If True, the number of replica nodes is decreased immediately. ApplyImmediately=False
	// is not currently supported.
	//
	// ApplyImmediately is a required field
	ApplyImmediately *bool `type:"boolean" required:"true"`

	// The number of read replica nodes you want at the completion of this operation.
	// For Redis (cluster mode disabled) replication groups, this is the number
	// of replica nodes in the replication group. For Redis (cluster mode enabled)
	// replication groups, this is the number of replica nodes in each of the replication
	// group's node groups.
	//
	// The minimum number of replicas in a shard or replication group is:
	//
	//    * Redis (cluster mode disabled) If Multi-AZ is enabled: 1 If Multi-AZ
	//    is not enabled: 0
	//
	//    * Redis (cluster mode enabled): 0 (though you will not be able to failover
	//    to a replica if your primary node fails)
	NewReplicaCount *int64 `type:"integer"`

	// A list of ConfigureShard objects that can be used to configure each shard
	// in a Redis (cluster mode enabled) replication group. The ConfigureShard has
	// three members: NewReplicaCount, NodeGroupId, and PreferredAvailabilityZones.
	ReplicaConfiguration []ConfigureShard `locationNameList:"ConfigureShard" type:"list"`

	// A list of the node ids to remove from the replication group or node group
	// (shard).
	ReplicasToRemove []string `type:"list"`

	// The id of the replication group from which you want to remove replica nodes.
	//
	// ReplicationGroupId is a required field
	ReplicationGroupId *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DecreaseReplicaCountInput) String added in v0.5.0

func (s DecreaseReplicaCountInput) String() string

String returns the string representation

func (*DecreaseReplicaCountInput) Validate added in v0.5.0

func (s *DecreaseReplicaCountInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DecreaseReplicaCountOutput added in v0.5.0

type DecreaseReplicaCountOutput struct {

	// Contains all of the attributes of a specific Redis replication group.
	ReplicationGroup *ReplicationGroup `type:"structure"`
	// contains filtered or unexported fields
}

func (DecreaseReplicaCountOutput) String added in v0.5.0

String returns the string representation

type DecreaseReplicaCountRequest added in v0.5.0

type DecreaseReplicaCountRequest struct {
	*aws.Request
	Input *DecreaseReplicaCountInput
	Copy  func(*DecreaseReplicaCountInput) DecreaseReplicaCountRequest
}

DecreaseReplicaCountRequest is the request type for the DecreaseReplicaCount API operation.

func (DecreaseReplicaCountRequest) Send added in v0.5.0

Send marshals and sends the DecreaseReplicaCount API request.

type DecreaseReplicaCountResponse added in v0.9.0

type DecreaseReplicaCountResponse struct {
	*DecreaseReplicaCountOutput
	// contains filtered or unexported fields
}

DecreaseReplicaCountResponse is the response type for the DecreaseReplicaCount API operation.

func (*DecreaseReplicaCountResponse) SDKResponseMetdata added in v0.9.0

func (r *DecreaseReplicaCountResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DecreaseReplicaCount request.

type DeleteCacheClusterInput

type DeleteCacheClusterInput struct {

	// The cluster identifier for the cluster to be deleted. This parameter is not
	// case sensitive.
	//
	// CacheClusterId is a required field
	CacheClusterId *string `type:"string" required:"true"`

	// The user-supplied name of a final cluster snapshot. This is the unique name
	// that identifies the snapshot. ElastiCache creates the snapshot, and then
	// deletes the cluster immediately afterward.
	FinalSnapshotIdentifier *string `type:"string"`
	// contains filtered or unexported fields
}

Represents the input of a DeleteCacheCluster operation.

func (DeleteCacheClusterInput) String

func (s DeleteCacheClusterInput) String() string

String returns the string representation

func (*DeleteCacheClusterInput) Validate

func (s *DeleteCacheClusterInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteCacheClusterOutput

type DeleteCacheClusterOutput struct {

	// Contains all of the attributes of a specific cluster.
	CacheCluster *CacheCluster `type:"structure"`
	// contains filtered or unexported fields
}

func (DeleteCacheClusterOutput) String

func (s DeleteCacheClusterOutput) String() string

String returns the string representation

type DeleteCacheClusterRequest

type DeleteCacheClusterRequest struct {
	*aws.Request
	Input *DeleteCacheClusterInput
	Copy  func(*DeleteCacheClusterInput) DeleteCacheClusterRequest
}

DeleteCacheClusterRequest is the request type for the DeleteCacheCluster API operation.

func (DeleteCacheClusterRequest) Send

Send marshals and sends the DeleteCacheCluster API request.

type DeleteCacheClusterResponse added in v0.9.0

type DeleteCacheClusterResponse struct {
	*DeleteCacheClusterOutput
	// contains filtered or unexported fields
}

DeleteCacheClusterResponse is the response type for the DeleteCacheCluster API operation.

func (*DeleteCacheClusterResponse) SDKResponseMetdata added in v0.9.0

func (r *DeleteCacheClusterResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DeleteCacheCluster request.

type DeleteCacheParameterGroupInput

type DeleteCacheParameterGroupInput struct {

	// The name of the cache parameter group to delete.
	//
	// The specified cache security group must not be associated with any clusters.
	//
	// CacheParameterGroupName is a required field
	CacheParameterGroupName *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

Represents the input of a DeleteCacheParameterGroup operation.

func (DeleteCacheParameterGroupInput) String

String returns the string representation

func (*DeleteCacheParameterGroupInput) Validate

func (s *DeleteCacheParameterGroupInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteCacheParameterGroupOutput

type DeleteCacheParameterGroupOutput struct {
	// contains filtered or unexported fields
}

func (DeleteCacheParameterGroupOutput) String

String returns the string representation

type DeleteCacheParameterGroupRequest

type DeleteCacheParameterGroupRequest struct {
	*aws.Request
	Input *DeleteCacheParameterGroupInput
	Copy  func(*DeleteCacheParameterGroupInput) DeleteCacheParameterGroupRequest
}

DeleteCacheParameterGroupRequest is the request type for the DeleteCacheParameterGroup API operation.

func (DeleteCacheParameterGroupRequest) Send

Send marshals and sends the DeleteCacheParameterGroup API request.

type DeleteCacheParameterGroupResponse added in v0.9.0

type DeleteCacheParameterGroupResponse struct {
	*DeleteCacheParameterGroupOutput
	// contains filtered or unexported fields
}

DeleteCacheParameterGroupResponse is the response type for the DeleteCacheParameterGroup API operation.

func (*DeleteCacheParameterGroupResponse) SDKResponseMetdata added in v0.9.0

func (r *DeleteCacheParameterGroupResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DeleteCacheParameterGroup request.

type DeleteCacheSecurityGroupInput

type DeleteCacheSecurityGroupInput struct {

	// The name of the cache security group to delete.
	//
	// You cannot delete the default security group.
	//
	// CacheSecurityGroupName is a required field
	CacheSecurityGroupName *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

Represents the input of a DeleteCacheSecurityGroup operation.

func (DeleteCacheSecurityGroupInput) String

String returns the string representation

func (*DeleteCacheSecurityGroupInput) Validate

func (s *DeleteCacheSecurityGroupInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteCacheSecurityGroupOutput

type DeleteCacheSecurityGroupOutput struct {
	// contains filtered or unexported fields
}

func (DeleteCacheSecurityGroupOutput) String

String returns the string representation

type DeleteCacheSecurityGroupRequest

type DeleteCacheSecurityGroupRequest struct {
	*aws.Request
	Input *DeleteCacheSecurityGroupInput
	Copy  func(*DeleteCacheSecurityGroupInput) DeleteCacheSecurityGroupRequest
}

DeleteCacheSecurityGroupRequest is the request type for the DeleteCacheSecurityGroup API operation.

func (DeleteCacheSecurityGroupRequest) Send

Send marshals and sends the DeleteCacheSecurityGroup API request.

type DeleteCacheSecurityGroupResponse added in v0.9.0

type DeleteCacheSecurityGroupResponse struct {
	*DeleteCacheSecurityGroupOutput
	// contains filtered or unexported fields
}

DeleteCacheSecurityGroupResponse is the response type for the DeleteCacheSecurityGroup API operation.

func (*DeleteCacheSecurityGroupResponse) SDKResponseMetdata added in v0.9.0

func (r *DeleteCacheSecurityGroupResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DeleteCacheSecurityGroup request.

type DeleteCacheSubnetGroupInput

type DeleteCacheSubnetGroupInput struct {

	// The name of the cache subnet group to delete.
	//
	// Constraints: Must contain no more than 255 alphanumeric characters or hyphens.
	//
	// CacheSubnetGroupName is a required field
	CacheSubnetGroupName *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

Represents the input of a DeleteCacheSubnetGroup operation.

func (DeleteCacheSubnetGroupInput) String

String returns the string representation

func (*DeleteCacheSubnetGroupInput) Validate

func (s *DeleteCacheSubnetGroupInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteCacheSubnetGroupOutput

type DeleteCacheSubnetGroupOutput struct {
	// contains filtered or unexported fields
}

func (DeleteCacheSubnetGroupOutput) String

String returns the string representation

type DeleteCacheSubnetGroupRequest

type DeleteCacheSubnetGroupRequest struct {
	*aws.Request
	Input *DeleteCacheSubnetGroupInput
	Copy  func(*DeleteCacheSubnetGroupInput) DeleteCacheSubnetGroupRequest
}

DeleteCacheSubnetGroupRequest is the request type for the DeleteCacheSubnetGroup API operation.

func (DeleteCacheSubnetGroupRequest) Send

Send marshals and sends the DeleteCacheSubnetGroup API request.

type DeleteCacheSubnetGroupResponse added in v0.9.0

type DeleteCacheSubnetGroupResponse struct {
	*DeleteCacheSubnetGroupOutput
	// contains filtered or unexported fields
}

DeleteCacheSubnetGroupResponse is the response type for the DeleteCacheSubnetGroup API operation.

func (*DeleteCacheSubnetGroupResponse) SDKResponseMetdata added in v0.9.0

func (r *DeleteCacheSubnetGroupResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DeleteCacheSubnetGroup request.

type DeleteGlobalReplicationGroupInput added in v0.20.0

type DeleteGlobalReplicationGroupInput struct {

	// The name of the Global Datastore
	//
	// GlobalReplicationGroupId is a required field
	GlobalReplicationGroupId *string `type:"string" required:"true"`

	// The primary replication group is retained as a standalone replication group.
	//
	// RetainPrimaryReplicationGroup is a required field
	RetainPrimaryReplicationGroup *bool `type:"boolean" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteGlobalReplicationGroupInput) String added in v0.20.0

String returns the string representation

func (*DeleteGlobalReplicationGroupInput) Validate added in v0.20.0

Validate inspects the fields of the type to determine if they are valid.

type DeleteGlobalReplicationGroupOutput added in v0.20.0

type DeleteGlobalReplicationGroupOutput struct {

	// Consists of a primary cluster that accepts writes and an associated secondary
	// cluster that resides in a different AWS region. The secondary cluster accepts
	// only reads. The primary cluster automatically replicates updates to the secondary
	// cluster.
	//
	//    * The GlobalReplicationGroupIdSuffix represents the name of the Global
	//    Datastore, which is what you use to associate a secondary cluster.
	GlobalReplicationGroup *GlobalReplicationGroup `type:"structure"`
	// contains filtered or unexported fields
}

func (DeleteGlobalReplicationGroupOutput) String added in v0.20.0

String returns the string representation

type DeleteGlobalReplicationGroupRequest added in v0.20.0

type DeleteGlobalReplicationGroupRequest struct {
	*aws.Request
	Input *DeleteGlobalReplicationGroupInput
	Copy  func(*DeleteGlobalReplicationGroupInput) DeleteGlobalReplicationGroupRequest
}

DeleteGlobalReplicationGroupRequest is the request type for the DeleteGlobalReplicationGroup API operation.

func (DeleteGlobalReplicationGroupRequest) Send added in v0.20.0

Send marshals and sends the DeleteGlobalReplicationGroup API request.

type DeleteGlobalReplicationGroupResponse added in v0.20.0

type DeleteGlobalReplicationGroupResponse struct {
	*DeleteGlobalReplicationGroupOutput
	// contains filtered or unexported fields
}

DeleteGlobalReplicationGroupResponse is the response type for the DeleteGlobalReplicationGroup API operation.

func (*DeleteGlobalReplicationGroupResponse) SDKResponseMetdata added in v0.20.0

func (r *DeleteGlobalReplicationGroupResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DeleteGlobalReplicationGroup request.

type DeleteReplicationGroupInput

type DeleteReplicationGroupInput struct {

	// The name of a final node group (shard) snapshot. ElastiCache creates the
	// snapshot from the primary node in the cluster, rather than one of the replicas;
	// this is to ensure that it captures the freshest data. After the final snapshot
	// is taken, the replication group is immediately deleted.
	FinalSnapshotIdentifier *string `type:"string"`

	// The identifier for the cluster to be deleted. This parameter is not case
	// sensitive.
	//
	// ReplicationGroupId is a required field
	ReplicationGroupId *string `type:"string" required:"true"`

	// If set to true, all of the read replicas are deleted, but the primary node
	// is retained.
	RetainPrimaryCluster *bool `type:"boolean"`
	// contains filtered or unexported fields
}

Represents the input of a DeleteReplicationGroup operation.

func (DeleteReplicationGroupInput) String

String returns the string representation

func (*DeleteReplicationGroupInput) Validate

func (s *DeleteReplicationGroupInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteReplicationGroupOutput

type DeleteReplicationGroupOutput struct {

	// Contains all of the attributes of a specific Redis replication group.
	ReplicationGroup *ReplicationGroup `type:"structure"`
	// contains filtered or unexported fields
}

func (DeleteReplicationGroupOutput) String

String returns the string representation

type DeleteReplicationGroupRequest

type DeleteReplicationGroupRequest struct {
	*aws.Request
	Input *DeleteReplicationGroupInput
	Copy  func(*DeleteReplicationGroupInput) DeleteReplicationGroupRequest
}

DeleteReplicationGroupRequest is the request type for the DeleteReplicationGroup API operation.

func (DeleteReplicationGroupRequest) Send

Send marshals and sends the DeleteReplicationGroup API request.

type DeleteReplicationGroupResponse added in v0.9.0

type DeleteReplicationGroupResponse struct {
	*DeleteReplicationGroupOutput
	// contains filtered or unexported fields
}

DeleteReplicationGroupResponse is the response type for the DeleteReplicationGroup API operation.

func (*DeleteReplicationGroupResponse) SDKResponseMetdata added in v0.9.0

func (r *DeleteReplicationGroupResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DeleteReplicationGroup request.

type DeleteSnapshotInput

type DeleteSnapshotInput struct {

	// The name of the snapshot to be deleted.
	//
	// SnapshotName is a required field
	SnapshotName *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

Represents the input of a DeleteSnapshot operation.

func (DeleteSnapshotInput) String

func (s DeleteSnapshotInput) String() string

String returns the string representation

func (*DeleteSnapshotInput) Validate

func (s *DeleteSnapshotInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteSnapshotOutput

type DeleteSnapshotOutput struct {

	// Represents a copy of an entire Redis cluster as of the time when the snapshot
	// was taken.
	Snapshot *Snapshot `type:"structure"`
	// contains filtered or unexported fields
}

func (DeleteSnapshotOutput) String

func (s DeleteSnapshotOutput) String() string

String returns the string representation

type DeleteSnapshotRequest

type DeleteSnapshotRequest struct {
	*aws.Request
	Input *DeleteSnapshotInput
	Copy  func(*DeleteSnapshotInput) DeleteSnapshotRequest
}

DeleteSnapshotRequest is the request type for the DeleteSnapshot API operation.

func (DeleteSnapshotRequest) Send

Send marshals and sends the DeleteSnapshot API request.

type DeleteSnapshotResponse added in v0.9.0

type DeleteSnapshotResponse struct {
	*DeleteSnapshotOutput
	// contains filtered or unexported fields
}

DeleteSnapshotResponse is the response type for the DeleteSnapshot API operation.

func (*DeleteSnapshotResponse) SDKResponseMetdata added in v0.9.0

func (r *DeleteSnapshotResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DeleteSnapshot request.

type DescribeCacheClustersInput

type DescribeCacheClustersInput struct {

	// The user-supplied cluster identifier. If this parameter is specified, only
	// information about that specific cluster is returned. This parameter isn't
	// case sensitive.
	CacheClusterId *string `type:"string"`

	// An optional marker returned from a prior request. Use this marker for pagination
	// of results from this operation. If this parameter is specified, the response
	// includes only records beyond the marker, up to the value specified by MaxRecords.
	Marker *string `type:"string"`

	// The maximum number of records to include in the response. If more records
	// exist than the specified MaxRecords value, a marker is included in the response
	// so that the remaining results can be retrieved.
	//
	// Default: 100
	//
	// Constraints: minimum 20; maximum 100.
	MaxRecords *int64 `type:"integer"`

	// An optional flag that can be included in the DescribeCacheCluster request
	// to show only nodes (API/CLI: clusters) that are not members of a replication
	// group. In practice, this mean Memcached and single node Redis clusters.
	ShowCacheClustersNotInReplicationGroups *bool `type:"boolean"`

	// An optional flag that can be included in the DescribeCacheCluster request
	// to retrieve information about the individual cache nodes.
	ShowCacheNodeInfo *bool `type:"boolean"`
	// contains filtered or unexported fields
}

Represents the input of a DescribeCacheClusters operation.

func (DescribeCacheClustersInput) String

String returns the string representation

type DescribeCacheClustersOutput

type DescribeCacheClustersOutput struct {

	// A list of clusters. Each item in the list contains detailed information about
	// one cluster.
	CacheClusters []CacheCluster `locationNameList:"CacheCluster" type:"list"`

	// Provides an identifier to allow retrieval of paginated results.
	Marker *string `type:"string"`
	// contains filtered or unexported fields
}

Represents the output of a DescribeCacheClusters operation.

func (DescribeCacheClustersOutput) String

String returns the string representation

type DescribeCacheClustersPaginator added in v0.9.0

type DescribeCacheClustersPaginator struct {
	aws.Pager
}

DescribeCacheClustersPaginator is used to paginate the request. This can be done by calling Next and CurrentPage.

func NewDescribeCacheClustersPaginator added in v0.9.0

func NewDescribeCacheClustersPaginator(req DescribeCacheClustersRequest) DescribeCacheClustersPaginator

NewDescribeCacheClustersRequestPaginator returns a paginator for DescribeCacheClusters. Use Next method to get the next page, and CurrentPage to get the current response page from the paginator. Next will return false, if there are no more pages, or an error was encountered.

Note: This operation can generate multiple requests to a service.

// Example iterating over pages.
req := client.DescribeCacheClustersRequest(input)
p := elasticache.NewDescribeCacheClustersRequestPaginator(req)

for p.Next(context.TODO()) {
    page := p.CurrentPage()
}

if err := p.Err(); err != nil {
    return err
}

func (*DescribeCacheClustersPaginator) CurrentPage added in v0.9.0

type DescribeCacheClustersRequest

type DescribeCacheClustersRequest struct {
	*aws.Request
	Input *DescribeCacheClustersInput
	Copy  func(*DescribeCacheClustersInput) DescribeCacheClustersRequest
}

DescribeCacheClustersRequest is the request type for the DescribeCacheClusters API operation.

func (DescribeCacheClustersRequest) Send

Send marshals and sends the DescribeCacheClusters API request.

type DescribeCacheClustersResponse added in v0.9.0

type DescribeCacheClustersResponse struct {
	*DescribeCacheClustersOutput
	// contains filtered or unexported fields
}

DescribeCacheClustersResponse is the response type for the DescribeCacheClusters API operation.

func (*DescribeCacheClustersResponse) SDKResponseMetdata added in v0.9.0

func (r *DescribeCacheClustersResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DescribeCacheClusters request.

type DescribeCacheEngineVersionsInput

type DescribeCacheEngineVersionsInput struct {

	// The name of a specific cache parameter group family to return details for.
	//
	// Valid values are: memcached1.4 | memcached1.5 | redis2.6 | redis2.8 | redis3.2
	// | redis4.0 | redis5.0 |
	//
	// Constraints:
	//
	//    * Must be 1 to 255 alphanumeric characters
	//
	//    * First character must be a letter
	//
	//    * Cannot end with a hyphen or contain two consecutive hyphens
	CacheParameterGroupFamily *string `type:"string"`

	// If true, specifies that only the default version of the specified engine
	// or engine and major version combination is to be returned.
	DefaultOnly *bool `type:"boolean"`

	// The cache engine to return. Valid values: memcached | redis
	Engine *string `type:"string"`

	// The cache engine version to return.
	//
	// Example: 1.4.14
	EngineVersion *string `type:"string"`

	// An optional marker returned from a prior request. Use this marker for pagination
	// of results from this operation. If this parameter is specified, the response
	// includes only records beyond the marker, up to the value specified by MaxRecords.
	Marker *string `type:"string"`

	// The maximum number of records to include in the response. If more records
	// exist than the specified MaxRecords value, a marker is included in the response
	// so that the remaining results can be retrieved.
	//
	// Default: 100
	//
	// Constraints: minimum 20; maximum 100.
	MaxRecords *int64 `type:"integer"`
	// contains filtered or unexported fields
}

Represents the input of a DescribeCacheEngineVersions operation.

func (DescribeCacheEngineVersionsInput) String

String returns the string representation

type DescribeCacheEngineVersionsOutput

type DescribeCacheEngineVersionsOutput struct {

	// A list of cache engine version details. Each element in the list contains
	// detailed information about one cache engine version.
	CacheEngineVersions []CacheEngineVersion `locationNameList:"CacheEngineVersion" type:"list"`

	// Provides an identifier to allow retrieval of paginated results.
	Marker *string `type:"string"`
	// contains filtered or unexported fields
}

Represents the output of a DescribeCacheEngineVersions operation.

func (DescribeCacheEngineVersionsOutput) String

String returns the string representation

type DescribeCacheEngineVersionsPaginator added in v0.9.0

type DescribeCacheEngineVersionsPaginator struct {
	aws.Pager
}

DescribeCacheEngineVersionsPaginator is used to paginate the request. This can be done by calling Next and CurrentPage.

func NewDescribeCacheEngineVersionsPaginator added in v0.9.0

func NewDescribeCacheEngineVersionsPaginator(req DescribeCacheEngineVersionsRequest) DescribeCacheEngineVersionsPaginator

NewDescribeCacheEngineVersionsRequestPaginator returns a paginator for DescribeCacheEngineVersions. Use Next method to get the next page, and CurrentPage to get the current response page from the paginator. Next will return false, if there are no more pages, or an error was encountered.

Note: This operation can generate multiple requests to a service.

// Example iterating over pages.
req := client.DescribeCacheEngineVersionsRequest(input)
p := elasticache.NewDescribeCacheEngineVersionsRequestPaginator(req)

for p.Next(context.TODO()) {
    page := p.CurrentPage()
}

if err := p.Err(); err != nil {
    return err
}

func (*DescribeCacheEngineVersionsPaginator) CurrentPage added in v0.9.0

type DescribeCacheEngineVersionsRequest

type DescribeCacheEngineVersionsRequest struct {
	*aws.Request
	Input *DescribeCacheEngineVersionsInput
	Copy  func(*DescribeCacheEngineVersionsInput) DescribeCacheEngineVersionsRequest
}

DescribeCacheEngineVersionsRequest is the request type for the DescribeCacheEngineVersions API operation.

func (DescribeCacheEngineVersionsRequest) Send

Send marshals and sends the DescribeCacheEngineVersions API request.

type DescribeCacheEngineVersionsResponse added in v0.9.0

type DescribeCacheEngineVersionsResponse struct {
	*DescribeCacheEngineVersionsOutput
	// contains filtered or unexported fields
}

DescribeCacheEngineVersionsResponse is the response type for the DescribeCacheEngineVersions API operation.

func (*DescribeCacheEngineVersionsResponse) SDKResponseMetdata added in v0.9.0

func (r *DescribeCacheEngineVersionsResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DescribeCacheEngineVersions request.

type DescribeCacheParameterGroupsInput

type DescribeCacheParameterGroupsInput struct {

	// The name of a specific cache parameter group to return details for.
	CacheParameterGroupName *string `type:"string"`

	// An optional marker returned from a prior request. Use this marker for pagination
	// of results from this operation. If this parameter is specified, the response
	// includes only records beyond the marker, up to the value specified by MaxRecords.
	Marker *string `type:"string"`

	// The maximum number of records to include in the response. If more records
	// exist than the specified MaxRecords value, a marker is included in the response
	// so that the remaining results can be retrieved.
	//
	// Default: 100
	//
	// Constraints: minimum 20; maximum 100.
	MaxRecords *int64 `type:"integer"`
	// contains filtered or unexported fields
}

Represents the input of a DescribeCacheParameterGroups operation.

func (DescribeCacheParameterGroupsInput) String

String returns the string representation

type DescribeCacheParameterGroupsOutput

type DescribeCacheParameterGroupsOutput struct {

	// A list of cache parameter groups. Each element in the list contains detailed
	// information about one cache parameter group.
	CacheParameterGroups []CacheParameterGroup `locationNameList:"CacheParameterGroup" type:"list"`

	// Provides an identifier to allow retrieval of paginated results.
	Marker *string `type:"string"`
	// contains filtered or unexported fields
}

Represents the output of a DescribeCacheParameterGroups operation.

func (DescribeCacheParameterGroupsOutput) String

String returns the string representation

type DescribeCacheParameterGroupsPaginator added in v0.9.0

type DescribeCacheParameterGroupsPaginator struct {
	aws.Pager
}

DescribeCacheParameterGroupsPaginator is used to paginate the request. This can be done by calling Next and CurrentPage.

func NewDescribeCacheParameterGroupsPaginator added in v0.9.0

func NewDescribeCacheParameterGroupsPaginator(req DescribeCacheParameterGroupsRequest) DescribeCacheParameterGroupsPaginator

NewDescribeCacheParameterGroupsRequestPaginator returns a paginator for DescribeCacheParameterGroups. Use Next method to get the next page, and CurrentPage to get the current response page from the paginator. Next will return false, if there are no more pages, or an error was encountered.

Note: This operation can generate multiple requests to a service.

// Example iterating over pages.
req := client.DescribeCacheParameterGroupsRequest(input)
p := elasticache.NewDescribeCacheParameterGroupsRequestPaginator(req)

for p.Next(context.TODO()) {
    page := p.CurrentPage()
}

if err := p.Err(); err != nil {
    return err
}

func (*DescribeCacheParameterGroupsPaginator) CurrentPage added in v0.9.0

type DescribeCacheParameterGroupsRequest

type DescribeCacheParameterGroupsRequest struct {
	*aws.Request
	Input *DescribeCacheParameterGroupsInput
	Copy  func(*DescribeCacheParameterGroupsInput) DescribeCacheParameterGroupsRequest
}

DescribeCacheParameterGroupsRequest is the request type for the DescribeCacheParameterGroups API operation.

func (DescribeCacheParameterGroupsRequest) Send

Send marshals and sends the DescribeCacheParameterGroups API request.

type DescribeCacheParameterGroupsResponse added in v0.9.0

type DescribeCacheParameterGroupsResponse struct {
	*DescribeCacheParameterGroupsOutput
	// contains filtered or unexported fields
}

DescribeCacheParameterGroupsResponse is the response type for the DescribeCacheParameterGroups API operation.

func (*DescribeCacheParameterGroupsResponse) SDKResponseMetdata added in v0.9.0

func (r *DescribeCacheParameterGroupsResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DescribeCacheParameterGroups request.

type DescribeCacheParametersInput

type DescribeCacheParametersInput struct {

	// The name of a specific cache parameter group to return details for.
	//
	// CacheParameterGroupName is a required field
	CacheParameterGroupName *string `type:"string" required:"true"`

	// An optional marker returned from a prior request. Use this marker for pagination
	// of results from this operation. If this parameter is specified, the response
	// includes only records beyond the marker, up to the value specified by MaxRecords.
	Marker *string `type:"string"`

	// The maximum number of records to include in the response. If more records
	// exist than the specified MaxRecords value, a marker is included in the response
	// so that the remaining results can be retrieved.
	//
	// Default: 100
	//
	// Constraints: minimum 20; maximum 100.
	MaxRecords *int64 `type:"integer"`

	// The parameter types to return.
	//
	// Valid values: user | system | engine-default
	Source *string `type:"string"`
	// contains filtered or unexported fields
}

Represents the input of a DescribeCacheParameters operation.

func (DescribeCacheParametersInput) String

String returns the string representation

func (*DescribeCacheParametersInput) Validate

func (s *DescribeCacheParametersInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeCacheParametersOutput

type DescribeCacheParametersOutput struct {

	// A list of parameters specific to a particular cache node type. Each element
	// in the list contains detailed information about one parameter.
	CacheNodeTypeSpecificParameters []CacheNodeTypeSpecificParameter `locationNameList:"CacheNodeTypeSpecificParameter" type:"list"`

	// Provides an identifier to allow retrieval of paginated results.
	Marker *string `type:"string"`

	// A list of Parameter instances.
	Parameters []Parameter `locationNameList:"Parameter" type:"list"`
	// contains filtered or unexported fields
}

Represents the output of a DescribeCacheParameters operation.

func (DescribeCacheParametersOutput) String

String returns the string representation

type DescribeCacheParametersPaginator added in v0.9.0

type DescribeCacheParametersPaginator struct {
	aws.Pager
}

DescribeCacheParametersPaginator is used to paginate the request. This can be done by calling Next and CurrentPage.

func NewDescribeCacheParametersPaginator added in v0.9.0

func NewDescribeCacheParametersPaginator(req DescribeCacheParametersRequest) DescribeCacheParametersPaginator

NewDescribeCacheParametersRequestPaginator returns a paginator for DescribeCacheParameters. Use Next method to get the next page, and CurrentPage to get the current response page from the paginator. Next will return false, if there are no more pages, or an error was encountered.

Note: This operation can generate multiple requests to a service.

// Example iterating over pages.
req := client.DescribeCacheParametersRequest(input)
p := elasticache.NewDescribeCacheParametersRequestPaginator(req)

for p.Next(context.TODO()) {
    page := p.CurrentPage()
}

if err := p.Err(); err != nil {
    return err
}

func (*DescribeCacheParametersPaginator) CurrentPage added in v0.9.0

type DescribeCacheParametersRequest

type DescribeCacheParametersRequest struct {
	*aws.Request
	Input *DescribeCacheParametersInput
	Copy  func(*DescribeCacheParametersInput) DescribeCacheParametersRequest
}

DescribeCacheParametersRequest is the request type for the DescribeCacheParameters API operation.

func (DescribeCacheParametersRequest) Send

Send marshals and sends the DescribeCacheParameters API request.

type DescribeCacheParametersResponse added in v0.9.0

type DescribeCacheParametersResponse struct {
	*DescribeCacheParametersOutput
	// contains filtered or unexported fields
}

DescribeCacheParametersResponse is the response type for the DescribeCacheParameters API operation.

func (*DescribeCacheParametersResponse) SDKResponseMetdata added in v0.9.0

func (r *DescribeCacheParametersResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DescribeCacheParameters request.

type DescribeCacheSecurityGroupsInput

type DescribeCacheSecurityGroupsInput struct {

	// The name of the cache security group to return details for.
	CacheSecurityGroupName *string `type:"string"`

	// An optional marker returned from a prior request. Use this marker for pagination
	// of results from this operation. If this parameter is specified, the response
	// includes only records beyond the marker, up to the value specified by MaxRecords.
	Marker *string `type:"string"`

	// The maximum number of records to include in the response. If more records
	// exist than the specified MaxRecords value, a marker is included in the response
	// so that the remaining results can be retrieved.
	//
	// Default: 100
	//
	// Constraints: minimum 20; maximum 100.
	MaxRecords *int64 `type:"integer"`
	// contains filtered or unexported fields
}

Represents the input of a DescribeCacheSecurityGroups operation.

func (DescribeCacheSecurityGroupsInput) String

String returns the string representation

type DescribeCacheSecurityGroupsOutput

type DescribeCacheSecurityGroupsOutput struct {

	// A list of cache security groups. Each element in the list contains detailed
	// information about one group.
	CacheSecurityGroups []CacheSecurityGroup `locationNameList:"CacheSecurityGroup" type:"list"`

	// Provides an identifier to allow retrieval of paginated results.
	Marker *string `type:"string"`
	// contains filtered or unexported fields
}

Represents the output of a DescribeCacheSecurityGroups operation.

func (DescribeCacheSecurityGroupsOutput) String

String returns the string representation

type DescribeCacheSecurityGroupsPaginator added in v0.9.0

type DescribeCacheSecurityGroupsPaginator struct {
	aws.Pager
}

DescribeCacheSecurityGroupsPaginator is used to paginate the request. This can be done by calling Next and CurrentPage.

func NewDescribeCacheSecurityGroupsPaginator added in v0.9.0

func NewDescribeCacheSecurityGroupsPaginator(req DescribeCacheSecurityGroupsRequest) DescribeCacheSecurityGroupsPaginator

NewDescribeCacheSecurityGroupsRequestPaginator returns a paginator for DescribeCacheSecurityGroups. Use Next method to get the next page, and CurrentPage to get the current response page from the paginator. Next will return false, if there are no more pages, or an error was encountered.

Note: This operation can generate multiple requests to a service.

// Example iterating over pages.
req := client.DescribeCacheSecurityGroupsRequest(input)
p := elasticache.NewDescribeCacheSecurityGroupsRequestPaginator(req)

for p.Next(context.TODO()) {
    page := p.CurrentPage()
}

if err := p.Err(); err != nil {
    return err
}

func (*DescribeCacheSecurityGroupsPaginator) CurrentPage added in v0.9.0

type DescribeCacheSecurityGroupsRequest

type DescribeCacheSecurityGroupsRequest struct {
	*aws.Request
	Input *DescribeCacheSecurityGroupsInput
	Copy  func(*DescribeCacheSecurityGroupsInput) DescribeCacheSecurityGroupsRequest
}

DescribeCacheSecurityGroupsRequest is the request type for the DescribeCacheSecurityGroups API operation.

func (DescribeCacheSecurityGroupsRequest) Send

Send marshals and sends the DescribeCacheSecurityGroups API request.

type DescribeCacheSecurityGroupsResponse added in v0.9.0

type DescribeCacheSecurityGroupsResponse struct {
	*DescribeCacheSecurityGroupsOutput
	// contains filtered or unexported fields
}

DescribeCacheSecurityGroupsResponse is the response type for the DescribeCacheSecurityGroups API operation.

func (*DescribeCacheSecurityGroupsResponse) SDKResponseMetdata added in v0.9.0

func (r *DescribeCacheSecurityGroupsResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DescribeCacheSecurityGroups request.

type DescribeCacheSubnetGroupsInput

type DescribeCacheSubnetGroupsInput struct {

	// The name of the cache subnet group to return details for.
	CacheSubnetGroupName *string `type:"string"`

	// An optional marker returned from a prior request. Use this marker for pagination
	// of results from this operation. If this parameter is specified, the response
	// includes only records beyond the marker, up to the value specified by MaxRecords.
	Marker *string `type:"string"`

	// The maximum number of records to include in the response. If more records
	// exist than the specified MaxRecords value, a marker is included in the response
	// so that the remaining results can be retrieved.
	//
	// Default: 100
	//
	// Constraints: minimum 20; maximum 100.
	MaxRecords *int64 `type:"integer"`
	// contains filtered or unexported fields
}

Represents the input of a DescribeCacheSubnetGroups operation.

func (DescribeCacheSubnetGroupsInput) String

String returns the string representation

type DescribeCacheSubnetGroupsOutput

type DescribeCacheSubnetGroupsOutput struct {

	// A list of cache subnet groups. Each element in the list contains detailed
	// information about one group.
	CacheSubnetGroups []CacheSubnetGroup `locationNameList:"CacheSubnetGroup" type:"list"`

	// Provides an identifier to allow retrieval of paginated results.
	Marker *string `type:"string"`
	// contains filtered or unexported fields
}

Represents the output of a DescribeCacheSubnetGroups operation.

func (DescribeCacheSubnetGroupsOutput) String

String returns the string representation

type DescribeCacheSubnetGroupsPaginator added in v0.9.0

type DescribeCacheSubnetGroupsPaginator struct {
	aws.Pager
}

DescribeCacheSubnetGroupsPaginator is used to paginate the request. This can be done by calling Next and CurrentPage.

func NewDescribeCacheSubnetGroupsPaginator added in v0.9.0

func NewDescribeCacheSubnetGroupsPaginator(req DescribeCacheSubnetGroupsRequest) DescribeCacheSubnetGroupsPaginator

NewDescribeCacheSubnetGroupsRequestPaginator returns a paginator for DescribeCacheSubnetGroups. Use Next method to get the next page, and CurrentPage to get the current response page from the paginator. Next will return false, if there are no more pages, or an error was encountered.

Note: This operation can generate multiple requests to a service.

// Example iterating over pages.
req := client.DescribeCacheSubnetGroupsRequest(input)
p := elasticache.NewDescribeCacheSubnetGroupsRequestPaginator(req)

for p.Next(context.TODO()) {
    page := p.CurrentPage()
}

if err := p.Err(); err != nil {
    return err
}

func (*DescribeCacheSubnetGroupsPaginator) CurrentPage added in v0.9.0

type DescribeCacheSubnetGroupsRequest

type DescribeCacheSubnetGroupsRequest struct {
	*aws.Request
	Input *DescribeCacheSubnetGroupsInput
	Copy  func(*DescribeCacheSubnetGroupsInput) DescribeCacheSubnetGroupsRequest
}

DescribeCacheSubnetGroupsRequest is the request type for the DescribeCacheSubnetGroups API operation.

func (DescribeCacheSubnetGroupsRequest) Send

Send marshals and sends the DescribeCacheSubnetGroups API request.

type DescribeCacheSubnetGroupsResponse added in v0.9.0

type DescribeCacheSubnetGroupsResponse struct {
	*DescribeCacheSubnetGroupsOutput
	// contains filtered or unexported fields
}

DescribeCacheSubnetGroupsResponse is the response type for the DescribeCacheSubnetGroups API operation.

func (*DescribeCacheSubnetGroupsResponse) SDKResponseMetdata added in v0.9.0

func (r *DescribeCacheSubnetGroupsResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DescribeCacheSubnetGroups request.

type DescribeEngineDefaultParametersInput

type DescribeEngineDefaultParametersInput struct {

	// The name of the cache parameter group family.
	//
	// Valid values are: memcached1.4 | memcached1.5 | redis2.6 | redis2.8 | redis3.2
	// | redis4.0 | redis5.0 |
	//
	// CacheParameterGroupFamily is a required field
	CacheParameterGroupFamily *string `type:"string" required:"true"`

	// An optional marker returned from a prior request. Use this marker for pagination
	// of results from this operation. If this parameter is specified, the response
	// includes only records beyond the marker, up to the value specified by MaxRecords.
	Marker *string `type:"string"`

	// The maximum number of records to include in the response. If more records
	// exist than the specified MaxRecords value, a marker is included in the response
	// so that the remaining results can be retrieved.
	//
	// Default: 100
	//
	// Constraints: minimum 20; maximum 100.
	MaxRecords *int64 `type:"integer"`
	// contains filtered or unexported fields
}

Represents the input of a DescribeEngineDefaultParameters operation.

func (DescribeEngineDefaultParametersInput) String

String returns the string representation

func (*DescribeEngineDefaultParametersInput) Validate

Validate inspects the fields of the type to determine if they are valid.

type DescribeEngineDefaultParametersOutput

type DescribeEngineDefaultParametersOutput struct {

	// Represents the output of a DescribeEngineDefaultParameters operation.
	EngineDefaults *EngineDefaults `type:"structure"`
	// contains filtered or unexported fields
}

func (DescribeEngineDefaultParametersOutput) String

String returns the string representation

type DescribeEngineDefaultParametersPaginator added in v0.9.0

type DescribeEngineDefaultParametersPaginator struct {
	aws.Pager
}

DescribeEngineDefaultParametersPaginator is used to paginate the request. This can be done by calling Next and CurrentPage.

func NewDescribeEngineDefaultParametersPaginator added in v0.9.0

func NewDescribeEngineDefaultParametersPaginator(req DescribeEngineDefaultParametersRequest) DescribeEngineDefaultParametersPaginator

NewDescribeEngineDefaultParametersRequestPaginator returns a paginator for DescribeEngineDefaultParameters. Use Next method to get the next page, and CurrentPage to get the current response page from the paginator. Next will return false, if there are no more pages, or an error was encountered.

Note: This operation can generate multiple requests to a service.

// Example iterating over pages.
req := client.DescribeEngineDefaultParametersRequest(input)
p := elasticache.NewDescribeEngineDefaultParametersRequestPaginator(req)

for p.Next(context.TODO()) {
    page := p.CurrentPage()
}

if err := p.Err(); err != nil {
    return err
}

func (*DescribeEngineDefaultParametersPaginator) CurrentPage added in v0.9.0

type DescribeEngineDefaultParametersRequest

type DescribeEngineDefaultParametersRequest struct {
	*aws.Request
	Input *DescribeEngineDefaultParametersInput
	Copy  func(*DescribeEngineDefaultParametersInput) DescribeEngineDefaultParametersRequest
}

DescribeEngineDefaultParametersRequest is the request type for the DescribeEngineDefaultParameters API operation.

func (DescribeEngineDefaultParametersRequest) Send

Send marshals and sends the DescribeEngineDefaultParameters API request.

type DescribeEngineDefaultParametersResponse added in v0.9.0

type DescribeEngineDefaultParametersResponse struct {
	*DescribeEngineDefaultParametersOutput
	// contains filtered or unexported fields
}

DescribeEngineDefaultParametersResponse is the response type for the DescribeEngineDefaultParameters API operation.

func (*DescribeEngineDefaultParametersResponse) SDKResponseMetdata added in v0.9.0

func (r *DescribeEngineDefaultParametersResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DescribeEngineDefaultParameters request.

type DescribeEventsInput

type DescribeEventsInput struct {

	// The number of minutes worth of events to retrieve.
	Duration *int64 `type:"integer"`

	// The end of the time interval for which to retrieve events, specified in ISO
	// 8601 format.
	//
	// Example: 2017-03-30T07:03:49.555Z
	EndTime *time.Time `type:"timestamp"`

	// An optional marker returned from a prior request. Use this marker for pagination
	// of results from this operation. If this parameter is specified, the response
	// includes only records beyond the marker, up to the value specified by MaxRecords.
	Marker *string `type:"string"`

	// The maximum number of records to include in the response. If more records
	// exist than the specified MaxRecords value, a marker is included in the response
	// so that the remaining results can be retrieved.
	//
	// Default: 100
	//
	// Constraints: minimum 20; maximum 100.
	MaxRecords *int64 `type:"integer"`

	// The identifier of the event source for which events are returned. If not
	// specified, all sources are included in the response.
	SourceIdentifier *string `type:"string"`

	// The event source to retrieve events for. If no value is specified, all events
	// are returned.
	SourceType SourceType `type:"string" enum:"true"`

	// The beginning of the time interval to retrieve events for, specified in ISO
	// 8601 format.
	//
	// Example: 2017-03-30T07:03:49.555Z
	StartTime *time.Time `type:"timestamp"`
	// contains filtered or unexported fields
}

Represents the input of a DescribeEvents operation.

func (DescribeEventsInput) String

func (s DescribeEventsInput) String() string

String returns the string representation

type DescribeEventsOutput

type DescribeEventsOutput struct {

	// A list of events. Each element in the list contains detailed information
	// about one event.
	Events []Event `locationNameList:"Event" type:"list"`

	// Provides an identifier to allow retrieval of paginated results.
	Marker *string `type:"string"`
	// contains filtered or unexported fields
}

Represents the output of a DescribeEvents operation.

func (DescribeEventsOutput) String

func (s DescribeEventsOutput) String() string

String returns the string representation

type DescribeEventsPaginator added in v0.9.0

type DescribeEventsPaginator struct {
	aws.Pager
}

DescribeEventsPaginator is used to paginate the request. This can be done by calling Next and CurrentPage.

func NewDescribeEventsPaginator added in v0.9.0

func NewDescribeEventsPaginator(req DescribeEventsRequest) DescribeEventsPaginator

NewDescribeEventsRequestPaginator returns a paginator for DescribeEvents. Use Next method to get the next page, and CurrentPage to get the current response page from the paginator. Next will return false, if there are no more pages, or an error was encountered.

Note: This operation can generate multiple requests to a service.

// Example iterating over pages.
req := client.DescribeEventsRequest(input)
p := elasticache.NewDescribeEventsRequestPaginator(req)

for p.Next(context.TODO()) {
    page := p.CurrentPage()
}

if err := p.Err(); err != nil {
    return err
}

func (*DescribeEventsPaginator) CurrentPage added in v0.9.0

type DescribeEventsRequest

type DescribeEventsRequest struct {
	*aws.Request
	Input *DescribeEventsInput
	Copy  func(*DescribeEventsInput) DescribeEventsRequest
}

DescribeEventsRequest is the request type for the DescribeEvents API operation.

func (DescribeEventsRequest) Send

Send marshals and sends the DescribeEvents API request.

type DescribeEventsResponse added in v0.9.0

type DescribeEventsResponse struct {
	*DescribeEventsOutput
	// contains filtered or unexported fields
}

DescribeEventsResponse is the response type for the DescribeEvents API operation.

func (*DescribeEventsResponse) SDKResponseMetdata added in v0.9.0

func (r *DescribeEventsResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DescribeEvents request.

type DescribeGlobalReplicationGroupsInput added in v0.20.0

type DescribeGlobalReplicationGroupsInput struct {

	// The name of the Global Datastore
	GlobalReplicationGroupId *string `type:"string"`

	// An optional marker returned from a prior request. Use this marker for pagination
	// of results from this operation. If this parameter is specified, the response
	// includes only records beyond the marker, up to the value specified by MaxRecords.
	Marker *string `type:"string"`

	// The maximum number of records to include in the response. If more records
	// exist than the specified MaxRecords value, a marker is included in the response
	// so that the remaining results can be retrieved.
	MaxRecords *int64 `type:"integer"`

	// Returns the list of members that comprise the Global Datastore.
	ShowMemberInfo *bool `type:"boolean"`
	// contains filtered or unexported fields
}

func (DescribeGlobalReplicationGroupsInput) String added in v0.20.0

String returns the string representation

type DescribeGlobalReplicationGroupsOutput added in v0.20.0

type DescribeGlobalReplicationGroupsOutput struct {

	// Indicates the slot configuration and global identifier for each slice group.
	GlobalReplicationGroups []GlobalReplicationGroup `locationNameList:"GlobalReplicationGroup" type:"list"`

	// An optional marker returned from a prior request. Use this marker for pagination
	// of results from this operation. If this parameter is specified, the response
	// includes only records beyond the marker, up to the value specified by MaxRecords.
	// >
	Marker *string `type:"string"`
	// contains filtered or unexported fields
}

func (DescribeGlobalReplicationGroupsOutput) String added in v0.20.0

String returns the string representation

type DescribeGlobalReplicationGroupsPaginator added in v0.20.0

type DescribeGlobalReplicationGroupsPaginator struct {
	aws.Pager
}

DescribeGlobalReplicationGroupsPaginator is used to paginate the request. This can be done by calling Next and CurrentPage.

func NewDescribeGlobalReplicationGroupsPaginator added in v0.20.0

func NewDescribeGlobalReplicationGroupsPaginator(req DescribeGlobalReplicationGroupsRequest) DescribeGlobalReplicationGroupsPaginator

NewDescribeGlobalReplicationGroupsRequestPaginator returns a paginator for DescribeGlobalReplicationGroups. Use Next method to get the next page, and CurrentPage to get the current response page from the paginator. Next will return false, if there are no more pages, or an error was encountered.

Note: This operation can generate multiple requests to a service.

// Example iterating over pages.
req := client.DescribeGlobalReplicationGroupsRequest(input)
p := elasticache.NewDescribeGlobalReplicationGroupsRequestPaginator(req)

for p.Next(context.TODO()) {
    page := p.CurrentPage()
}

if err := p.Err(); err != nil {
    return err
}

func (*DescribeGlobalReplicationGroupsPaginator) CurrentPage added in v0.20.0

type DescribeGlobalReplicationGroupsRequest added in v0.20.0

type DescribeGlobalReplicationGroupsRequest struct {
	*aws.Request
	Input *DescribeGlobalReplicationGroupsInput
	Copy  func(*DescribeGlobalReplicationGroupsInput) DescribeGlobalReplicationGroupsRequest
}

DescribeGlobalReplicationGroupsRequest is the request type for the DescribeGlobalReplicationGroups API operation.

func (DescribeGlobalReplicationGroupsRequest) Send added in v0.20.0

Send marshals and sends the DescribeGlobalReplicationGroups API request.

type DescribeGlobalReplicationGroupsResponse added in v0.20.0

type DescribeGlobalReplicationGroupsResponse struct {
	*DescribeGlobalReplicationGroupsOutput
	// contains filtered or unexported fields
}

DescribeGlobalReplicationGroupsResponse is the response type for the DescribeGlobalReplicationGroups API operation.

func (*DescribeGlobalReplicationGroupsResponse) SDKResponseMetdata added in v0.20.0

func (r *DescribeGlobalReplicationGroupsResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DescribeGlobalReplicationGroups request.

type DescribeReplicationGroupsInput

type DescribeReplicationGroupsInput struct {

	// An optional marker returned from a prior request. Use this marker for pagination
	// of results from this operation. If this parameter is specified, the response
	// includes only records beyond the marker, up to the value specified by MaxRecords.
	Marker *string `type:"string"`

	// The maximum number of records to include in the response. If more records
	// exist than the specified MaxRecords value, a marker is included in the response
	// so that the remaining results can be retrieved.
	//
	// Default: 100
	//
	// Constraints: minimum 20; maximum 100.
	MaxRecords *int64 `type:"integer"`

	// The identifier for the replication group to be described. This parameter
	// is not case sensitive.
	//
	// If you do not specify this parameter, information about all replication groups
	// is returned.
	ReplicationGroupId *string `type:"string"`
	// contains filtered or unexported fields
}

Represents the input of a DescribeReplicationGroups operation.

func (DescribeReplicationGroupsInput) String

String returns the string representation

type DescribeReplicationGroupsOutput

type DescribeReplicationGroupsOutput struct {

	// Provides an identifier to allow retrieval of paginated results.
	Marker *string `type:"string"`

	// A list of replication groups. Each item in the list contains detailed information
	// about one replication group.
	ReplicationGroups []ReplicationGroup `locationNameList:"ReplicationGroup" type:"list"`
	// contains filtered or unexported fields
}

Represents the output of a DescribeReplicationGroups operation.

func (DescribeReplicationGroupsOutput) String

String returns the string representation

type DescribeReplicationGroupsPaginator added in v0.9.0

type DescribeReplicationGroupsPaginator struct {
	aws.Pager
}

DescribeReplicationGroupsPaginator is used to paginate the request. This can be done by calling Next and CurrentPage.

func NewDescribeReplicationGroupsPaginator added in v0.9.0

func NewDescribeReplicationGroupsPaginator(req DescribeReplicationGroupsRequest) DescribeReplicationGroupsPaginator

NewDescribeReplicationGroupsRequestPaginator returns a paginator for DescribeReplicationGroups. Use Next method to get the next page, and CurrentPage to get the current response page from the paginator. Next will return false, if there are no more pages, or an error was encountered.

Note: This operation can generate multiple requests to a service.

// Example iterating over pages.
req := client.DescribeReplicationGroupsRequest(input)
p := elasticache.NewDescribeReplicationGroupsRequestPaginator(req)

for p.Next(context.TODO()) {
    page := p.CurrentPage()
}

if err := p.Err(); err != nil {
    return err
}

func (*DescribeReplicationGroupsPaginator) CurrentPage added in v0.9.0

type DescribeReplicationGroupsRequest

type DescribeReplicationGroupsRequest struct {
	*aws.Request
	Input *DescribeReplicationGroupsInput
	Copy  func(*DescribeReplicationGroupsInput) DescribeReplicationGroupsRequest
}

DescribeReplicationGroupsRequest is the request type for the DescribeReplicationGroups API operation.

func (DescribeReplicationGroupsRequest) Send

Send marshals and sends the DescribeReplicationGroups API request.

type DescribeReplicationGroupsResponse added in v0.9.0

type DescribeReplicationGroupsResponse struct {
	*DescribeReplicationGroupsOutput
	// contains filtered or unexported fields
}

DescribeReplicationGroupsResponse is the response type for the DescribeReplicationGroups API operation.

func (*DescribeReplicationGroupsResponse) SDKResponseMetdata added in v0.9.0

func (r *DescribeReplicationGroupsResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DescribeReplicationGroups request.

type DescribeReservedCacheNodesInput

type DescribeReservedCacheNodesInput struct {

	// The cache node type filter value. Use this parameter to show only those reservations
	// matching the specified cache node type.
	//
	// 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: M5 node types: cache.m5.large,
	//    cache.m5.xlarge, cache.m5.2xlarge, cache.m5.4xlarge, cache.m5.12xlarge,
	//    cache.m5.24xlarge M4 node types: cache.m4.large, cache.m4.xlarge, cache.m4.2xlarge,
	//    cache.m4.4xlarge, cache.m4.10xlarge T3 node types: cache.t3.micro, cache.t3.small,
	//    cache.t3.medium T2 node types: cache.t2.micro, cache.t2.small, cache.t2.medium
	//    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
	//    M3 node types: cache.m3.medium, cache.m3.large, cache.m3.xlarge, cache.m3.2xlarge
	//
	//    * Compute optimized: Previous generation: (not recommended) C1 node types:
	//    cache.c1.xlarge
	//
	//    * Memory optimized: Current generation: R5 node types: cache.r5.large,
	//    cache.r5.xlarge, cache.r5.2xlarge, cache.r5.4xlarge, cache.r5.12xlarge,
	//    cache.r5.24xlarge R4 node types: cache.r4.large, cache.r4.xlarge, cache.r4.2xlarge,
	//    cache.r4.4xlarge, cache.r4.8xlarge, cache.r4.16xlarge Previous generation:
	//    (not recommended) M2 node types: cache.m2.xlarge, cache.m2.2xlarge, cache.m2.4xlarge
	//    R3 node types: cache.r3.large, cache.r3.xlarge, cache.r3.2xlarge, cache.r3.4xlarge,
	//    cache.r3.8xlarge
	//
	// Additional node type info
	//
	//    * All current generation instance types are created in Amazon VPC by default.
	//
	//    * Redis append-only files (AOF) are not supported for T1 or T2 instances.
	//
	//    * Redis Multi-AZ with automatic failover is not supported on T1 instances.
	//
	//    * Redis configuration variables appendonly and appendfsync are not supported
	//    on Redis version 2.8.22 and later.
	CacheNodeType *string `type:"string"`

	// The duration filter value, specified in years or seconds. Use this parameter
	// to show only reservations for this duration.
	//
	// Valid Values: 1 | 3 | 31536000 | 94608000
	Duration *string `type:"string"`

	// An optional marker returned from a prior request. Use this marker for pagination
	// of results from this operation. If this parameter is specified, the response
	// includes only records beyond the marker, up to the value specified by MaxRecords.
	Marker *string `type:"string"`

	// The maximum number of records to include in the response. If more records
	// exist than the specified MaxRecords value, a marker is included in the response
	// so that the remaining results can be retrieved.
	//
	// Default: 100
	//
	// Constraints: minimum 20; maximum 100.
	MaxRecords *int64 `type:"integer"`

	// The offering type filter value. Use this parameter to show only the available
	// offerings matching the specified offering type.
	//
	// Valid values: "Light Utilization"|"Medium Utilization"|"Heavy Utilization"
	OfferingType *string `type:"string"`

	// The product description filter value. Use this parameter to show only those
	// reservations matching the specified product description.
	ProductDescription *string `type:"string"`

	// The reserved cache node identifier filter value. Use this parameter to show
	// only the reservation that matches the specified reservation ID.
	ReservedCacheNodeId *string `type:"string"`

	// The offering identifier filter value. Use this parameter to show only purchased
	// reservations matching the specified offering identifier.
	ReservedCacheNodesOfferingId *string `type:"string"`
	// contains filtered or unexported fields
}

Represents the input of a DescribeReservedCacheNodes operation.

func (DescribeReservedCacheNodesInput) String

String returns the string representation

type DescribeReservedCacheNodesOfferingsInput

type DescribeReservedCacheNodesOfferingsInput struct {

	// The cache node type filter value. Use this parameter to show only the available
	// offerings matching the specified cache node type.
	//
	// 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: M5 node types: cache.m5.large,
	//    cache.m5.xlarge, cache.m5.2xlarge, cache.m5.4xlarge, cache.m5.12xlarge,
	//    cache.m5.24xlarge M4 node types: cache.m4.large, cache.m4.xlarge, cache.m4.2xlarge,
	//    cache.m4.4xlarge, cache.m4.10xlarge T3 node types: cache.t3.micro, cache.t3.small,
	//    cache.t3.medium T2 node types: cache.t2.micro, cache.t2.small, cache.t2.medium
	//    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
	//    M3 node types: cache.m3.medium, cache.m3.large, cache.m3.xlarge, cache.m3.2xlarge
	//
	//    * Compute optimized: Previous generation: (not recommended) C1 node types:
	//    cache.c1.xlarge
	//
	//    * Memory optimized: Current generation: R5 node types: cache.r5.large,
	//    cache.r5.xlarge, cache.r5.2xlarge, cache.r5.4xlarge, cache.r5.12xlarge,
	//    cache.r5.24xlarge R4 node types: cache.r4.large, cache.r4.xlarge, cache.r4.2xlarge,
	//    cache.r4.4xlarge, cache.r4.8xlarge, cache.r4.16xlarge Previous generation:
	//    (not recommended) M2 node types: cache.m2.xlarge, cache.m2.2xlarge, cache.m2.4xlarge
	//    R3 node types: cache.r3.large, cache.r3.xlarge, cache.r3.2xlarge, cache.r3.4xlarge,
	//    cache.r3.8xlarge
	//
	// Additional node type info
	//
	//    * All current generation instance types are created in Amazon VPC by default.
	//
	//    * Redis append-only files (AOF) are not supported for T1 or T2 instances.
	//
	//    * Redis Multi-AZ with automatic failover is not supported on T1 instances.
	//
	//    * Redis configuration variables appendonly and appendfsync are not supported
	//    on Redis version 2.8.22 and later.
	CacheNodeType *string `type:"string"`

	// Duration filter value, specified in years or seconds. Use this parameter
	// to show only reservations for a given duration.
	//
	// Valid Values: 1 | 3 | 31536000 | 94608000
	Duration *string `type:"string"`

	// An optional marker returned from a prior request. Use this marker for pagination
	// of results from this operation. If this parameter is specified, the response
	// includes only records beyond the marker, up to the value specified by MaxRecords.
	Marker *string `type:"string"`

	// The maximum number of records to include in the response. If more records
	// exist than the specified MaxRecords value, a marker is included in the response
	// so that the remaining results can be retrieved.
	//
	// Default: 100
	//
	// Constraints: minimum 20; maximum 100.
	MaxRecords *int64 `type:"integer"`

	// The offering type filter value. Use this parameter to show only the available
	// offerings matching the specified offering type.
	//
	// Valid Values: "Light Utilization"|"Medium Utilization"|"Heavy Utilization"
	OfferingType *string `type:"string"`

	// The product description filter value. Use this parameter to show only the
	// available offerings matching the specified product description.
	ProductDescription *string `type:"string"`

	// The offering identifier filter value. Use this parameter to show only the
	// available offering that matches the specified reservation identifier.
	//
	// Example: 438012d3-4052-4cc7-b2e3-8d3372e0e706
	ReservedCacheNodesOfferingId *string `type:"string"`
	// contains filtered or unexported fields
}

Represents the input of a DescribeReservedCacheNodesOfferings operation.

func (DescribeReservedCacheNodesOfferingsInput) String

String returns the string representation

type DescribeReservedCacheNodesOfferingsOutput

type DescribeReservedCacheNodesOfferingsOutput struct {

	// Provides an identifier to allow retrieval of paginated results.
	Marker *string `type:"string"`

	// A list of reserved cache node offerings. Each element in the list contains
	// detailed information about one offering.
	ReservedCacheNodesOfferings []ReservedCacheNodesOffering `locationNameList:"ReservedCacheNodesOffering" type:"list"`
	// contains filtered or unexported fields
}

Represents the output of a DescribeReservedCacheNodesOfferings operation.

func (DescribeReservedCacheNodesOfferingsOutput) String

String returns the string representation

type DescribeReservedCacheNodesOfferingsPaginator added in v0.9.0

type DescribeReservedCacheNodesOfferingsPaginator struct {
	aws.Pager
}

DescribeReservedCacheNodesOfferingsPaginator is used to paginate the request. This can be done by calling Next and CurrentPage.

func NewDescribeReservedCacheNodesOfferingsPaginator added in v0.9.0

func NewDescribeReservedCacheNodesOfferingsPaginator(req DescribeReservedCacheNodesOfferingsRequest) DescribeReservedCacheNodesOfferingsPaginator

NewDescribeReservedCacheNodesOfferingsRequestPaginator returns a paginator for DescribeReservedCacheNodesOfferings. Use Next method to get the next page, and CurrentPage to get the current response page from the paginator. Next will return false, if there are no more pages, or an error was encountered.

Note: This operation can generate multiple requests to a service.

// Example iterating over pages.
req := client.DescribeReservedCacheNodesOfferingsRequest(input)
p := elasticache.NewDescribeReservedCacheNodesOfferingsRequestPaginator(req)

for p.Next(context.TODO()) {
    page := p.CurrentPage()
}

if err := p.Err(); err != nil {
    return err
}

func (*DescribeReservedCacheNodesOfferingsPaginator) CurrentPage added in v0.9.0

type DescribeReservedCacheNodesOfferingsRequest

DescribeReservedCacheNodesOfferingsRequest is the request type for the DescribeReservedCacheNodesOfferings API operation.

func (DescribeReservedCacheNodesOfferingsRequest) Send

Send marshals and sends the DescribeReservedCacheNodesOfferings API request.

type DescribeReservedCacheNodesOfferingsResponse added in v0.9.0

type DescribeReservedCacheNodesOfferingsResponse struct {
	*DescribeReservedCacheNodesOfferingsOutput
	// contains filtered or unexported fields
}

DescribeReservedCacheNodesOfferingsResponse is the response type for the DescribeReservedCacheNodesOfferings API operation.

func (*DescribeReservedCacheNodesOfferingsResponse) SDKResponseMetdata added in v0.9.0

func (r *DescribeReservedCacheNodesOfferingsResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DescribeReservedCacheNodesOfferings request.

type DescribeReservedCacheNodesOutput

type DescribeReservedCacheNodesOutput struct {

	// Provides an identifier to allow retrieval of paginated results.
	Marker *string `type:"string"`

	// A list of reserved cache nodes. Each element in the list contains detailed
	// information about one node.
	ReservedCacheNodes []ReservedCacheNode `locationNameList:"ReservedCacheNode" type:"list"`
	// contains filtered or unexported fields
}

Represents the output of a DescribeReservedCacheNodes operation.

func (DescribeReservedCacheNodesOutput) String

String returns the string representation

type DescribeReservedCacheNodesPaginator added in v0.9.0

type DescribeReservedCacheNodesPaginator struct {
	aws.Pager
}

DescribeReservedCacheNodesPaginator is used to paginate the request. This can be done by calling Next and CurrentPage.

func NewDescribeReservedCacheNodesPaginator added in v0.9.0

func NewDescribeReservedCacheNodesPaginator(req DescribeReservedCacheNodesRequest) DescribeReservedCacheNodesPaginator

NewDescribeReservedCacheNodesRequestPaginator returns a paginator for DescribeReservedCacheNodes. Use Next method to get the next page, and CurrentPage to get the current response page from the paginator. Next will return false, if there are no more pages, or an error was encountered.

Note: This operation can generate multiple requests to a service.

// Example iterating over pages.
req := client.DescribeReservedCacheNodesRequest(input)
p := elasticache.NewDescribeReservedCacheNodesRequestPaginator(req)

for p.Next(context.TODO()) {
    page := p.CurrentPage()
}

if err := p.Err(); err != nil {
    return err
}

func (*DescribeReservedCacheNodesPaginator) CurrentPage added in v0.9.0

type DescribeReservedCacheNodesRequest

type DescribeReservedCacheNodesRequest struct {
	*aws.Request
	Input *DescribeReservedCacheNodesInput
	Copy  func(*DescribeReservedCacheNodesInput) DescribeReservedCacheNodesRequest
}

DescribeReservedCacheNodesRequest is the request type for the DescribeReservedCacheNodes API operation.

func (DescribeReservedCacheNodesRequest) Send

Send marshals and sends the DescribeReservedCacheNodes API request.

type DescribeReservedCacheNodesResponse added in v0.9.0

type DescribeReservedCacheNodesResponse struct {
	*DescribeReservedCacheNodesOutput
	// contains filtered or unexported fields
}

DescribeReservedCacheNodesResponse is the response type for the DescribeReservedCacheNodes API operation.

func (*DescribeReservedCacheNodesResponse) SDKResponseMetdata added in v0.9.0

func (r *DescribeReservedCacheNodesResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DescribeReservedCacheNodes request.

type DescribeServiceUpdatesInput added in v0.10.0

type DescribeServiceUpdatesInput struct {

	// An optional marker returned from a prior request. Use this marker for pagination
	// of results from this operation. If this parameter is specified, the response
	// includes only records beyond the marker, up to the value specified by MaxRecords.
	Marker *string `type:"string"`

	// The maximum number of records to include in the response
	MaxRecords *int64 `type:"integer"`

	// The unique ID of the service update
	ServiceUpdateName *string `type:"string"`

	// The status of the service update
	ServiceUpdateStatus []ServiceUpdateStatus `type:"list"`
	// contains filtered or unexported fields
}

func (DescribeServiceUpdatesInput) String added in v0.10.0

String returns the string representation

type DescribeServiceUpdatesOutput added in v0.10.0

type DescribeServiceUpdatesOutput struct {

	// An optional marker returned from a prior request. Use this marker for pagination
	// of results from this operation. If this parameter is specified, the response
	// includes only records beyond the marker, up to the value specified by MaxRecords.
	Marker *string `type:"string"`

	// A list of service updates
	ServiceUpdates []ServiceUpdate `locationNameList:"ServiceUpdate" type:"list"`
	// contains filtered or unexported fields
}

func (DescribeServiceUpdatesOutput) String added in v0.10.0

String returns the string representation

type DescribeServiceUpdatesPaginator added in v0.10.0

type DescribeServiceUpdatesPaginator struct {
	aws.Pager
}

DescribeServiceUpdatesPaginator is used to paginate the request. This can be done by calling Next and CurrentPage.

func NewDescribeServiceUpdatesPaginator added in v0.10.0

func NewDescribeServiceUpdatesPaginator(req DescribeServiceUpdatesRequest) DescribeServiceUpdatesPaginator

NewDescribeServiceUpdatesRequestPaginator returns a paginator for DescribeServiceUpdates. Use Next method to get the next page, and CurrentPage to get the current response page from the paginator. Next will return false, if there are no more pages, or an error was encountered.

Note: This operation can generate multiple requests to a service.

// Example iterating over pages.
req := client.DescribeServiceUpdatesRequest(input)
p := elasticache.NewDescribeServiceUpdatesRequestPaginator(req)

for p.Next(context.TODO()) {
    page := p.CurrentPage()
}

if err := p.Err(); err != nil {
    return err
}

func (*DescribeServiceUpdatesPaginator) CurrentPage added in v0.10.0

type DescribeServiceUpdatesRequest added in v0.10.0

type DescribeServiceUpdatesRequest struct {
	*aws.Request
	Input *DescribeServiceUpdatesInput
	Copy  func(*DescribeServiceUpdatesInput) DescribeServiceUpdatesRequest
}

DescribeServiceUpdatesRequest is the request type for the DescribeServiceUpdates API operation.

func (DescribeServiceUpdatesRequest) Send added in v0.10.0

Send marshals and sends the DescribeServiceUpdates API request.

type DescribeServiceUpdatesResponse added in v0.10.0

type DescribeServiceUpdatesResponse struct {
	*DescribeServiceUpdatesOutput
	// contains filtered or unexported fields
}

DescribeServiceUpdatesResponse is the response type for the DescribeServiceUpdates API operation.

func (*DescribeServiceUpdatesResponse) SDKResponseMetdata added in v0.10.0

func (r *DescribeServiceUpdatesResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DescribeServiceUpdates request.

type DescribeSnapshotsInput

type DescribeSnapshotsInput struct {

	// A user-supplied cluster identifier. If this parameter is specified, only
	// snapshots associated with that specific cluster are described.
	CacheClusterId *string `type:"string"`

	// An optional marker returned from a prior request. Use this marker for pagination
	// of results from this operation. If this parameter is specified, the response
	// includes only records beyond the marker, up to the value specified by MaxRecords.
	Marker *string `type:"string"`

	// The maximum number of records to include in the response. If more records
	// exist than the specified MaxRecords value, a marker is included in the response
	// so that the remaining results can be retrieved.
	//
	// Default: 50
	//
	// Constraints: minimum 20; maximum 50.
	MaxRecords *int64 `type:"integer"`

	// A user-supplied replication group identifier. If this parameter is specified,
	// only snapshots associated with that specific replication group are described.
	ReplicationGroupId *string `type:"string"`

	// A Boolean value which if true, the node group (shard) configuration is included
	// in the snapshot description.
	ShowNodeGroupConfig *bool `type:"boolean"`

	// A user-supplied name of the snapshot. If this parameter is specified, only
	// this snapshot are described.
	SnapshotName *string `type:"string"`

	// If set to system, the output shows snapshots that were automatically created
	// by ElastiCache. If set to user the output shows snapshots that were manually
	// created. If omitted, the output shows both automatically and manually created
	// snapshots.
	SnapshotSource *string `type:"string"`
	// contains filtered or unexported fields
}

Represents the input of a DescribeSnapshotsMessage operation.

func (DescribeSnapshotsInput) String

func (s DescribeSnapshotsInput) String() string

String returns the string representation

type DescribeSnapshotsOutput

type DescribeSnapshotsOutput struct {

	// An optional marker returned from a prior request. Use this marker for pagination
	// of results from this operation. If this parameter is specified, the response
	// includes only records beyond the marker, up to the value specified by MaxRecords.
	Marker *string `type:"string"`

	// A list of snapshots. Each item in the list contains detailed information
	// about one snapshot.
	Snapshots []Snapshot `locationNameList:"Snapshot" type:"list"`
	// contains filtered or unexported fields
}

Represents the output of a DescribeSnapshots operation.

func (DescribeSnapshotsOutput) String

func (s DescribeSnapshotsOutput) String() string

String returns the string representation

type DescribeSnapshotsPaginator added in v0.9.0

type DescribeSnapshotsPaginator struct {
	aws.Pager
}

DescribeSnapshotsPaginator is used to paginate the request. This can be done by calling Next and CurrentPage.

func NewDescribeSnapshotsPaginator added in v0.9.0

func NewDescribeSnapshotsPaginator(req DescribeSnapshotsRequest) DescribeSnapshotsPaginator

NewDescribeSnapshotsRequestPaginator returns a paginator for DescribeSnapshots. Use Next method to get the next page, and CurrentPage to get the current response page from the paginator. Next will return false, if there are no more pages, or an error was encountered.

Note: This operation can generate multiple requests to a service.

// Example iterating over pages.
req := client.DescribeSnapshotsRequest(input)
p := elasticache.NewDescribeSnapshotsRequestPaginator(req)

for p.Next(context.TODO()) {
    page := p.CurrentPage()
}

if err := p.Err(); err != nil {
    return err
}

func (*DescribeSnapshotsPaginator) CurrentPage added in v0.9.0

type DescribeSnapshotsRequest

type DescribeSnapshotsRequest struct {
	*aws.Request
	Input *DescribeSnapshotsInput
	Copy  func(*DescribeSnapshotsInput) DescribeSnapshotsRequest
}

DescribeSnapshotsRequest is the request type for the DescribeSnapshots API operation.

func (DescribeSnapshotsRequest) Send

Send marshals and sends the DescribeSnapshots API request.

type DescribeSnapshotsResponse added in v0.9.0

type DescribeSnapshotsResponse struct {
	*DescribeSnapshotsOutput
	// contains filtered or unexported fields
}

DescribeSnapshotsResponse is the response type for the DescribeSnapshots API operation.

func (*DescribeSnapshotsResponse) SDKResponseMetdata added in v0.9.0

func (r *DescribeSnapshotsResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DescribeSnapshots request.

type DescribeUpdateActionsInput added in v0.10.0

type DescribeUpdateActionsInput struct {

	// The cache cluster IDs
	CacheClusterIds []string `type:"list"`

	// The Elasticache engine to which the update applies. Either Redis or Memcached
	Engine *string `type:"string"`

	// An optional marker returned from a prior request. Use this marker for pagination
	// of results from this operation. If this parameter is specified, the response
	// includes only records beyond the marker, up to the value specified by MaxRecords.
	Marker *string `type:"string"`

	// The maximum number of records to include in the response
	MaxRecords *int64 `type:"integer"`

	// The replication group IDs
	ReplicationGroupIds []string `type:"list"`

	// The unique ID of the service update
	ServiceUpdateName *string `type:"string"`

	// The status of the service update
	ServiceUpdateStatus []ServiceUpdateStatus `type:"list"`

	// The range of time specified to search for service updates that are in available
	// status
	ServiceUpdateTimeRange *TimeRangeFilter `type:"structure"`

	// Dictates whether to include node level update status in the response
	ShowNodeLevelUpdateStatus *bool `type:"boolean"`

	// The status of the update action.
	UpdateActionStatus []UpdateActionStatus `type:"list"`
	// contains filtered or unexported fields
}

func (DescribeUpdateActionsInput) String added in v0.10.0

String returns the string representation

type DescribeUpdateActionsOutput added in v0.10.0

type DescribeUpdateActionsOutput struct {

	// An optional marker returned from a prior request. Use this marker for pagination
	// of results from this operation. If this parameter is specified, the response
	// includes only records beyond the marker, up to the value specified by MaxRecords.
	Marker *string `type:"string"`

	// Returns a list of update actions
	UpdateActions []UpdateAction `locationNameList:"UpdateAction" type:"list"`
	// contains filtered or unexported fields
}

func (DescribeUpdateActionsOutput) String added in v0.10.0

String returns the string representation

type DescribeUpdateActionsPaginator added in v0.10.0

type DescribeUpdateActionsPaginator struct {
	aws.Pager
}

DescribeUpdateActionsPaginator is used to paginate the request. This can be done by calling Next and CurrentPage.

func NewDescribeUpdateActionsPaginator added in v0.10.0

func NewDescribeUpdateActionsPaginator(req DescribeUpdateActionsRequest) DescribeUpdateActionsPaginator

NewDescribeUpdateActionsRequestPaginator returns a paginator for DescribeUpdateActions. Use Next method to get the next page, and CurrentPage to get the current response page from the paginator. Next will return false, if there are no more pages, or an error was encountered.

Note: This operation can generate multiple requests to a service.

// Example iterating over pages.
req := client.DescribeUpdateActionsRequest(input)
p := elasticache.NewDescribeUpdateActionsRequestPaginator(req)

for p.Next(context.TODO()) {
    page := p.CurrentPage()
}

if err := p.Err(); err != nil {
    return err
}

func (*DescribeUpdateActionsPaginator) CurrentPage added in v0.10.0

type DescribeUpdateActionsRequest added in v0.10.0

type DescribeUpdateActionsRequest struct {
	*aws.Request
	Input *DescribeUpdateActionsInput
	Copy  func(*DescribeUpdateActionsInput) DescribeUpdateActionsRequest
}

DescribeUpdateActionsRequest is the request type for the DescribeUpdateActions API operation.

func (DescribeUpdateActionsRequest) Send added in v0.10.0

Send marshals and sends the DescribeUpdateActions API request.

type DescribeUpdateActionsResponse added in v0.10.0

type DescribeUpdateActionsResponse struct {
	*DescribeUpdateActionsOutput
	// contains filtered or unexported fields
}

DescribeUpdateActionsResponse is the response type for the DescribeUpdateActions API operation.

func (*DescribeUpdateActionsResponse) SDKResponseMetdata added in v0.10.0

func (r *DescribeUpdateActionsResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DescribeUpdateActions request.

type DisassociateGlobalReplicationGroupInput added in v0.20.0

type DisassociateGlobalReplicationGroupInput struct {

	// The name of the Global Datastore
	//
	// GlobalReplicationGroupId is a required field
	GlobalReplicationGroupId *string `type:"string" required:"true"`

	// The name of the secondary cluster you wish to remove from the Global Datastore
	//
	// ReplicationGroupId is a required field
	ReplicationGroupId *string `type:"string" required:"true"`

	// The AWS region of secondary cluster you wish to remove from the Global Datastore
	//
	// ReplicationGroupRegion is a required field
	ReplicationGroupRegion *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DisassociateGlobalReplicationGroupInput) String added in v0.20.0

String returns the string representation

func (*DisassociateGlobalReplicationGroupInput) Validate added in v0.20.0

Validate inspects the fields of the type to determine if they are valid.

type DisassociateGlobalReplicationGroupOutput added in v0.20.0

type DisassociateGlobalReplicationGroupOutput struct {

	// Consists of a primary cluster that accepts writes and an associated secondary
	// cluster that resides in a different AWS region. The secondary cluster accepts
	// only reads. The primary cluster automatically replicates updates to the secondary
	// cluster.
	//
	//    * The GlobalReplicationGroupIdSuffix represents the name of the Global
	//    Datastore, which is what you use to associate a secondary cluster.
	GlobalReplicationGroup *GlobalReplicationGroup `type:"structure"`
	// contains filtered or unexported fields
}

func (DisassociateGlobalReplicationGroupOutput) String added in v0.20.0

String returns the string representation

type DisassociateGlobalReplicationGroupRequest added in v0.20.0

DisassociateGlobalReplicationGroupRequest is the request type for the DisassociateGlobalReplicationGroup API operation.

func (DisassociateGlobalReplicationGroupRequest) Send added in v0.20.0

Send marshals and sends the DisassociateGlobalReplicationGroup API request.

type DisassociateGlobalReplicationGroupResponse added in v0.20.0

type DisassociateGlobalReplicationGroupResponse struct {
	*DisassociateGlobalReplicationGroupOutput
	// contains filtered or unexported fields
}

DisassociateGlobalReplicationGroupResponse is the response type for the DisassociateGlobalReplicationGroup API operation.

func (*DisassociateGlobalReplicationGroupResponse) SDKResponseMetdata added in v0.20.0

func (r *DisassociateGlobalReplicationGroupResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DisassociateGlobalReplicationGroup request.

type EC2SecurityGroup

type EC2SecurityGroup struct {

	// The name of the Amazon EC2 security group.
	EC2SecurityGroupName *string `type:"string"`

	// The AWS account ID of the Amazon EC2 security group owner.
	EC2SecurityGroupOwnerId *string `type:"string"`

	// The status of the Amazon EC2 security group.
	Status *string `type:"string"`
	// contains filtered or unexported fields
}

Provides ownership and status information for an Amazon EC2 security group.

func (EC2SecurityGroup) String

func (s EC2SecurityGroup) String() string

String returns the string representation

type Endpoint

type Endpoint struct {

	// The DNS hostname of the cache node.
	Address *string `type:"string"`

	// The port number that the cache engine is listening on.
	Port *int64 `type:"integer"`
	// contains filtered or unexported fields
}

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

func (Endpoint) String

func (s Endpoint) String() string

String returns the string representation

type EngineDefaults

type EngineDefaults struct {

	// A list of parameters specific to a particular cache node type. Each element
	// in the list contains detailed information about one parameter.
	CacheNodeTypeSpecificParameters []CacheNodeTypeSpecificParameter `locationNameList:"CacheNodeTypeSpecificParameter" type:"list"`

	// Specifies the name of the cache parameter group family to which the engine
	// default parameters apply.
	//
	// Valid values are: memcached1.4 | memcached1.5 | redis2.6 | redis2.8 | redis3.2
	// | redis4.0 | redis5.0 |
	CacheParameterGroupFamily *string `type:"string"`

	// Provides an identifier to allow retrieval of paginated results.
	Marker *string `type:"string"`

	// Contains a list of engine default parameters.
	Parameters []Parameter `locationNameList:"Parameter" type:"list"`
	// contains filtered or unexported fields
}

Represents the output of a DescribeEngineDefaultParameters operation.

func (EngineDefaults) String

func (s EngineDefaults) String() string

String returns the string representation

type Event

type Event struct {

	// The date and time when the event occurred.
	Date *time.Time `type:"timestamp"`

	// The text of the event.
	Message *string `type:"string"`

	// The identifier for the source of the event. For example, if the event occurred
	// at the cluster level, the identifier would be the name of the cluster.
	SourceIdentifier *string `type:"string"`

	// Specifies the origin of this event - a cluster, a parameter group, a security
	// group, etc.
	SourceType SourceType `type:"string" enum:"true"`
	// contains filtered or unexported fields
}

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.

func (Event) String

func (s Event) String() string

String returns the string representation

type FailoverGlobalReplicationGroupInput added in v0.20.0

type FailoverGlobalReplicationGroupInput struct {

	// The name of the Global Datastore
	//
	// GlobalReplicationGroupId is a required field
	GlobalReplicationGroupId *string `type:"string" required:"true"`

	// The AWS region of the primary cluster of the Global Datastore
	//
	// PrimaryRegion is a required field
	PrimaryRegion *string `type:"string" required:"true"`

	// The name of the primary replication group
	//
	// PrimaryReplicationGroupId is a required field
	PrimaryReplicationGroupId *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (FailoverGlobalReplicationGroupInput) String added in v0.20.0

String returns the string representation

func (*FailoverGlobalReplicationGroupInput) Validate added in v0.20.0

Validate inspects the fields of the type to determine if they are valid.

type FailoverGlobalReplicationGroupOutput added in v0.20.0

type FailoverGlobalReplicationGroupOutput struct {

	// Consists of a primary cluster that accepts writes and an associated secondary
	// cluster that resides in a different AWS region. The secondary cluster accepts
	// only reads. The primary cluster automatically replicates updates to the secondary
	// cluster.
	//
	//    * The GlobalReplicationGroupIdSuffix represents the name of the Global
	//    Datastore, which is what you use to associate a secondary cluster.
	GlobalReplicationGroup *GlobalReplicationGroup `type:"structure"`
	// contains filtered or unexported fields
}

func (FailoverGlobalReplicationGroupOutput) String added in v0.20.0

String returns the string representation

type FailoverGlobalReplicationGroupRequest added in v0.20.0

type FailoverGlobalReplicationGroupRequest struct {
	*aws.Request
	Input *FailoverGlobalReplicationGroupInput
	Copy  func(*FailoverGlobalReplicationGroupInput) FailoverGlobalReplicationGroupRequest
}

FailoverGlobalReplicationGroupRequest is the request type for the FailoverGlobalReplicationGroup API operation.

func (FailoverGlobalReplicationGroupRequest) Send added in v0.20.0

Send marshals and sends the FailoverGlobalReplicationGroup API request.

type FailoverGlobalReplicationGroupResponse added in v0.20.0

type FailoverGlobalReplicationGroupResponse struct {
	*FailoverGlobalReplicationGroupOutput
	// contains filtered or unexported fields
}

FailoverGlobalReplicationGroupResponse is the response type for the FailoverGlobalReplicationGroup API operation.

func (*FailoverGlobalReplicationGroupResponse) SDKResponseMetdata added in v0.20.0

func (r *FailoverGlobalReplicationGroupResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the FailoverGlobalReplicationGroup request.

type GlobalNodeGroup added in v0.20.0

type GlobalNodeGroup struct {

	// The name of the global node group
	GlobalNodeGroupId *string `type:"string"`

	// The keyspace for this node group
	Slots *string `type:"string"`
	// contains filtered or unexported fields
}

Indicates the slot configuration and global identifier for a slice group.

func (GlobalNodeGroup) String added in v0.20.0

func (s GlobalNodeGroup) String() string

String returns the string representation

type GlobalReplicationGroup added in v0.20.0

type GlobalReplicationGroup struct {

	// The ARN (Amazon Resource Name) of the global replication group.
	ARN *string `type:"string"`

	// A flag that enables encryption at rest when set to true.
	//
	// You cannot modify the value of AtRestEncryptionEnabled after the replication
	// group is created. To enable encryption at rest on a replication group you
	// must set AtRestEncryptionEnabled to true when you create the replication
	// group.
	//
	// Required: Only available when creating a replication group in an Amazon VPC
	// using redis version 3.2.6, 4.x or later.
	AtRestEncryptionEnabled *bool `type:"boolean"`

	// A flag that enables using an AuthToken (password) when issuing Redis commands.
	//
	// Default: false
	AuthTokenEnabled *bool `type:"boolean"`

	// The cache node type of the Global Datastore
	CacheNodeType *string `type:"string"`

	// A flag that indicates whether the Global Datastore is cluster enabled.
	ClusterEnabled *bool `type:"boolean"`

	// The Elasticache engine. For Redis only.
	Engine *string `type:"string"`

	// The Elasticache Redis engine version. For preview, it is Redis version 5.0.5
	// only.
	EngineVersion *string `type:"string"`

	// Indicates the slot configuration and global identifier for each slice group.
	GlobalNodeGroups []GlobalNodeGroup `locationNameList:"GlobalNodeGroup" type:"list"`

	// The optional description of the Global Datastore
	GlobalReplicationGroupDescription *string `type:"string"`

	// The name of the Global Datastore
	GlobalReplicationGroupId *string `type:"string"`

	// The replication groups that comprise the Global Datastore.
	Members []GlobalReplicationGroupMember `locationNameList:"GlobalReplicationGroupMember" type:"list"`

	// The status of the Global Datastore
	Status *string `type:"string"`

	// A flag that enables in-transit encryption when set to true. You cannot modify
	// the value of TransitEncryptionEnabled after the cluster is created. To enable
	// in-transit encryption on a cluster you must set TransitEncryptionEnabled
	// to true when you create a cluster.
	TransitEncryptionEnabled *bool `type:"boolean"`
	// contains filtered or unexported fields
}

Consists of a primary cluster that accepts writes and an associated secondary cluster that resides in a different AWS region. The secondary cluster accepts only reads. The primary cluster automatically replicates updates to the secondary cluster.

  • The GlobalReplicationGroupIdSuffix represents the name of the Global Datastore, which is what you use to associate a secondary cluster.

func (GlobalReplicationGroup) String added in v0.20.0

func (s GlobalReplicationGroup) String() string

String returns the string representation

type GlobalReplicationGroupInfo added in v0.20.0

type GlobalReplicationGroupInfo struct {

	// The name of the Global Datastore
	GlobalReplicationGroupId *string `type:"string"`

	// The role of the replication group in a Global Datastore. Can be primary or
	// secondary.
	GlobalReplicationGroupMemberRole *string `type:"string"`
	// contains filtered or unexported fields
}

The name of the Global Datastore and role of this replication group in the Global Datastore.

func (GlobalReplicationGroupInfo) String added in v0.20.0

String returns the string representation

type GlobalReplicationGroupMember added in v0.20.0

type GlobalReplicationGroupMember struct {

	// Indicates whether automatic failover is enabled for the replication group.
	AutomaticFailover AutomaticFailoverStatus `type:"string" enum:"true"`

	// The replication group id of the Global Datastore member.
	ReplicationGroupId *string `type:"string"`

	// The AWS region of the Global Datastore member.
	ReplicationGroupRegion *string `type:"string"`

	// Indicates the role of the replication group, primary or secondary.
	Role *string `type:"string"`

	// The status of the membership of the replication group.
	Status *string `type:"string"`
	// contains filtered or unexported fields
}

A member of a Global Datastore. It contains the Replication Group Id, the AWS region and the role of the replication group.

func (GlobalReplicationGroupMember) String added in v0.20.0

String returns the string representation

type IncreaseNodeGroupsInGlobalReplicationGroupInput added in v0.20.0

type IncreaseNodeGroupsInGlobalReplicationGroupInput struct {

	// Indicates that the process begins immediately. At present, the only permitted
	// value for this parameter is true.
	//
	// ApplyImmediately is a required field
	ApplyImmediately *bool `type:"boolean" required:"true"`

	// The name of the Global Datastore
	//
	// GlobalReplicationGroupId is a required field
	GlobalReplicationGroupId *string `type:"string" required:"true"`

	// The number of node groups you wish to add
	//
	// NodeGroupCount is a required field
	NodeGroupCount *int64 `type:"integer" required:"true"`

	// Describes the replication group IDs, the AWS regions where they are stored
	// and the shard configuration for each that comprise the Global Datastore
	RegionalConfigurations []RegionalConfiguration `locationNameList:"RegionalConfiguration" type:"list"`
	// contains filtered or unexported fields
}

func (IncreaseNodeGroupsInGlobalReplicationGroupInput) String added in v0.20.0

String returns the string representation

func (*IncreaseNodeGroupsInGlobalReplicationGroupInput) Validate added in v0.20.0

Validate inspects the fields of the type to determine if they are valid.

type IncreaseNodeGroupsInGlobalReplicationGroupOutput added in v0.20.0

type IncreaseNodeGroupsInGlobalReplicationGroupOutput struct {

	// Consists of a primary cluster that accepts writes and an associated secondary
	// cluster that resides in a different AWS region. The secondary cluster accepts
	// only reads. The primary cluster automatically replicates updates to the secondary
	// cluster.
	//
	//    * The GlobalReplicationGroupIdSuffix represents the name of the Global
	//    Datastore, which is what you use to associate a secondary cluster.
	GlobalReplicationGroup *GlobalReplicationGroup `type:"structure"`
	// contains filtered or unexported fields
}

func (IncreaseNodeGroupsInGlobalReplicationGroupOutput) String added in v0.20.0

String returns the string representation

type IncreaseNodeGroupsInGlobalReplicationGroupRequest added in v0.20.0

IncreaseNodeGroupsInGlobalReplicationGroupRequest is the request type for the IncreaseNodeGroupsInGlobalReplicationGroup API operation.

func (IncreaseNodeGroupsInGlobalReplicationGroupRequest) Send added in v0.20.0

Send marshals and sends the IncreaseNodeGroupsInGlobalReplicationGroup API request.

type IncreaseNodeGroupsInGlobalReplicationGroupResponse added in v0.20.0

type IncreaseNodeGroupsInGlobalReplicationGroupResponse struct {
	*IncreaseNodeGroupsInGlobalReplicationGroupOutput
	// contains filtered or unexported fields
}

IncreaseNodeGroupsInGlobalReplicationGroupResponse is the response type for the IncreaseNodeGroupsInGlobalReplicationGroup API operation.

func (*IncreaseNodeGroupsInGlobalReplicationGroupResponse) SDKResponseMetdata added in v0.20.0

SDKResponseMetdata returns the response metadata for the IncreaseNodeGroupsInGlobalReplicationGroup request.

type IncreaseReplicaCountInput added in v0.5.0

type IncreaseReplicaCountInput struct {

	// If True, the number of replica nodes is increased immediately. ApplyImmediately=False
	// is not currently supported.
	//
	// ApplyImmediately is a required field
	ApplyImmediately *bool `type:"boolean" required:"true"`

	// The number of read replica nodes you want at the completion of this operation.
	// For Redis (cluster mode disabled) replication groups, this is the number
	// of replica nodes in the replication group. For Redis (cluster mode enabled)
	// replication groups, this is the number of replica nodes in each of the replication
	// group's node groups.
	NewReplicaCount *int64 `type:"integer"`

	// A list of ConfigureShard objects that can be used to configure each shard
	// in a Redis (cluster mode enabled) replication group. The ConfigureShard has
	// three members: NewReplicaCount, NodeGroupId, and PreferredAvailabilityZones.
	ReplicaConfiguration []ConfigureShard `locationNameList:"ConfigureShard" type:"list"`

	// The id of the replication group to which you want to add replica nodes.
	//
	// ReplicationGroupId is a required field
	ReplicationGroupId *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (IncreaseReplicaCountInput) String added in v0.5.0

func (s IncreaseReplicaCountInput) String() string

String returns the string representation

func (*IncreaseReplicaCountInput) Validate added in v0.5.0

func (s *IncreaseReplicaCountInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type IncreaseReplicaCountOutput added in v0.5.0

type IncreaseReplicaCountOutput struct {

	// Contains all of the attributes of a specific Redis replication group.
	ReplicationGroup *ReplicationGroup `type:"structure"`
	// contains filtered or unexported fields
}

func (IncreaseReplicaCountOutput) String added in v0.5.0

String returns the string representation

type IncreaseReplicaCountRequest added in v0.5.0

type IncreaseReplicaCountRequest struct {
	*aws.Request
	Input *IncreaseReplicaCountInput
	Copy  func(*IncreaseReplicaCountInput) IncreaseReplicaCountRequest
}

IncreaseReplicaCountRequest is the request type for the IncreaseReplicaCount API operation.

func (IncreaseReplicaCountRequest) Send added in v0.5.0

Send marshals and sends the IncreaseReplicaCount API request.

type IncreaseReplicaCountResponse added in v0.9.0

type IncreaseReplicaCountResponse struct {
	*IncreaseReplicaCountOutput
	// contains filtered or unexported fields
}

IncreaseReplicaCountResponse is the response type for the IncreaseReplicaCount API operation.

func (*IncreaseReplicaCountResponse) SDKResponseMetdata added in v0.9.0

func (r *IncreaseReplicaCountResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the IncreaseReplicaCount request.

type ListAllowedNodeTypeModificationsInput

type ListAllowedNodeTypeModificationsInput struct {

	// The name of the cluster you want to scale up to a larger node instanced type.
	// ElastiCache uses the cluster id to identify the current node type of this
	// cluster and from that to create a list of node types you can scale up to.
	//
	// You must provide a value for either the CacheClusterId or the ReplicationGroupId.
	CacheClusterId *string `type:"string"`

	// The name of the replication group want to scale up to a larger node type.
	// ElastiCache uses the replication group id to identify the current node type
	// being used by this replication group, and from that to create a list of node
	// types you can scale up to.
	//
	// You must provide a value for either the CacheClusterId or the ReplicationGroupId.
	ReplicationGroupId *string `type:"string"`
	// contains filtered or unexported fields
}

The input parameters for the ListAllowedNodeTypeModifications operation.

func (ListAllowedNodeTypeModificationsInput) String

String returns the string representation

type ListAllowedNodeTypeModificationsOutput

type ListAllowedNodeTypeModificationsOutput struct {

	// A string list, each element of which specifies a cache node type which you
	// can use to scale your cluster or replication group. When scaling down a Redis
	// cluster or replication group using ModifyCacheCluster or ModifyReplicationGroup,
	// use a value from this list for the CacheNodeType parameter.
	ScaleDownModifications []string `type:"list"`

	// A string list, each element of which specifies a cache node type which you
	// can use to scale your cluster or replication group.
	//
	// When scaling up a Redis cluster or replication group using ModifyCacheCluster
	// or ModifyReplicationGroup, use a value from this list for the CacheNodeType
	// parameter.
	ScaleUpModifications []string `type:"list"`
	// contains filtered or unexported fields
}

Represents the allowed node types you can use to modify your cluster or replication group.

func (ListAllowedNodeTypeModificationsOutput) String

String returns the string representation

type ListAllowedNodeTypeModificationsRequest

type ListAllowedNodeTypeModificationsRequest struct {
	*aws.Request
	Input *ListAllowedNodeTypeModificationsInput
	Copy  func(*ListAllowedNodeTypeModificationsInput) ListAllowedNodeTypeModificationsRequest
}

ListAllowedNodeTypeModificationsRequest is the request type for the ListAllowedNodeTypeModifications API operation.

func (ListAllowedNodeTypeModificationsRequest) Send

Send marshals and sends the ListAllowedNodeTypeModifications API request.

type ListAllowedNodeTypeModificationsResponse added in v0.9.0

type ListAllowedNodeTypeModificationsResponse struct {
	*ListAllowedNodeTypeModificationsOutput
	// contains filtered or unexported fields
}

ListAllowedNodeTypeModificationsResponse is the response type for the ListAllowedNodeTypeModifications API operation.

func (*ListAllowedNodeTypeModificationsResponse) SDKResponseMetdata added in v0.9.0

func (r *ListAllowedNodeTypeModificationsResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the ListAllowedNodeTypeModifications request.

type ListTagsForResourceInput

type ListTagsForResourceInput struct {

	// The Amazon Resource Name (ARN) of the resource for which you want the list
	// of tags, for example arn:aws:elasticache:us-west-2:0123456789:cluster:myCluster
	// or arn:aws:elasticache:us-west-2:0123456789:snapshot:mySnapshot.
	//
	// For more information about ARNs, see Amazon Resource Names (ARNs) and AWS
	// Service Namespaces (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html).
	//
	// ResourceName is a required field
	ResourceName *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

The input parameters for the ListTagsForResource operation.

func (ListTagsForResourceInput) String

func (s ListTagsForResourceInput) String() string

String returns the string representation

func (*ListTagsForResourceInput) Validate

func (s *ListTagsForResourceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListTagsForResourceOutput added in v0.9.0

type ListTagsForResourceOutput struct {

	// A list of cost allocation tags as key-value pairs.
	TagList []Tag `locationNameList:"Tag" type:"list"`
	// contains filtered or unexported fields
}

Represents the output from the AddTagsToResource, ListTagsForResource, and RemoveTagsFromResource operations.

func (ListTagsForResourceOutput) String added in v0.9.0

func (s ListTagsForResourceOutput) String() string

String returns the string representation

type ListTagsForResourceRequest

type ListTagsForResourceRequest struct {
	*aws.Request
	Input *ListTagsForResourceInput
	Copy  func(*ListTagsForResourceInput) ListTagsForResourceRequest
}

ListTagsForResourceRequest is the request type for the ListTagsForResource API operation.

func (ListTagsForResourceRequest) Send

Send marshals and sends the ListTagsForResource API request.

type ListTagsForResourceResponse added in v0.9.0

type ListTagsForResourceResponse struct {
	*ListTagsForResourceOutput
	// contains filtered or unexported fields
}

ListTagsForResourceResponse is the response type for the ListTagsForResource API operation.

func (*ListTagsForResourceResponse) SDKResponseMetdata added in v0.9.0

func (r *ListTagsForResourceResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the ListTagsForResource request.

type ModifyCacheClusterInput

type ModifyCacheClusterInput struct {

	// Specifies whether the new nodes in this Memcached cluster are all created
	// in a single Availability Zone or created across multiple Availability Zones.
	//
	// Valid values: single-az | cross-az.
	//
	// This option is only supported for Memcached clusters.
	//
	// You cannot specify single-az if the Memcached cluster already has cache nodes
	// in different Availability Zones. If cross-az is specified, existing Memcached
	// nodes remain in their current Availability Zone.
	//
	// Only newly created nodes are located in different Availability Zones.
	AZMode AZMode `type:"string" enum:"true"`

	// If true, this parameter causes the modifications in this request and any
	// pending modifications to be applied, asynchronously and as soon as possible,
	// regardless of the PreferredMaintenanceWindow setting for the cluster.
	//
	// If false, changes to the cluster are applied on the next maintenance reboot,
	// or the next failure reboot, whichever occurs first.
	//
	// If you perform a ModifyCacheCluster before a pending modification is applied,
	// the pending modification is replaced by the newer modification.
	//
	// Valid values: true | false
	//
	// Default: false
	ApplyImmediately *bool `type:"boolean"`

	// Reserved parameter. The password used to access a password protected server.
	// This parameter must be specified with the auth-token-update parameter. Password
	// constraints:
	//
	//    * Must be only printable ASCII characters
	//
	//    * Must be at least 16 characters and no more than 128 characters in length
	//
	//    * Cannot contain any of the following characters: '/', '"', or '@', '%'
	//
	// For more information, see AUTH password at AUTH (http://redis.io/commands/AUTH).
	AuthToken *string `type:"string"`

	// Specifies the strategy to use to update the AUTH token. This parameter must
	// be specified with the auth-token parameter. Possible values:
	//
	//    * Rotate
	//
	//    * Set
	//
	// For more information, see Authenticating Users with Redis AUTH (https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/auth.html)
	AuthTokenUpdateStrategy AuthTokenUpdateStrategyType `type:"string" enum:"true"`

	// This parameter is currently disabled.
	AutoMinorVersionUpgrade *bool `type:"boolean"`

	// The cluster identifier. This value is stored as a lowercase string.
	//
	// CacheClusterId is a required field
	CacheClusterId *string `type:"string" required:"true"`

	// A list of cache node IDs to be removed. A node ID is a numeric identifier
	// (0001, 0002, etc.). This parameter is only valid when NumCacheNodes is less
	// than the existing number of cache nodes. The number of cache node IDs supplied
	// in this parameter must match the difference between the existing number of
	// cache nodes in the cluster or pending cache nodes, whichever is greater,
	// and the value of NumCacheNodes in the request.
	//
	// For example: If you have 3 active cache nodes, 7 pending cache nodes, and
	// the number of cache nodes in this ModifyCacheCluster call is 5, you must
	// list 2 (7 - 5) cache node IDs to remove.
	CacheNodeIdsToRemove []string `locationNameList:"CacheNodeId" type:"list"`

	// A valid cache node type that you want to scale this cluster up to.
	CacheNodeType *string `type:"string"`

	// The name of the cache parameter group to apply to this cluster. This change
	// is asynchronously applied as soon as possible for parameters when the ApplyImmediately
	// parameter is specified as true for this request.
	CacheParameterGroupName *string `type:"string"`

	// A list of cache security group names to authorize on this cluster. This change
	// is asynchronously applied as soon as possible.
	//
	// You can use this parameter only with clusters that are created outside of
	// an Amazon Virtual Private Cloud (Amazon VPC).
	//
	// Constraints: Must contain no more than 255 alphanumeric characters. Must
	// not be "Default".
	CacheSecurityGroupNames []string `locationNameList:"CacheSecurityGroupName" type:"list"`

	// The upgraded version of the cache engine to be run on the cache nodes.
	//
	// Important: You can upgrade to a newer engine version (see Selecting a Cache
	// Engine and Version (https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/SelectEngine.html#VersionManagement)),
	// but you cannot downgrade to an earlier engine version. If you want to use
	// an earlier engine version, you must delete the existing cluster and create
	// it anew with the earlier engine version.
	EngineVersion *string `type:"string"`

	// The list of Availability Zones where the new Memcached cache nodes are created.
	//
	// This parameter is only valid when NumCacheNodes in the request is greater
	// than the sum of the number of active cache nodes and the number of cache
	// nodes pending creation (which may be zero). The number of Availability Zones
	// supplied in this list must match the cache nodes being added in this request.
	//
	// This option is only supported on Memcached clusters.
	//
	// Scenarios:
	//
	//    * Scenario 1: You have 3 active nodes and wish to add 2 nodes. Specify
	//    NumCacheNodes=5 (3 + 2) and optionally specify two Availability Zones
	//    for the two new nodes.
	//
	//    * Scenario 2: You have 3 active nodes and 2 nodes pending creation (from
	//    the scenario 1 call) and want to add 1 more node. Specify NumCacheNodes=6
	//    ((3 + 2) + 1) and optionally specify an Availability Zone for the new
	//    node.
	//
	//    * Scenario 3: You want to cancel all pending operations. Specify NumCacheNodes=3
	//    to cancel all pending operations.
	//
	// The Availability Zone placement of nodes pending creation cannot be modified.
	// If you wish to cancel any nodes pending creation, add 0 nodes by setting
	// NumCacheNodes to the number of current nodes.
	//
	// If cross-az is specified, existing Memcached nodes remain in their current
	// Availability Zone. Only newly created nodes can be located in different Availability
	// Zones. For guidance on how to move existing Memcached nodes to different
	// Availability Zones, see the Availability Zone Considerations section of Cache
	// Node Considerations for Memcached (https://docs.aws.amazon.com/AmazonElastiCache/latest/mem-ug/CacheNodes.SupportedTypes.html).
	//
	// Impact of new add/remove requests upon pending requests
	//
	//    * Scenario-1 Pending Action: Delete New Request: Delete Result: The new
	//    delete, pending or immediate, replaces the pending delete.
	//
	//    * Scenario-2 Pending Action: Delete New Request: Create Result: The new
	//    create, pending or immediate, replaces the pending delete.
	//
	//    * Scenario-3 Pending Action: Create New Request: Delete Result: The new
	//    delete, pending or immediate, replaces the pending create.
	//
	//    * Scenario-4 Pending Action: Create New Request: Create Result: The new
	//    create is added to the pending create. Important: If the new create request
	//    is Apply Immediately - Yes, all creates are performed immediately. If
	//    the new create request is Apply Immediately - No, all creates are pending.
	NewAvailabilityZones []string `locationNameList:"PreferredAvailabilityZone" type:"list"`

	// The Amazon Resource Name (ARN) of the Amazon SNS topic to which notifications
	// are sent.
	//
	// The Amazon SNS topic owner must be same as the cluster owner.
	NotificationTopicArn *string `type:"string"`

	// The status of the Amazon SNS notification topic. Notifications are sent only
	// if the status is active.
	//
	// Valid values: active | inactive
	NotificationTopicStatus *string `type:"string"`

	// The number of cache nodes that the cluster should have. If the value for
	// NumCacheNodes is greater than the sum of the number of current cache nodes
	// and the number of cache nodes pending creation (which may be zero), more
	// nodes are added. If the value is less than the number of existing cache nodes,
	// nodes are removed. If the value is equal to the number of current cache nodes,
	// any pending add or remove requests are canceled.
	//
	// If you are removing cache nodes, you must use the CacheNodeIdsToRemove parameter
	// to provide the IDs of the specific cache nodes to remove.
	//
	// For clusters running Redis, this value must be 1. For clusters running Memcached,
	// this value must be between 1 and 20.
	//
	// Adding or removing Memcached cache nodes can be applied immediately or as
	// a pending operation (see ApplyImmediately).
	//
	// A pending operation to modify the number of cache nodes in a cluster during
	// its maintenance window, whether by adding or removing nodes in accordance
	// with the scale out architecture, is not queued. The customer's latest request
	// to add or remove nodes to the cluster overrides any previous pending operations
	// to modify the number of cache nodes in the cluster. For example, a request
	// to remove 2 nodes would override a previous pending operation to remove 3
	// nodes. Similarly, a request to add 2 nodes would override a previous pending
	// operation to remove 3 nodes and vice versa. As Memcached cache nodes may
	// now be provisioned in different Availability Zones with flexible cache node
	// placement, a request to add nodes does not automatically override a previous
	// pending operation to add nodes. The customer can modify the previous pending
	// operation to add more nodes or explicitly cancel the pending request and
	// retry the new request. To cancel pending operations to modify the number
	// of cache nodes in a cluster, use the ModifyCacheCluster request and set NumCacheNodes
	// equal to the number of cache nodes currently in the cluster.
	NumCacheNodes *int64 `type:"integer"`

	// Specifies the weekly time range during which maintenance on the cluster is
	// performed. It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi
	// (24H Clock UTC). The minimum maintenance window is a 60 minute period.
	//
	// Valid values for ddd are:
	//
	//    * sun
	//
	//    * mon
	//
	//    * tue
	//
	//    * wed
	//
	//    * thu
	//
	//    * fri
	//
	//    * sat
	//
	// Example: sun:23:00-mon:01:30
	PreferredMaintenanceWindow *string `type:"string"`

	// Specifies the VPC Security Groups associated with the cluster.
	//
	// This parameter can be used only with clusters that are created in an Amazon
	// Virtual Private Cloud (Amazon VPC).
	SecurityGroupIds []string `locationNameList:"SecurityGroupId" type:"list"`

	// The number of days for which ElastiCache retains automatic cluster snapshots
	// before deleting them. For example, if you set SnapshotRetentionLimit to 5,
	// a snapshot that was taken today is retained for 5 days before being deleted.
	//
	// If the value of SnapshotRetentionLimit is set to zero (0), backups are turned
	// off.
	SnapshotRetentionLimit *int64 `type:"integer"`

	// The daily time range (in UTC) during which ElastiCache begins taking a daily
	// snapshot of your cluster.
	SnapshotWindow *string `type:"string"`
	// contains filtered or unexported fields
}

Represents the input of a ModifyCacheCluster operation.

func (ModifyCacheClusterInput) String

func (s ModifyCacheClusterInput) String() string

String returns the string representation

func (*ModifyCacheClusterInput) Validate

func (s *ModifyCacheClusterInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ModifyCacheClusterOutput

type ModifyCacheClusterOutput struct {

	// Contains all of the attributes of a specific cluster.
	CacheCluster *CacheCluster `type:"structure"`
	// contains filtered or unexported fields
}

func (ModifyCacheClusterOutput) String

func (s ModifyCacheClusterOutput) String() string

String returns the string representation

type ModifyCacheClusterRequest

type ModifyCacheClusterRequest struct {
	*aws.Request
	Input *ModifyCacheClusterInput
	Copy  func(*ModifyCacheClusterInput) ModifyCacheClusterRequest
}

ModifyCacheClusterRequest is the request type for the ModifyCacheCluster API operation.

func (ModifyCacheClusterRequest) Send

Send marshals and sends the ModifyCacheCluster API request.

type ModifyCacheClusterResponse added in v0.9.0

type ModifyCacheClusterResponse struct {
	*ModifyCacheClusterOutput
	// contains filtered or unexported fields
}

ModifyCacheClusterResponse is the response type for the ModifyCacheCluster API operation.

func (*ModifyCacheClusterResponse) SDKResponseMetdata added in v0.9.0

func (r *ModifyCacheClusterResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the ModifyCacheCluster request.

type ModifyCacheParameterGroupInput

type ModifyCacheParameterGroupInput struct {

	// The name of the cache parameter group to modify.
	//
	// CacheParameterGroupName is a required field
	CacheParameterGroupName *string `type:"string" required:"true"`

	// An array of parameter names and values for the parameter update. You must
	// supply at least one parameter name and value; subsequent arguments are optional.
	// A maximum of 20 parameters may be modified per request.
	//
	// ParameterNameValues is a required field
	ParameterNameValues []ParameterNameValue `locationNameList:"ParameterNameValue" type:"list" required:"true"`
	// contains filtered or unexported fields
}

Represents the input of a ModifyCacheParameterGroup operation.

func (ModifyCacheParameterGroupInput) String

String returns the string representation

func (*ModifyCacheParameterGroupInput) Validate

func (s *ModifyCacheParameterGroupInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ModifyCacheParameterGroupOutput added in v0.9.0

type ModifyCacheParameterGroupOutput struct {

	// The name of the cache parameter group.
	CacheParameterGroupName *string `type:"string"`
	// contains filtered or unexported fields
}

Represents the output of one of the following operations:

  • ModifyCacheParameterGroup

  • ResetCacheParameterGroup

func (ModifyCacheParameterGroupOutput) String added in v0.9.0

String returns the string representation

type ModifyCacheParameterGroupRequest

type ModifyCacheParameterGroupRequest struct {
	*aws.Request
	Input *ModifyCacheParameterGroupInput
	Copy  func(*ModifyCacheParameterGroupInput) ModifyCacheParameterGroupRequest
}

ModifyCacheParameterGroupRequest is the request type for the ModifyCacheParameterGroup API operation.

func (ModifyCacheParameterGroupRequest) Send

Send marshals and sends the ModifyCacheParameterGroup API request.

type ModifyCacheParameterGroupResponse added in v0.9.0

type ModifyCacheParameterGroupResponse struct {
	*ModifyCacheParameterGroupOutput
	// contains filtered or unexported fields
}

ModifyCacheParameterGroupResponse is the response type for the ModifyCacheParameterGroup API operation.

func (*ModifyCacheParameterGroupResponse) SDKResponseMetdata added in v0.9.0

func (r *ModifyCacheParameterGroupResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the ModifyCacheParameterGroup request.

type ModifyCacheSubnetGroupInput

type ModifyCacheSubnetGroupInput struct {

	// A description of the cache subnet group.
	CacheSubnetGroupDescription *string `type:"string"`

	// The name for the cache subnet group. This value is stored as a lowercase
	// string.
	//
	// Constraints: Must contain no more than 255 alphanumeric characters or hyphens.
	//
	// Example: mysubnetgroup
	//
	// CacheSubnetGroupName is a required field
	CacheSubnetGroupName *string `type:"string" required:"true"`

	// The EC2 subnet IDs for the cache subnet group.
	SubnetIds []string `locationNameList:"SubnetIdentifier" type:"list"`
	// contains filtered or unexported fields
}

Represents the input of a ModifyCacheSubnetGroup operation.

func (ModifyCacheSubnetGroupInput) String

String returns the string representation

func (*ModifyCacheSubnetGroupInput) Validate

func (s *ModifyCacheSubnetGroupInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ModifyCacheSubnetGroupOutput

type ModifyCacheSubnetGroupOutput struct {

	// Represents the output of one of the following operations:
	//
	//    * CreateCacheSubnetGroup
	//
	//    * ModifyCacheSubnetGroup
	CacheSubnetGroup *CacheSubnetGroup `type:"structure"`
	// contains filtered or unexported fields
}

func (ModifyCacheSubnetGroupOutput) String

String returns the string representation

type ModifyCacheSubnetGroupRequest

type ModifyCacheSubnetGroupRequest struct {
	*aws.Request
	Input *ModifyCacheSubnetGroupInput
	Copy  func(*ModifyCacheSubnetGroupInput) ModifyCacheSubnetGroupRequest
}

ModifyCacheSubnetGroupRequest is the request type for the ModifyCacheSubnetGroup API operation.

func (ModifyCacheSubnetGroupRequest) Send

Send marshals and sends the ModifyCacheSubnetGroup API request.

type ModifyCacheSubnetGroupResponse added in v0.9.0

type ModifyCacheSubnetGroupResponse struct {
	*ModifyCacheSubnetGroupOutput
	// contains filtered or unexported fields
}

ModifyCacheSubnetGroupResponse is the response type for the ModifyCacheSubnetGroup API operation.

func (*ModifyCacheSubnetGroupResponse) SDKResponseMetdata added in v0.9.0

func (r *ModifyCacheSubnetGroupResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the ModifyCacheSubnetGroup request.

type ModifyGlobalReplicationGroupInput added in v0.20.0

type ModifyGlobalReplicationGroupInput struct {

	// This parameter causes the modifications in this request and any pending modifications
	// to be applied, asynchronously and as soon as possible. Modifications to Global
	// Replication Groups cannot be requested to be applied in PreferredMaintenceWindow.
	//
	// ApplyImmediately is a required field
	ApplyImmediately *bool `type:"boolean" required:"true"`

	// Determines whether a read replica is automatically promoted to read/write
	// primary if the existing primary encounters a failure.
	AutomaticFailoverEnabled *bool `type:"boolean"`

	// A valid cache node type that you want to scale this Global Datastore to.
	CacheNodeType *string `type:"string"`

	// The upgraded version of the cache engine to be run on the clusters in the
	// Global Datastore.
	EngineVersion *string `type:"string"`

	// A description of the Global Datastore
	GlobalReplicationGroupDescription *string `type:"string"`

	// The name of the Global Datastore
	//
	// GlobalReplicationGroupId is a required field
	GlobalReplicationGroupId *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (ModifyGlobalReplicationGroupInput) String added in v0.20.0

String returns the string representation

func (*ModifyGlobalReplicationGroupInput) Validate added in v0.20.0

Validate inspects the fields of the type to determine if they are valid.

type ModifyGlobalReplicationGroupOutput added in v0.20.0

type ModifyGlobalReplicationGroupOutput struct {

	// Consists of a primary cluster that accepts writes and an associated secondary
	// cluster that resides in a different AWS region. The secondary cluster accepts
	// only reads. The primary cluster automatically replicates updates to the secondary
	// cluster.
	//
	//    * The GlobalReplicationGroupIdSuffix represents the name of the Global
	//    Datastore, which is what you use to associate a secondary cluster.
	GlobalReplicationGroup *GlobalReplicationGroup `type:"structure"`
	// contains filtered or unexported fields
}

func (ModifyGlobalReplicationGroupOutput) String added in v0.20.0

String returns the string representation

type ModifyGlobalReplicationGroupRequest added in v0.20.0

type ModifyGlobalReplicationGroupRequest struct {
	*aws.Request
	Input *ModifyGlobalReplicationGroupInput
	Copy  func(*ModifyGlobalReplicationGroupInput) ModifyGlobalReplicationGroupRequest
}

ModifyGlobalReplicationGroupRequest is the request type for the ModifyGlobalReplicationGroup API operation.

func (ModifyGlobalReplicationGroupRequest) Send added in v0.20.0

Send marshals and sends the ModifyGlobalReplicationGroup API request.

type ModifyGlobalReplicationGroupResponse added in v0.20.0

type ModifyGlobalReplicationGroupResponse struct {
	*ModifyGlobalReplicationGroupOutput
	// contains filtered or unexported fields
}

ModifyGlobalReplicationGroupResponse is the response type for the ModifyGlobalReplicationGroup API operation.

func (*ModifyGlobalReplicationGroupResponse) SDKResponseMetdata added in v0.20.0

func (r *ModifyGlobalReplicationGroupResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the ModifyGlobalReplicationGroup request.

type ModifyReplicationGroupInput

type ModifyReplicationGroupInput struct {

	// If true, this parameter causes the modifications in this request and any
	// pending modifications to be applied, asynchronously and as soon as possible,
	// regardless of the PreferredMaintenanceWindow setting for the replication
	// group.
	//
	// If false, changes to the nodes in the replication group are applied on the
	// next maintenance reboot, or the next failure reboot, whichever occurs first.
	//
	// Valid values: true | false
	//
	// Default: false
	ApplyImmediately *bool `type:"boolean"`

	// Reserved parameter. The password used to access a password protected server.
	// This parameter must be specified with the auth-token-update-strategy parameter.
	// Password constraints:
	//
	//    * Must be only printable ASCII characters
	//
	//    * Must be at least 16 characters and no more than 128 characters in length
	//
	//    * Cannot contain any of the following characters: '/', '"', or '@', '%'
	//
	// For more information, see AUTH password at AUTH (http://redis.io/commands/AUTH).
	AuthToken *string `type:"string"`

	// Specifies the strategy to use to update the AUTH token. This parameter must
	// be specified with the auth-token parameter. Possible values:
	//
	//    * Rotate
	//
	//    * Set
	//
	// For more information, see Authenticating Users with Redis AUTH (https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/auth.html)
	AuthTokenUpdateStrategy AuthTokenUpdateStrategyType `type:"string" enum:"true"`

	// This parameter is currently disabled.
	AutoMinorVersionUpgrade *bool `type:"boolean"`

	// Determines whether a read replica is automatically promoted to read/write
	// primary if the existing primary encounters a failure.
	//
	// Valid values: true | false
	AutomaticFailoverEnabled *bool `type:"boolean"`

	// A valid cache node type that you want to scale this replication group to.
	CacheNodeType *string `type:"string"`

	// The name of the cache parameter group to apply to all of the clusters in
	// this replication group. This change is asynchronously applied as soon as
	// possible for parameters when the ApplyImmediately parameter is specified
	// as true for this request.
	CacheParameterGroupName *string `type:"string"`

	// A list of cache security group names to authorize for the clusters in this
	// replication group. This change is asynchronously applied as soon as possible.
	//
	// This parameter can be used only with replication group containing clusters
	// running outside of an Amazon Virtual Private Cloud (Amazon VPC).
	//
	// Constraints: Must contain no more than 255 alphanumeric characters. Must
	// not be Default.
	CacheSecurityGroupNames []string `locationNameList:"CacheSecurityGroupName" type:"list"`

	// The upgraded version of the cache engine to be run on the clusters in the
	// replication group.
	//
	// Important: You can upgrade to a newer engine version (see Selecting a Cache
	// Engine and Version (https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/SelectEngine.html#VersionManagement)),
	// but you cannot downgrade to an earlier engine version. If you want to use
	// an earlier engine version, you must delete the existing replication group
	// and create it anew with the earlier engine version.
	EngineVersion *string `type:"string"`

	// A flag indicating if you have Multi-AZ enabled to enhance fault tolerance.
	// For more information, see Minimizing Downtime: Multi-AZ (http://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/AutoFailover.html).
	MultiAZEnabled *bool `type:"boolean"`

	// Deprecated. This parameter is not used.
	NodeGroupId *string `deprecated:"true" type:"string"`

	// The Amazon Resource Name (ARN) of the Amazon SNS topic to which notifications
	// are sent.
	//
	// The Amazon SNS topic owner must be same as the replication group owner.
	NotificationTopicArn *string `type:"string"`

	// The status of the Amazon SNS notification topic for the replication group.
	// Notifications are sent only if the status is active.
	//
	// Valid values: active | inactive
	NotificationTopicStatus *string `type:"string"`

	// Specifies the weekly time range during which maintenance on the cluster is
	// performed. It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi
	// (24H Clock UTC). The minimum maintenance window is a 60 minute period.
	//
	// Valid values for ddd are:
	//
	//    * sun
	//
	//    * mon
	//
	//    * tue
	//
	//    * wed
	//
	//    * thu
	//
	//    * fri
	//
	//    * sat
	//
	// Example: sun:23:00-mon:01:30
	PreferredMaintenanceWindow *string `type:"string"`

	// For replication groups with a single primary, if this parameter is specified,
	// ElastiCache promotes the specified cluster in the specified replication group
	// to the primary role. The nodes of all other clusters in the replication group
	// are read replicas.
	PrimaryClusterId *string `type:"string"`

	// A description for the replication group. Maximum length is 255 characters.
	ReplicationGroupDescription *string `type:"string"`

	// The identifier of the replication group to modify.
	//
	// ReplicationGroupId is a required field
	ReplicationGroupId *string `type:"string" required:"true"`

	// Specifies the VPC Security Groups associated with the clusters in the replication
	// group.
	//
	// This parameter can be used only with replication group containing clusters
	// running in an Amazon Virtual Private Cloud (Amazon VPC).
	SecurityGroupIds []string `locationNameList:"SecurityGroupId" type:"list"`

	// The number of days for which ElastiCache retains automatic node group (shard)
	// snapshots before deleting them. For example, if you set SnapshotRetentionLimit
	// to 5, a snapshot that was taken today is retained for 5 days before being
	// deleted.
	//
	// Important If the value of SnapshotRetentionLimit is set to zero (0), backups
	// are turned off.
	SnapshotRetentionLimit *int64 `type:"integer"`

	// The daily time range (in UTC) during which ElastiCache begins taking a daily
	// snapshot of the node group (shard) specified by SnapshottingClusterId.
	//
	// Example: 05:00-09:00
	//
	// If you do not specify this parameter, ElastiCache automatically chooses an
	// appropriate time range.
	SnapshotWindow *string `type:"string"`

	// The cluster ID that is used as the daily snapshot source for the replication
	// group. This parameter cannot be set for Redis (cluster mode enabled) replication
	// groups.
	SnapshottingClusterId *string `type:"string"`
	// contains filtered or unexported fields
}

Represents the input of a ModifyReplicationGroups operation.

func (ModifyReplicationGroupInput) String

String returns the string representation

func (*ModifyReplicationGroupInput) Validate

func (s *ModifyReplicationGroupInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ModifyReplicationGroupOutput

type ModifyReplicationGroupOutput struct {

	// Contains all of the attributes of a specific Redis replication group.
	ReplicationGroup *ReplicationGroup `type:"structure"`
	// contains filtered or unexported fields
}

func (ModifyReplicationGroupOutput) String

String returns the string representation

type ModifyReplicationGroupRequest

type ModifyReplicationGroupRequest struct {
	*aws.Request
	Input *ModifyReplicationGroupInput
	Copy  func(*ModifyReplicationGroupInput) ModifyReplicationGroupRequest
}

ModifyReplicationGroupRequest is the request type for the ModifyReplicationGroup API operation.

func (ModifyReplicationGroupRequest) Send

Send marshals and sends the ModifyReplicationGroup API request.

type ModifyReplicationGroupResponse added in v0.9.0

type ModifyReplicationGroupResponse struct {
	*ModifyReplicationGroupOutput
	// contains filtered or unexported fields
}

ModifyReplicationGroupResponse is the response type for the ModifyReplicationGroup API operation.

func (*ModifyReplicationGroupResponse) SDKResponseMetdata added in v0.9.0

func (r *ModifyReplicationGroupResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the ModifyReplicationGroup request.

type ModifyReplicationGroupShardConfigurationInput added in v0.2.0

type ModifyReplicationGroupShardConfigurationInput struct {

	// Indicates that the shard reconfiguration process begins immediately. At present,
	// the only permitted value for this parameter is true.
	//
	// Value: true
	//
	// ApplyImmediately is a required field
	ApplyImmediately *bool `type:"boolean" required:"true"`

	// The number of node groups (shards) that results from the modification of
	// the shard configuration.
	//
	// NodeGroupCount is a required field
	NodeGroupCount *int64 `type:"integer" required:"true"`

	// If the value of NodeGroupCount is less than the current number of node groups
	// (shards), then either NodeGroupsToRemove or NodeGroupsToRetain is required.
	// NodeGroupsToRemove is a list of NodeGroupIds to remove from the cluster.
	//
	// ElastiCache for Redis will attempt to remove all node groups listed by NodeGroupsToRemove
	// from the cluster.
	NodeGroupsToRemove []string `locationNameList:"NodeGroupToRemove" type:"list"`

	// If the value of NodeGroupCount is less than the current number of node groups
	// (shards), then either NodeGroupsToRemove or NodeGroupsToRetain is required.
	// NodeGroupsToRetain is a list of NodeGroupIds to retain in the cluster.
	//
	// ElastiCache for Redis will attempt to remove all node groups except those
	// listed by NodeGroupsToRetain from the cluster.
	NodeGroupsToRetain []string `locationNameList:"NodeGroupToRetain" type:"list"`

	// The name of the Redis (cluster mode enabled) cluster (replication group)
	// on which the shards are to be configured.
	//
	// ReplicationGroupId is a required field
	ReplicationGroupId *string `type:"string" required:"true"`

	// Specifies the preferred availability zones for each node group in the cluster.
	// If the value of NodeGroupCount is greater than the current number of node
	// groups (shards), you can use this parameter to specify the preferred availability
	// zones of the cluster's shards. If you omit this parameter ElastiCache selects
	// availability zones for you.
	//
	// You can specify this parameter only if the value of NodeGroupCount is greater
	// than the current number of node groups (shards).
	ReshardingConfiguration []ReshardingConfiguration `locationNameList:"ReshardingConfiguration" type:"list"`
	// contains filtered or unexported fields
}

Represents the input for a ModifyReplicationGroupShardConfiguration operation.

func (ModifyReplicationGroupShardConfigurationInput) String added in v0.2.0

String returns the string representation

func (*ModifyReplicationGroupShardConfigurationInput) Validate added in v0.2.0

Validate inspects the fields of the type to determine if they are valid.

type ModifyReplicationGroupShardConfigurationOutput added in v0.2.0

type ModifyReplicationGroupShardConfigurationOutput struct {

	// Contains all of the attributes of a specific Redis replication group.
	ReplicationGroup *ReplicationGroup `type:"structure"`
	// contains filtered or unexported fields
}

func (ModifyReplicationGroupShardConfigurationOutput) String added in v0.2.0

String returns the string representation

type ModifyReplicationGroupShardConfigurationRequest added in v0.2.0

ModifyReplicationGroupShardConfigurationRequest is the request type for the ModifyReplicationGroupShardConfiguration API operation.

func (ModifyReplicationGroupShardConfigurationRequest) Send added in v0.2.0

Send marshals and sends the ModifyReplicationGroupShardConfiguration API request.

type ModifyReplicationGroupShardConfigurationResponse added in v0.9.0

type ModifyReplicationGroupShardConfigurationResponse struct {
	*ModifyReplicationGroupShardConfigurationOutput
	// contains filtered or unexported fields
}

ModifyReplicationGroupShardConfigurationResponse is the response type for the ModifyReplicationGroupShardConfiguration API operation.

func (*ModifyReplicationGroupShardConfigurationResponse) SDKResponseMetdata added in v0.9.0

SDKResponseMetdata returns the response metadata for the ModifyReplicationGroupShardConfiguration request.

type MultiAZStatus added in v0.24.0

type MultiAZStatus string
const (
	MultiAZStatusEnabled  MultiAZStatus = "enabled"
	MultiAZStatusDisabled MultiAZStatus = "disabled"
)

Enum values for MultiAZStatus

func (MultiAZStatus) MarshalValue added in v0.24.0

func (enum MultiAZStatus) MarshalValue() (string, error)

func (MultiAZStatus) MarshalValueBuf added in v0.24.0

func (enum MultiAZStatus) MarshalValueBuf(b []byte) ([]byte, error)

type NodeGroup

type NodeGroup struct {

	// The identifier for the node group (shard). A Redis (cluster mode disabled)
	// replication group contains only 1 node group; therefore, the node group ID
	// is 0001. A Redis (cluster mode enabled) replication group contains 1 to 90
	// node groups numbered 0001 to 0090. Optionally, the user can provide the id
	// for a node group.
	NodeGroupId *string `type:"string"`

	// A list containing information about individual nodes within the node group
	// (shard).
	NodeGroupMembers []NodeGroupMember `locationNameList:"NodeGroupMember" type:"list"`

	// The endpoint of the primary node in this node group (shard).
	PrimaryEndpoint *Endpoint `type:"structure"`

	// The endpoint of the replica nodes in this node group (shard).
	ReaderEndpoint *Endpoint `type:"structure"`

	// The keyspace for this node group (shard).
	Slots *string `type:"string"`

	// The current state of this replication group - creating, available, modifying,
	// deleting.
	Status *string `type:"string"`
	// contains filtered or unexported fields
}

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.

func (NodeGroup) String

func (s NodeGroup) String() string

String returns the string representation

type NodeGroupConfiguration

type NodeGroupConfiguration struct {

	// Either the ElastiCache for Redis supplied 4-digit id or a user supplied id
	// for the node group these configuration values apply to.
	NodeGroupId *string `min:"1" type:"string"`

	// The Availability Zone where the primary node of this node group (shard) is
	// launched.
	PrimaryAvailabilityZone *string `type:"string"`

	// A list of Availability Zones to be used for the read replicas. The number
	// of Availability Zones in this list must match the value of ReplicaCount or
	// ReplicasPerNodeGroup if not specified.
	ReplicaAvailabilityZones []string `locationNameList:"AvailabilityZone" type:"list"`

	// The number of read replica nodes in this node group (shard).
	ReplicaCount *int64 `type:"integer"`

	// A string that specifies the keyspace for a particular node group. Keyspaces
	// range from 0 to 16,383. The string is in the format startkey-endkey.
	//
	// Example: "0-3999"
	Slots *string `type:"string"`
	// contains filtered or unexported fields
}

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

func (NodeGroupConfiguration) String

func (s NodeGroupConfiguration) String() string

String returns the string representation

func (*NodeGroupConfiguration) Validate added in v0.5.0

func (s *NodeGroupConfiguration) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type NodeGroupMember

type NodeGroupMember struct {

	// The ID of the cluster to which the node belongs.
	CacheClusterId *string `type:"string"`

	// The ID of the node within its cluster. A node ID is a numeric identifier
	// (0001, 0002, etc.).
	CacheNodeId *string `type:"string"`

	// The role that is currently assigned to the node - primary or replica. This
	// member is only applicable for Redis (cluster mode disabled) replication groups.
	CurrentRole *string `type:"string"`

	// The name of the Availability Zone in which the node is located.
	PreferredAvailabilityZone *string `type:"string"`

	// The information required for client programs to connect to a node for read
	// operations. The read endpoint is only applicable on Redis (cluster mode disabled)
	// clusters.
	ReadEndpoint *Endpoint `type:"structure"`
	// contains filtered or unexported fields
}

Represents a single node within a node group (shard).

func (NodeGroupMember) String

func (s NodeGroupMember) String() string

String returns the string representation

type NodeGroupMemberUpdateStatus added in v0.10.0

type NodeGroupMemberUpdateStatus struct {

	// The cache cluster ID
	CacheClusterId *string `type:"string"`

	// The node ID of the cache cluster
	CacheNodeId *string `type:"string"`

	// The deletion date of the node
	NodeDeletionDate *time.Time `type:"timestamp"`

	// The end date of the update for a node
	NodeUpdateEndDate *time.Time `type:"timestamp"`

	// Reflects whether the update was initiated by the customer or automatically
	// applied
	NodeUpdateInitiatedBy NodeUpdateInitiatedBy `type:"string" enum:"true"`

	// The date when the update is triggered
	NodeUpdateInitiatedDate *time.Time `type:"timestamp"`

	// The start date of the update for a node
	NodeUpdateStartDate *time.Time `type:"timestamp"`

	// The update status of the node
	NodeUpdateStatus NodeUpdateStatus `type:"string" enum:"true"`

	// The date when the NodeUpdateStatus was last modified
	NodeUpdateStatusModifiedDate *time.Time `type:"timestamp"`
	// contains filtered or unexported fields
}

The status of the service update on the node group member

func (NodeGroupMemberUpdateStatus) String added in v0.10.0

String returns the string representation

type NodeGroupUpdateStatus added in v0.10.0

type NodeGroupUpdateStatus struct {

	// The ID of the node group
	NodeGroupId *string `type:"string"`

	// The status of the service update on the node group member
	NodeGroupMemberUpdateStatus []NodeGroupMemberUpdateStatus `locationNameList:"NodeGroupMemberUpdateStatus" type:"list"`
	// contains filtered or unexported fields
}

The status of the service update on the node group

func (NodeGroupUpdateStatus) String added in v0.10.0

func (s NodeGroupUpdateStatus) String() string

String returns the string representation

type NodeSnapshot

type NodeSnapshot struct {

	// A unique identifier for the source cluster.
	CacheClusterId *string `type:"string"`

	// The date and time when the cache node was created in the source cluster.
	CacheNodeCreateTime *time.Time `type:"timestamp"`

	// The cache node identifier for the node in the source cluster.
	CacheNodeId *string `type:"string"`

	// The size of the cache on the source cache node.
	CacheSize *string `type:"string"`

	// The configuration for the source node group (shard).
	NodeGroupConfiguration *NodeGroupConfiguration `type:"structure"`

	// A unique identifier for the source node group (shard).
	NodeGroupId *string `type:"string"`

	// The date and time when the source node's metadata and cache data set was
	// obtained for the snapshot.
	SnapshotCreateTime *time.Time `type:"timestamp"`
	// contains filtered or unexported fields
}

Represents an individual cache node in a snapshot of a cluster.

func (NodeSnapshot) String

func (s NodeSnapshot) String() string

String returns the string representation

type NodeUpdateInitiatedBy added in v0.10.0

type NodeUpdateInitiatedBy string
const (
	NodeUpdateInitiatedBySystem   NodeUpdateInitiatedBy = "system"
	NodeUpdateInitiatedByCustomer NodeUpdateInitiatedBy = "customer"
)

Enum values for NodeUpdateInitiatedBy

func (NodeUpdateInitiatedBy) MarshalValue added in v0.10.0

func (enum NodeUpdateInitiatedBy) MarshalValue() (string, error)

func (NodeUpdateInitiatedBy) MarshalValueBuf added in v0.10.0

func (enum NodeUpdateInitiatedBy) MarshalValueBuf(b []byte) ([]byte, error)

type NodeUpdateStatus added in v0.10.0

type NodeUpdateStatus string
const (
	NodeUpdateStatusNotApplied     NodeUpdateStatus = "not-applied"
	NodeUpdateStatusWaitingToStart NodeUpdateStatus = "waiting-to-start"
	NodeUpdateStatusInProgress     NodeUpdateStatus = "in-progress"
	NodeUpdateStatusStopping       NodeUpdateStatus = "stopping"
	NodeUpdateStatusStopped        NodeUpdateStatus = "stopped"
	NodeUpdateStatusComplete       NodeUpdateStatus = "complete"
)

Enum values for NodeUpdateStatus

func (NodeUpdateStatus) MarshalValue added in v0.10.0

func (enum NodeUpdateStatus) MarshalValue() (string, error)

func (NodeUpdateStatus) MarshalValueBuf added in v0.10.0

func (enum NodeUpdateStatus) MarshalValueBuf(b []byte) ([]byte, error)

type NotificationConfiguration

type NotificationConfiguration struct {

	// The Amazon Resource Name (ARN) that identifies the topic.
	TopicArn *string `type:"string"`

	// The current state of the topic.
	TopicStatus *string `type:"string"`
	// contains filtered or unexported fields
}

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

func (NotificationConfiguration) String

func (s NotificationConfiguration) String() string

String returns the string representation

type Parameter

type Parameter struct {

	// The valid range of values for the parameter.
	AllowedValues *string `type:"string"`

	// Indicates whether a change to the parameter is applied immediately or requires
	// a reboot for the change to be applied. You can force a reboot or wait until
	// the next maintenance window's reboot. For more information, see Rebooting
	// a Cluster (https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/Clusters.Rebooting.html).
	ChangeType ChangeType `type:"string" enum:"true"`

	// The valid data type for the parameter.
	DataType *string `type:"string"`

	// A description of the parameter.
	Description *string `type:"string"`

	// Indicates whether (true) or not (false) the parameter can be modified. Some
	// parameters have security or operational implications that prevent them from
	// being changed.
	IsModifiable *bool `type:"boolean"`

	// The earliest cache engine version to which the parameter can apply.
	MinimumEngineVersion *string `type:"string"`

	// The name of the parameter.
	ParameterName *string `type:"string"`

	// The value of the parameter.
	ParameterValue *string `type:"string"`

	// The source of the parameter.
	Source *string `type:"string"`
	// contains filtered or unexported fields
}

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

func (Parameter) String

func (s Parameter) String() string

String returns the string representation

type ParameterNameValue

type ParameterNameValue struct {

	// The name of the parameter.
	ParameterName *string `type:"string"`

	// The value of the parameter.
	ParameterValue *string `type:"string"`
	// contains filtered or unexported fields
}

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

func (ParameterNameValue) String

func (s ParameterNameValue) String() string

String returns the string representation

type PendingAutomaticFailoverStatus

type PendingAutomaticFailoverStatus string
const (
	PendingAutomaticFailoverStatusEnabled  PendingAutomaticFailoverStatus = "enabled"
	PendingAutomaticFailoverStatusDisabled PendingAutomaticFailoverStatus = "disabled"
)

Enum values for PendingAutomaticFailoverStatus

func (PendingAutomaticFailoverStatus) MarshalValue added in v0.3.0

func (enum PendingAutomaticFailoverStatus) MarshalValue() (string, error)

func (PendingAutomaticFailoverStatus) MarshalValueBuf added in v0.3.0

func (enum PendingAutomaticFailoverStatus) MarshalValueBuf(b []byte) ([]byte, error)

type PendingModifiedValues

type PendingModifiedValues struct {

	// The auth token status
	AuthTokenStatus AuthTokenUpdateStatus `type:"string" enum:"true"`

	// A list of cache node IDs that are being removed (or will be removed) from
	// the cluster. A node ID is a 4-digit numeric identifier (0001, 0002, etc.).
	CacheNodeIdsToRemove []string `locationNameList:"CacheNodeId" type:"list"`

	// The cache node type that this cluster or replication group is scaled to.
	CacheNodeType *string `type:"string"`

	// The new cache engine version that the cluster runs.
	EngineVersion *string `type:"string"`

	// The new number of cache nodes for the cluster.
	//
	// For clusters running Redis, this value must be 1. For clusters running Memcached,
	// this value must be between 1 and 20.
	NumCacheNodes *int64 `type:"integer"`
	// contains filtered or unexported fields
}

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

func (PendingModifiedValues) String

func (s PendingModifiedValues) String() string

String returns the string representation

type ProcessedUpdateAction added in v0.10.0

type ProcessedUpdateAction struct {

	// The ID of the cache cluster
	CacheClusterId *string `type:"string"`

	// The ID of the replication group
	ReplicationGroupId *string `type:"string"`

	// The unique ID of the service update
	ServiceUpdateName *string `type:"string"`

	// The status of the update action on the Redis cluster
	UpdateActionStatus UpdateActionStatus `type:"string" enum:"true"`
	// contains filtered or unexported fields
}

Update action that has been processed for the corresponding apply/stop request

func (ProcessedUpdateAction) String added in v0.10.0

func (s ProcessedUpdateAction) String() string

String returns the string representation

type PurchaseReservedCacheNodesOfferingInput

type PurchaseReservedCacheNodesOfferingInput struct {

	// The number of cache node instances to reserve.
	//
	// Default: 1
	CacheNodeCount *int64 `type:"integer"`

	// A customer-specified identifier to track this reservation.
	//
	// The Reserved Cache Node ID is an unique customer-specified identifier to
	// track this reservation. If this parameter is not specified, ElastiCache automatically
	// generates an identifier for the reservation.
	//
	// Example: myreservationID
	ReservedCacheNodeId *string `type:"string"`

	// The ID of the reserved cache node offering to purchase.
	//
	// Example: 438012d3-4052-4cc7-b2e3-8d3372e0e706
	//
	// ReservedCacheNodesOfferingId is a required field
	ReservedCacheNodesOfferingId *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

Represents the input of a PurchaseReservedCacheNodesOffering operation.

func (PurchaseReservedCacheNodesOfferingInput) String

String returns the string representation

func (*PurchaseReservedCacheNodesOfferingInput) Validate

Validate inspects the fields of the type to determine if they are valid.

type PurchaseReservedCacheNodesOfferingOutput

type PurchaseReservedCacheNodesOfferingOutput struct {

	// Represents the output of a PurchaseReservedCacheNodesOffering operation.
	ReservedCacheNode *ReservedCacheNode `type:"structure"`
	// contains filtered or unexported fields
}

func (PurchaseReservedCacheNodesOfferingOutput) String

String returns the string representation

type PurchaseReservedCacheNodesOfferingRequest

PurchaseReservedCacheNodesOfferingRequest is the request type for the PurchaseReservedCacheNodesOffering API operation.

func (PurchaseReservedCacheNodesOfferingRequest) Send

Send marshals and sends the PurchaseReservedCacheNodesOffering API request.

type PurchaseReservedCacheNodesOfferingResponse added in v0.9.0

type PurchaseReservedCacheNodesOfferingResponse struct {
	*PurchaseReservedCacheNodesOfferingOutput
	// contains filtered or unexported fields
}

PurchaseReservedCacheNodesOfferingResponse is the response type for the PurchaseReservedCacheNodesOffering API operation.

func (*PurchaseReservedCacheNodesOfferingResponse) SDKResponseMetdata added in v0.9.0

func (r *PurchaseReservedCacheNodesOfferingResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the PurchaseReservedCacheNodesOffering request.

type RebalanceSlotsInGlobalReplicationGroupInput added in v0.20.0

type RebalanceSlotsInGlobalReplicationGroupInput struct {

	// If True, redistribution is applied immediately.
	//
	// ApplyImmediately is a required field
	ApplyImmediately *bool `type:"boolean" required:"true"`

	// The name of the Global Datastore
	//
	// GlobalReplicationGroupId is a required field
	GlobalReplicationGroupId *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (RebalanceSlotsInGlobalReplicationGroupInput) String added in v0.20.0

String returns the string representation

func (*RebalanceSlotsInGlobalReplicationGroupInput) Validate added in v0.20.0

Validate inspects the fields of the type to determine if they are valid.

type RebalanceSlotsInGlobalReplicationGroupOutput added in v0.20.0

type RebalanceSlotsInGlobalReplicationGroupOutput struct {

	// Consists of a primary cluster that accepts writes and an associated secondary
	// cluster that resides in a different AWS region. The secondary cluster accepts
	// only reads. The primary cluster automatically replicates updates to the secondary
	// cluster.
	//
	//    * The GlobalReplicationGroupIdSuffix represents the name of the Global
	//    Datastore, which is what you use to associate a secondary cluster.
	GlobalReplicationGroup *GlobalReplicationGroup `type:"structure"`
	// contains filtered or unexported fields
}

func (RebalanceSlotsInGlobalReplicationGroupOutput) String added in v0.20.0

String returns the string representation

type RebalanceSlotsInGlobalReplicationGroupRequest added in v0.20.0

RebalanceSlotsInGlobalReplicationGroupRequest is the request type for the RebalanceSlotsInGlobalReplicationGroup API operation.

func (RebalanceSlotsInGlobalReplicationGroupRequest) Send added in v0.20.0

Send marshals and sends the RebalanceSlotsInGlobalReplicationGroup API request.

type RebalanceSlotsInGlobalReplicationGroupResponse added in v0.20.0

type RebalanceSlotsInGlobalReplicationGroupResponse struct {
	*RebalanceSlotsInGlobalReplicationGroupOutput
	// contains filtered or unexported fields
}

RebalanceSlotsInGlobalReplicationGroupResponse is the response type for the RebalanceSlotsInGlobalReplicationGroup API operation.

func (*RebalanceSlotsInGlobalReplicationGroupResponse) SDKResponseMetdata added in v0.20.0

SDKResponseMetdata returns the response metadata for the RebalanceSlotsInGlobalReplicationGroup request.

type RebootCacheClusterInput

type RebootCacheClusterInput struct {

	// The cluster identifier. This parameter is stored as a lowercase string.
	//
	// CacheClusterId is a required field
	CacheClusterId *string `type:"string" required:"true"`

	// A list of cache node IDs to reboot. A node ID is a numeric identifier (0001,
	// 0002, etc.). To reboot an entire cluster, specify all of the cache node IDs.
	//
	// CacheNodeIdsToReboot is a required field
	CacheNodeIdsToReboot []string `locationNameList:"CacheNodeId" type:"list" required:"true"`
	// contains filtered or unexported fields
}

Represents the input of a RebootCacheCluster operation.

func (RebootCacheClusterInput) String

func (s RebootCacheClusterInput) String() string

String returns the string representation

func (*RebootCacheClusterInput) Validate

func (s *RebootCacheClusterInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type RebootCacheClusterOutput

type RebootCacheClusterOutput struct {

	// Contains all of the attributes of a specific cluster.
	CacheCluster *CacheCluster `type:"structure"`
	// contains filtered or unexported fields
}

func (RebootCacheClusterOutput) String

func (s RebootCacheClusterOutput) String() string

String returns the string representation

type RebootCacheClusterRequest

type RebootCacheClusterRequest struct {
	*aws.Request
	Input *RebootCacheClusterInput
	Copy  func(*RebootCacheClusterInput) RebootCacheClusterRequest
}

RebootCacheClusterRequest is the request type for the RebootCacheCluster API operation.

func (RebootCacheClusterRequest) Send

Send marshals and sends the RebootCacheCluster API request.

type RebootCacheClusterResponse added in v0.9.0

type RebootCacheClusterResponse struct {
	*RebootCacheClusterOutput
	// contains filtered or unexported fields
}

RebootCacheClusterResponse is the response type for the RebootCacheCluster API operation.

func (*RebootCacheClusterResponse) SDKResponseMetdata added in v0.9.0

func (r *RebootCacheClusterResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the RebootCacheCluster request.

type RecurringCharge

type RecurringCharge struct {

	// The monetary amount of the recurring charge.
	RecurringChargeAmount *float64 `type:"double"`

	// The frequency of the recurring charge.
	RecurringChargeFrequency *string `type:"string"`
	// contains filtered or unexported fields
}

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

func (RecurringCharge) String

func (s RecurringCharge) String() string

String returns the string representation

type RegionalConfiguration added in v0.20.0

type RegionalConfiguration struct {

	// The name of the secondary cluster
	//
	// ReplicationGroupId is a required field
	ReplicationGroupId *string `type:"string" required:"true"`

	// The AWS region where the cluster is stored
	//
	// ReplicationGroupRegion is a required field
	ReplicationGroupRegion *string `type:"string" required:"true"`

	// A list of PreferredAvailabilityZones objects that specifies the configuration
	// of a node group in the resharded cluster.
	//
	// ReshardingConfiguration is a required field
	ReshardingConfiguration []ReshardingConfiguration `locationNameList:"ReshardingConfiguration" type:"list" required:"true"`
	// contains filtered or unexported fields
}

A list of the replication groups

func (RegionalConfiguration) String added in v0.20.0

func (s RegionalConfiguration) String() string

String returns the string representation

func (*RegionalConfiguration) Validate added in v0.20.0

func (s *RegionalConfiguration) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type RemoveTagsFromResourceInput

type RemoveTagsFromResourceInput struct {

	// The Amazon Resource Name (ARN) of the resource from which you want the tags
	// removed, for example arn:aws:elasticache:us-west-2:0123456789:cluster:myCluster
	// or arn:aws:elasticache:us-west-2:0123456789:snapshot:mySnapshot.
	//
	// For more information about ARNs, see Amazon Resource Names (ARNs) and AWS
	// Service Namespaces (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html).
	//
	// ResourceName is a required field
	ResourceName *string `type:"string" required:"true"`

	// A list of TagKeys identifying the tags you want removed from the named resource.
	//
	// TagKeys is a required field
	TagKeys []string `type:"list" required:"true"`
	// contains filtered or unexported fields
}

Represents the input of a RemoveTagsFromResource operation.

func (RemoveTagsFromResourceInput) String

String returns the string representation

func (*RemoveTagsFromResourceInput) Validate

func (s *RemoveTagsFromResourceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type RemoveTagsFromResourceOutput

type RemoveTagsFromResourceOutput struct {

	// A list of cost allocation tags as key-value pairs.
	TagList []Tag `locationNameList:"Tag" type:"list"`
	// contains filtered or unexported fields
}

Represents the output from the AddTagsToResource, ListTagsForResource, and RemoveTagsFromResource operations.

func (RemoveTagsFromResourceOutput) String

String returns the string representation

type RemoveTagsFromResourceRequest

type RemoveTagsFromResourceRequest struct {
	*aws.Request
	Input *RemoveTagsFromResourceInput
	Copy  func(*RemoveTagsFromResourceInput) RemoveTagsFromResourceRequest
}

RemoveTagsFromResourceRequest is the request type for the RemoveTagsFromResource API operation.

func (RemoveTagsFromResourceRequest) Send

Send marshals and sends the RemoveTagsFromResource API request.

type RemoveTagsFromResourceResponse added in v0.9.0

type RemoveTagsFromResourceResponse struct {
	*RemoveTagsFromResourceOutput
	// contains filtered or unexported fields
}

RemoveTagsFromResourceResponse is the response type for the RemoveTagsFromResource API operation.

func (*RemoveTagsFromResourceResponse) SDKResponseMetdata added in v0.9.0

func (r *RemoveTagsFromResourceResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the RemoveTagsFromResource request.

type ReplicationGroup

type ReplicationGroup struct {

	// The ARN (Amazon Resource Name) of the replication group.
	ARN *string `type:"string"`

	// A flag that enables encryption at-rest when set to true.
	//
	// You cannot modify the value of AtRestEncryptionEnabled after the cluster
	// is created. To enable encryption at-rest on a cluster you must set AtRestEncryptionEnabled
	// to true when you create a cluster.
	//
	// Required: Only available when creating a replication group in an Amazon VPC
	// using redis version 3.2.6, 4.x or later.
	//
	// Default: false
	AtRestEncryptionEnabled *bool `type:"boolean"`

	// A flag that enables using an AuthToken (password) when issuing Redis commands.
	//
	// Default: false
	AuthTokenEnabled *bool `type:"boolean"`

	// The date the auth token was last modified
	AuthTokenLastModifiedDate *time.Time `type:"timestamp"`

	// Indicates the status of automatic failover for this Redis replication group.
	AutomaticFailover AutomaticFailoverStatus `type:"string" enum:"true"`

	// The name of the compute and memory capacity node type for each node in the
	// replication group.
	CacheNodeType *string `type:"string"`

	// A flag indicating whether or not this replication group is cluster enabled;
	// i.e., whether its data can be partitioned across multiple shards (API/CLI:
	// node groups).
	//
	// Valid values: true | false
	ClusterEnabled *bool `type:"boolean"`

	// The configuration endpoint for this replication group. Use the configuration
	// endpoint to connect to this replication group.
	ConfigurationEndpoint *Endpoint `type:"structure"`

	// The user supplied description of the replication group.
	Description *string `type:"string"`

	// The name of the Global Datastore and role of this replication group in the
	// Global Datastore.
	GlobalReplicationGroupInfo *GlobalReplicationGroupInfo `type:"structure"`

	// The ID of the KMS key used to encrypt the disk in the cluster.
	KmsKeyId *string `type:"string"`

	// The names of all the cache clusters that are part of this replication group.
	MemberClusters []string `locationNameList:"ClusterId" type:"list"`

	// A flag indicating if you have Multi-AZ enabled to enhance fault tolerance.
	// For more information, see Minimizing Downtime: Multi-AZ (http://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/AutoFailover.html)
	MultiAZ MultiAZStatus `type:"string" enum:"true"`

	// A list of node groups in this replication group. For Redis (cluster mode
	// disabled) replication groups, this is a single-element list. For Redis (cluster
	// mode enabled) replication groups, the list contains an entry for each node
	// group (shard).
	NodeGroups []NodeGroup `locationNameList:"NodeGroup" type:"list"`

	// A group of settings to be applied to the replication group, either immediately
	// or during the next maintenance window.
	PendingModifiedValues *ReplicationGroupPendingModifiedValues `type:"structure"`

	// The identifier for the replication group.
	ReplicationGroupId *string `type:"string"`

	// The number of days for which ElastiCache retains automatic cluster snapshots
	// before deleting them. For example, if you set SnapshotRetentionLimit to 5,
	// a snapshot that was taken today is retained for 5 days before being deleted.
	//
	// If the value of SnapshotRetentionLimit is set to zero (0), backups are turned
	// off.
	SnapshotRetentionLimit *int64 `type:"integer"`

	// The daily time range (in UTC) during which ElastiCache begins taking a daily
	// snapshot of your node group (shard).
	//
	// Example: 05:00-09:00
	//
	// If you do not specify this parameter, ElastiCache automatically chooses an
	// appropriate time range.
	//
	// This parameter is only valid if the Engine parameter is redis.
	SnapshotWindow *string `type:"string"`

	// The cluster ID that is used as the daily snapshot source for the replication
	// group.
	SnapshottingClusterId *string `type:"string"`

	// The current state of this replication group - creating, available, modifying,
	// deleting, create-failed, snapshotting.
	Status *string `type:"string"`

	// A flag that enables in-transit encryption when set to true.
	//
	// You cannot modify the value of TransitEncryptionEnabled after the cluster
	// is created. To enable in-transit encryption on a cluster you must set TransitEncryptionEnabled
	// to true when you create a cluster.
	//
	// Required: Only available when creating a replication group in an Amazon VPC
	// using redis version 3.2.6, 4.x or later.
	//
	// Default: false
	TransitEncryptionEnabled *bool `type:"boolean"`
	// contains filtered or unexported fields
}

Contains all of the attributes of a specific Redis replication group.

func (ReplicationGroup) String

func (s ReplicationGroup) String() string

String returns the string representation

type ReplicationGroupPendingModifiedValues

type ReplicationGroupPendingModifiedValues struct {

	// The auth token status
	AuthTokenStatus AuthTokenUpdateStatus `type:"string" enum:"true"`

	// Indicates the status of automatic failover for this Redis replication group.
	AutomaticFailoverStatus PendingAutomaticFailoverStatus `type:"string" enum:"true"`

	// The primary cluster ID that is applied immediately (if --apply-immediately
	// was specified), or during the next maintenance window.
	PrimaryClusterId *string `type:"string"`

	// The status of an online resharding operation.
	Resharding *ReshardingStatus `type:"structure"`
	// contains filtered or unexported fields
}

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

func (ReplicationGroupPendingModifiedValues) String

String returns the string representation

type ReservedCacheNode

type ReservedCacheNode struct {

	// The number of cache nodes that have been reserved.
	CacheNodeCount *int64 `type:"integer"`

	// The cache node type for the reserved cache nodes.
	//
	// 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: M5 node types: cache.m5.large,
	//    cache.m5.xlarge, cache.m5.2xlarge, cache.m5.4xlarge, cache.m5.12xlarge,
	//    cache.m5.24xlarge M4 node types: cache.m4.large, cache.m4.xlarge, cache.m4.2xlarge,
	//    cache.m4.4xlarge, cache.m4.10xlarge T3 node types: cache.t3.micro, cache.t3.small,
	//    cache.t3.medium T2 node types: cache.t2.micro, cache.t2.small, cache.t2.medium
	//    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
	//    M3 node types: cache.m3.medium, cache.m3.large, cache.m3.xlarge, cache.m3.2xlarge
	//
	//    * Compute optimized: Previous generation: (not recommended) C1 node types:
	//    cache.c1.xlarge
	//
	//    * Memory optimized: Current generation: R5 node types: cache.r5.large,
	//    cache.r5.xlarge, cache.r5.2xlarge, cache.r5.4xlarge, cache.r5.12xlarge,
	//    cache.r5.24xlarge R4 node types: cache.r4.large, cache.r4.xlarge, cache.r4.2xlarge,
	//    cache.r4.4xlarge, cache.r4.8xlarge, cache.r4.16xlarge Previous generation:
	//    (not recommended) M2 node types: cache.m2.xlarge, cache.m2.2xlarge, cache.m2.4xlarge
	//    R3 node types: cache.r3.large, cache.r3.xlarge, cache.r3.2xlarge, cache.r3.4xlarge,
	//    cache.r3.8xlarge
	//
	// Additional node type info
	//
	//    * All current generation instance types are created in Amazon VPC by default.
	//
	//    * Redis append-only files (AOF) are not supported for T1 or T2 instances.
	//
	//    * Redis Multi-AZ with automatic failover is not supported on T1 instances.
	//
	//    * Redis configuration variables appendonly and appendfsync are not supported
	//    on Redis version 2.8.22 and later.
	CacheNodeType *string `type:"string"`

	// The duration of the reservation in seconds.
	Duration *int64 `type:"integer"`

	// The fixed price charged for this reserved cache node.
	FixedPrice *float64 `type:"double"`

	// The offering type of this reserved cache node.
	OfferingType *string `type:"string"`

	// The description of the reserved cache node.
	ProductDescription *string `type:"string"`

	// The recurring price charged to run this reserved cache node.
	RecurringCharges []RecurringCharge `locationNameList:"RecurringCharge" type:"list"`

	// The Amazon Resource Name (ARN) of the reserved cache node.
	//
	// Example: arn:aws:elasticache:us-east-1:123456789012:reserved-instance:ri-2017-03-27-08-33-25-582
	ReservationARN *string `type:"string"`

	// The unique identifier for the reservation.
	ReservedCacheNodeId *string `type:"string"`

	// The offering identifier.
	ReservedCacheNodesOfferingId *string `type:"string"`

	// The time the reservation started.
	StartTime *time.Time `type:"timestamp"`

	// The state of the reserved cache node.
	State *string `type:"string"`

	// The hourly price charged for this reserved cache node.
	UsagePrice *float64 `type:"double"`
	// contains filtered or unexported fields
}

Represents the output of a PurchaseReservedCacheNodesOffering operation.

func (ReservedCacheNode) String

func (s ReservedCacheNode) String() string

String returns the string representation

type ReservedCacheNodesOffering

type ReservedCacheNodesOffering struct {

	// The cache node type for the reserved cache node.
	//
	// 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: M5 node types: cache.m5.large,
	//    cache.m5.xlarge, cache.m5.2xlarge, cache.m5.4xlarge, cache.m5.12xlarge,
	//    cache.m5.24xlarge M4 node types: cache.m4.large, cache.m4.xlarge, cache.m4.2xlarge,
	//    cache.m4.4xlarge, cache.m4.10xlarge T3 node types: cache.t3.micro, cache.t3.small,
	//    cache.t3.medium T2 node types: cache.t2.micro, cache.t2.small, cache.t2.medium
	//    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
	//    M3 node types: cache.m3.medium, cache.m3.large, cache.m3.xlarge, cache.m3.2xlarge
	//
	//    * Compute optimized: Previous generation: (not recommended) C1 node types:
	//    cache.c1.xlarge
	//
	//    * Memory optimized: Current generation: R5 node types: cache.r5.large,
	//    cache.r5.xlarge, cache.r5.2xlarge, cache.r5.4xlarge, cache.r5.12xlarge,
	//    cache.r5.24xlarge R4 node types: cache.r4.large, cache.r4.xlarge, cache.r4.2xlarge,
	//    cache.r4.4xlarge, cache.r4.8xlarge, cache.r4.16xlarge Previous generation:
	//    (not recommended) M2 node types: cache.m2.xlarge, cache.m2.2xlarge, cache.m2.4xlarge
	//    R3 node types: cache.r3.large, cache.r3.xlarge, cache.r3.2xlarge, cache.r3.4xlarge,
	//    cache.r3.8xlarge
	//
	// Additional node type info
	//
	//    * All current generation instance types are created in Amazon VPC by default.
	//
	//    * Redis append-only files (AOF) are not supported for T1 or T2 instances.
	//
	//    * Redis Multi-AZ with automatic failover is not supported on T1 instances.
	//
	//    * Redis configuration variables appendonly and appendfsync are not supported
	//    on Redis version 2.8.22 and later.
	CacheNodeType *string `type:"string"`

	// The duration of the offering. in seconds.
	Duration *int64 `type:"integer"`

	// The fixed price charged for this offering.
	FixedPrice *float64 `type:"double"`

	// The offering type.
	OfferingType *string `type:"string"`

	// The cache engine used by the offering.
	ProductDescription *string `type:"string"`

	// The recurring price charged to run this reserved cache node.
	RecurringCharges []RecurringCharge `locationNameList:"RecurringCharge" type:"list"`

	// A unique identifier for the reserved cache node offering.
	ReservedCacheNodesOfferingId *string `type:"string"`

	// The hourly price charged for this offering.
	UsagePrice *float64 `type:"double"`
	// contains filtered or unexported fields
}

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

func (ReservedCacheNodesOffering) String

String returns the string representation

type ResetCacheParameterGroupInput

type ResetCacheParameterGroupInput struct {

	// The name of the cache parameter group to reset.
	//
	// CacheParameterGroupName is a required field
	CacheParameterGroupName *string `type:"string" required:"true"`

	// An array of parameter names to reset to their default values. If ResetAllParameters
	// is true, do not use ParameterNameValues. If ResetAllParameters is false,
	// you must specify the name of at least one parameter to reset.
	ParameterNameValues []ParameterNameValue `locationNameList:"ParameterNameValue" type:"list"`

	// If true, all parameters in the cache parameter group are reset to their default
	// values. If false, only the parameters listed by ParameterNameValues are reset
	// to their default values.
	//
	// Valid values: true | false
	ResetAllParameters *bool `type:"boolean"`
	// contains filtered or unexported fields
}

Represents the input of a ResetCacheParameterGroup operation.

func (ResetCacheParameterGroupInput) String

String returns the string representation

func (*ResetCacheParameterGroupInput) Validate

func (s *ResetCacheParameterGroupInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ResetCacheParameterGroupOutput

type ResetCacheParameterGroupOutput struct {

	// The name of the cache parameter group.
	CacheParameterGroupName *string `type:"string"`
	// contains filtered or unexported fields
}

Represents the output of one of the following operations:

  • ModifyCacheParameterGroup

  • ResetCacheParameterGroup

func (ResetCacheParameterGroupOutput) String

String returns the string representation

type ResetCacheParameterGroupRequest

type ResetCacheParameterGroupRequest struct {
	*aws.Request
	Input *ResetCacheParameterGroupInput
	Copy  func(*ResetCacheParameterGroupInput) ResetCacheParameterGroupRequest
}

ResetCacheParameterGroupRequest is the request type for the ResetCacheParameterGroup API operation.

func (ResetCacheParameterGroupRequest) Send

Send marshals and sends the ResetCacheParameterGroup API request.

type ResetCacheParameterGroupResponse added in v0.9.0

type ResetCacheParameterGroupResponse struct {
	*ResetCacheParameterGroupOutput
	// contains filtered or unexported fields
}

ResetCacheParameterGroupResponse is the response type for the ResetCacheParameterGroup API operation.

func (*ResetCacheParameterGroupResponse) SDKResponseMetdata added in v0.9.0

func (r *ResetCacheParameterGroupResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the ResetCacheParameterGroup request.

type ReshardingConfiguration added in v0.2.0

type ReshardingConfiguration struct {

	// Either the ElastiCache for Redis supplied 4-digit id or a user supplied id
	// for the node group these configuration values apply to.
	NodeGroupId *string `min:"1" type:"string"`

	// A list of preferred availability zones for the nodes in this cluster.
	PreferredAvailabilityZones []string `locationNameList:"AvailabilityZone" type:"list"`
	// contains filtered or unexported fields
}

A list of PreferredAvailabilityZones objects that specifies the configuration of a node group in the resharded cluster.

func (ReshardingConfiguration) String added in v0.2.0

func (s ReshardingConfiguration) String() string

String returns the string representation

func (*ReshardingConfiguration) Validate added in v0.5.0

func (s *ReshardingConfiguration) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ReshardingStatus added in v0.2.0

type ReshardingStatus struct {

	// Represents the progress of an online resharding operation.
	SlotMigration *SlotMigration `type:"structure"`
	// contains filtered or unexported fields
}

The status of an online resharding operation.

func (ReshardingStatus) String added in v0.2.0

func (s ReshardingStatus) String() string

String returns the string representation

type RevokeCacheSecurityGroupIngressInput

type RevokeCacheSecurityGroupIngressInput struct {

	// The name of the cache security group to revoke ingress from.
	//
	// CacheSecurityGroupName is a required field
	CacheSecurityGroupName *string `type:"string" required:"true"`

	// The name of the Amazon EC2 security group to revoke access from.
	//
	// EC2SecurityGroupName is a required field
	EC2SecurityGroupName *string `type:"string" required:"true"`

	// The AWS account number of the Amazon EC2 security group owner. Note that
	// this is not the same thing as an AWS access key ID - you must provide a valid
	// AWS account number for this parameter.
	//
	// EC2SecurityGroupOwnerId is a required field
	EC2SecurityGroupOwnerId *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

Represents the input of a RevokeCacheSecurityGroupIngress operation.

func (RevokeCacheSecurityGroupIngressInput) String

String returns the string representation

func (*RevokeCacheSecurityGroupIngressInput) Validate

Validate inspects the fields of the type to determine if they are valid.

type RevokeCacheSecurityGroupIngressOutput

type RevokeCacheSecurityGroupIngressOutput struct {

	// Represents the output of one of the following operations:
	//
	//    * AuthorizeCacheSecurityGroupIngress
	//
	//    * CreateCacheSecurityGroup
	//
	//    * RevokeCacheSecurityGroupIngress
	CacheSecurityGroup *CacheSecurityGroup `type:"structure"`
	// contains filtered or unexported fields
}

func (RevokeCacheSecurityGroupIngressOutput) String

String returns the string representation

type RevokeCacheSecurityGroupIngressRequest

type RevokeCacheSecurityGroupIngressRequest struct {
	*aws.Request
	Input *RevokeCacheSecurityGroupIngressInput
	Copy  func(*RevokeCacheSecurityGroupIngressInput) RevokeCacheSecurityGroupIngressRequest
}

RevokeCacheSecurityGroupIngressRequest is the request type for the RevokeCacheSecurityGroupIngress API operation.

func (RevokeCacheSecurityGroupIngressRequest) Send

Send marshals and sends the RevokeCacheSecurityGroupIngress API request.

type RevokeCacheSecurityGroupIngressResponse added in v0.9.0

type RevokeCacheSecurityGroupIngressResponse struct {
	*RevokeCacheSecurityGroupIngressOutput
	// contains filtered or unexported fields
}

RevokeCacheSecurityGroupIngressResponse is the response type for the RevokeCacheSecurityGroupIngress API operation.

func (*RevokeCacheSecurityGroupIngressResponse) SDKResponseMetdata added in v0.9.0

func (r *RevokeCacheSecurityGroupIngressResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the RevokeCacheSecurityGroupIngress request.

type SecurityGroupMembership

type SecurityGroupMembership struct {

	// The identifier of the cache security group.
	SecurityGroupId *string `type:"string"`

	// The status of the cache security group membership. The status changes whenever
	// a cache security group is modified, or when the cache security groups assigned
	// to a cluster are modified.
	Status *string `type:"string"`
	// contains filtered or unexported fields
}

Represents a single cache security group and its status.

func (SecurityGroupMembership) String

func (s SecurityGroupMembership) String() string

String returns the string representation

type ServiceUpdate added in v0.10.0

type ServiceUpdate struct {

	// Indicates whether the service update will be automatically applied once the
	// recommended apply-by date has expired.
	AutoUpdateAfterRecommendedApplyByDate *bool `type:"boolean"`

	// The Elasticache engine to which the update applies. Either Redis or Memcached
	Engine *string `type:"string"`

	// The Elasticache engine version to which the update applies. Either Redis
	// or Memcached engine version
	EngineVersion *string `type:"string"`

	// The estimated length of time the service update will take
	EstimatedUpdateTime *string `type:"string"`

	// Provides details of the service update
	ServiceUpdateDescription *string `type:"string"`

	// The date after which the service update is no longer available
	ServiceUpdateEndDate *time.Time `type:"timestamp"`

	// The unique ID of the service update
	ServiceUpdateName *string `type:"string"`

	// The recommendend date to apply the service update in order to ensure compliance.
	// For information on compliance, see Self-Service Security Updates for Compliance
	// (https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/elasticache-compliance.html#elasticache-compliance-self-service).
	ServiceUpdateRecommendedApplyByDate *time.Time `type:"timestamp"`

	// The date when the service update is initially available
	ServiceUpdateReleaseDate *time.Time `type:"timestamp"`

	// The severity of the service update
	ServiceUpdateSeverity ServiceUpdateSeverity `type:"string" enum:"true"`

	// The status of the service update
	ServiceUpdateStatus ServiceUpdateStatus `type:"string" enum:"true"`

	// Reflects the nature of the service update
	ServiceUpdateType ServiceUpdateType `type:"string" enum:"true"`
	// contains filtered or unexported fields
}

An update that you can apply to your Redis clusters.

func (ServiceUpdate) String added in v0.10.0

func (s ServiceUpdate) String() string

String returns the string representation

type ServiceUpdateSeverity added in v0.10.0

type ServiceUpdateSeverity string
const (
	ServiceUpdateSeverityCritical  ServiceUpdateSeverity = "critical"
	ServiceUpdateSeverityImportant ServiceUpdateSeverity = "important"
	ServiceUpdateSeverityMedium    ServiceUpdateSeverity = "medium"
	ServiceUpdateSeverityLow       ServiceUpdateSeverity = "low"
)

Enum values for ServiceUpdateSeverity

func (ServiceUpdateSeverity) MarshalValue added in v0.10.0

func (enum ServiceUpdateSeverity) MarshalValue() (string, error)

func (ServiceUpdateSeverity) MarshalValueBuf added in v0.10.0

func (enum ServiceUpdateSeverity) MarshalValueBuf(b []byte) ([]byte, error)

type ServiceUpdateStatus added in v0.10.0

type ServiceUpdateStatus string
const (
	ServiceUpdateStatusAvailable ServiceUpdateStatus = "available"
	ServiceUpdateStatusCancelled ServiceUpdateStatus = "cancelled"
	ServiceUpdateStatusExpired   ServiceUpdateStatus = "expired"
)

Enum values for ServiceUpdateStatus

func (ServiceUpdateStatus) MarshalValue added in v0.10.0

func (enum ServiceUpdateStatus) MarshalValue() (string, error)

func (ServiceUpdateStatus) MarshalValueBuf added in v0.10.0

func (enum ServiceUpdateStatus) MarshalValueBuf(b []byte) ([]byte, error)

type ServiceUpdateType added in v0.10.0

type ServiceUpdateType string
const (
	ServiceUpdateTypeSecurityUpdate ServiceUpdateType = "security-update"
)

Enum values for ServiceUpdateType

func (ServiceUpdateType) MarshalValue added in v0.10.0

func (enum ServiceUpdateType) MarshalValue() (string, error)

func (ServiceUpdateType) MarshalValueBuf added in v0.10.0

func (enum ServiceUpdateType) MarshalValueBuf(b []byte) ([]byte, error)

type SlaMet added in v0.10.0

type SlaMet string
const (
	SlaMetYes SlaMet = "yes"
	SlaMetNo  SlaMet = "no"
	SlaMetNA  SlaMet = "n/a"
)

Enum values for SlaMet

func (SlaMet) MarshalValue added in v0.10.0

func (enum SlaMet) MarshalValue() (string, error)

func (SlaMet) MarshalValueBuf added in v0.10.0

func (enum SlaMet) MarshalValueBuf(b []byte) ([]byte, error)

type SlotMigration added in v0.2.0

type SlotMigration struct {

	// The percentage of the slot migration that is complete.
	ProgressPercentage *float64 `type:"double"`
	// contains filtered or unexported fields
}

Represents the progress of an online resharding operation.

func (SlotMigration) String added in v0.2.0

func (s SlotMigration) String() string

String returns the string representation

type Snapshot

type Snapshot struct {

	// The ARN (Amazon Resource Name) of the snapshot.
	ARN *string `type:"string"`

	// This parameter is currently disabled.
	AutoMinorVersionUpgrade *bool `type:"boolean"`

	// Indicates the status of automatic failover for the source Redis replication
	// group.
	AutomaticFailover AutomaticFailoverStatus `type:"string" enum:"true"`

	// The date and time when the source cluster was created.
	CacheClusterCreateTime *time.Time `type:"timestamp"`

	// The user-supplied identifier of the source cluster.
	CacheClusterId *string `type:"string"`

	// The name of the compute and memory capacity node type for the source cluster.
	//
	// 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: M5 node types: cache.m5.large,
	//    cache.m5.xlarge, cache.m5.2xlarge, cache.m5.4xlarge, cache.m5.12xlarge,
	//    cache.m5.24xlarge M4 node types: cache.m4.large, cache.m4.xlarge, cache.m4.2xlarge,
	//    cache.m4.4xlarge, cache.m4.10xlarge T3 node types: cache.t3.micro, cache.t3.small,
	//    cache.t3.medium T2 node types: cache.t2.micro, cache.t2.small, cache.t2.medium
	//    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
	//    M3 node types: cache.m3.medium, cache.m3.large, cache.m3.xlarge, cache.m3.2xlarge
	//
	//    * Compute optimized: Previous generation: (not recommended) C1 node types:
	//    cache.c1.xlarge
	//
	//    * Memory optimized: Current generation: R5 node types: cache.r5.large,
	//    cache.r5.xlarge, cache.r5.2xlarge, cache.r5.4xlarge, cache.r5.12xlarge,
	//    cache.r5.24xlarge R4 node types: cache.r4.large, cache.r4.xlarge, cache.r4.2xlarge,
	//    cache.r4.4xlarge, cache.r4.8xlarge, cache.r4.16xlarge Previous generation:
	//    (not recommended) M2 node types: cache.m2.xlarge, cache.m2.2xlarge, cache.m2.4xlarge
	//    R3 node types: cache.r3.large, cache.r3.xlarge, cache.r3.2xlarge, cache.r3.4xlarge,
	//    cache.r3.8xlarge
	//
	// Additional node type info
	//
	//    * All current generation instance types are created in Amazon VPC by default.
	//
	//    * Redis append-only files (AOF) are not supported for T1 or T2 instances.
	//
	//    * Redis Multi-AZ with automatic failover is not supported on T1 instances.
	//
	//    * Redis configuration variables appendonly and appendfsync are not supported
	//    on Redis version 2.8.22 and later.
	CacheNodeType *string `type:"string"`

	// The cache parameter group that is associated with the source cluster.
	CacheParameterGroupName *string `type:"string"`

	// The name of the cache subnet group associated with the source cluster.
	CacheSubnetGroupName *string `type:"string"`

	// The name of the cache engine (memcached or redis) used by the source cluster.
	Engine *string `type:"string"`

	// The version of the cache engine version that is used by the source cluster.
	EngineVersion *string `type:"string"`

	// The ID of the KMS key used to encrypt the snapshot.
	KmsKeyId *string `type:"string"`

	// A list of the cache nodes in the source cluster.
	NodeSnapshots []NodeSnapshot `locationNameList:"NodeSnapshot" type:"list"`

	// The number of cache nodes in the source cluster.
	//
	// For clusters running Redis, this value must be 1. For clusters running Memcached,
	// this value must be between 1 and 20.
	NumCacheNodes *int64 `type:"integer"`

	// The number of node groups (shards) in this snapshot. When restoring from
	// a snapshot, the number of node groups (shards) in the snapshot and in the
	// restored replication group must be the same.
	NumNodeGroups *int64 `type:"integer"`

	// The port number used by each cache nodes in the source cluster.
	Port *int64 `type:"integer"`

	// The name of the Availability Zone in which the source cluster is located.
	PreferredAvailabilityZone *string `type:"string"`

	// Specifies the weekly time range during which maintenance on the cluster is
	// performed. It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi
	// (24H Clock UTC). The minimum maintenance window is a 60 minute period.
	//
	// Valid values for ddd are:
	//
	//    * sun
	//
	//    * mon
	//
	//    * tue
	//
	//    * wed
	//
	//    * thu
	//
	//    * fri
	//
	//    * sat
	//
	// Example: sun:23:00-mon:01:30
	PreferredMaintenanceWindow *string `type:"string"`

	// A description of the source replication group.
	ReplicationGroupDescription *string `type:"string"`

	// The unique identifier of the source replication group.
	ReplicationGroupId *string `type:"string"`

	// The name of a snapshot. For an automatic snapshot, the name is system-generated.
	// For a manual snapshot, this is the user-provided name.
	SnapshotName *string `type:"string"`

	// For an automatic snapshot, the number of days for which ElastiCache retains
	// the snapshot before deleting it.
	//
	// For manual snapshots, this field reflects the SnapshotRetentionLimit for
	// the source cluster when the snapshot was created. This field is otherwise
	// ignored: Manual snapshots do not expire, and can only be deleted using the
	// DeleteSnapshot operation.
	//
	// Important If the value of SnapshotRetentionLimit is set to zero (0), backups
	// are turned off.
	SnapshotRetentionLimit *int64 `type:"integer"`

	// Indicates whether the snapshot is from an automatic backup (automated) or
	// was created manually (manual).
	SnapshotSource *string `type:"string"`

	// The status of the snapshot. Valid values: creating | available | restoring
	// | copying | deleting.
	SnapshotStatus *string `type:"string"`

	// The daily time range during which ElastiCache takes daily snapshots of the
	// source cluster.
	SnapshotWindow *string `type:"string"`

	// The Amazon Resource Name (ARN) for the topic used by the source cluster for
	// publishing notifications.
	TopicArn *string `type:"string"`

	// The Amazon Virtual Private Cloud identifier (VPC ID) of the cache subnet
	// group for the source cluster.
	VpcId *string `type:"string"`
	// contains filtered or unexported fields
}

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

func (Snapshot) String

func (s Snapshot) String() string

String returns the string representation

type SourceType

type SourceType string
const (
	SourceTypeCacheCluster        SourceType = "cache-cluster"
	SourceTypeCacheParameterGroup SourceType = "cache-parameter-group"
	SourceTypeCacheSecurityGroup  SourceType = "cache-security-group"
	SourceTypeCacheSubnetGroup    SourceType = "cache-subnet-group"
	SourceTypeReplicationGroup    SourceType = "replication-group"
)

Enum values for SourceType

func (SourceType) MarshalValue added in v0.3.0

func (enum SourceType) MarshalValue() (string, error)

func (SourceType) MarshalValueBuf added in v0.3.0

func (enum SourceType) MarshalValueBuf(b []byte) ([]byte, error)

type StartMigrationInput added in v0.16.0

type StartMigrationInput struct {

	// List of endpoints from which data should be migrated. For Redis (cluster
	// mode disabled), list should have only one element.
	//
	// CustomerNodeEndpointList is a required field
	CustomerNodeEndpointList []CustomerNodeEndpoint `type:"list" required:"true"`

	// The ID of the replication group to which data should be migrated.
	//
	// ReplicationGroupId is a required field
	ReplicationGroupId *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (StartMigrationInput) String added in v0.16.0

func (s StartMigrationInput) String() string

String returns the string representation

func (*StartMigrationInput) Validate added in v0.16.0

func (s *StartMigrationInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type StartMigrationOutput added in v0.16.0

type StartMigrationOutput struct {

	// Contains all of the attributes of a specific Redis replication group.
	ReplicationGroup *ReplicationGroup `type:"structure"`
	// contains filtered or unexported fields
}

func (StartMigrationOutput) String added in v0.16.0

func (s StartMigrationOutput) String() string

String returns the string representation

type StartMigrationRequest added in v0.16.0

type StartMigrationRequest struct {
	*aws.Request
	Input *StartMigrationInput
	Copy  func(*StartMigrationInput) StartMigrationRequest
}

StartMigrationRequest is the request type for the StartMigration API operation.

func (StartMigrationRequest) Send added in v0.16.0

Send marshals and sends the StartMigration API request.

type StartMigrationResponse added in v0.16.0

type StartMigrationResponse struct {
	*StartMigrationOutput
	// contains filtered or unexported fields
}

StartMigrationResponse is the response type for the StartMigration API operation.

func (*StartMigrationResponse) SDKResponseMetdata added in v0.16.0

func (r *StartMigrationResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the StartMigration request.

type Subnet

type Subnet struct {

	// The Availability Zone associated with the subnet.
	SubnetAvailabilityZone *AvailabilityZone `type:"structure"`

	// The unique identifier for the subnet.
	SubnetIdentifier *string `type:"string"`
	// contains filtered or unexported fields
}

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

func (Subnet) String

func (s Subnet) String() string

String returns the string representation

type Tag

type Tag struct {

	// The key for the tag. May not be null.
	Key *string `type:"string"`

	// The tag's value. May be null.
	Value *string `type:"string"`
	// contains filtered or unexported fields
}

A cost allocation Tag that can be added to an ElastiCache cluster or replication group. Tags are composed of a Key/Value pair. A tag with a null Value is permitted.

func (Tag) String

func (s Tag) String() string

String returns the string representation

type TestFailoverInput

type TestFailoverInput struct {

	// The name of the node group (called shard in the console) in this replication
	// group on which automatic failover is to be tested. You may test automatic
	// failover on up to 5 node groups in any rolling 24-hour period.
	//
	// NodeGroupId is a required field
	NodeGroupId *string `min:"1" type:"string" required:"true"`

	// The name of the replication group (console: cluster) whose automatic failover
	// is being tested by this operation.
	//
	// ReplicationGroupId is a required field
	ReplicationGroupId *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (TestFailoverInput) String

func (s TestFailoverInput) String() string

String returns the string representation

func (*TestFailoverInput) Validate

func (s *TestFailoverInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type TestFailoverOutput

type TestFailoverOutput struct {

	// Contains all of the attributes of a specific Redis replication group.
	ReplicationGroup *ReplicationGroup `type:"structure"`
	// contains filtered or unexported fields
}

func (TestFailoverOutput) String

func (s TestFailoverOutput) String() string

String returns the string representation

type TestFailoverRequest

type TestFailoverRequest struct {
	*aws.Request
	Input *TestFailoverInput
	Copy  func(*TestFailoverInput) TestFailoverRequest
}

TestFailoverRequest is the request type for the TestFailover API operation.

func (TestFailoverRequest) Send

Send marshals and sends the TestFailover API request.

type TestFailoverResponse added in v0.9.0

type TestFailoverResponse struct {
	*TestFailoverOutput
	// contains filtered or unexported fields
}

TestFailoverResponse is the response type for the TestFailover API operation.

func (*TestFailoverResponse) SDKResponseMetdata added in v0.9.0

func (r *TestFailoverResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the TestFailover request.

type TimeRangeFilter added in v0.10.0

type TimeRangeFilter struct {

	// The end time of the time range filter
	EndTime *time.Time `type:"timestamp"`

	// The start time of the time range filter
	StartTime *time.Time `type:"timestamp"`
	// contains filtered or unexported fields
}

Filters update actions from the service updates that are in available status during the time range.

func (TimeRangeFilter) String added in v0.10.0

func (s TimeRangeFilter) String() string

String returns the string representation

type UnprocessedUpdateAction added in v0.10.0

type UnprocessedUpdateAction struct {

	// The ID of the cache cluster
	CacheClusterId *string `type:"string"`

	// The error message that describes the reason the request was not processed
	ErrorMessage *string `type:"string"`

	// The error type for requests that are not processed
	ErrorType *string `type:"string"`

	// The replication group ID
	ReplicationGroupId *string `type:"string"`

	// The unique ID of the service update
	ServiceUpdateName *string `type:"string"`
	// contains filtered or unexported fields
}

Update action that has failed to be processed for the corresponding apply/stop request

func (UnprocessedUpdateAction) String added in v0.10.0

func (s UnprocessedUpdateAction) String() string

String returns the string representation

type UpdateAction added in v0.10.0

type UpdateAction struct {

	// The ID of the cache cluster
	CacheClusterId *string `type:"string"`

	// The status of the service update on the cache node
	CacheNodeUpdateStatus []CacheNodeUpdateStatus `locationNameList:"CacheNodeUpdateStatus" type:"list"`

	// The Elasticache engine to which the update applies. Either Redis or Memcached
	Engine *string `type:"string"`

	// The estimated length of time for the update to complete
	EstimatedUpdateTime *string `type:"string"`

	// The status of the service update on the node group
	NodeGroupUpdateStatus []NodeGroupUpdateStatus `locationNameList:"NodeGroupUpdateStatus" type:"list"`

	// The progress of the service update on the replication group
	NodesUpdated *string `type:"string"`

	// The ID of the replication group
	ReplicationGroupId *string `type:"string"`

	// The unique ID of the service update
	ServiceUpdateName *string `type:"string"`

	// The recommended date to apply the service update to ensure compliance. For
	// information on compliance, see Self-Service Security Updates for Compliance
	// (https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/elasticache-compliance.html#elasticache-compliance-self-service).
	ServiceUpdateRecommendedApplyByDate *time.Time `type:"timestamp"`

	// The date the update is first available
	ServiceUpdateReleaseDate *time.Time `type:"timestamp"`

	// The severity of the service update
	ServiceUpdateSeverity ServiceUpdateSeverity `type:"string" enum:"true"`

	// The status of the service update
	ServiceUpdateStatus ServiceUpdateStatus `type:"string" enum:"true"`

	// Reflects the nature of the service update
	ServiceUpdateType ServiceUpdateType `type:"string" enum:"true"`

	// If yes, all nodes in the replication group have been updated by the recommended
	// apply-by date. If no, at least one node in the replication group have not
	// been updated by the recommended apply-by date. If N/A, the replication group
	// was created after the recommended apply-by date.
	SlaMet SlaMet `type:"string" enum:"true"`

	// The date that the service update is available to a replication group
	UpdateActionAvailableDate *time.Time `type:"timestamp"`

	// The status of the update action
	UpdateActionStatus UpdateActionStatus `type:"string" enum:"true"`

	// The date when the UpdateActionStatus was last modified
	UpdateActionStatusModifiedDate *time.Time `type:"timestamp"`
	// contains filtered or unexported fields
}

The status of the service update for a specific replication group

func (UpdateAction) String added in v0.10.0

func (s UpdateAction) String() string

String returns the string representation

type UpdateActionStatus added in v0.10.0

type UpdateActionStatus string
const (
	UpdateActionStatusNotApplied     UpdateActionStatus = "not-applied"
	UpdateActionStatusWaitingToStart UpdateActionStatus = "waiting-to-start"
	UpdateActionStatusInProgress     UpdateActionStatus = "in-progress"
	UpdateActionStatusStopping       UpdateActionStatus = "stopping"
	UpdateActionStatusStopped        UpdateActionStatus = "stopped"
	UpdateActionStatusComplete       UpdateActionStatus = "complete"
	UpdateActionStatusScheduling     UpdateActionStatus = "scheduling"
	UpdateActionStatusScheduled      UpdateActionStatus = "scheduled"
	UpdateActionStatusNotApplicable  UpdateActionStatus = "not-applicable"
)

Enum values for UpdateActionStatus

func (UpdateActionStatus) MarshalValue added in v0.10.0

func (enum UpdateActionStatus) MarshalValue() (string, error)

func (UpdateActionStatus) MarshalValueBuf added in v0.10.0

func (enum UpdateActionStatus) MarshalValueBuf(b []byte) ([]byte, error)

Source Files

Directories

Path Synopsis
Package elasticacheiface provides an interface to enable mocking the Amazon ElastiCache service client for testing your code.
Package elasticacheiface provides an interface to enable mocking the Amazon ElastiCache service client for testing your code.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL