elasticache

package
v1.42.9 Latest Latest
Warning

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

Go to latest
Published: Aug 3, 2023 License: Apache-2.0 Imports: 10 Imported by: 0

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 contact 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 ElastiCache 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 (
	// AZModeSingleAz is a AZMode enum value
	AZModeSingleAz = "single-az"

	// AZModeCrossAz is a AZMode enum value
	AZModeCrossAz = "cross-az"
)
View Source
const (
	// AuthTokenUpdateStatusSetting is a AuthTokenUpdateStatus enum value
	AuthTokenUpdateStatusSetting = "SETTING"

	// AuthTokenUpdateStatusRotating is a AuthTokenUpdateStatus enum value
	AuthTokenUpdateStatusRotating = "ROTATING"
)
View Source
const (
	// AuthTokenUpdateStrategyTypeSet is a AuthTokenUpdateStrategyType enum value
	AuthTokenUpdateStrategyTypeSet = "SET"

	// AuthTokenUpdateStrategyTypeRotate is a AuthTokenUpdateStrategyType enum value
	AuthTokenUpdateStrategyTypeRotate = "ROTATE"

	// AuthTokenUpdateStrategyTypeDelete is a AuthTokenUpdateStrategyType enum value
	AuthTokenUpdateStrategyTypeDelete = "DELETE"
)
View Source
const (
	// AuthenticationTypePassword is a AuthenticationType enum value
	AuthenticationTypePassword = "password"

	// AuthenticationTypeNoPassword is a AuthenticationType enum value
	AuthenticationTypeNoPassword = "no-password"

	// AuthenticationTypeIam is a AuthenticationType enum value
	AuthenticationTypeIam = "iam"
)
View Source
const (
	// AutomaticFailoverStatusEnabled is a AutomaticFailoverStatus enum value
	AutomaticFailoverStatusEnabled = "enabled"

	// AutomaticFailoverStatusDisabled is a AutomaticFailoverStatus enum value
	AutomaticFailoverStatusDisabled = "disabled"

	// AutomaticFailoverStatusEnabling is a AutomaticFailoverStatus enum value
	AutomaticFailoverStatusEnabling = "enabling"

	// AutomaticFailoverStatusDisabling is a AutomaticFailoverStatus enum value
	AutomaticFailoverStatusDisabling = "disabling"
)
View Source
const (
	// ChangeTypeImmediate is a ChangeType enum value
	ChangeTypeImmediate = "immediate"

	// ChangeTypeRequiresReboot is a ChangeType enum value
	ChangeTypeRequiresReboot = "requires-reboot"
)
View Source
const (
	// ClusterModeEnabled is a ClusterMode enum value
	ClusterModeEnabled = "enabled"

	// ClusterModeDisabled is a ClusterMode enum value
	ClusterModeDisabled = "disabled"

	// ClusterModeCompatible is a ClusterMode enum value
	ClusterModeCompatible = "compatible"
)
View Source
const (
	// DataTieringStatusEnabled is a DataTieringStatus enum value
	DataTieringStatusEnabled = "enabled"

	// DataTieringStatusDisabled is a DataTieringStatus enum value
	DataTieringStatusDisabled = "disabled"
)
View Source
const (
	// DestinationTypeCloudwatchLogs is a DestinationType enum value
	DestinationTypeCloudwatchLogs = "cloudwatch-logs"

	// DestinationTypeKinesisFirehose is a DestinationType enum value
	DestinationTypeKinesisFirehose = "kinesis-firehose"
)
View Source
const (
	// InputAuthenticationTypePassword is a InputAuthenticationType enum value
	InputAuthenticationTypePassword = "password"

	// InputAuthenticationTypeNoPasswordRequired is a InputAuthenticationType enum value
	InputAuthenticationTypeNoPasswordRequired = "no-password-required"

	// InputAuthenticationTypeIam is a InputAuthenticationType enum value
	InputAuthenticationTypeIam = "iam"
)
View Source
const (
	// IpDiscoveryIpv4 is a IpDiscovery enum value
	IpDiscoveryIpv4 = "ipv4"

	// IpDiscoveryIpv6 is a IpDiscovery enum value
	IpDiscoveryIpv6 = "ipv6"
)
View Source
const (
	// LogDeliveryConfigurationStatusActive is a LogDeliveryConfigurationStatus enum value
	LogDeliveryConfigurationStatusActive = "active"

	// LogDeliveryConfigurationStatusEnabling is a LogDeliveryConfigurationStatus enum value
	LogDeliveryConfigurationStatusEnabling = "enabling"

	// LogDeliveryConfigurationStatusModifying is a LogDeliveryConfigurationStatus enum value
	LogDeliveryConfigurationStatusModifying = "modifying"

	// LogDeliveryConfigurationStatusDisabling is a LogDeliveryConfigurationStatus enum value
	LogDeliveryConfigurationStatusDisabling = "disabling"

	// LogDeliveryConfigurationStatusError is a LogDeliveryConfigurationStatus enum value
	LogDeliveryConfigurationStatusError = "error"
)
View Source
const (
	// LogFormatText is a LogFormat enum value
	LogFormatText = "text"

	// LogFormatJson is a LogFormat enum value
	LogFormatJson = "json"
)
View Source
const (
	// LogTypeSlowLog is a LogType enum value
	LogTypeSlowLog = "slow-log"

	// LogTypeEngineLog is a LogType enum value
	LogTypeEngineLog = "engine-log"
)
View Source
const (
	// MultiAZStatusEnabled is a MultiAZStatus enum value
	MultiAZStatusEnabled = "enabled"

	// MultiAZStatusDisabled is a MultiAZStatus enum value
	MultiAZStatusDisabled = "disabled"
)
View Source
const (
	// NetworkTypeIpv4 is a NetworkType enum value
	NetworkTypeIpv4 = "ipv4"

	// NetworkTypeIpv6 is a NetworkType enum value
	NetworkTypeIpv6 = "ipv6"

	// NetworkTypeDualStack is a NetworkType enum value
	NetworkTypeDualStack = "dual_stack"
)
View Source
const (
	// NodeUpdateInitiatedBySystem is a NodeUpdateInitiatedBy enum value
	NodeUpdateInitiatedBySystem = "system"

	// NodeUpdateInitiatedByCustomer is a NodeUpdateInitiatedBy enum value
	NodeUpdateInitiatedByCustomer = "customer"
)
View Source
const (
	// NodeUpdateStatusNotApplied is a NodeUpdateStatus enum value
	NodeUpdateStatusNotApplied = "not-applied"

	// NodeUpdateStatusWaitingToStart is a NodeUpdateStatus enum value
	NodeUpdateStatusWaitingToStart = "waiting-to-start"

	// NodeUpdateStatusInProgress is a NodeUpdateStatus enum value
	NodeUpdateStatusInProgress = "in-progress"

	// NodeUpdateStatusStopping is a NodeUpdateStatus enum value
	NodeUpdateStatusStopping = "stopping"

	// NodeUpdateStatusStopped is a NodeUpdateStatus enum value
	NodeUpdateStatusStopped = "stopped"

	// NodeUpdateStatusComplete is a NodeUpdateStatus enum value
	NodeUpdateStatusComplete = "complete"
)
View Source
const (
	// OutpostModeSingleOutpost is a OutpostMode enum value
	OutpostModeSingleOutpost = "single-outpost"

	// OutpostModeCrossOutpost is a OutpostMode enum value
	OutpostModeCrossOutpost = "cross-outpost"
)
View Source
const (
	// PendingAutomaticFailoverStatusEnabled is a PendingAutomaticFailoverStatus enum value
	PendingAutomaticFailoverStatusEnabled = "enabled"

	// PendingAutomaticFailoverStatusDisabled is a PendingAutomaticFailoverStatus enum value
	PendingAutomaticFailoverStatusDisabled = "disabled"
)
View Source
const (
	// ServiceUpdateSeverityCritical is a ServiceUpdateSeverity enum value
	ServiceUpdateSeverityCritical = "critical"

	// ServiceUpdateSeverityImportant is a ServiceUpdateSeverity enum value
	ServiceUpdateSeverityImportant = "important"

	// ServiceUpdateSeverityMedium is a ServiceUpdateSeverity enum value
	ServiceUpdateSeverityMedium = "medium"

	// ServiceUpdateSeverityLow is a ServiceUpdateSeverity enum value
	ServiceUpdateSeverityLow = "low"
)
View Source
const (
	// ServiceUpdateStatusAvailable is a ServiceUpdateStatus enum value
	ServiceUpdateStatusAvailable = "available"

	// ServiceUpdateStatusCancelled is a ServiceUpdateStatus enum value
	ServiceUpdateStatusCancelled = "cancelled"

	// ServiceUpdateStatusExpired is a ServiceUpdateStatus enum value
	ServiceUpdateStatusExpired = "expired"
)
View Source
const (
	// SlaMetYes is a SlaMet enum value
	SlaMetYes = "yes"

	// SlaMetNo is a SlaMet enum value
	SlaMetNo = "no"

	// SlaMetNA is a SlaMet enum value
	SlaMetNA = "n/a"
)
View Source
const (
	// SourceTypeCacheCluster is a SourceType enum value
	SourceTypeCacheCluster = "cache-cluster"

	// SourceTypeCacheParameterGroup is a SourceType enum value
	SourceTypeCacheParameterGroup = "cache-parameter-group"

	// SourceTypeCacheSecurityGroup is a SourceType enum value
	SourceTypeCacheSecurityGroup = "cache-security-group"

	// SourceTypeCacheSubnetGroup is a SourceType enum value
	SourceTypeCacheSubnetGroup = "cache-subnet-group"

	// SourceTypeReplicationGroup is a SourceType enum value
	SourceTypeReplicationGroup = "replication-group"

	// SourceTypeUser is a SourceType enum value
	SourceTypeUser = "user"

	// SourceTypeUserGroup is a SourceType enum value
	SourceTypeUserGroup = "user-group"
)
View Source
const (
	// TransitEncryptionModePreferred is a TransitEncryptionMode enum value
	TransitEncryptionModePreferred = "preferred"

	// TransitEncryptionModeRequired is a TransitEncryptionMode enum value
	TransitEncryptionModeRequired = "required"
)
View Source
const (
	// UpdateActionStatusNotApplied is a UpdateActionStatus enum value
	UpdateActionStatusNotApplied = "not-applied"

	// UpdateActionStatusWaitingToStart is a UpdateActionStatus enum value
	UpdateActionStatusWaitingToStart = "waiting-to-start"

	// UpdateActionStatusInProgress is a UpdateActionStatus enum value
	UpdateActionStatusInProgress = "in-progress"

	// UpdateActionStatusStopping is a UpdateActionStatus enum value
	UpdateActionStatusStopping = "stopping"

	// UpdateActionStatusStopped is a UpdateActionStatus enum value
	UpdateActionStatusStopped = "stopped"

	// UpdateActionStatusComplete is a UpdateActionStatus enum value
	UpdateActionStatusComplete = "complete"

	// UpdateActionStatusScheduling is a UpdateActionStatus enum value
	UpdateActionStatusScheduling = "scheduling"

	// UpdateActionStatusScheduled is a UpdateActionStatus enum value
	UpdateActionStatusScheduled = "scheduled"

	// UpdateActionStatusNotApplicable is a UpdateActionStatus enum value
	UpdateActionStatusNotApplicable = "not-applicable"
)
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"

	// ErrCodeDefaultUserAssociatedToUserGroupFault for service response error code
	// "DefaultUserAssociatedToUserGroup".
	//
	// The default user assigned to the user group.
	ErrCodeDefaultUserAssociatedToUserGroupFault = "DefaultUserAssociatedToUserGroup"

	// ErrCodeDefaultUserRequired for service response error code
	// "DefaultUserRequired".
	//
	// You must add default user to a user group.
	ErrCodeDefaultUserRequired = "DefaultUserRequired"

	// ErrCodeDuplicateUserNameFault for service response error code
	// "DuplicateUserName".
	//
	// A user with this username already exists.
	ErrCodeDuplicateUserNameFault = "DuplicateUserName"

	// 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"

	// ErrCodeInvalidUserGroupStateFault for service response error code
	// "InvalidUserGroupState".
	//
	// The user group is not in an active state.
	ErrCodeInvalidUserGroupStateFault = "InvalidUserGroupState"

	// ErrCodeInvalidUserStateFault for service response error code
	// "InvalidUserState".
	//
	// The user is not in active state.
	ErrCodeInvalidUserStateFault = "InvalidUserState"

	// 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"

	// ErrCodeSubnetNotAllowedFault for service response error code
	// "SubnetNotAllowedFault".
	//
	// At least one subnet ID does not match the other subnet IDs. This mismatch
	// typically occurs when a user sets one subnet ID to a regional Availability
	// Zone and a different one to an outpost. Or when a user sets the subnet ID
	// to an Outpost when not subscribed on this service.
	ErrCodeSubnetNotAllowedFault = "SubnetNotAllowedFault"

	// 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"

	// ErrCodeUserAlreadyExistsFault for service response error code
	// "UserAlreadyExists".
	//
	// A user with this ID already exists.
	ErrCodeUserAlreadyExistsFault = "UserAlreadyExists"

	// ErrCodeUserGroupAlreadyExistsFault for service response error code
	// "UserGroupAlreadyExists".
	//
	// The user group with this ID already exists.
	ErrCodeUserGroupAlreadyExistsFault = "UserGroupAlreadyExists"

	// ErrCodeUserGroupNotFoundFault for service response error code
	// "UserGroupNotFound".
	//
	// The user group was not found or does not exist
	ErrCodeUserGroupNotFoundFault = "UserGroupNotFound"

	// ErrCodeUserGroupQuotaExceededFault for service response error code
	// "UserGroupQuotaExceeded".
	//
	// The number of users exceeds the user group limit.
	ErrCodeUserGroupQuotaExceededFault = "UserGroupQuotaExceeded"

	// ErrCodeUserNotFoundFault for service response error code
	// "UserNotFound".
	//
	// The user does not exist or could not be found.
	ErrCodeUserNotFoundFault = "UserNotFound"

	// ErrCodeUserQuotaExceededFault for service response error code
	// "UserQuotaExceeded".
	//
	// The quota of users has been exceeded.
	ErrCodeUserQuotaExceededFault = "UserQuotaExceeded"
)
View Source
const (
	ServiceName = "elasticache" // Name of service.
	EndpointsID = ServiceName   // ID to lookup a service endpoint with.
	ServiceID   = "ElastiCache" // ServiceID is a unique identifier of a specific service.
)

Service information constants

View Source
const (
	// ServiceUpdateTypeSecurityUpdate is a ServiceUpdateType enum value
	ServiceUpdateTypeSecurityUpdate = "security-update"
)

Variables

This section is empty.

Functions

func AZMode_Values

func AZMode_Values() []string

AZMode_Values returns all elements of the AZMode enum

func AuthTokenUpdateStatus_Values

func AuthTokenUpdateStatus_Values() []string

AuthTokenUpdateStatus_Values returns all elements of the AuthTokenUpdateStatus enum

func AuthTokenUpdateStrategyType_Values

func AuthTokenUpdateStrategyType_Values() []string

AuthTokenUpdateStrategyType_Values returns all elements of the AuthTokenUpdateStrategyType enum

func AuthenticationType_Values

func AuthenticationType_Values() []string

AuthenticationType_Values returns all elements of the AuthenticationType enum

func AutomaticFailoverStatus_Values

func AutomaticFailoverStatus_Values() []string

AutomaticFailoverStatus_Values returns all elements of the AutomaticFailoverStatus enum

func ChangeType_Values

func ChangeType_Values() []string

ChangeType_Values returns all elements of the ChangeType enum

func ClusterMode_Values added in v1.42.9

func ClusterMode_Values() []string

ClusterMode_Values returns all elements of the ClusterMode enum

func DataTieringStatus_Values added in v1.42.9

func DataTieringStatus_Values() []string

DataTieringStatus_Values returns all elements of the DataTieringStatus enum

func DestinationType_Values

func DestinationType_Values() []string

DestinationType_Values returns all elements of the DestinationType enum

func InputAuthenticationType_Values added in v1.42.9

func InputAuthenticationType_Values() []string

InputAuthenticationType_Values returns all elements of the InputAuthenticationType enum

func IpDiscovery_Values added in v1.42.9

func IpDiscovery_Values() []string

IpDiscovery_Values returns all elements of the IpDiscovery enum

func LogDeliveryConfigurationStatus_Values

func LogDeliveryConfigurationStatus_Values() []string

LogDeliveryConfigurationStatus_Values returns all elements of the LogDeliveryConfigurationStatus enum

func LogFormat_Values

func LogFormat_Values() []string

LogFormat_Values returns all elements of the LogFormat enum

func LogType_Values

func LogType_Values() []string

LogType_Values returns all elements of the LogType enum

func MultiAZStatus_Values

func MultiAZStatus_Values() []string

MultiAZStatus_Values returns all elements of the MultiAZStatus enum

func NetworkType_Values added in v1.42.9

func NetworkType_Values() []string

NetworkType_Values returns all elements of the NetworkType enum

func NodeUpdateInitiatedBy_Values

func NodeUpdateInitiatedBy_Values() []string

NodeUpdateInitiatedBy_Values returns all elements of the NodeUpdateInitiatedBy enum

func NodeUpdateStatus_Values

func NodeUpdateStatus_Values() []string

NodeUpdateStatus_Values returns all elements of the NodeUpdateStatus enum

func OutpostMode_Values

func OutpostMode_Values() []string

OutpostMode_Values returns all elements of the OutpostMode enum

func PendingAutomaticFailoverStatus_Values

func PendingAutomaticFailoverStatus_Values() []string

PendingAutomaticFailoverStatus_Values returns all elements of the PendingAutomaticFailoverStatus enum

func ServiceUpdateSeverity_Values

func ServiceUpdateSeverity_Values() []string

ServiceUpdateSeverity_Values returns all elements of the ServiceUpdateSeverity enum

func ServiceUpdateStatus_Values

func ServiceUpdateStatus_Values() []string

ServiceUpdateStatus_Values returns all elements of the ServiceUpdateStatus enum

func ServiceUpdateType_Values

func ServiceUpdateType_Values() []string

ServiceUpdateType_Values returns all elements of the ServiceUpdateType enum

func SlaMet_Values

func SlaMet_Values() []string

SlaMet_Values returns all elements of the SlaMet enum

func SourceType_Values

func SourceType_Values() []string

SourceType_Values returns all elements of the SourceType enum

func TransitEncryptionMode_Values added in v1.42.9

func TransitEncryptionMode_Values() []string

TransitEncryptionMode_Values returns all elements of the TransitEncryptionMode enum

func UpdateActionStatus_Values

func UpdateActionStatus_Values() []string

UpdateActionStatus_Values returns all elements of the UpdateActionStatus enum

Types

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 Amazon
	// 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 tags to be added to this resource. A tag is a key-value pair. A
	// tag key must be accompanied by a tag value, although null is accepted.
	//
	// 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) GoString

func (s AddTagsToResourceInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AddTagsToResourceInput) SetResourceName

func (s *AddTagsToResourceInput) SetResourceName(v string) *AddTagsToResourceInput

SetResourceName sets the ResourceName field's value.

func (*AddTagsToResourceInput) SetTags

SetTags sets the Tags field's value.

func (AddTagsToResourceInput) String

func (s AddTagsToResourceInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AddTagsToResourceInput) Validate

func (s *AddTagsToResourceInput) Validate() error

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

type Authentication

type Authentication struct {

	// The number of passwords belonging to the user. The maximum is two.
	PasswordCount *int64 `type:"integer"`

	// Indicates whether the user requires a password to authenticate.
	Type *string `type:"string" enum:"AuthenticationType"`
	// contains filtered or unexported fields
}

Indicates whether the user requires a password to authenticate.

func (Authentication) GoString

func (s Authentication) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Authentication) SetPasswordCount

func (s *Authentication) SetPasswordCount(v int64) *Authentication

SetPasswordCount sets the PasswordCount field's value.

func (*Authentication) SetType

func (s *Authentication) SetType(v string) *Authentication

SetType sets the Type field's value.

func (Authentication) String

func (s Authentication) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AuthenticationMode added in v1.42.9

type AuthenticationMode struct {

	// Specifies the passwords to use for authentication if Type is set to password.
	Passwords []*string `min:"1" type:"list"`

	// Specifies the authentication type. Possible options are IAM authentication,
	// password and no password.
	Type *string `type:"string" enum:"InputAuthenticationType"`
	// contains filtered or unexported fields
}

Specifies the authentication mode to use.

func (AuthenticationMode) GoString added in v1.42.9

func (s AuthenticationMode) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AuthenticationMode) SetPasswords added in v1.42.9

func (s *AuthenticationMode) SetPasswords(v []*string) *AuthenticationMode

SetPasswords sets the Passwords field's value.

func (*AuthenticationMode) SetType added in v1.42.9

SetType sets the Type field's value.

func (AuthenticationMode) String added in v1.42.9

func (s AuthenticationMode) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AuthenticationMode) Validate added in v1.42.9

func (s *AuthenticationMode) Validate() error

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

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 Amazon account number of the Amazon EC2 security group owner. Note that
	// this is not the same thing as an Amazon access key ID - you must provide
	// a valid Amazon 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) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AuthorizeCacheSecurityGroupIngressInput) SetCacheSecurityGroupName

SetCacheSecurityGroupName sets the CacheSecurityGroupName field's value.

func (*AuthorizeCacheSecurityGroupIngressInput) SetEC2SecurityGroupName

SetEC2SecurityGroupName sets the EC2SecurityGroupName field's value.

func (*AuthorizeCacheSecurityGroupIngressInput) SetEC2SecurityGroupOwnerId

SetEC2SecurityGroupOwnerId sets the EC2SecurityGroupOwnerId field's value.

func (AuthorizeCacheSecurityGroupIngressInput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AuthorizeCacheSecurityGroupIngressOutput) SetCacheSecurityGroup

SetCacheSecurityGroup sets the CacheSecurityGroup field's value.

func (AuthorizeCacheSecurityGroupIngressOutput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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) GoString

func (s AvailabilityZone) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AvailabilityZone) SetName

func (s *AvailabilityZone) SetName(v string) *AvailabilityZone

SetName sets the Name field's value.

func (AvailabilityZone) String

func (s AvailabilityZone) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type BatchApplyUpdateActionInput

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) GoString

func (s BatchApplyUpdateActionInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*BatchApplyUpdateActionInput) SetCacheClusterIds

func (s *BatchApplyUpdateActionInput) SetCacheClusterIds(v []*string) *BatchApplyUpdateActionInput

SetCacheClusterIds sets the CacheClusterIds field's value.

func (*BatchApplyUpdateActionInput) SetReplicationGroupIds

func (s *BatchApplyUpdateActionInput) SetReplicationGroupIds(v []*string) *BatchApplyUpdateActionInput

SetReplicationGroupIds sets the ReplicationGroupIds field's value.

func (*BatchApplyUpdateActionInput) SetServiceUpdateName

SetServiceUpdateName sets the ServiceUpdateName field's value.

func (BatchApplyUpdateActionInput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*BatchApplyUpdateActionInput) Validate

func (s *BatchApplyUpdateActionInput) Validate() error

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

type BatchApplyUpdateActionOutput

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) GoString

func (s BatchApplyUpdateActionOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*BatchApplyUpdateActionOutput) SetProcessedUpdateActions

SetProcessedUpdateActions sets the ProcessedUpdateActions field's value.

func (*BatchApplyUpdateActionOutput) SetUnprocessedUpdateActions

SetUnprocessedUpdateActions sets the UnprocessedUpdateActions field's value.

func (BatchApplyUpdateActionOutput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type BatchStopUpdateActionInput

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) GoString

func (s BatchStopUpdateActionInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*BatchStopUpdateActionInput) SetCacheClusterIds

func (s *BatchStopUpdateActionInput) SetCacheClusterIds(v []*string) *BatchStopUpdateActionInput

SetCacheClusterIds sets the CacheClusterIds field's value.

func (*BatchStopUpdateActionInput) SetReplicationGroupIds

func (s *BatchStopUpdateActionInput) SetReplicationGroupIds(v []*string) *BatchStopUpdateActionInput

SetReplicationGroupIds sets the ReplicationGroupIds field's value.

func (*BatchStopUpdateActionInput) SetServiceUpdateName

func (s *BatchStopUpdateActionInput) SetServiceUpdateName(v string) *BatchStopUpdateActionInput

SetServiceUpdateName sets the ServiceUpdateName field's value.

func (BatchStopUpdateActionInput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*BatchStopUpdateActionInput) Validate

func (s *BatchStopUpdateActionInput) Validate() error

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

type BatchStopUpdateActionOutput

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) GoString

func (s BatchStopUpdateActionOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*BatchStopUpdateActionOutput) SetProcessedUpdateActions

SetProcessedUpdateActions sets the ProcessedUpdateActions field's value.

func (*BatchStopUpdateActionOutput) SetUnprocessedUpdateActions

SetUnprocessedUpdateActions sets the UnprocessedUpdateActions field's value.

func (BatchStopUpdateActionOutput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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"`

	// If you are running Redis engine version 6.0 or later, set this parameter
	// to yes if you want to opt-in to the next auto minor version upgrade campaign.
	// This parameter is disabled for previous versions.
	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: M6g node types (available only
	//    for Redis engine version 5.0.6 onward and for Memcached engine version
	//    1.5.16 onward): cache.m6g.large, cache.m6g.xlarge, cache.m6g.2xlarge,
	//    cache.m6g.4xlarge, cache.m6g.8xlarge, cache.m6g.12xlarge, cache.m6g.16xlarge
	//    For region availability, see Supported Node Types (https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/CacheNodes.SupportedTypes.html#CacheNodes.SupportedTypesByRegion)
	//    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 T4g node types (available
	//    only for Redis engine version 5.0.6 onward and Memcached engine version
	//    1.5.16 onward): cache.t4g.micro, cache.t4g.small, cache.t4g.medium 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. Existing clusters are still supported but creation of new
	//    clusters is not supported for these types.) 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. Existing clusters
	//    are still supported but creation of new clusters is not supported for
	//    these types.) C1 node types: cache.c1.xlarge
	//
	//    * Memory optimized: Current generation: R6g node types (available only
	//    for Redis engine version 5.0.6 onward and for Memcached engine version
	//    1.5.16 onward). cache.r6g.large, cache.r6g.xlarge, cache.r6g.2xlarge,
	//    cache.r6g.4xlarge, cache.r6g.8xlarge, cache.r6g.12xlarge, cache.r6g.16xlarge
	//    For region availability, see Supported Node Types (https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/CacheNodes.SupportedTypes.html#CacheNodes.SupportedTypesByRegion)
	//    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. Existing clusters are still supported
	//    but creation of new clusters is not supported for these types.) 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 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"`

	// The network type associated with the cluster, either ipv4 | ipv6. IPv6 is
	// supported for workloads using Redis engine version 6.2 onward or Memcached
	// engine version 1.6.6 on all instances built on the Nitro system (http://aws.amazon.com/ec2/nitro/).
	IpDiscovery *string `type:"string" enum:"IpDiscovery"`

	// Returns the destination, format and type of the logs.
	LogDeliveryConfigurations []*LogDeliveryConfiguration `locationNameList:"LogDeliveryConfiguration" type:"list"`

	// Must be either ipv4 | ipv6 | dual_stack. IPv6 is supported for workloads
	// using Redis engine version 6.2 onward or Memcached engine version 1.6.6 on
	// all instances built on the Nitro system (http://aws.amazon.com/ec2/nitro/).
	NetworkType *string `type:"string" enum:"NetworkType"`

	// 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 40.
	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 outpost ARN in which the cache cluster is created.
	PreferredOutpostArn *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 boolean value indicating whether log delivery is enabled for the replication
	// group.
	ReplicationGroupLogDeliveryEnabled *bool `type:"boolean"`

	// 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.
	//
	// 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"`

	// A setting that allows you to migrate your clients to use in-transit encryption,
	// with no downtime.
	TransitEncryptionMode *string `type:"string" enum:"TransitEncryptionMode"`
	// contains filtered or unexported fields
}

Contains all of the attributes of a specific cluster.

func (CacheCluster) GoString

func (s CacheCluster) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CacheCluster) SetARN

func (s *CacheCluster) SetARN(v string) *CacheCluster

SetARN sets the ARN field's value.

func (*CacheCluster) SetAtRestEncryptionEnabled

func (s *CacheCluster) SetAtRestEncryptionEnabled(v bool) *CacheCluster

SetAtRestEncryptionEnabled sets the AtRestEncryptionEnabled field's value.

func (*CacheCluster) SetAuthTokenEnabled

func (s *CacheCluster) SetAuthTokenEnabled(v bool) *CacheCluster

SetAuthTokenEnabled sets the AuthTokenEnabled field's value.

func (*CacheCluster) SetAuthTokenLastModifiedDate

func (s *CacheCluster) SetAuthTokenLastModifiedDate(v time.Time) *CacheCluster

SetAuthTokenLastModifiedDate sets the AuthTokenLastModifiedDate field's value.

func (*CacheCluster) SetAutoMinorVersionUpgrade

func (s *CacheCluster) SetAutoMinorVersionUpgrade(v bool) *CacheCluster

SetAutoMinorVersionUpgrade sets the AutoMinorVersionUpgrade field's value.

func (*CacheCluster) SetCacheClusterCreateTime

func (s *CacheCluster) SetCacheClusterCreateTime(v time.Time) *CacheCluster

SetCacheClusterCreateTime sets the CacheClusterCreateTime field's value.

func (*CacheCluster) SetCacheClusterId

func (s *CacheCluster) SetCacheClusterId(v string) *CacheCluster

SetCacheClusterId sets the CacheClusterId field's value.

func (*CacheCluster) SetCacheClusterStatus

func (s *CacheCluster) SetCacheClusterStatus(v string) *CacheCluster

SetCacheClusterStatus sets the CacheClusterStatus field's value.

func (*CacheCluster) SetCacheNodeType

func (s *CacheCluster) SetCacheNodeType(v string) *CacheCluster

SetCacheNodeType sets the CacheNodeType field's value.

func (*CacheCluster) SetCacheNodes

func (s *CacheCluster) SetCacheNodes(v []*CacheNode) *CacheCluster

SetCacheNodes sets the CacheNodes field's value.

func (*CacheCluster) SetCacheParameterGroup

func (s *CacheCluster) SetCacheParameterGroup(v *CacheParameterGroupStatus) *CacheCluster

SetCacheParameterGroup sets the CacheParameterGroup field's value.

func (*CacheCluster) SetCacheSecurityGroups

func (s *CacheCluster) SetCacheSecurityGroups(v []*CacheSecurityGroupMembership) *CacheCluster

SetCacheSecurityGroups sets the CacheSecurityGroups field's value.

func (*CacheCluster) SetCacheSubnetGroupName

func (s *CacheCluster) SetCacheSubnetGroupName(v string) *CacheCluster

SetCacheSubnetGroupName sets the CacheSubnetGroupName field's value.

func (*CacheCluster) SetClientDownloadLandingPage

func (s *CacheCluster) SetClientDownloadLandingPage(v string) *CacheCluster

SetClientDownloadLandingPage sets the ClientDownloadLandingPage field's value.

func (*CacheCluster) SetConfigurationEndpoint

func (s *CacheCluster) SetConfigurationEndpoint(v *Endpoint) *CacheCluster

SetConfigurationEndpoint sets the ConfigurationEndpoint field's value.

func (*CacheCluster) SetEngine

func (s *CacheCluster) SetEngine(v string) *CacheCluster

SetEngine sets the Engine field's value.

func (*CacheCluster) SetEngineVersion

func (s *CacheCluster) SetEngineVersion(v string) *CacheCluster

SetEngineVersion sets the EngineVersion field's value.

func (*CacheCluster) SetIpDiscovery added in v1.42.9

func (s *CacheCluster) SetIpDiscovery(v string) *CacheCluster

SetIpDiscovery sets the IpDiscovery field's value.

func (*CacheCluster) SetLogDeliveryConfigurations

func (s *CacheCluster) SetLogDeliveryConfigurations(v []*LogDeliveryConfiguration) *CacheCluster

SetLogDeliveryConfigurations sets the LogDeliveryConfigurations field's value.

func (*CacheCluster) SetNetworkType added in v1.42.9

func (s *CacheCluster) SetNetworkType(v string) *CacheCluster

SetNetworkType sets the NetworkType field's value.

func (*CacheCluster) SetNotificationConfiguration

func (s *CacheCluster) SetNotificationConfiguration(v *NotificationConfiguration) *CacheCluster

SetNotificationConfiguration sets the NotificationConfiguration field's value.

func (*CacheCluster) SetNumCacheNodes

func (s *CacheCluster) SetNumCacheNodes(v int64) *CacheCluster

SetNumCacheNodes sets the NumCacheNodes field's value.

func (*CacheCluster) SetPendingModifiedValues

func (s *CacheCluster) SetPendingModifiedValues(v *PendingModifiedValues) *CacheCluster

SetPendingModifiedValues sets the PendingModifiedValues field's value.

func (*CacheCluster) SetPreferredAvailabilityZone

func (s *CacheCluster) SetPreferredAvailabilityZone(v string) *CacheCluster

SetPreferredAvailabilityZone sets the PreferredAvailabilityZone field's value.

func (*CacheCluster) SetPreferredMaintenanceWindow

func (s *CacheCluster) SetPreferredMaintenanceWindow(v string) *CacheCluster

SetPreferredMaintenanceWindow sets the PreferredMaintenanceWindow field's value.

func (*CacheCluster) SetPreferredOutpostArn

func (s *CacheCluster) SetPreferredOutpostArn(v string) *CacheCluster

SetPreferredOutpostArn sets the PreferredOutpostArn field's value.

func (*CacheCluster) SetReplicationGroupId

func (s *CacheCluster) SetReplicationGroupId(v string) *CacheCluster

SetReplicationGroupId sets the ReplicationGroupId field's value.

func (*CacheCluster) SetReplicationGroupLogDeliveryEnabled

func (s *CacheCluster) SetReplicationGroupLogDeliveryEnabled(v bool) *CacheCluster

SetReplicationGroupLogDeliveryEnabled sets the ReplicationGroupLogDeliveryEnabled field's value.

func (*CacheCluster) SetSecurityGroups

func (s *CacheCluster) SetSecurityGroups(v []*SecurityGroupMembership) *CacheCluster

SetSecurityGroups sets the SecurityGroups field's value.

func (*CacheCluster) SetSnapshotRetentionLimit

func (s *CacheCluster) SetSnapshotRetentionLimit(v int64) *CacheCluster

SetSnapshotRetentionLimit sets the SnapshotRetentionLimit field's value.

func (*CacheCluster) SetSnapshotWindow

func (s *CacheCluster) SetSnapshotWindow(v string) *CacheCluster

SetSnapshotWindow sets the SnapshotWindow field's value.

func (*CacheCluster) SetTransitEncryptionEnabled

func (s *CacheCluster) SetTransitEncryptionEnabled(v bool) *CacheCluster

SetTransitEncryptionEnabled sets the TransitEncryptionEnabled field's value.

func (*CacheCluster) SetTransitEncryptionMode added in v1.42.9

func (s *CacheCluster) SetTransitEncryptionMode(v string) *CacheCluster

SetTransitEncryptionMode sets the TransitEncryptionMode field's value.

func (CacheCluster) String

func (s CacheCluster) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 | memcached1.6 | redis2.6 |
	// redis2.8 | redis3.2 | redis4.0 | redis5.0 | redis6.x | redis7
	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) GoString

func (s CacheEngineVersion) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CacheEngineVersion) SetCacheEngineDescription

func (s *CacheEngineVersion) SetCacheEngineDescription(v string) *CacheEngineVersion

SetCacheEngineDescription sets the CacheEngineDescription field's value.

func (*CacheEngineVersion) SetCacheEngineVersionDescription

func (s *CacheEngineVersion) SetCacheEngineVersionDescription(v string) *CacheEngineVersion

SetCacheEngineVersionDescription sets the CacheEngineVersionDescription field's value.

func (*CacheEngineVersion) SetCacheParameterGroupFamily

func (s *CacheEngineVersion) SetCacheParameterGroupFamily(v string) *CacheEngineVersion

SetCacheParameterGroupFamily sets the CacheParameterGroupFamily field's value.

func (*CacheEngineVersion) SetEngine

func (s *CacheEngineVersion) SetEngine(v string) *CacheEngineVersion

SetEngine sets the Engine field's value.

func (*CacheEngineVersion) SetEngineVersion

func (s *CacheEngineVersion) SetEngineVersion(v string) *CacheEngineVersion

SetEngineVersion sets the EngineVersion field's value.

func (CacheEngineVersion) String

func (s CacheEngineVersion) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 Amazon 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 customer outpost ARN of the cache node.
	CustomerOutpostArn *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: M6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward): cache.m6g.large, cache.m6g.xlarge, cache.m6g.2xlarge, cache.m6g.4xlarge, cache.m6g.8xlarge, cache.m6g.12xlarge, cache.m6g.16xlarge For region availability, see Supported Node Types (https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/CacheNodes.SupportedTypes.html#CacheNodes.SupportedTypesByRegion) 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 T4g node types (available only for Redis engine version 5.0.6 onward and Memcached engine version 1.5.16 onward): cache.t4g.micro, cache.t4g.small, cache.t4g.medium 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. Existing clusters are still supported but creation of new clusters is not supported for these types.) 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. Existing clusters are still supported but creation of new clusters is not supported for these types.) C1 node types: cache.c1.xlarge

  • Memory optimized: Current generation: R6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward). cache.r6g.large, cache.r6g.xlarge, cache.r6g.2xlarge, cache.r6g.4xlarge, cache.r6g.8xlarge, cache.r6g.12xlarge, cache.r6g.16xlarge For region availability, see Supported Node Types (https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/CacheNodes.SupportedTypes.html#CacheNodes.SupportedTypesByRegion) 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. Existing clusters are still supported but creation of new clusters is not supported for these types.) 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) GoString

func (s CacheNode) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CacheNode) SetCacheNodeCreateTime

func (s *CacheNode) SetCacheNodeCreateTime(v time.Time) *CacheNode

SetCacheNodeCreateTime sets the CacheNodeCreateTime field's value.

func (*CacheNode) SetCacheNodeId

func (s *CacheNode) SetCacheNodeId(v string) *CacheNode

SetCacheNodeId sets the CacheNodeId field's value.

func (*CacheNode) SetCacheNodeStatus

func (s *CacheNode) SetCacheNodeStatus(v string) *CacheNode

SetCacheNodeStatus sets the CacheNodeStatus field's value.

func (*CacheNode) SetCustomerAvailabilityZone

func (s *CacheNode) SetCustomerAvailabilityZone(v string) *CacheNode

SetCustomerAvailabilityZone sets the CustomerAvailabilityZone field's value.

func (*CacheNode) SetCustomerOutpostArn

func (s *CacheNode) SetCustomerOutpostArn(v string) *CacheNode

SetCustomerOutpostArn sets the CustomerOutpostArn field's value.

func (*CacheNode) SetEndpoint

func (s *CacheNode) SetEndpoint(v *Endpoint) *CacheNode

SetEndpoint sets the Endpoint field's value.

func (*CacheNode) SetParameterGroupStatus

func (s *CacheNode) SetParameterGroupStatus(v string) *CacheNode

SetParameterGroupStatus sets the ParameterGroupStatus field's value.

func (*CacheNode) SetSourceCacheNodeId

func (s *CacheNode) SetSourceCacheNodeId(v string) *CacheNode

SetSourceCacheNodeId sets the SourceCacheNodeId field's value.

func (CacheNode) String

func (s CacheNode) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 *string `type:"string" enum:"ChangeType"`

	// 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) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CacheNodeTypeSpecificParameter) SetAllowedValues

SetAllowedValues sets the AllowedValues field's value.

func (*CacheNodeTypeSpecificParameter) SetCacheNodeTypeSpecificValues

SetCacheNodeTypeSpecificValues sets the CacheNodeTypeSpecificValues field's value.

func (*CacheNodeTypeSpecificParameter) SetChangeType

SetChangeType sets the ChangeType field's value.

func (*CacheNodeTypeSpecificParameter) SetDataType

SetDataType sets the DataType field's value.

func (*CacheNodeTypeSpecificParameter) SetDescription

SetDescription sets the Description field's value.

func (*CacheNodeTypeSpecificParameter) SetIsModifiable

SetIsModifiable sets the IsModifiable field's value.

func (*CacheNodeTypeSpecificParameter) SetMinimumEngineVersion

SetMinimumEngineVersion sets the MinimumEngineVersion field's value.

func (*CacheNodeTypeSpecificParameter) SetParameterName

SetParameterName sets the ParameterName field's value.

func (*CacheNodeTypeSpecificParameter) SetSource

SetSource sets the Source field's value.

func (CacheNodeTypeSpecificParameter) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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) GoString

func (s CacheNodeTypeSpecificValue) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CacheNodeTypeSpecificValue) SetCacheNodeType

SetCacheNodeType sets the CacheNodeType field's value.

func (*CacheNodeTypeSpecificValue) SetValue

SetValue sets the Value field's value.

func (CacheNodeTypeSpecificValue) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CacheNodeUpdateStatus

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 *string `type:"string" enum:"NodeUpdateInitiatedBy"`

	// 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 *string `type:"string" enum:"NodeUpdateStatus"`

	// 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) GoString

func (s CacheNodeUpdateStatus) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CacheNodeUpdateStatus) SetCacheNodeId

func (s *CacheNodeUpdateStatus) SetCacheNodeId(v string) *CacheNodeUpdateStatus

SetCacheNodeId sets the CacheNodeId field's value.

func (*CacheNodeUpdateStatus) SetNodeDeletionDate

func (s *CacheNodeUpdateStatus) SetNodeDeletionDate(v time.Time) *CacheNodeUpdateStatus

SetNodeDeletionDate sets the NodeDeletionDate field's value.

func (*CacheNodeUpdateStatus) SetNodeUpdateEndDate

func (s *CacheNodeUpdateStatus) SetNodeUpdateEndDate(v time.Time) *CacheNodeUpdateStatus

SetNodeUpdateEndDate sets the NodeUpdateEndDate field's value.

func (*CacheNodeUpdateStatus) SetNodeUpdateInitiatedBy

func (s *CacheNodeUpdateStatus) SetNodeUpdateInitiatedBy(v string) *CacheNodeUpdateStatus

SetNodeUpdateInitiatedBy sets the NodeUpdateInitiatedBy field's value.

func (*CacheNodeUpdateStatus) SetNodeUpdateInitiatedDate

func (s *CacheNodeUpdateStatus) SetNodeUpdateInitiatedDate(v time.Time) *CacheNodeUpdateStatus

SetNodeUpdateInitiatedDate sets the NodeUpdateInitiatedDate field's value.

func (*CacheNodeUpdateStatus) SetNodeUpdateStartDate

func (s *CacheNodeUpdateStatus) SetNodeUpdateStartDate(v time.Time) *CacheNodeUpdateStatus

SetNodeUpdateStartDate sets the NodeUpdateStartDate field's value.

func (*CacheNodeUpdateStatus) SetNodeUpdateStatus

func (s *CacheNodeUpdateStatus) SetNodeUpdateStatus(v string) *CacheNodeUpdateStatus

SetNodeUpdateStatus sets the NodeUpdateStatus field's value.

func (*CacheNodeUpdateStatus) SetNodeUpdateStatusModifiedDate

func (s *CacheNodeUpdateStatus) SetNodeUpdateStatusModifiedDate(v time.Time) *CacheNodeUpdateStatus

SetNodeUpdateStatusModifiedDate sets the NodeUpdateStatusModifiedDate field's value.

func (CacheNodeUpdateStatus) String

func (s CacheNodeUpdateStatus) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 | memcached1.6 | redis2.6 |
	// redis2.8 | redis3.2 | redis4.0 | redis5.0 | redis6.x | redis7
	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) GoString

func (s CacheParameterGroup) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CacheParameterGroup) SetARN

SetARN sets the ARN field's value.

func (*CacheParameterGroup) SetCacheParameterGroupFamily

func (s *CacheParameterGroup) SetCacheParameterGroupFamily(v string) *CacheParameterGroup

SetCacheParameterGroupFamily sets the CacheParameterGroupFamily field's value.

func (*CacheParameterGroup) SetCacheParameterGroupName

func (s *CacheParameterGroup) SetCacheParameterGroupName(v string) *CacheParameterGroup

SetCacheParameterGroupName sets the CacheParameterGroupName field's value.

func (*CacheParameterGroup) SetDescription

func (s *CacheParameterGroup) SetDescription(v string) *CacheParameterGroup

SetDescription sets the Description field's value.

func (*CacheParameterGroup) SetIsGlobal

func (s *CacheParameterGroup) SetIsGlobal(v bool) *CacheParameterGroup

SetIsGlobal sets the IsGlobal field's value.

func (CacheParameterGroup) String

func (s CacheParameterGroup) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CacheParameterGroupNameMessage

type CacheParameterGroupNameMessage 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 (CacheParameterGroupNameMessage) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CacheParameterGroupNameMessage) SetCacheParameterGroupName

func (s *CacheParameterGroupNameMessage) SetCacheParameterGroupName(v string) *CacheParameterGroupNameMessage

SetCacheParameterGroupName sets the CacheParameterGroupName field's value.

func (CacheParameterGroupNameMessage) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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) GoString

func (s CacheParameterGroupStatus) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CacheParameterGroupStatus) SetCacheNodeIdsToReboot

func (s *CacheParameterGroupStatus) SetCacheNodeIdsToReboot(v []*string) *CacheParameterGroupStatus

SetCacheNodeIdsToReboot sets the CacheNodeIdsToReboot field's value.

func (*CacheParameterGroupStatus) SetCacheParameterGroupName

func (s *CacheParameterGroupStatus) SetCacheParameterGroupName(v string) *CacheParameterGroupStatus

SetCacheParameterGroupName sets the CacheParameterGroupName field's value.

func (*CacheParameterGroupStatus) SetParameterApplyStatus

func (s *CacheParameterGroupStatus) SetParameterApplyStatus(v string) *CacheParameterGroupStatus

SetParameterApplyStatus sets the ParameterApplyStatus field's value.

func (CacheParameterGroupStatus) String

func (s CacheParameterGroupStatus) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CacheSecurityGroup

type CacheSecurityGroup struct {

	// The ARN 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 Amazon 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) GoString

func (s CacheSecurityGroup) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CacheSecurityGroup) SetARN

SetARN sets the ARN field's value.

func (*CacheSecurityGroup) SetCacheSecurityGroupName

func (s *CacheSecurityGroup) SetCacheSecurityGroupName(v string) *CacheSecurityGroup

SetCacheSecurityGroupName sets the CacheSecurityGroupName field's value.

func (*CacheSecurityGroup) SetDescription

func (s *CacheSecurityGroup) SetDescription(v string) *CacheSecurityGroup

SetDescription sets the Description field's value.

func (*CacheSecurityGroup) SetEC2SecurityGroups

func (s *CacheSecurityGroup) SetEC2SecurityGroups(v []*EC2SecurityGroup) *CacheSecurityGroup

SetEC2SecurityGroups sets the EC2SecurityGroups field's value.

func (*CacheSecurityGroup) SetOwnerId

func (s *CacheSecurityGroup) SetOwnerId(v string) *CacheSecurityGroup

SetOwnerId sets the OwnerId field's value.

func (CacheSecurityGroup) String

func (s CacheSecurityGroup) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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) GoString

func (s CacheSecurityGroupMembership) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CacheSecurityGroupMembership) SetCacheSecurityGroupName

func (s *CacheSecurityGroupMembership) SetCacheSecurityGroupName(v string) *CacheSecurityGroupMembership

SetCacheSecurityGroupName sets the CacheSecurityGroupName field's value.

func (*CacheSecurityGroupMembership) SetStatus

SetStatus sets the Status field's value.

func (CacheSecurityGroupMembership) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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"`

	// Either ipv4 | ipv6 | dual_stack. IPv6 is supported for workloads using Redis
	// engine version 6.2 onward or Memcached engine version 1.6.6 on all instances
	// built on the Nitro system (http://aws.amazon.com/ec2/nitro/).
	SupportedNetworkTypes []*string `type:"list" enum:"NetworkType"`

	// 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) GoString

func (s CacheSubnetGroup) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CacheSubnetGroup) SetARN

SetARN sets the ARN field's value.

func (*CacheSubnetGroup) SetCacheSubnetGroupDescription

func (s *CacheSubnetGroup) SetCacheSubnetGroupDescription(v string) *CacheSubnetGroup

SetCacheSubnetGroupDescription sets the CacheSubnetGroupDescription field's value.

func (*CacheSubnetGroup) SetCacheSubnetGroupName

func (s *CacheSubnetGroup) SetCacheSubnetGroupName(v string) *CacheSubnetGroup

SetCacheSubnetGroupName sets the CacheSubnetGroupName field's value.

func (*CacheSubnetGroup) SetSubnets

func (s *CacheSubnetGroup) SetSubnets(v []*Subnet) *CacheSubnetGroup

SetSubnets sets the Subnets field's value.

func (*CacheSubnetGroup) SetSupportedNetworkTypes added in v1.42.9

func (s *CacheSubnetGroup) SetSupportedNetworkTypes(v []*string) *CacheSubnetGroup

SetSupportedNetworkTypes sets the SupportedNetworkTypes field's value.

func (*CacheSubnetGroup) SetVpcId

func (s *CacheSubnetGroup) SetVpcId(v string) *CacheSubnetGroup

SetVpcId sets the VpcId field's value.

func (CacheSubnetGroup) String

func (s CacheSubnetGroup) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CloudWatchLogsDestinationDetails

type CloudWatchLogsDestinationDetails struct {

	// The name of the CloudWatch Logs log group.
	LogGroup *string `type:"string"`
	// contains filtered or unexported fields
}

The configuration details of the CloudWatch Logs destination.

func (CloudWatchLogsDestinationDetails) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CloudWatchLogsDestinationDetails) SetLogGroup

SetLogGroup sets the LogGroup field's value.

func (CloudWatchLogsDestinationDetails) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CompleteMigrationInput

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) GoString

func (s CompleteMigrationInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CompleteMigrationInput) SetForce

SetForce sets the Force field's value.

func (*CompleteMigrationInput) SetReplicationGroupId

func (s *CompleteMigrationInput) SetReplicationGroupId(v string) *CompleteMigrationInput

SetReplicationGroupId sets the ReplicationGroupId field's value.

func (CompleteMigrationInput) String

func (s CompleteMigrationInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CompleteMigrationInput) Validate

func (s *CompleteMigrationInput) Validate() error

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

type CompleteMigrationOutput

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) GoString

func (s CompleteMigrationOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CompleteMigrationOutput) SetReplicationGroup

SetReplicationGroup sets the ReplicationGroup field's value.

func (CompleteMigrationOutput) String

func (s CompleteMigrationOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ConfigureShard

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"`

	// The outpost ARNs in which the cache cluster is created.
	PreferredOutpostArns []*string `locationNameList:"PreferredOutpostArn" 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) GoString

func (s ConfigureShard) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ConfigureShard) SetNewReplicaCount

func (s *ConfigureShard) SetNewReplicaCount(v int64) *ConfigureShard

SetNewReplicaCount sets the NewReplicaCount field's value.

func (*ConfigureShard) SetNodeGroupId

func (s *ConfigureShard) SetNodeGroupId(v string) *ConfigureShard

SetNodeGroupId sets the NodeGroupId field's value.

func (*ConfigureShard) SetPreferredAvailabilityZones

func (s *ConfigureShard) SetPreferredAvailabilityZones(v []*string) *ConfigureShard

SetPreferredAvailabilityZones sets the PreferredAvailabilityZones field's value.

func (*ConfigureShard) SetPreferredOutpostArns

func (s *ConfigureShard) SetPreferredOutpostArns(v []*string) *ConfigureShard

SetPreferredOutpostArns sets the PreferredOutpostArns field's value.

func (ConfigureShard) String

func (s ConfigureShard) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ConfigureShard) Validate

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"`

	// A list of tags to be added to this resource. A tag is a key-value pair. A
	// tag key must be accompanied by a tag value, although null is accepted.
	Tags []*Tag `locationNameList:"Tag" type:"list"`

	// 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/backups-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) GoString

func (s CopySnapshotInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CopySnapshotInput) SetKmsKeyId

func (s *CopySnapshotInput) SetKmsKeyId(v string) *CopySnapshotInput

SetKmsKeyId sets the KmsKeyId field's value.

func (*CopySnapshotInput) SetSourceSnapshotName

func (s *CopySnapshotInput) SetSourceSnapshotName(v string) *CopySnapshotInput

SetSourceSnapshotName sets the SourceSnapshotName field's value.

func (*CopySnapshotInput) SetTags

func (s *CopySnapshotInput) SetTags(v []*Tag) *CopySnapshotInput

SetTags sets the Tags field's value.

func (*CopySnapshotInput) SetTargetBucket

func (s *CopySnapshotInput) SetTargetBucket(v string) *CopySnapshotInput

SetTargetBucket sets the TargetBucket field's value.

func (*CopySnapshotInput) SetTargetSnapshotName

func (s *CopySnapshotInput) SetTargetSnapshotName(v string) *CopySnapshotInput

SetTargetSnapshotName sets the TargetSnapshotName field's value.

func (CopySnapshotInput) String

func (s CopySnapshotInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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) GoString

func (s CopySnapshotOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CopySnapshotOutput) SetSnapshot

func (s *CopySnapshotOutput) SetSnapshot(v *Snapshot) *CopySnapshotOutput

SetSnapshot sets the Snapshot field's value.

func (CopySnapshotOutput) String

func (s CopySnapshotOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 *string `type:"string" enum:"AZMode"`

	// 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"`

	// If you are running Redis engine version 6.0 or later, set this parameter
	// to yes if you want to opt-in to the next auto minor version upgrade campaign.
	// This parameter is disabled for previous versions.
	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: M6g node types (available only
	//    for Redis engine version 5.0.6 onward and for Memcached engine version
	//    1.5.16 onward): cache.m6g.large, cache.m6g.xlarge, cache.m6g.2xlarge,
	//    cache.m6g.4xlarge, cache.m6g.8xlarge, cache.m6g.12xlarge, cache.m6g.16xlarge
	//    For region availability, see Supported Node Types (https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/CacheNodes.SupportedTypes.html#CacheNodes.SupportedTypesByRegion)
	//    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 T4g node types (available
	//    only for Redis engine version 5.0.6 onward and Memcached engine version
	//    1.5.16 onward): cache.t4g.micro, cache.t4g.small, cache.t4g.medium 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. Existing clusters are still supported but creation of new
	//    clusters is not supported for these types.) 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. Existing clusters
	//    are still supported but creation of new clusters is not supported for
	//    these types.) C1 node types: cache.c1.xlarge
	//
	//    * Memory optimized: Current generation: R6g node types (available only
	//    for Redis engine version 5.0.6 onward and for Memcached engine version
	//    1.5.16 onward). cache.r6g.large, cache.r6g.xlarge, cache.r6g.2xlarge,
	//    cache.r6g.4xlarge, cache.r6g.8xlarge, cache.r6g.12xlarge, cache.r6g.16xlarge
	//    For region availability, see Supported Node Types (https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/CacheNodes.SupportedTypes.html#CacheNodes.SupportedTypesByRegion)
	//    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. Existing clusters are still supported
	//    but creation of new clusters is not supported for these types.) 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 network type you choose when modifying a cluster, either ipv4 | ipv6.
	// IPv6 is supported for workloads using Redis engine version 6.2 onward or
	// Memcached engine version 1.6.6 on all instances built on the Nitro system
	// (http://aws.amazon.com/ec2/nitro/).
	IpDiscovery *string `type:"string" enum:"IpDiscovery"`

	// Specifies the destination, format and type of the logs.
	LogDeliveryConfigurations []*LogDeliveryConfigurationRequest `locationNameList:"LogDeliveryConfigurationRequest" type:"list"`

	// Must be either ipv4 | ipv6 | dual_stack. IPv6 is supported for workloads
	// using Redis engine version 6.2 onward or Memcached engine version 1.6.6 on
	// all instances built on the Nitro system (http://aws.amazon.com/ec2/nitro/).
	NetworkType *string `type:"string" enum:"NetworkType"`

	// 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 40.
	//
	// If you need more than 40 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"`

	// Specifies whether the nodes in the cluster are created in a single outpost
	// or across multiple outposts.
	OutpostMode *string `type:"string" enum:"OutpostMode"`

	// 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.
	PreferredMaintenanceWindow *string `type:"string"`

	// The outpost ARN in which the cache cluster is created.
	PreferredOutpostArn *string `type:"string"`

	// The outpost ARNs in which the cache cluster is created.
	PreferredOutpostArns []*string `locationNameList:"PreferredOutpostArn" type:"list"`

	// 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 tags to be added to this resource.
	Tags []*Tag `locationNameList:"Tag" type:"list"`

	// A flag that enables in-transit encryption when set to true.
	TransitEncryptionEnabled *bool `type:"boolean"`
	// contains filtered or unexported fields
}

Represents the input of a CreateCacheCluster operation.

func (CreateCacheClusterInput) GoString

func (s CreateCacheClusterInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateCacheClusterInput) SetAZMode

SetAZMode sets the AZMode field's value.

func (*CreateCacheClusterInput) SetAuthToken

SetAuthToken sets the AuthToken field's value.

func (*CreateCacheClusterInput) SetAutoMinorVersionUpgrade

func (s *CreateCacheClusterInput) SetAutoMinorVersionUpgrade(v bool) *CreateCacheClusterInput

SetAutoMinorVersionUpgrade sets the AutoMinorVersionUpgrade field's value.

func (*CreateCacheClusterInput) SetCacheClusterId

func (s *CreateCacheClusterInput) SetCacheClusterId(v string) *CreateCacheClusterInput

SetCacheClusterId sets the CacheClusterId field's value.

func (*CreateCacheClusterInput) SetCacheNodeType

func (s *CreateCacheClusterInput) SetCacheNodeType(v string) *CreateCacheClusterInput

SetCacheNodeType sets the CacheNodeType field's value.

func (*CreateCacheClusterInput) SetCacheParameterGroupName

func (s *CreateCacheClusterInput) SetCacheParameterGroupName(v string) *CreateCacheClusterInput

SetCacheParameterGroupName sets the CacheParameterGroupName field's value.

func (*CreateCacheClusterInput) SetCacheSecurityGroupNames

func (s *CreateCacheClusterInput) SetCacheSecurityGroupNames(v []*string) *CreateCacheClusterInput

SetCacheSecurityGroupNames sets the CacheSecurityGroupNames field's value.

func (*CreateCacheClusterInput) SetCacheSubnetGroupName

func (s *CreateCacheClusterInput) SetCacheSubnetGroupName(v string) *CreateCacheClusterInput

SetCacheSubnetGroupName sets the CacheSubnetGroupName field's value.

func (*CreateCacheClusterInput) SetEngine

SetEngine sets the Engine field's value.

func (*CreateCacheClusterInput) SetEngineVersion

func (s *CreateCacheClusterInput) SetEngineVersion(v string) *CreateCacheClusterInput

SetEngineVersion sets the EngineVersion field's value.

func (*CreateCacheClusterInput) SetIpDiscovery added in v1.42.9

SetIpDiscovery sets the IpDiscovery field's value.

func (*CreateCacheClusterInput) SetLogDeliveryConfigurations

SetLogDeliveryConfigurations sets the LogDeliveryConfigurations field's value.

func (*CreateCacheClusterInput) SetNetworkType added in v1.42.9

SetNetworkType sets the NetworkType field's value.

func (*CreateCacheClusterInput) SetNotificationTopicArn

func (s *CreateCacheClusterInput) SetNotificationTopicArn(v string) *CreateCacheClusterInput

SetNotificationTopicArn sets the NotificationTopicArn field's value.

func (*CreateCacheClusterInput) SetNumCacheNodes

func (s *CreateCacheClusterInput) SetNumCacheNodes(v int64) *CreateCacheClusterInput

SetNumCacheNodes sets the NumCacheNodes field's value.

func (*CreateCacheClusterInput) SetOutpostMode

SetOutpostMode sets the OutpostMode field's value.

func (*CreateCacheClusterInput) SetPort

SetPort sets the Port field's value.

func (*CreateCacheClusterInput) SetPreferredAvailabilityZone

func (s *CreateCacheClusterInput) SetPreferredAvailabilityZone(v string) *CreateCacheClusterInput

SetPreferredAvailabilityZone sets the PreferredAvailabilityZone field's value.

func (*CreateCacheClusterInput) SetPreferredAvailabilityZones

func (s *CreateCacheClusterInput) SetPreferredAvailabilityZones(v []*string) *CreateCacheClusterInput

SetPreferredAvailabilityZones sets the PreferredAvailabilityZones field's value.

func (*CreateCacheClusterInput) SetPreferredMaintenanceWindow

func (s *CreateCacheClusterInput) SetPreferredMaintenanceWindow(v string) *CreateCacheClusterInput

SetPreferredMaintenanceWindow sets the PreferredMaintenanceWindow field's value.

func (*CreateCacheClusterInput) SetPreferredOutpostArn

func (s *CreateCacheClusterInput) SetPreferredOutpostArn(v string) *CreateCacheClusterInput

SetPreferredOutpostArn sets the PreferredOutpostArn field's value.

func (*CreateCacheClusterInput) SetPreferredOutpostArns

func (s *CreateCacheClusterInput) SetPreferredOutpostArns(v []*string) *CreateCacheClusterInput

SetPreferredOutpostArns sets the PreferredOutpostArns field's value.

func (*CreateCacheClusterInput) SetReplicationGroupId

func (s *CreateCacheClusterInput) SetReplicationGroupId(v string) *CreateCacheClusterInput

SetReplicationGroupId sets the ReplicationGroupId field's value.

func (*CreateCacheClusterInput) SetSecurityGroupIds

func (s *CreateCacheClusterInput) SetSecurityGroupIds(v []*string) *CreateCacheClusterInput

SetSecurityGroupIds sets the SecurityGroupIds field's value.

func (*CreateCacheClusterInput) SetSnapshotArns

func (s *CreateCacheClusterInput) SetSnapshotArns(v []*string) *CreateCacheClusterInput

SetSnapshotArns sets the SnapshotArns field's value.

func (*CreateCacheClusterInput) SetSnapshotName

SetSnapshotName sets the SnapshotName field's value.

func (*CreateCacheClusterInput) SetSnapshotRetentionLimit

func (s *CreateCacheClusterInput) SetSnapshotRetentionLimit(v int64) *CreateCacheClusterInput

SetSnapshotRetentionLimit sets the SnapshotRetentionLimit field's value.

func (*CreateCacheClusterInput) SetSnapshotWindow

func (s *CreateCacheClusterInput) SetSnapshotWindow(v string) *CreateCacheClusterInput

SetSnapshotWindow sets the SnapshotWindow field's value.

func (*CreateCacheClusterInput) SetTags

SetTags sets the Tags field's value.

func (*CreateCacheClusterInput) SetTransitEncryptionEnabled added in v1.42.9

func (s *CreateCacheClusterInput) SetTransitEncryptionEnabled(v bool) *CreateCacheClusterInput

SetTransitEncryptionEnabled sets the TransitEncryptionEnabled field's value.

func (CreateCacheClusterInput) String

func (s CreateCacheClusterInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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) GoString

func (s CreateCacheClusterOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateCacheClusterOutput) SetCacheCluster

SetCacheCluster sets the CacheCluster field's value.

func (CreateCacheClusterOutput) String

func (s CreateCacheClusterOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 | memcached1.6 | redis2.6 |
	// redis2.8 | redis3.2 | redis4.0 | redis5.0 | redis6.x | redis7
	//
	// 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"`

	// A list of tags to be added to this resource. A tag is a key-value pair. A
	// tag key must be accompanied by a tag value, although null is accepted.
	Tags []*Tag `locationNameList:"Tag" type:"list"`
	// contains filtered or unexported fields
}

Represents the input of a CreateCacheParameterGroup operation.

func (CreateCacheParameterGroupInput) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateCacheParameterGroupInput) SetCacheParameterGroupFamily

func (s *CreateCacheParameterGroupInput) SetCacheParameterGroupFamily(v string) *CreateCacheParameterGroupInput

SetCacheParameterGroupFamily sets the CacheParameterGroupFamily field's value.

func (*CreateCacheParameterGroupInput) SetCacheParameterGroupName

func (s *CreateCacheParameterGroupInput) SetCacheParameterGroupName(v string) *CreateCacheParameterGroupInput

SetCacheParameterGroupName sets the CacheParameterGroupName field's value.

func (*CreateCacheParameterGroupInput) SetDescription

SetDescription sets the Description field's value.

func (*CreateCacheParameterGroupInput) SetTags

SetTags sets the Tags field's value.

func (CreateCacheParameterGroupInput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateCacheParameterGroupOutput) SetCacheParameterGroup

SetCacheParameterGroup sets the CacheParameterGroup field's value.

func (CreateCacheParameterGroupOutput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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"`

	// A list of tags to be added to this resource. A tag is a key-value pair. A
	// tag key must be accompanied by a tag value, although null is accepted.
	Tags []*Tag `locationNameList:"Tag" type:"list"`
	// contains filtered or unexported fields
}

Represents the input of a CreateCacheSecurityGroup operation.

func (CreateCacheSecurityGroupInput) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateCacheSecurityGroupInput) SetCacheSecurityGroupName

func (s *CreateCacheSecurityGroupInput) SetCacheSecurityGroupName(v string) *CreateCacheSecurityGroupInput

SetCacheSecurityGroupName sets the CacheSecurityGroupName field's value.

func (*CreateCacheSecurityGroupInput) SetDescription

SetDescription sets the Description field's value.

func (*CreateCacheSecurityGroupInput) SetTags

SetTags sets the Tags field's value.

func (CreateCacheSecurityGroupInput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateCacheSecurityGroupOutput) SetCacheSecurityGroup

SetCacheSecurityGroup sets the CacheSecurityGroup field's value.

func (CreateCacheSecurityGroupOutput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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"`

	// A list of tags to be added to this resource. A tag is a key-value pair. A
	// tag key must be accompanied by a tag value, although null is accepted.
	Tags []*Tag `locationNameList:"Tag" type:"list"`
	// contains filtered or unexported fields
}

Represents the input of a CreateCacheSubnetGroup operation.

func (CreateCacheSubnetGroupInput) GoString

func (s CreateCacheSubnetGroupInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateCacheSubnetGroupInput) SetCacheSubnetGroupDescription

func (s *CreateCacheSubnetGroupInput) SetCacheSubnetGroupDescription(v string) *CreateCacheSubnetGroupInput

SetCacheSubnetGroupDescription sets the CacheSubnetGroupDescription field's value.

func (*CreateCacheSubnetGroupInput) SetCacheSubnetGroupName

func (s *CreateCacheSubnetGroupInput) SetCacheSubnetGroupName(v string) *CreateCacheSubnetGroupInput

SetCacheSubnetGroupName sets the CacheSubnetGroupName field's value.

func (*CreateCacheSubnetGroupInput) SetSubnetIds

SetSubnetIds sets the SubnetIds field's value.

func (*CreateCacheSubnetGroupInput) SetTags

SetTags sets the Tags field's value.

func (CreateCacheSubnetGroupInput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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) GoString

func (s CreateCacheSubnetGroupOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateCacheSubnetGroupOutput) SetCacheSubnetGroup

SetCacheSubnetGroup sets the CacheSubnetGroup field's value.

func (CreateCacheSubnetGroupOutput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreateGlobalReplicationGroupInput

type CreateGlobalReplicationGroupInput struct {

	// Provides details of the Global datastore
	GlobalReplicationGroupDescription *string `type:"string"`

	// The suffix name of a Global datastore. Amazon ElastiCache automatically applies
	// a prefix to the Global datastore ID when it is created. Each Amazon Region
	// has its own prefix. For instance, a Global datastore ID created in the US-West-1
	// region will begin with "dsdfu" along with the suffix name you provide. The
	// suffix, combined with the auto-generated prefix, guarantees uniqueness of
	// the Global datastore name across multiple regions.
	//
	// For a full list of Amazon Regions and their respective Global datastore iD
	// prefixes, see Using the Amazon CLI with Global datastores (http://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/Redis-Global-Datastores-CLI.html).
	//
	// 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) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateGlobalReplicationGroupInput) SetGlobalReplicationGroupDescription

func (s *CreateGlobalReplicationGroupInput) SetGlobalReplicationGroupDescription(v string) *CreateGlobalReplicationGroupInput

SetGlobalReplicationGroupDescription sets the GlobalReplicationGroupDescription field's value.

func (*CreateGlobalReplicationGroupInput) SetGlobalReplicationGroupIdSuffix

func (s *CreateGlobalReplicationGroupInput) SetGlobalReplicationGroupIdSuffix(v string) *CreateGlobalReplicationGroupInput

SetGlobalReplicationGroupIdSuffix sets the GlobalReplicationGroupIdSuffix field's value.

func (*CreateGlobalReplicationGroupInput) SetPrimaryReplicationGroupId

SetPrimaryReplicationGroupId sets the PrimaryReplicationGroupId field's value.

func (CreateGlobalReplicationGroupInput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateGlobalReplicationGroupInput) Validate

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

type CreateGlobalReplicationGroupOutput

type CreateGlobalReplicationGroupOutput struct {

	// Consists of a primary cluster that accepts writes and an associated secondary
	// cluster that resides in a different Amazon 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) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateGlobalReplicationGroupOutput) SetGlobalReplicationGroup

SetGlobalReplicationGroup sets the GlobalReplicationGroup field's value.

func (CreateGlobalReplicationGroupOutput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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"`

	// If you are running Redis engine version 6.0 or later, set this parameter
	// to yes if you want to opt-in to the next auto minor version upgrade campaign.
	// This parameter is disabled for previous versions.
	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: M6g node types (available only
	//    for Redis engine version 5.0.6 onward and for Memcached engine version
	//    1.5.16 onward): cache.m6g.large, cache.m6g.xlarge, cache.m6g.2xlarge,
	//    cache.m6g.4xlarge, cache.m6g.8xlarge, cache.m6g.12xlarge, cache.m6g.16xlarge
	//    For region availability, see Supported Node Types (https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/CacheNodes.SupportedTypes.html#CacheNodes.SupportedTypesByRegion)
	//    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 T4g node types (available
	//    only for Redis engine version 5.0.6 onward and Memcached engine version
	//    1.5.16 onward): cache.t4g.micro, cache.t4g.small, cache.t4g.medium 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. Existing clusters are still supported but creation of new
	//    clusters is not supported for these types.) 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. Existing clusters
	//    are still supported but creation of new clusters is not supported for
	//    these types.) C1 node types: cache.c1.xlarge
	//
	//    * Memory optimized: Current generation: R6g node types (available only
	//    for Redis engine version 5.0.6 onward and for Memcached engine version
	//    1.5.16 onward). cache.r6g.large, cache.r6g.xlarge, cache.r6g.2xlarge,
	//    cache.r6g.4xlarge, cache.r6g.8xlarge, cache.r6g.12xlarge, cache.r6g.16xlarge
	//    For region availability, see Supported Node Types (https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/CacheNodes.SupportedTypes.html#CacheNodes.SupportedTypesByRegion)
	//    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. Existing clusters are still supported
	//    but creation of new clusters is not supported for these types.) 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 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"`

	// Enabled or Disabled. To modify cluster mode from Disabled to Enabled, you
	// must first set the cluster mode to Compatible. Compatible mode allows your
	// Redis clients to connect using both cluster mode enabled and cluster mode
	// disabled. After you migrate all Redis clients to use cluster mode enabled,
	// you can then complete cluster mode configuration and set the cluster mode
	// to Enabled.
	ClusterMode *string `type:"string" enum:"ClusterMode"`

	// Enables data tiering. Data tiering is only supported for replication groups
	// using the r6gd node type. This parameter must be set to true when using r6gd
	// nodes. For more information, see Data tiering (https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/data-tiering.html).
	DataTieringEnabled *bool `type:"boolean"`

	// The name of the cache engine to be used for the clusters in this replication
	// group. The value must be set to Redis.
	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 network type you choose when creating a replication group, either ipv4
	// | ipv6. IPv6 is supported for workloads using Redis engine version 6.2 onward
	// or Memcached engine version 1.6.6 on all instances built on the Nitro system
	// (http://aws.amazon.com/ec2/nitro/).
	IpDiscovery *string `type:"string" enum:"IpDiscovery"`

	// The ID of the KMS key used to encrypt the disk in the cluster.
	KmsKeyId *string `type:"string"`

	// Specifies the destination, format and type of the logs.
	LogDeliveryConfigurations []*LogDeliveryConfigurationRequest `locationNameList:"LogDeliveryConfigurationRequest" 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).
	MultiAZEnabled *bool `type:"boolean"`

	// Must be either ipv4 | ipv6 | dual_stack. IPv6 is supported for workloads
	// using Redis engine version 6.2 onward or Memcached engine version 1.6.6 on
	// all instances built on the Nitro system (http://aws.amazon.com/ec2/nitro/).
	NetworkType *string `type:"string" enum:"NetworkType"`

	// 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 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 on replication groups will be replicated to all nodes.
	Tags []*Tag `locationNameList:"Tag" type:"list"`

	// A flag that enables in-transit encryption when set to true.
	//
	// 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"`

	// A setting that allows you to migrate your clients to use in-transit encryption,
	// with no downtime.
	//
	// When setting TransitEncryptionEnabled to true, you can set your TransitEncryptionMode
	// to preferred in the same request, to allow both encrypted and unencrypted
	// connections at the same time. Once you migrate all your Redis clients to
	// use encrypted connections you can modify the value to required to allow encrypted
	// connections only.
	//
	// Setting TransitEncryptionMode to required is a two-step process that requires
	// you to first set the TransitEncryptionMode to preferred, after that you can
	// set TransitEncryptionMode to required.
	//
	// This process will not trigger the replacement of the replication group.
	TransitEncryptionMode *string `type:"string" enum:"TransitEncryptionMode"`

	// The user group to associate with the replication group.
	UserGroupIds []*string `min:"1" type:"list"`
	// contains filtered or unexported fields
}

Represents the input of a CreateReplicationGroup operation.

func (CreateReplicationGroupInput) GoString

func (s CreateReplicationGroupInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateReplicationGroupInput) SetAtRestEncryptionEnabled

func (s *CreateReplicationGroupInput) SetAtRestEncryptionEnabled(v bool) *CreateReplicationGroupInput

SetAtRestEncryptionEnabled sets the AtRestEncryptionEnabled field's value.

func (*CreateReplicationGroupInput) SetAuthToken

SetAuthToken sets the AuthToken field's value.

func (*CreateReplicationGroupInput) SetAutoMinorVersionUpgrade

func (s *CreateReplicationGroupInput) SetAutoMinorVersionUpgrade(v bool) *CreateReplicationGroupInput

SetAutoMinorVersionUpgrade sets the AutoMinorVersionUpgrade field's value.

func (*CreateReplicationGroupInput) SetAutomaticFailoverEnabled

func (s *CreateReplicationGroupInput) SetAutomaticFailoverEnabled(v bool) *CreateReplicationGroupInput

SetAutomaticFailoverEnabled sets the AutomaticFailoverEnabled field's value.

func (*CreateReplicationGroupInput) SetCacheNodeType

SetCacheNodeType sets the CacheNodeType field's value.

func (*CreateReplicationGroupInput) SetCacheParameterGroupName

func (s *CreateReplicationGroupInput) SetCacheParameterGroupName(v string) *CreateReplicationGroupInput

SetCacheParameterGroupName sets the CacheParameterGroupName field's value.

func (*CreateReplicationGroupInput) SetCacheSecurityGroupNames

func (s *CreateReplicationGroupInput) SetCacheSecurityGroupNames(v []*string) *CreateReplicationGroupInput

SetCacheSecurityGroupNames sets the CacheSecurityGroupNames field's value.

func (*CreateReplicationGroupInput) SetCacheSubnetGroupName

func (s *CreateReplicationGroupInput) SetCacheSubnetGroupName(v string) *CreateReplicationGroupInput

SetCacheSubnetGroupName sets the CacheSubnetGroupName field's value.

func (*CreateReplicationGroupInput) SetClusterMode added in v1.42.9

SetClusterMode sets the ClusterMode field's value.

func (*CreateReplicationGroupInput) SetDataTieringEnabled added in v1.42.9

func (s *CreateReplicationGroupInput) SetDataTieringEnabled(v bool) *CreateReplicationGroupInput

SetDataTieringEnabled sets the DataTieringEnabled field's value.

func (*CreateReplicationGroupInput) SetEngine

SetEngine sets the Engine field's value.

func (*CreateReplicationGroupInput) SetEngineVersion

SetEngineVersion sets the EngineVersion field's value.

func (*CreateReplicationGroupInput) SetGlobalReplicationGroupId

func (s *CreateReplicationGroupInput) SetGlobalReplicationGroupId(v string) *CreateReplicationGroupInput

SetGlobalReplicationGroupId sets the GlobalReplicationGroupId field's value.

func (*CreateReplicationGroupInput) SetIpDiscovery added in v1.42.9

SetIpDiscovery sets the IpDiscovery field's value.

func (*CreateReplicationGroupInput) SetKmsKeyId

SetKmsKeyId sets the KmsKeyId field's value.

func (*CreateReplicationGroupInput) SetLogDeliveryConfigurations

SetLogDeliveryConfigurations sets the LogDeliveryConfigurations field's value.

func (*CreateReplicationGroupInput) SetMultiAZEnabled

SetMultiAZEnabled sets the MultiAZEnabled field's value.

func (*CreateReplicationGroupInput) SetNetworkType added in v1.42.9

SetNetworkType sets the NetworkType field's value.

func (*CreateReplicationGroupInput) SetNodeGroupConfiguration

SetNodeGroupConfiguration sets the NodeGroupConfiguration field's value.

func (*CreateReplicationGroupInput) SetNotificationTopicArn

func (s *CreateReplicationGroupInput) SetNotificationTopicArn(v string) *CreateReplicationGroupInput

SetNotificationTopicArn sets the NotificationTopicArn field's value.

func (*CreateReplicationGroupInput) SetNumCacheClusters

SetNumCacheClusters sets the NumCacheClusters field's value.

func (*CreateReplicationGroupInput) SetNumNodeGroups

SetNumNodeGroups sets the NumNodeGroups field's value.

func (*CreateReplicationGroupInput) SetPort

SetPort sets the Port field's value.

func (*CreateReplicationGroupInput) SetPreferredCacheClusterAZs

func (s *CreateReplicationGroupInput) SetPreferredCacheClusterAZs(v []*string) *CreateReplicationGroupInput

SetPreferredCacheClusterAZs sets the PreferredCacheClusterAZs field's value.

func (*CreateReplicationGroupInput) SetPreferredMaintenanceWindow

func (s *CreateReplicationGroupInput) SetPreferredMaintenanceWindow(v string) *CreateReplicationGroupInput

SetPreferredMaintenanceWindow sets the PreferredMaintenanceWindow field's value.

func (*CreateReplicationGroupInput) SetPrimaryClusterId

SetPrimaryClusterId sets the PrimaryClusterId field's value.

func (*CreateReplicationGroupInput) SetReplicasPerNodeGroup

func (s *CreateReplicationGroupInput) SetReplicasPerNodeGroup(v int64) *CreateReplicationGroupInput

SetReplicasPerNodeGroup sets the ReplicasPerNodeGroup field's value.

func (*CreateReplicationGroupInput) SetReplicationGroupDescription

func (s *CreateReplicationGroupInput) SetReplicationGroupDescription(v string) *CreateReplicationGroupInput

SetReplicationGroupDescription sets the ReplicationGroupDescription field's value.

func (*CreateReplicationGroupInput) SetReplicationGroupId

func (s *CreateReplicationGroupInput) SetReplicationGroupId(v string) *CreateReplicationGroupInput

SetReplicationGroupId sets the ReplicationGroupId field's value.

func (*CreateReplicationGroupInput) SetSecurityGroupIds

func (s *CreateReplicationGroupInput) SetSecurityGroupIds(v []*string) *CreateReplicationGroupInput

SetSecurityGroupIds sets the SecurityGroupIds field's value.

func (*CreateReplicationGroupInput) SetSnapshotArns

SetSnapshotArns sets the SnapshotArns field's value.

func (*CreateReplicationGroupInput) SetSnapshotName

SetSnapshotName sets the SnapshotName field's value.

func (*CreateReplicationGroupInput) SetSnapshotRetentionLimit

func (s *CreateReplicationGroupInput) SetSnapshotRetentionLimit(v int64) *CreateReplicationGroupInput

SetSnapshotRetentionLimit sets the SnapshotRetentionLimit field's value.

func (*CreateReplicationGroupInput) SetSnapshotWindow

SetSnapshotWindow sets the SnapshotWindow field's value.

func (*CreateReplicationGroupInput) SetTags

SetTags sets the Tags field's value.

func (*CreateReplicationGroupInput) SetTransitEncryptionEnabled

func (s *CreateReplicationGroupInput) SetTransitEncryptionEnabled(v bool) *CreateReplicationGroupInput

SetTransitEncryptionEnabled sets the TransitEncryptionEnabled field's value.

func (*CreateReplicationGroupInput) SetTransitEncryptionMode added in v1.42.9

func (s *CreateReplicationGroupInput) SetTransitEncryptionMode(v string) *CreateReplicationGroupInput

SetTransitEncryptionMode sets the TransitEncryptionMode field's value.

func (*CreateReplicationGroupInput) SetUserGroupIds

SetUserGroupIds sets the UserGroupIds field's value.

func (CreateReplicationGroupInput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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) GoString

func (s CreateReplicationGroupOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateReplicationGroupOutput) SetReplicationGroup

SetReplicationGroup sets the ReplicationGroup field's value.

func (CreateReplicationGroupOutput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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"`

	// A list of tags to be added to this resource. A tag is a key-value pair. A
	// tag key must be accompanied by a tag value, although null is accepted.
	Tags []*Tag `locationNameList:"Tag" type:"list"`
	// contains filtered or unexported fields
}

Represents the input of a CreateSnapshot operation.

func (CreateSnapshotInput) GoString

func (s CreateSnapshotInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateSnapshotInput) SetCacheClusterId

func (s *CreateSnapshotInput) SetCacheClusterId(v string) *CreateSnapshotInput

SetCacheClusterId sets the CacheClusterId field's value.

func (*CreateSnapshotInput) SetKmsKeyId

func (s *CreateSnapshotInput) SetKmsKeyId(v string) *CreateSnapshotInput

SetKmsKeyId sets the KmsKeyId field's value.

func (*CreateSnapshotInput) SetReplicationGroupId

func (s *CreateSnapshotInput) SetReplicationGroupId(v string) *CreateSnapshotInput

SetReplicationGroupId sets the ReplicationGroupId field's value.

func (*CreateSnapshotInput) SetSnapshotName

func (s *CreateSnapshotInput) SetSnapshotName(v string) *CreateSnapshotInput

SetSnapshotName sets the SnapshotName field's value.

func (*CreateSnapshotInput) SetTags

func (s *CreateSnapshotInput) SetTags(v []*Tag) *CreateSnapshotInput

SetTags sets the Tags field's value.

func (CreateSnapshotInput) String

func (s CreateSnapshotInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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) GoString

func (s CreateSnapshotOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateSnapshotOutput) SetSnapshot

SetSnapshot sets the Snapshot field's value.

func (CreateSnapshotOutput) String

func (s CreateSnapshotOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreateUserGroupInput

type CreateUserGroupInput struct {

	// The current supported value is Redis.
	//
	// Engine is a required field
	Engine *string `type:"string" required:"true"`

	// A list of tags to be added to this resource. A tag is a key-value pair. A
	// tag key must be accompanied by a tag value, although null is accepted.
	Tags []*Tag `locationNameList:"Tag" type:"list"`

	// The ID of the user group.
	//
	// UserGroupId is a required field
	UserGroupId *string `type:"string" required:"true"`

	// The list of user IDs that belong to the user group.
	UserIds []*string `min:"1" type:"list"`
	// contains filtered or unexported fields
}

func (CreateUserGroupInput) GoString

func (s CreateUserGroupInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateUserGroupInput) SetEngine

SetEngine sets the Engine field's value.

func (*CreateUserGroupInput) SetTags

func (s *CreateUserGroupInput) SetTags(v []*Tag) *CreateUserGroupInput

SetTags sets the Tags field's value.

func (*CreateUserGroupInput) SetUserGroupId

func (s *CreateUserGroupInput) SetUserGroupId(v string) *CreateUserGroupInput

SetUserGroupId sets the UserGroupId field's value.

func (*CreateUserGroupInput) SetUserIds

func (s *CreateUserGroupInput) SetUserIds(v []*string) *CreateUserGroupInput

SetUserIds sets the UserIds field's value.

func (CreateUserGroupInput) String

func (s CreateUserGroupInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateUserGroupInput) Validate

func (s *CreateUserGroupInput) Validate() error

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

type CreateUserGroupOutput

type CreateUserGroupOutput struct {

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

	// The current supported value is Redis.
	Engine *string `type:"string"`

	// The minimum engine version required, which is Redis 6.0
	MinimumEngineVersion *string `type:"string"`

	// A list of updates being applied to the user group.
	PendingChanges *UserGroupPendingChanges `type:"structure"`

	// A list of replication groups that the user group can access.
	ReplicationGroups []*string `type:"list"`

	// Indicates user group status. Can be "creating", "active", "modifying", "deleting".
	Status *string `type:"string"`

	// The ID of the user group.
	UserGroupId *string `type:"string"`

	// The list of user IDs that belong to the user group.
	UserIds []*string `type:"list"`
	// contains filtered or unexported fields
}

func (CreateUserGroupOutput) GoString

func (s CreateUserGroupOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateUserGroupOutput) SetARN

SetARN sets the ARN field's value.

func (*CreateUserGroupOutput) SetEngine

SetEngine sets the Engine field's value.

func (*CreateUserGroupOutput) SetMinimumEngineVersion added in v1.42.9

func (s *CreateUserGroupOutput) SetMinimumEngineVersion(v string) *CreateUserGroupOutput

SetMinimumEngineVersion sets the MinimumEngineVersion field's value.

func (*CreateUserGroupOutput) SetPendingChanges

SetPendingChanges sets the PendingChanges field's value.

func (*CreateUserGroupOutput) SetReplicationGroups

func (s *CreateUserGroupOutput) SetReplicationGroups(v []*string) *CreateUserGroupOutput

SetReplicationGroups sets the ReplicationGroups field's value.

func (*CreateUserGroupOutput) SetStatus

SetStatus sets the Status field's value.

func (*CreateUserGroupOutput) SetUserGroupId

func (s *CreateUserGroupOutput) SetUserGroupId(v string) *CreateUserGroupOutput

SetUserGroupId sets the UserGroupId field's value.

func (*CreateUserGroupOutput) SetUserIds

func (s *CreateUserGroupOutput) SetUserIds(v []*string) *CreateUserGroupOutput

SetUserIds sets the UserIds field's value.

func (CreateUserGroupOutput) String

func (s CreateUserGroupOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreateUserInput

type CreateUserInput struct {

	// Access permissions string used for this user.
	//
	// AccessString is a required field
	AccessString *string `type:"string" required:"true"`

	// Specifies how to authenticate the user.
	AuthenticationMode *AuthenticationMode `type:"structure"`

	// The current supported value is Redis.
	//
	// Engine is a required field
	Engine *string `type:"string" required:"true"`

	// Indicates a password is not required for this user.
	NoPasswordRequired *bool `type:"boolean"`

	// Passwords used for this user. You can create up to two passwords for each
	// user.
	Passwords []*string `min:"1" type:"list"`

	// A list of tags to be added to this resource. A tag is a key-value pair. A
	// tag key must be accompanied by a tag value, although null is accepted.
	Tags []*Tag `locationNameList:"Tag" type:"list"`

	// The ID of the user.
	//
	// UserId is a required field
	UserId *string `min:"1" type:"string" required:"true"`

	// The username of the user.
	//
	// UserName is a required field
	UserName *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (CreateUserInput) GoString

func (s CreateUserInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateUserInput) SetAccessString

func (s *CreateUserInput) SetAccessString(v string) *CreateUserInput

SetAccessString sets the AccessString field's value.

func (*CreateUserInput) SetAuthenticationMode added in v1.42.9

func (s *CreateUserInput) SetAuthenticationMode(v *AuthenticationMode) *CreateUserInput

SetAuthenticationMode sets the AuthenticationMode field's value.

func (*CreateUserInput) SetEngine

func (s *CreateUserInput) SetEngine(v string) *CreateUserInput

SetEngine sets the Engine field's value.

func (*CreateUserInput) SetNoPasswordRequired

func (s *CreateUserInput) SetNoPasswordRequired(v bool) *CreateUserInput

SetNoPasswordRequired sets the NoPasswordRequired field's value.

func (*CreateUserInput) SetPasswords

func (s *CreateUserInput) SetPasswords(v []*string) *CreateUserInput

SetPasswords sets the Passwords field's value.

func (*CreateUserInput) SetTags

func (s *CreateUserInput) SetTags(v []*Tag) *CreateUserInput

SetTags sets the Tags field's value.

func (*CreateUserInput) SetUserId

func (s *CreateUserInput) SetUserId(v string) *CreateUserInput

SetUserId sets the UserId field's value.

func (*CreateUserInput) SetUserName

func (s *CreateUserInput) SetUserName(v string) *CreateUserInput

SetUserName sets the UserName field's value.

func (CreateUserInput) String

func (s CreateUserInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateUserInput) Validate

func (s *CreateUserInput) Validate() error

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

type CreateUserOutput

type CreateUserOutput struct {

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

	// Access permissions string used for this user.
	AccessString *string `type:"string"`

	// Denotes whether the user requires a password to authenticate.
	Authentication *Authentication `type:"structure"`

	// The current supported value is Redis.
	Engine *string `type:"string"`

	// The minimum engine version required, which is Redis 6.0
	MinimumEngineVersion *string `type:"string"`

	// Indicates the user status. Can be "active", "modifying" or "deleting".
	Status *string `type:"string"`

	// Returns a list of the user group IDs the user belongs to.
	UserGroupIds []*string `type:"list"`

	// The ID of the user.
	UserId *string `type:"string"`

	// The username of the user.
	UserName *string `type:"string"`
	// contains filtered or unexported fields
}

func (CreateUserOutput) GoString

func (s CreateUserOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateUserOutput) SetARN

SetARN sets the ARN field's value.

func (*CreateUserOutput) SetAccessString

func (s *CreateUserOutput) SetAccessString(v string) *CreateUserOutput

SetAccessString sets the AccessString field's value.

func (*CreateUserOutput) SetAuthentication

func (s *CreateUserOutput) SetAuthentication(v *Authentication) *CreateUserOutput

SetAuthentication sets the Authentication field's value.

func (*CreateUserOutput) SetEngine

func (s *CreateUserOutput) SetEngine(v string) *CreateUserOutput

SetEngine sets the Engine field's value.

func (*CreateUserOutput) SetMinimumEngineVersion added in v1.42.9

func (s *CreateUserOutput) SetMinimumEngineVersion(v string) *CreateUserOutput

SetMinimumEngineVersion sets the MinimumEngineVersion field's value.

func (*CreateUserOutput) SetStatus

func (s *CreateUserOutput) SetStatus(v string) *CreateUserOutput

SetStatus sets the Status field's value.

func (*CreateUserOutput) SetUserGroupIds

func (s *CreateUserOutput) SetUserGroupIds(v []*string) *CreateUserOutput

SetUserGroupIds sets the UserGroupIds field's value.

func (*CreateUserOutput) SetUserId

func (s *CreateUserOutput) SetUserId(v string) *CreateUserOutput

SetUserId sets the UserId field's value.

func (*CreateUserOutput) SetUserName

func (s *CreateUserOutput) SetUserName(v string) *CreateUserOutput

SetUserName sets the UserName field's value.

func (CreateUserOutput) String

func (s CreateUserOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CustomerNodeEndpoint

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) GoString

func (s CustomerNodeEndpoint) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CustomerNodeEndpoint) SetAddress

SetAddress sets the Address field's value.

func (*CustomerNodeEndpoint) SetPort

SetPort sets the Port field's value.

func (CustomerNodeEndpoint) String

func (s CustomerNodeEndpoint) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DecreaseNodeGroupsInGlobalReplicationGroupInput

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.
	// GlobalNodeGroupsToRemove is a list of NodeGroupIds to remove from the cluster.
	// ElastiCache for Redis will attempt to remove all node groups listed by GlobalNodeGroupsToRemove
	// 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.
	// GlobalNodeGroupsToRetain is a list of NodeGroupIds to retain from the cluster.
	// ElastiCache for Redis will attempt to retain all node groups listed by GlobalNodeGroupsToRetain
	// 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) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DecreaseNodeGroupsInGlobalReplicationGroupInput) SetApplyImmediately

SetApplyImmediately sets the ApplyImmediately field's value.

func (*DecreaseNodeGroupsInGlobalReplicationGroupInput) SetGlobalNodeGroupsToRemove

SetGlobalNodeGroupsToRemove sets the GlobalNodeGroupsToRemove field's value.

func (*DecreaseNodeGroupsInGlobalReplicationGroupInput) SetGlobalNodeGroupsToRetain

SetGlobalNodeGroupsToRetain sets the GlobalNodeGroupsToRetain field's value.

func (*DecreaseNodeGroupsInGlobalReplicationGroupInput) SetGlobalReplicationGroupId

SetGlobalReplicationGroupId sets the GlobalReplicationGroupId field's value.

func (*DecreaseNodeGroupsInGlobalReplicationGroupInput) SetNodeGroupCount

SetNodeGroupCount sets the NodeGroupCount field's value.

func (DecreaseNodeGroupsInGlobalReplicationGroupInput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DecreaseNodeGroupsInGlobalReplicationGroupInput) Validate

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

type DecreaseNodeGroupsInGlobalReplicationGroupOutput

type DecreaseNodeGroupsInGlobalReplicationGroupOutput struct {

	// Consists of a primary cluster that accepts writes and an associated secondary
	// cluster that resides in a different Amazon 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) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DecreaseNodeGroupsInGlobalReplicationGroupOutput) SetGlobalReplicationGroup

SetGlobalReplicationGroup sets the GlobalReplicationGroup field's value.

func (DecreaseNodeGroupsInGlobalReplicationGroupOutput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DecreaseReplicaCountInput

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) GoString

func (s DecreaseReplicaCountInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DecreaseReplicaCountInput) SetApplyImmediately

func (s *DecreaseReplicaCountInput) SetApplyImmediately(v bool) *DecreaseReplicaCountInput

SetApplyImmediately sets the ApplyImmediately field's value.

func (*DecreaseReplicaCountInput) SetNewReplicaCount

func (s *DecreaseReplicaCountInput) SetNewReplicaCount(v int64) *DecreaseReplicaCountInput

SetNewReplicaCount sets the NewReplicaCount field's value.

func (*DecreaseReplicaCountInput) SetReplicaConfiguration

func (s *DecreaseReplicaCountInput) SetReplicaConfiguration(v []*ConfigureShard) *DecreaseReplicaCountInput

SetReplicaConfiguration sets the ReplicaConfiguration field's value.

func (*DecreaseReplicaCountInput) SetReplicasToRemove

func (s *DecreaseReplicaCountInput) SetReplicasToRemove(v []*string) *DecreaseReplicaCountInput

SetReplicasToRemove sets the ReplicasToRemove field's value.

func (*DecreaseReplicaCountInput) SetReplicationGroupId

func (s *DecreaseReplicaCountInput) SetReplicationGroupId(v string) *DecreaseReplicaCountInput

SetReplicationGroupId sets the ReplicationGroupId field's value.

func (DecreaseReplicaCountInput) String

func (s DecreaseReplicaCountInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DecreaseReplicaCountInput) Validate

func (s *DecreaseReplicaCountInput) Validate() error

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

type DecreaseReplicaCountOutput

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) GoString

func (s DecreaseReplicaCountOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DecreaseReplicaCountOutput) SetReplicationGroup

SetReplicationGroup sets the ReplicationGroup field's value.

func (DecreaseReplicaCountOutput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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) GoString

func (s DeleteCacheClusterInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteCacheClusterInput) SetCacheClusterId

func (s *DeleteCacheClusterInput) SetCacheClusterId(v string) *DeleteCacheClusterInput

SetCacheClusterId sets the CacheClusterId field's value.

func (*DeleteCacheClusterInput) SetFinalSnapshotIdentifier

func (s *DeleteCacheClusterInput) SetFinalSnapshotIdentifier(v string) *DeleteCacheClusterInput

SetFinalSnapshotIdentifier sets the FinalSnapshotIdentifier field's value.

func (DeleteCacheClusterInput) String

func (s DeleteCacheClusterInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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) GoString

func (s DeleteCacheClusterOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteCacheClusterOutput) SetCacheCluster

SetCacheCluster sets the CacheCluster field's value.

func (DeleteCacheClusterOutput) String

func (s DeleteCacheClusterOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteCacheParameterGroupInput) SetCacheParameterGroupName

func (s *DeleteCacheParameterGroupInput) SetCacheParameterGroupName(v string) *DeleteCacheParameterGroupInput

SetCacheParameterGroupName sets the CacheParameterGroupName field's value.

func (DeleteCacheParameterGroupInput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DeleteCacheParameterGroupOutput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteCacheSecurityGroupInput) SetCacheSecurityGroupName

func (s *DeleteCacheSecurityGroupInput) SetCacheSecurityGroupName(v string) *DeleteCacheSecurityGroupInput

SetCacheSecurityGroupName sets the CacheSecurityGroupName field's value.

func (DeleteCacheSecurityGroupInput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DeleteCacheSecurityGroupOutput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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) GoString

func (s DeleteCacheSubnetGroupInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteCacheSubnetGroupInput) SetCacheSubnetGroupName

func (s *DeleteCacheSubnetGroupInput) SetCacheSubnetGroupName(v string) *DeleteCacheSubnetGroupInput

SetCacheSubnetGroupName sets the CacheSubnetGroupName field's value.

func (DeleteCacheSubnetGroupInput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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) GoString

func (s DeleteCacheSubnetGroupOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DeleteCacheSubnetGroupOutput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteGlobalReplicationGroupInput

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) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteGlobalReplicationGroupInput) SetGlobalReplicationGroupId

SetGlobalReplicationGroupId sets the GlobalReplicationGroupId field's value.

func (*DeleteGlobalReplicationGroupInput) SetRetainPrimaryReplicationGroup

func (s *DeleteGlobalReplicationGroupInput) SetRetainPrimaryReplicationGroup(v bool) *DeleteGlobalReplicationGroupInput

SetRetainPrimaryReplicationGroup sets the RetainPrimaryReplicationGroup field's value.

func (DeleteGlobalReplicationGroupInput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteGlobalReplicationGroupInput) Validate

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

type DeleteGlobalReplicationGroupOutput

type DeleteGlobalReplicationGroupOutput struct {

	// Consists of a primary cluster that accepts writes and an associated secondary
	// cluster that resides in a different Amazon 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) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteGlobalReplicationGroupOutput) SetGlobalReplicationGroup

SetGlobalReplicationGroup sets the GlobalReplicationGroup field's value.

func (DeleteGlobalReplicationGroupOutput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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) GoString

func (s DeleteReplicationGroupInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteReplicationGroupInput) SetFinalSnapshotIdentifier

func (s *DeleteReplicationGroupInput) SetFinalSnapshotIdentifier(v string) *DeleteReplicationGroupInput

SetFinalSnapshotIdentifier sets the FinalSnapshotIdentifier field's value.

func (*DeleteReplicationGroupInput) SetReplicationGroupId

func (s *DeleteReplicationGroupInput) SetReplicationGroupId(v string) *DeleteReplicationGroupInput

SetReplicationGroupId sets the ReplicationGroupId field's value.

func (*DeleteReplicationGroupInput) SetRetainPrimaryCluster

func (s *DeleteReplicationGroupInput) SetRetainPrimaryCluster(v bool) *DeleteReplicationGroupInput

SetRetainPrimaryCluster sets the RetainPrimaryCluster field's value.

func (DeleteReplicationGroupInput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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) GoString

func (s DeleteReplicationGroupOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteReplicationGroupOutput) SetReplicationGroup

SetReplicationGroup sets the ReplicationGroup field's value.

func (DeleteReplicationGroupOutput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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) GoString

func (s DeleteSnapshotInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteSnapshotInput) SetSnapshotName

func (s *DeleteSnapshotInput) SetSnapshotName(v string) *DeleteSnapshotInput

SetSnapshotName sets the SnapshotName field's value.

func (DeleteSnapshotInput) String

func (s DeleteSnapshotInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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) GoString

func (s DeleteSnapshotOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteSnapshotOutput) SetSnapshot

SetSnapshot sets the Snapshot field's value.

func (DeleteSnapshotOutput) String

func (s DeleteSnapshotOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteUserGroupInput

type DeleteUserGroupInput struct {

	// The ID of the user group.
	//
	// UserGroupId is a required field
	UserGroupId *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteUserGroupInput) GoString

func (s DeleteUserGroupInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteUserGroupInput) SetUserGroupId

func (s *DeleteUserGroupInput) SetUserGroupId(v string) *DeleteUserGroupInput

SetUserGroupId sets the UserGroupId field's value.

func (DeleteUserGroupInput) String

func (s DeleteUserGroupInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteUserGroupInput) Validate

func (s *DeleteUserGroupInput) Validate() error

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

type DeleteUserGroupOutput

type DeleteUserGroupOutput struct {

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

	// The current supported value is Redis.
	Engine *string `type:"string"`

	// The minimum engine version required, which is Redis 6.0
	MinimumEngineVersion *string `type:"string"`

	// A list of updates being applied to the user group.
	PendingChanges *UserGroupPendingChanges `type:"structure"`

	// A list of replication groups that the user group can access.
	ReplicationGroups []*string `type:"list"`

	// Indicates user group status. Can be "creating", "active", "modifying", "deleting".
	Status *string `type:"string"`

	// The ID of the user group.
	UserGroupId *string `type:"string"`

	// The list of user IDs that belong to the user group.
	UserIds []*string `type:"list"`
	// contains filtered or unexported fields
}

func (DeleteUserGroupOutput) GoString

func (s DeleteUserGroupOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteUserGroupOutput) SetARN

SetARN sets the ARN field's value.

func (*DeleteUserGroupOutput) SetEngine

SetEngine sets the Engine field's value.

func (*DeleteUserGroupOutput) SetMinimumEngineVersion added in v1.42.9

func (s *DeleteUserGroupOutput) SetMinimumEngineVersion(v string) *DeleteUserGroupOutput

SetMinimumEngineVersion sets the MinimumEngineVersion field's value.

func (*DeleteUserGroupOutput) SetPendingChanges

SetPendingChanges sets the PendingChanges field's value.

func (*DeleteUserGroupOutput) SetReplicationGroups

func (s *DeleteUserGroupOutput) SetReplicationGroups(v []*string) *DeleteUserGroupOutput

SetReplicationGroups sets the ReplicationGroups field's value.

func (*DeleteUserGroupOutput) SetStatus

SetStatus sets the Status field's value.

func (*DeleteUserGroupOutput) SetUserGroupId

func (s *DeleteUserGroupOutput) SetUserGroupId(v string) *DeleteUserGroupOutput

SetUserGroupId sets the UserGroupId field's value.

func (*DeleteUserGroupOutput) SetUserIds

func (s *DeleteUserGroupOutput) SetUserIds(v []*string) *DeleteUserGroupOutput

SetUserIds sets the UserIds field's value.

func (DeleteUserGroupOutput) String

func (s DeleteUserGroupOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteUserInput

type DeleteUserInput struct {

	// The ID of the user.
	//
	// UserId is a required field
	UserId *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteUserInput) GoString

func (s DeleteUserInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteUserInput) SetUserId

func (s *DeleteUserInput) SetUserId(v string) *DeleteUserInput

SetUserId sets the UserId field's value.

func (DeleteUserInput) String

func (s DeleteUserInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteUserInput) Validate

func (s *DeleteUserInput) Validate() error

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

type DeleteUserOutput

type DeleteUserOutput struct {

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

	// Access permissions string used for this user.
	AccessString *string `type:"string"`

	// Denotes whether the user requires a password to authenticate.
	Authentication *Authentication `type:"structure"`

	// The current supported value is Redis.
	Engine *string `type:"string"`

	// The minimum engine version required, which is Redis 6.0
	MinimumEngineVersion *string `type:"string"`

	// Indicates the user status. Can be "active", "modifying" or "deleting".
	Status *string `type:"string"`

	// Returns a list of the user group IDs the user belongs to.
	UserGroupIds []*string `type:"list"`

	// The ID of the user.
	UserId *string `type:"string"`

	// The username of the user.
	UserName *string `type:"string"`
	// contains filtered or unexported fields
}

func (DeleteUserOutput) GoString

func (s DeleteUserOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteUserOutput) SetARN

SetARN sets the ARN field's value.

func (*DeleteUserOutput) SetAccessString

func (s *DeleteUserOutput) SetAccessString(v string) *DeleteUserOutput

SetAccessString sets the AccessString field's value.

func (*DeleteUserOutput) SetAuthentication

func (s *DeleteUserOutput) SetAuthentication(v *Authentication) *DeleteUserOutput

SetAuthentication sets the Authentication field's value.

func (*DeleteUserOutput) SetEngine

func (s *DeleteUserOutput) SetEngine(v string) *DeleteUserOutput

SetEngine sets the Engine field's value.

func (*DeleteUserOutput) SetMinimumEngineVersion added in v1.42.9

func (s *DeleteUserOutput) SetMinimumEngineVersion(v string) *DeleteUserOutput

SetMinimumEngineVersion sets the MinimumEngineVersion field's value.

func (*DeleteUserOutput) SetStatus

func (s *DeleteUserOutput) SetStatus(v string) *DeleteUserOutput

SetStatus sets the Status field's value.

func (*DeleteUserOutput) SetUserGroupIds

func (s *DeleteUserOutput) SetUserGroupIds(v []*string) *DeleteUserOutput

SetUserGroupIds sets the UserGroupIds field's value.

func (*DeleteUserOutput) SetUserId

func (s *DeleteUserOutput) SetUserId(v string) *DeleteUserOutput

SetUserId sets the UserId field's value.

func (*DeleteUserOutput) SetUserName

func (s *DeleteUserOutput) SetUserName(v string) *DeleteUserOutput

SetUserName sets the UserName field's value.

func (DeleteUserOutput) String

func (s DeleteUserOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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) GoString

func (s DescribeCacheClustersInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeCacheClustersInput) SetCacheClusterId

SetCacheClusterId sets the CacheClusterId field's value.

func (*DescribeCacheClustersInput) SetMarker

SetMarker sets the Marker field's value.

func (*DescribeCacheClustersInput) SetMaxRecords

SetMaxRecords sets the MaxRecords field's value.

func (*DescribeCacheClustersInput) SetShowCacheClustersNotInReplicationGroups

func (s *DescribeCacheClustersInput) SetShowCacheClustersNotInReplicationGroups(v bool) *DescribeCacheClustersInput

SetShowCacheClustersNotInReplicationGroups sets the ShowCacheClustersNotInReplicationGroups field's value.

func (*DescribeCacheClustersInput) SetShowCacheNodeInfo

func (s *DescribeCacheClustersInput) SetShowCacheNodeInfo(v bool) *DescribeCacheClustersInput

SetShowCacheNodeInfo sets the ShowCacheNodeInfo field's value.

func (DescribeCacheClustersInput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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) GoString

func (s DescribeCacheClustersOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeCacheClustersOutput) SetCacheClusters

SetCacheClusters sets the CacheClusters field's value.

func (*DescribeCacheClustersOutput) SetMarker

SetMarker sets the Marker field's value.

func (DescribeCacheClustersOutput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 | memcached1.6 | redis2.6 |
	// redis2.8 | redis3.2 | redis4.0 | redis5.0 | redis6.x | redis6.2 | redis7
	//
	// 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) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeCacheEngineVersionsInput) SetCacheParameterGroupFamily

func (s *DescribeCacheEngineVersionsInput) SetCacheParameterGroupFamily(v string) *DescribeCacheEngineVersionsInput

SetCacheParameterGroupFamily sets the CacheParameterGroupFamily field's value.

func (*DescribeCacheEngineVersionsInput) SetDefaultOnly

SetDefaultOnly sets the DefaultOnly field's value.

func (*DescribeCacheEngineVersionsInput) SetEngine

SetEngine sets the Engine field's value.

func (*DescribeCacheEngineVersionsInput) SetEngineVersion

SetEngineVersion sets the EngineVersion field's value.

func (*DescribeCacheEngineVersionsInput) SetMarker

SetMarker sets the Marker field's value.

func (*DescribeCacheEngineVersionsInput) SetMaxRecords

SetMaxRecords sets the MaxRecords field's value.

func (DescribeCacheEngineVersionsInput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeCacheEngineVersionsOutput) SetCacheEngineVersions

SetCacheEngineVersions sets the CacheEngineVersions field's value.

func (*DescribeCacheEngineVersionsOutput) SetMarker

SetMarker sets the Marker field's value.

func (DescribeCacheEngineVersionsOutput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeCacheParameterGroupsInput) SetCacheParameterGroupName

SetCacheParameterGroupName sets the CacheParameterGroupName field's value.

func (*DescribeCacheParameterGroupsInput) SetMarker

SetMarker sets the Marker field's value.

func (*DescribeCacheParameterGroupsInput) SetMaxRecords

SetMaxRecords sets the MaxRecords field's value.

func (DescribeCacheParameterGroupsInput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeCacheParameterGroupsOutput) SetCacheParameterGroups

SetCacheParameterGroups sets the CacheParameterGroups field's value.

func (*DescribeCacheParameterGroupsOutput) SetMarker

SetMarker sets the Marker field's value.

func (DescribeCacheParameterGroupsOutput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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) GoString

func (s DescribeCacheParametersInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeCacheParametersInput) SetCacheParameterGroupName

func (s *DescribeCacheParametersInput) SetCacheParameterGroupName(v string) *DescribeCacheParametersInput

SetCacheParameterGroupName sets the CacheParameterGroupName field's value.

func (*DescribeCacheParametersInput) SetMarker

SetMarker sets the Marker field's value.

func (*DescribeCacheParametersInput) SetMaxRecords

SetMaxRecords sets the MaxRecords field's value.

func (*DescribeCacheParametersInput) SetSource

SetSource sets the Source field's value.

func (DescribeCacheParametersInput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeCacheParametersOutput) SetCacheNodeTypeSpecificParameters

SetCacheNodeTypeSpecificParameters sets the CacheNodeTypeSpecificParameters field's value.

func (*DescribeCacheParametersOutput) SetMarker

SetMarker sets the Marker field's value.

func (*DescribeCacheParametersOutput) SetParameters

SetParameters sets the Parameters field's value.

func (DescribeCacheParametersOutput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeCacheSecurityGroupsInput) SetCacheSecurityGroupName

SetCacheSecurityGroupName sets the CacheSecurityGroupName field's value.

func (*DescribeCacheSecurityGroupsInput) SetMarker

SetMarker sets the Marker field's value.

func (*DescribeCacheSecurityGroupsInput) SetMaxRecords

SetMaxRecords sets the MaxRecords field's value.

func (DescribeCacheSecurityGroupsInput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeCacheSecurityGroupsOutput) SetCacheSecurityGroups

SetCacheSecurityGroups sets the CacheSecurityGroups field's value.

func (*DescribeCacheSecurityGroupsOutput) SetMarker

SetMarker sets the Marker field's value.

func (DescribeCacheSecurityGroupsOutput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeCacheSubnetGroupsInput) SetCacheSubnetGroupName

SetCacheSubnetGroupName sets the CacheSubnetGroupName field's value.

func (*DescribeCacheSubnetGroupsInput) SetMarker

SetMarker sets the Marker field's value.

func (*DescribeCacheSubnetGroupsInput) SetMaxRecords

SetMaxRecords sets the MaxRecords field's value.

func (DescribeCacheSubnetGroupsInput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeCacheSubnetGroupsOutput) SetCacheSubnetGroups

SetCacheSubnetGroups sets the CacheSubnetGroups field's value.

func (*DescribeCacheSubnetGroupsOutput) SetMarker

SetMarker sets the Marker field's value.

func (DescribeCacheSubnetGroupsOutput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeEngineDefaultParametersInput

type DescribeEngineDefaultParametersInput struct {

	// The name of the cache parameter group family.
	//
	// Valid values are: memcached1.4 | memcached1.5 | memcached1.6 | redis2.6 |
	// redis2.8 | redis3.2 | redis4.0 | redis5.0 | redis6.x | redis6.2 | redis7
	//
	// 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) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeEngineDefaultParametersInput) SetCacheParameterGroupFamily

SetCacheParameterGroupFamily sets the CacheParameterGroupFamily field's value.

func (*DescribeEngineDefaultParametersInput) SetMarker

SetMarker sets the Marker field's value.

func (*DescribeEngineDefaultParametersInput) SetMaxRecords

SetMaxRecords sets the MaxRecords field's value.

func (DescribeEngineDefaultParametersInput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeEngineDefaultParametersOutput) SetEngineDefaults

SetEngineDefaults sets the EngineDefaults field's value.

func (DescribeEngineDefaultParametersOutput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 *string `type:"string" enum:"SourceType"`

	// 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) GoString

func (s DescribeEventsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeEventsInput) SetDuration

func (s *DescribeEventsInput) SetDuration(v int64) *DescribeEventsInput

SetDuration sets the Duration field's value.

func (*DescribeEventsInput) SetEndTime

SetEndTime sets the EndTime field's value.

func (*DescribeEventsInput) SetMarker

SetMarker sets the Marker field's value.

func (*DescribeEventsInput) SetMaxRecords

func (s *DescribeEventsInput) SetMaxRecords(v int64) *DescribeEventsInput

SetMaxRecords sets the MaxRecords field's value.

func (*DescribeEventsInput) SetSourceIdentifier

func (s *DescribeEventsInput) SetSourceIdentifier(v string) *DescribeEventsInput

SetSourceIdentifier sets the SourceIdentifier field's value.

func (*DescribeEventsInput) SetSourceType

func (s *DescribeEventsInput) SetSourceType(v string) *DescribeEventsInput

SetSourceType sets the SourceType field's value.

func (*DescribeEventsInput) SetStartTime

func (s *DescribeEventsInput) SetStartTime(v time.Time) *DescribeEventsInput

SetStartTime sets the StartTime field's value.

func (DescribeEventsInput) String

func (s DescribeEventsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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) GoString

func (s DescribeEventsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeEventsOutput) SetEvents

func (s *DescribeEventsOutput) SetEvents(v []*Event) *DescribeEventsOutput

SetEvents sets the Events field's value.

func (*DescribeEventsOutput) SetMarker

SetMarker sets the Marker field's value.

func (DescribeEventsOutput) String

func (s DescribeEventsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeGlobalReplicationGroupsInput

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) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeGlobalReplicationGroupsInput) SetGlobalReplicationGroupId

SetGlobalReplicationGroupId sets the GlobalReplicationGroupId field's value.

func (*DescribeGlobalReplicationGroupsInput) SetMarker

SetMarker sets the Marker field's value.

func (*DescribeGlobalReplicationGroupsInput) SetMaxRecords

SetMaxRecords sets the MaxRecords field's value.

func (*DescribeGlobalReplicationGroupsInput) SetShowMemberInfo

SetShowMemberInfo sets the ShowMemberInfo field's value.

func (DescribeGlobalReplicationGroupsInput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeGlobalReplicationGroupsOutput

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) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeGlobalReplicationGroupsOutput) SetGlobalReplicationGroups

SetGlobalReplicationGroups sets the GlobalReplicationGroups field's value.

func (*DescribeGlobalReplicationGroupsOutput) SetMarker

SetMarker sets the Marker field's value.

func (DescribeGlobalReplicationGroupsOutput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeReplicationGroupsInput) SetMarker

SetMarker sets the Marker field's value.

func (*DescribeReplicationGroupsInput) SetMaxRecords

SetMaxRecords sets the MaxRecords field's value.

func (*DescribeReplicationGroupsInput) SetReplicationGroupId

SetReplicationGroupId sets the ReplicationGroupId field's value.

func (DescribeReplicationGroupsInput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeReplicationGroupsOutput) SetMarker

SetMarker sets the Marker field's value.

func (*DescribeReplicationGroupsOutput) SetReplicationGroups

SetReplicationGroups sets the ReplicationGroups field's value.

func (DescribeReplicationGroupsOutput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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: M6g node types (available only
	//    for Redis engine version 5.0.6 onward and for Memcached engine version
	//    1.5.16 onward): cache.m6g.large, cache.m6g.xlarge, cache.m6g.2xlarge,
	//    cache.m6g.4xlarge, cache.m6g.8xlarge, cache.m6g.12xlarge, cache.m6g.16xlarge
	//    For region availability, see Supported Node Types (https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/CacheNodes.SupportedTypes.html#CacheNodes.SupportedTypesByRegion)
	//    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 T4g node types (available
	//    only for Redis engine version 5.0.6 onward and Memcached engine version
	//    1.5.16 onward): cache.t4g.micro, cache.t4g.small, cache.t4g.medium 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. Existing clusters are still supported but creation of new
	//    clusters is not supported for these types.) 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. Existing clusters
	//    are still supported but creation of new clusters is not supported for
	//    these types.) C1 node types: cache.c1.xlarge
	//
	//    * Memory optimized: Current generation: R6g node types (available only
	//    for Redis engine version 5.0.6 onward and for Memcached engine version
	//    1.5.16 onward). cache.r6g.large, cache.r6g.xlarge, cache.r6g.2xlarge,
	//    cache.r6g.4xlarge, cache.r6g.8xlarge, cache.r6g.12xlarge, cache.r6g.16xlarge
	//    For region availability, see Supported Node Types (https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/CacheNodes.SupportedTypes.html#CacheNodes.SupportedTypesByRegion)
	//    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. Existing clusters are still supported
	//    but creation of new clusters is not supported for these types.) 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"|"All
	// Upfront"|"Partial Upfront"| "No Upfront"
	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) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeReservedCacheNodesInput) SetCacheNodeType

SetCacheNodeType sets the CacheNodeType field's value.

func (*DescribeReservedCacheNodesInput) SetDuration

SetDuration sets the Duration field's value.

func (*DescribeReservedCacheNodesInput) SetMarker

SetMarker sets the Marker field's value.

func (*DescribeReservedCacheNodesInput) SetMaxRecords

SetMaxRecords sets the MaxRecords field's value.

func (*DescribeReservedCacheNodesInput) SetOfferingType

SetOfferingType sets the OfferingType field's value.

func (*DescribeReservedCacheNodesInput) SetProductDescription

SetProductDescription sets the ProductDescription field's value.

func (*DescribeReservedCacheNodesInput) SetReservedCacheNodeId

SetReservedCacheNodeId sets the ReservedCacheNodeId field's value.

func (*DescribeReservedCacheNodesInput) SetReservedCacheNodesOfferingId

func (s *DescribeReservedCacheNodesInput) SetReservedCacheNodesOfferingId(v string) *DescribeReservedCacheNodesInput

SetReservedCacheNodesOfferingId sets the ReservedCacheNodesOfferingId field's value.

func (DescribeReservedCacheNodesInput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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: M6g node types (available only
	//    for Redis engine version 5.0.6 onward and for Memcached engine version
	//    1.5.16 onward): cache.m6g.large, cache.m6g.xlarge, cache.m6g.2xlarge,
	//    cache.m6g.4xlarge, cache.m6g.8xlarge, cache.m6g.12xlarge, cache.m6g.16xlarge
	//    For region availability, see Supported Node Types (https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/CacheNodes.SupportedTypes.html#CacheNodes.SupportedTypesByRegion)
	//    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 T4g node types (available
	//    only for Redis engine version 5.0.6 onward and Memcached engine version
	//    1.5.16 onward): cache.t4g.micro, cache.t4g.small, cache.t4g.medium 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. Existing clusters are still supported but creation of new
	//    clusters is not supported for these types.) 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. Existing clusters
	//    are still supported but creation of new clusters is not supported for
	//    these types.) C1 node types: cache.c1.xlarge
	//
	//    * Memory optimized: Current generation: R6g node types (available only
	//    for Redis engine version 5.0.6 onward and for Memcached engine version
	//    1.5.16 onward). cache.r6g.large, cache.r6g.xlarge, cache.r6g.2xlarge,
	//    cache.r6g.4xlarge, cache.r6g.8xlarge, cache.r6g.12xlarge, cache.r6g.16xlarge
	//    For region availability, see Supported Node Types (https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/CacheNodes.SupportedTypes.html#CacheNodes.SupportedTypesByRegion)
	//    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. Existing clusters are still supported
	//    but creation of new clusters is not supported for these types.) 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"
	// |"All Upfront"|"Partial Upfront"| "No Upfront"
	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) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeReservedCacheNodesOfferingsInput) SetCacheNodeType

SetCacheNodeType sets the CacheNodeType field's value.

func (*DescribeReservedCacheNodesOfferingsInput) SetDuration

SetDuration sets the Duration field's value.

func (*DescribeReservedCacheNodesOfferingsInput) SetMarker

SetMarker sets the Marker field's value.

func (*DescribeReservedCacheNodesOfferingsInput) SetMaxRecords

SetMaxRecords sets the MaxRecords field's value.

func (*DescribeReservedCacheNodesOfferingsInput) SetOfferingType

SetOfferingType sets the OfferingType field's value.

func (*DescribeReservedCacheNodesOfferingsInput) SetProductDescription

SetProductDescription sets the ProductDescription field's value.

func (*DescribeReservedCacheNodesOfferingsInput) SetReservedCacheNodesOfferingId

SetReservedCacheNodesOfferingId sets the ReservedCacheNodesOfferingId field's value.

func (DescribeReservedCacheNodesOfferingsInput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeReservedCacheNodesOfferingsOutput) SetMarker

SetMarker sets the Marker field's value.

func (*DescribeReservedCacheNodesOfferingsOutput) SetReservedCacheNodesOfferings

SetReservedCacheNodesOfferings sets the ReservedCacheNodesOfferings field's value.

func (DescribeReservedCacheNodesOfferingsOutput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeReservedCacheNodesOutput) SetMarker

SetMarker sets the Marker field's value.

func (*DescribeReservedCacheNodesOutput) SetReservedCacheNodes

SetReservedCacheNodes sets the ReservedCacheNodes field's value.

func (DescribeReservedCacheNodesOutput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeServiceUpdatesInput

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 []*string `type:"list" enum:"ServiceUpdateStatus"`
	// contains filtered or unexported fields
}

func (DescribeServiceUpdatesInput) GoString

func (s DescribeServiceUpdatesInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeServiceUpdatesInput) SetMarker

SetMarker sets the Marker field's value.

func (*DescribeServiceUpdatesInput) SetMaxRecords

SetMaxRecords sets the MaxRecords field's value.

func (*DescribeServiceUpdatesInput) SetServiceUpdateName

SetServiceUpdateName sets the ServiceUpdateName field's value.

func (*DescribeServiceUpdatesInput) SetServiceUpdateStatus

func (s *DescribeServiceUpdatesInput) SetServiceUpdateStatus(v []*string) *DescribeServiceUpdatesInput

SetServiceUpdateStatus sets the ServiceUpdateStatus field's value.

func (DescribeServiceUpdatesInput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeServiceUpdatesOutput

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) GoString

func (s DescribeServiceUpdatesOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeServiceUpdatesOutput) SetMarker

SetMarker sets the Marker field's value.

func (*DescribeServiceUpdatesOutput) SetServiceUpdates

SetServiceUpdates sets the ServiceUpdates field's value.

func (DescribeServiceUpdatesOutput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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) GoString

func (s DescribeSnapshotsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeSnapshotsInput) SetCacheClusterId

func (s *DescribeSnapshotsInput) SetCacheClusterId(v string) *DescribeSnapshotsInput

SetCacheClusterId sets the CacheClusterId field's value.

func (*DescribeSnapshotsInput) SetMarker

SetMarker sets the Marker field's value.

func (*DescribeSnapshotsInput) SetMaxRecords

SetMaxRecords sets the MaxRecords field's value.

func (*DescribeSnapshotsInput) SetReplicationGroupId

func (s *DescribeSnapshotsInput) SetReplicationGroupId(v string) *DescribeSnapshotsInput

SetReplicationGroupId sets the ReplicationGroupId field's value.

func (*DescribeSnapshotsInput) SetShowNodeGroupConfig

func (s *DescribeSnapshotsInput) SetShowNodeGroupConfig(v bool) *DescribeSnapshotsInput

SetShowNodeGroupConfig sets the ShowNodeGroupConfig field's value.

func (*DescribeSnapshotsInput) SetSnapshotName

func (s *DescribeSnapshotsInput) SetSnapshotName(v string) *DescribeSnapshotsInput

SetSnapshotName sets the SnapshotName field's value.

func (*DescribeSnapshotsInput) SetSnapshotSource

func (s *DescribeSnapshotsInput) SetSnapshotSource(v string) *DescribeSnapshotsInput

SetSnapshotSource sets the SnapshotSource field's value.

func (DescribeSnapshotsInput) String

func (s DescribeSnapshotsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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) GoString

func (s DescribeSnapshotsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeSnapshotsOutput) SetMarker

SetMarker sets the Marker field's value.

func (*DescribeSnapshotsOutput) SetSnapshots

SetSnapshots sets the Snapshots field's value.

func (DescribeSnapshotsOutput) String

func (s DescribeSnapshotsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeUpdateActionsInput

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 []*string `type:"list" enum:"ServiceUpdateStatus"`

	// 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 []*string `type:"list" enum:"UpdateActionStatus"`
	// contains filtered or unexported fields
}

func (DescribeUpdateActionsInput) GoString

func (s DescribeUpdateActionsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeUpdateActionsInput) SetCacheClusterIds

func (s *DescribeUpdateActionsInput) SetCacheClusterIds(v []*string) *DescribeUpdateActionsInput

SetCacheClusterIds sets the CacheClusterIds field's value.

func (*DescribeUpdateActionsInput) SetEngine

SetEngine sets the Engine field's value.

func (*DescribeUpdateActionsInput) SetMarker

SetMarker sets the Marker field's value.

func (*DescribeUpdateActionsInput) SetMaxRecords

SetMaxRecords sets the MaxRecords field's value.

func (*DescribeUpdateActionsInput) SetReplicationGroupIds

func (s *DescribeUpdateActionsInput) SetReplicationGroupIds(v []*string) *DescribeUpdateActionsInput

SetReplicationGroupIds sets the ReplicationGroupIds field's value.

func (*DescribeUpdateActionsInput) SetServiceUpdateName

func (s *DescribeUpdateActionsInput) SetServiceUpdateName(v string) *DescribeUpdateActionsInput

SetServiceUpdateName sets the ServiceUpdateName field's value.

func (*DescribeUpdateActionsInput) SetServiceUpdateStatus

func (s *DescribeUpdateActionsInput) SetServiceUpdateStatus(v []*string) *DescribeUpdateActionsInput

SetServiceUpdateStatus sets the ServiceUpdateStatus field's value.

func (*DescribeUpdateActionsInput) SetServiceUpdateTimeRange

func (s *DescribeUpdateActionsInput) SetServiceUpdateTimeRange(v *TimeRangeFilter) *DescribeUpdateActionsInput

SetServiceUpdateTimeRange sets the ServiceUpdateTimeRange field's value.

func (*DescribeUpdateActionsInput) SetShowNodeLevelUpdateStatus

func (s *DescribeUpdateActionsInput) SetShowNodeLevelUpdateStatus(v bool) *DescribeUpdateActionsInput

SetShowNodeLevelUpdateStatus sets the ShowNodeLevelUpdateStatus field's value.

func (*DescribeUpdateActionsInput) SetUpdateActionStatus

func (s *DescribeUpdateActionsInput) SetUpdateActionStatus(v []*string) *DescribeUpdateActionsInput

SetUpdateActionStatus sets the UpdateActionStatus field's value.

func (DescribeUpdateActionsInput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeUpdateActionsOutput

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) GoString

func (s DescribeUpdateActionsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeUpdateActionsOutput) SetMarker

SetMarker sets the Marker field's value.

func (*DescribeUpdateActionsOutput) SetUpdateActions

SetUpdateActions sets the UpdateActions field's value.

func (DescribeUpdateActionsOutput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeUserGroupsInput

type DescribeUserGroupsInput 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.
	MaxRecords *int64 `type:"integer"`

	// The ID of the user group.
	UserGroupId *string `type:"string"`
	// contains filtered or unexported fields
}

func (DescribeUserGroupsInput) GoString

func (s DescribeUserGroupsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeUserGroupsInput) SetMarker

SetMarker sets the Marker field's value.

func (*DescribeUserGroupsInput) SetMaxRecords

SetMaxRecords sets the MaxRecords field's value.

func (*DescribeUserGroupsInput) SetUserGroupId

SetUserGroupId sets the UserGroupId field's value.

func (DescribeUserGroupsInput) String

func (s DescribeUserGroupsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeUserGroupsOutput

type DescribeUserGroupsOutput 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 user groups.
	UserGroups []*UserGroup `type:"list"`
	// contains filtered or unexported fields
}

func (DescribeUserGroupsOutput) GoString

func (s DescribeUserGroupsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeUserGroupsOutput) SetMarker

SetMarker sets the Marker field's value.

func (*DescribeUserGroupsOutput) SetUserGroups

SetUserGroups sets the UserGroups field's value.

func (DescribeUserGroupsOutput) String

func (s DescribeUserGroupsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeUsersInput

type DescribeUsersInput struct {

	// The Redis engine.
	Engine *string `type:"string"`

	// Filter to determine the list of User IDs to return.
	Filters []*Filter `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"`

	// 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"`

	// The ID of the user.
	UserId *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (DescribeUsersInput) GoString

func (s DescribeUsersInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeUsersInput) SetEngine

func (s *DescribeUsersInput) SetEngine(v string) *DescribeUsersInput

SetEngine sets the Engine field's value.

func (*DescribeUsersInput) SetFilters

func (s *DescribeUsersInput) SetFilters(v []*Filter) *DescribeUsersInput

SetFilters sets the Filters field's value.

func (*DescribeUsersInput) SetMarker

func (s *DescribeUsersInput) SetMarker(v string) *DescribeUsersInput

SetMarker sets the Marker field's value.

func (*DescribeUsersInput) SetMaxRecords

func (s *DescribeUsersInput) SetMaxRecords(v int64) *DescribeUsersInput

SetMaxRecords sets the MaxRecords field's value.

func (*DescribeUsersInput) SetUserId

func (s *DescribeUsersInput) SetUserId(v string) *DescribeUsersInput

SetUserId sets the UserId field's value.

func (DescribeUsersInput) String

func (s DescribeUsersInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeUsersInput) Validate

func (s *DescribeUsersInput) Validate() error

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

type DescribeUsersOutput

type DescribeUsersOutput 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 users.
	Users []*User `type:"list"`
	// contains filtered or unexported fields
}

func (DescribeUsersOutput) GoString

func (s DescribeUsersOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeUsersOutput) SetMarker

SetMarker sets the Marker field's value.

func (*DescribeUsersOutput) SetUsers

func (s *DescribeUsersOutput) SetUsers(v []*User) *DescribeUsersOutput

SetUsers sets the Users field's value.

func (DescribeUsersOutput) String

func (s DescribeUsersOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DestinationDetails

type DestinationDetails struct {

	// The configuration details of the CloudWatch Logs destination.
	CloudWatchLogsDetails *CloudWatchLogsDestinationDetails `type:"structure"`

	// The configuration details of the Kinesis Data Firehose destination.
	KinesisFirehoseDetails *KinesisFirehoseDestinationDetails `type:"structure"`
	// contains filtered or unexported fields
}

Configuration details of either a CloudWatch Logs destination or Kinesis Data Firehose destination.

func (DestinationDetails) GoString

func (s DestinationDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DestinationDetails) SetCloudWatchLogsDetails

SetCloudWatchLogsDetails sets the CloudWatchLogsDetails field's value.

func (*DestinationDetails) SetKinesisFirehoseDetails

SetKinesisFirehoseDetails sets the KinesisFirehoseDetails field's value.

func (DestinationDetails) String

func (s DestinationDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DisassociateGlobalReplicationGroupInput

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 Amazon 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) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DisassociateGlobalReplicationGroupInput) SetGlobalReplicationGroupId

SetGlobalReplicationGroupId sets the GlobalReplicationGroupId field's value.

func (*DisassociateGlobalReplicationGroupInput) SetReplicationGroupId

SetReplicationGroupId sets the ReplicationGroupId field's value.

func (*DisassociateGlobalReplicationGroupInput) SetReplicationGroupRegion

SetReplicationGroupRegion sets the ReplicationGroupRegion field's value.

func (DisassociateGlobalReplicationGroupInput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DisassociateGlobalReplicationGroupInput) Validate

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

type DisassociateGlobalReplicationGroupOutput

type DisassociateGlobalReplicationGroupOutput struct {

	// Consists of a primary cluster that accepts writes and an associated secondary
	// cluster that resides in a different Amazon 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) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DisassociateGlobalReplicationGroupOutput) SetGlobalReplicationGroup

SetGlobalReplicationGroup sets the GlobalReplicationGroup field's value.

func (DisassociateGlobalReplicationGroupOutput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type EC2SecurityGroup

type EC2SecurityGroup struct {

	// The name of the Amazon EC2 security group.
	EC2SecurityGroupName *string `type:"string"`

	// The Amazon 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) GoString

func (s EC2SecurityGroup) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*EC2SecurityGroup) SetEC2SecurityGroupName

func (s *EC2SecurityGroup) SetEC2SecurityGroupName(v string) *EC2SecurityGroup

SetEC2SecurityGroupName sets the EC2SecurityGroupName field's value.

func (*EC2SecurityGroup) SetEC2SecurityGroupOwnerId

func (s *EC2SecurityGroup) SetEC2SecurityGroupOwnerId(v string) *EC2SecurityGroup

SetEC2SecurityGroupOwnerId sets the EC2SecurityGroupOwnerId field's value.

func (*EC2SecurityGroup) SetStatus

func (s *EC2SecurityGroup) SetStatus(v string) *EC2SecurityGroup

SetStatus sets the Status field's value.

func (EC2SecurityGroup) String

func (s EC2SecurityGroup) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ElastiCache

type ElastiCache struct {
	*client.Client
}

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

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

func New

func New(p client.ConfigProvider, cfgs ...*aws.Config) *ElastiCache

New creates a new instance of the ElastiCache client with a session. If additional configuration is needed for the client instance use the optional aws.Config parameter to add your extra config.

Example:

mySession := session.Must(session.NewSession())

// Create a ElastiCache client from just a session.
svc := elasticache.New(mySession)

// Create a ElastiCache client with additional configuration
svc := elasticache.New(mySession, aws.NewConfig().WithRegion("us-west-2"))

func (*ElastiCache) AddTagsToResource

func (c *ElastiCache) AddTagsToResource(input *AddTagsToResourceInput) (*TagListMessage, error)

AddTagsToResource API operation for Amazon ElastiCache.

A tag is a key-value pair where the key and value are case-sensitive. You can use tags to categorize and track all your ElastiCache resources, with the exception of global replication group. When you add or remove tags on replication groups, those actions will be replicated to all nodes in the replication group. For more information, see Resource-level permissions (http://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/IAM.ResourceLevelPermissions.html).

For example, you can use cost-allocation tags to your ElastiCache resources, Amazon 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.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon ElastiCache's API operation AddTagsToResource for usage and error information.

Returned Error Codes:

  • ErrCodeCacheClusterNotFoundFault "CacheClusterNotFound" The requested cluster ID does not refer to an existing cluster.

  • ErrCodeCacheParameterGroupNotFoundFault "CacheParameterGroupNotFound" The requested cache parameter group name does not refer to an existing cache parameter group.

  • ErrCodeCacheSecurityGroupNotFoundFault "CacheSecurityGroupNotFound" The requested cache security group name does not refer to an existing cache security group.

  • ErrCodeCacheSubnetGroupNotFoundFault "CacheSubnetGroupNotFoundFault" The requested cache subnet group name does not refer to an existing cache subnet group.

  • ErrCodeInvalidReplicationGroupStateFault "InvalidReplicationGroupState" The requested replication group is not in the available state.

  • ErrCodeReplicationGroupNotFoundFault "ReplicationGroupNotFoundFault" The specified replication group does not exist.

  • ErrCodeReservedCacheNodeNotFoundFault "ReservedCacheNodeNotFound" The requested reserved cache node was not found.

  • ErrCodeSnapshotNotFoundFault "SnapshotNotFoundFault" The requested snapshot name does not refer to an existing snapshot.

  • ErrCodeUserNotFoundFault "UserNotFound" The user does not exist or could not be found.

  • ErrCodeUserGroupNotFoundFault "UserGroupNotFound" The user group was not found or does not exist

  • ErrCodeTagQuotaPerResourceExceeded "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.

  • ErrCodeInvalidARNFault "InvalidARN" The requested Amazon Resource Name (ARN) does not refer to an existing resource.

See also, 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 (
	"fmt"

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

func main() {
	svc := elasticache.New(session.New())
	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"),
			},
		},
	}

	result, err := svc.AddTagsToResource(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case elasticache.ErrCodeCacheClusterNotFoundFault:
				fmt.Println(elasticache.ErrCodeCacheClusterNotFoundFault, aerr.Error())
			case elasticache.ErrCodeCacheParameterGroupNotFoundFault:
				fmt.Println(elasticache.ErrCodeCacheParameterGroupNotFoundFault, aerr.Error())
			case elasticache.ErrCodeCacheSecurityGroupNotFoundFault:
				fmt.Println(elasticache.ErrCodeCacheSecurityGroupNotFoundFault, aerr.Error())
			case elasticache.ErrCodeCacheSubnetGroupNotFoundFault:
				fmt.Println(elasticache.ErrCodeCacheSubnetGroupNotFoundFault, aerr.Error())
			case elasticache.ErrCodeInvalidReplicationGroupStateFault:
				fmt.Println(elasticache.ErrCodeInvalidReplicationGroupStateFault, aerr.Error())
			case elasticache.ErrCodeReplicationGroupNotFoundFault:
				fmt.Println(elasticache.ErrCodeReplicationGroupNotFoundFault, aerr.Error())
			case elasticache.ErrCodeReservedCacheNodeNotFoundFault:
				fmt.Println(elasticache.ErrCodeReservedCacheNodeNotFoundFault, aerr.Error())
			case elasticache.ErrCodeSnapshotNotFoundFault:
				fmt.Println(elasticache.ErrCodeSnapshotNotFoundFault, aerr.Error())
			case elasticache.ErrCodeUserNotFoundFault:
				fmt.Println(elasticache.ErrCodeUserNotFoundFault, aerr.Error())
			case elasticache.ErrCodeUserGroupNotFoundFault:
				fmt.Println(elasticache.ErrCodeUserGroupNotFoundFault, 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 (*ElastiCache) AddTagsToResourceRequest

func (c *ElastiCache) AddTagsToResourceRequest(input *AddTagsToResourceInput) (req *request.Request, output *TagListMessage)

AddTagsToResourceRequest generates a "aws/request.Request" representing the client's request for the AddTagsToResource operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See AddTagsToResource for more information on using the AddTagsToResource API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the AddTagsToResourceRequest method.
req, resp := client.AddTagsToResourceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*ElastiCache) AddTagsToResourceWithContext

func (c *ElastiCache) AddTagsToResourceWithContext(ctx aws.Context, input *AddTagsToResourceInput, opts ...request.Option) (*TagListMessage, error)

AddTagsToResourceWithContext is the same as AddTagsToResource with the addition of the ability to pass a context and additional request options.

See AddTagsToResource for details on how to use this API operation.

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 (*ElastiCache) AuthorizeCacheSecurityGroupIngress

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon ElastiCache's API operation AuthorizeCacheSecurityGroupIngress for usage and error information.

Returned Error Codes:

  • ErrCodeCacheSecurityGroupNotFoundFault "CacheSecurityGroupNotFound" The requested cache security group name does not refer to an existing cache security group.

  • ErrCodeInvalidCacheSecurityGroupStateFault "InvalidCacheSecurityGroupState" The current state of the cache security group does not allow deletion.

  • ErrCodeAuthorizationAlreadyExistsFault "AuthorizationAlreadyExists" The specified Amazon EC2 security group is already authorized for the specified cache security group.

  • ErrCodeInvalidParameterValueException "InvalidParameterValue" The value for a parameter is invalid.

  • ErrCodeInvalidParameterCombinationException "InvalidParameterCombination" Two or more incompatible parameters were specified.

See also, 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 (
	"fmt"

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

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

	result, err := svc.AuthorizeCacheSecurityGroupIngress(input)
	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 (*ElastiCache) AuthorizeCacheSecurityGroupIngressRequest

func (c *ElastiCache) AuthorizeCacheSecurityGroupIngressRequest(input *AuthorizeCacheSecurityGroupIngressInput) (req *request.Request, output *AuthorizeCacheSecurityGroupIngressOutput)

AuthorizeCacheSecurityGroupIngressRequest generates a "aws/request.Request" representing the client's request for the AuthorizeCacheSecurityGroupIngress operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See AuthorizeCacheSecurityGroupIngress for more information on using the AuthorizeCacheSecurityGroupIngress API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the AuthorizeCacheSecurityGroupIngressRequest method.
req, resp := client.AuthorizeCacheSecurityGroupIngressRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*ElastiCache) AuthorizeCacheSecurityGroupIngressWithContext

func (c *ElastiCache) AuthorizeCacheSecurityGroupIngressWithContext(ctx aws.Context, input *AuthorizeCacheSecurityGroupIngressInput, opts ...request.Option) (*AuthorizeCacheSecurityGroupIngressOutput, error)

AuthorizeCacheSecurityGroupIngressWithContext is the same as AuthorizeCacheSecurityGroupIngress with the addition of the ability to pass a context and additional request options.

See AuthorizeCacheSecurityGroupIngress for details on how to use this API operation.

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 (*ElastiCache) BatchApplyUpdateAction

func (c *ElastiCache) BatchApplyUpdateAction(input *BatchApplyUpdateActionInput) (*BatchApplyUpdateActionOutput, error)

BatchApplyUpdateAction 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).

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon ElastiCache's API operation BatchApplyUpdateAction for usage and error information.

Returned Error Codes:

  • ErrCodeServiceUpdateNotFoundFault "ServiceUpdateNotFoundFault" The service update doesn't exist

  • ErrCodeInvalidParameterValueException "InvalidParameterValue" The value for a parameter is invalid.

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

func (*ElastiCache) BatchApplyUpdateActionRequest

func (c *ElastiCache) BatchApplyUpdateActionRequest(input *BatchApplyUpdateActionInput) (req *request.Request, output *BatchApplyUpdateActionOutput)

BatchApplyUpdateActionRequest generates a "aws/request.Request" representing the client's request for the BatchApplyUpdateAction operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See BatchApplyUpdateAction for more information on using the BatchApplyUpdateAction API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the BatchApplyUpdateActionRequest method.
req, resp := client.BatchApplyUpdateActionRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*ElastiCache) BatchApplyUpdateActionWithContext

func (c *ElastiCache) BatchApplyUpdateActionWithContext(ctx aws.Context, input *BatchApplyUpdateActionInput, opts ...request.Option) (*BatchApplyUpdateActionOutput, error)

BatchApplyUpdateActionWithContext is the same as BatchApplyUpdateAction with the addition of the ability to pass a context and additional request options.

See BatchApplyUpdateAction for details on how to use this API operation.

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 (*ElastiCache) BatchStopUpdateAction

func (c *ElastiCache) BatchStopUpdateAction(input *BatchStopUpdateActionInput) (*BatchStopUpdateActionOutput, error)

BatchStopUpdateAction 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).

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon ElastiCache's API operation BatchStopUpdateAction for usage and error information.

Returned Error Codes:

  • ErrCodeServiceUpdateNotFoundFault "ServiceUpdateNotFoundFault" The service update doesn't exist

  • ErrCodeInvalidParameterValueException "InvalidParameterValue" The value for a parameter is invalid.

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

func (*ElastiCache) BatchStopUpdateActionRequest

func (c *ElastiCache) BatchStopUpdateActionRequest(input *BatchStopUpdateActionInput) (req *request.Request, output *BatchStopUpdateActionOutput)

BatchStopUpdateActionRequest generates a "aws/request.Request" representing the client's request for the BatchStopUpdateAction operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See BatchStopUpdateAction for more information on using the BatchStopUpdateAction API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the BatchStopUpdateActionRequest method.
req, resp := client.BatchStopUpdateActionRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*ElastiCache) BatchStopUpdateActionWithContext

func (c *ElastiCache) BatchStopUpdateActionWithContext(ctx aws.Context, input *BatchStopUpdateActionInput, opts ...request.Option) (*BatchStopUpdateActionOutput, error)

BatchStopUpdateActionWithContext is the same as BatchStopUpdateAction with the addition of the ability to pass a context and additional request options.

See BatchStopUpdateAction for details on how to use this API operation.

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 (*ElastiCache) CompleteMigration

func (c *ElastiCache) CompleteMigration(input *CompleteMigrationInput) (*CompleteMigrationOutput, error)

CompleteMigration API operation for Amazon ElastiCache.

Complete the migration of data.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon ElastiCache's API operation CompleteMigration for usage and error information.

Returned Error Codes:

  • ErrCodeReplicationGroupNotFoundFault "ReplicationGroupNotFoundFault" The specified replication group does not exist.

  • ErrCodeInvalidReplicationGroupStateFault "InvalidReplicationGroupState" The requested replication group is not in the available state.

  • ErrCodeReplicationGroupNotUnderMigrationFault "ReplicationGroupNotUnderMigrationFault" The designated replication group is not available for data migration.

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

func (*ElastiCache) CompleteMigrationRequest

func (c *ElastiCache) CompleteMigrationRequest(input *CompleteMigrationInput) (req *request.Request, output *CompleteMigrationOutput)

CompleteMigrationRequest generates a "aws/request.Request" representing the client's request for the CompleteMigration operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CompleteMigration for more information on using the CompleteMigration API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the CompleteMigrationRequest method.
req, resp := client.CompleteMigrationRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*ElastiCache) CompleteMigrationWithContext

func (c *ElastiCache) CompleteMigrationWithContext(ctx aws.Context, input *CompleteMigrationInput, opts ...request.Option) (*CompleteMigrationOutput, error)

CompleteMigrationWithContext is the same as CompleteMigration with the addition of the ability to pass a context and additional request options.

See CompleteMigration for details on how to use this API operation.

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 (*ElastiCache) CopySnapshot

func (c *ElastiCache) CopySnapshot(input *CopySnapshotInput) (*CopySnapshotOutput, error)

CopySnapshot 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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon ElastiCache's API operation CopySnapshot for usage and error information.

Returned Error Codes:

  • ErrCodeSnapshotAlreadyExistsFault "SnapshotAlreadyExistsFault" You already have a snapshot with the given name.

  • ErrCodeSnapshotNotFoundFault "SnapshotNotFoundFault" The requested snapshot name does not refer to an existing snapshot.

  • ErrCodeSnapshotQuotaExceededFault "SnapshotQuotaExceededFault" The request cannot be processed because it would exceed the maximum number of snapshots.

  • ErrCodeInvalidSnapshotStateFault "InvalidSnapshotState" The current state of the snapshot does not allow the requested operation to occur.

  • ErrCodeTagQuotaPerResourceExceeded "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.

  • ErrCodeInvalidParameterValueException "InvalidParameterValue" The value for a parameter is invalid.

  • ErrCodeInvalidParameterCombinationException "InvalidParameterCombination" Two or more incompatible parameters were specified.

See also, 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 (
	"fmt"

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

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

	result, err := svc.CopySnapshot(input)
	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.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 (*ElastiCache) CopySnapshotRequest

func (c *ElastiCache) CopySnapshotRequest(input *CopySnapshotInput) (req *request.Request, output *CopySnapshotOutput)

CopySnapshotRequest generates a "aws/request.Request" representing the client's request for the CopySnapshot operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CopySnapshot for more information on using the CopySnapshot API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the CopySnapshotRequest method.
req, resp := client.CopySnapshotRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*ElastiCache) CopySnapshotWithContext

func (c *ElastiCache) CopySnapshotWithContext(ctx aws.Context, input *CopySnapshotInput, opts ...request.Option) (*CopySnapshotOutput, error)

CopySnapshotWithContext is the same as CopySnapshot with the addition of the ability to pass a context and additional request options.

See CopySnapshot for details on how to use this API operation.

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 (*ElastiCache) CreateCacheCluster

func (c *ElastiCache) CreateCacheCluster(input *CreateCacheClusterInput) (*CreateCacheClusterOutput, error)

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon ElastiCache's API operation CreateCacheCluster for usage and error information.

Returned Error Codes:

  • ErrCodeReplicationGroupNotFoundFault "ReplicationGroupNotFoundFault" The specified replication group does not exist.

  • ErrCodeInvalidReplicationGroupStateFault "InvalidReplicationGroupState" The requested replication group is not in the available state.

  • ErrCodeCacheClusterAlreadyExistsFault "CacheClusterAlreadyExists" You already have a cluster with the given identifier.

  • ErrCodeInsufficientCacheClusterCapacityFault "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.

  • ErrCodeCacheSecurityGroupNotFoundFault "CacheSecurityGroupNotFound" The requested cache security group name does not refer to an existing cache security group.

  • ErrCodeCacheSubnetGroupNotFoundFault "CacheSubnetGroupNotFoundFault" The requested cache subnet group name does not refer to an existing cache subnet group.

  • ErrCodeClusterQuotaForCustomerExceededFault "ClusterQuotaForCustomerExceeded" The request cannot be processed because it would exceed the allowed number of clusters per customer.

  • ErrCodeNodeQuotaForClusterExceededFault "NodeQuotaForClusterExceeded" The request cannot be processed because it would exceed the allowed number of cache nodes in a single cluster.

  • ErrCodeNodeQuotaForCustomerExceededFault "NodeQuotaForCustomerExceeded" The request cannot be processed because it would exceed the allowed number of cache nodes per customer.

  • ErrCodeCacheParameterGroupNotFoundFault "CacheParameterGroupNotFound" The requested cache parameter group name does not refer to an existing cache parameter group.

  • ErrCodeInvalidVPCNetworkStateFault "InvalidVPCNetworkStateFault" The VPC network is in an invalid state.

  • ErrCodeTagQuotaPerResourceExceeded "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.

  • ErrCodeInvalidParameterValueException "InvalidParameterValue" The value for a parameter is invalid.

  • ErrCodeInvalidParameterCombinationException "InvalidParameterCombination" Two or more incompatible parameters were specified.

See also, 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 (
	"fmt"

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

func main() {
	svc := elasticache.New(session.New())
	input := &elasticache.CreateCacheClusterInput{
		AZMode:               aws.String("cross-az"),
		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),
	}

	result, err := svc.CreateCacheCluster(input)
	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 (
	"fmt"

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

func main() {
	svc := elasticache.New(session.New())
	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),
	}

	result, err := svc.CreateCacheCluster(input)
	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 (*ElastiCache) CreateCacheClusterRequest

func (c *ElastiCache) CreateCacheClusterRequest(input *CreateCacheClusterInput) (req *request.Request, output *CreateCacheClusterOutput)

CreateCacheClusterRequest generates a "aws/request.Request" representing the client's request for the CreateCacheCluster operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateCacheCluster for more information on using the CreateCacheCluster API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the CreateCacheClusterRequest method.
req, resp := client.CreateCacheClusterRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*ElastiCache) CreateCacheClusterWithContext

func (c *ElastiCache) CreateCacheClusterWithContext(ctx aws.Context, input *CreateCacheClusterInput, opts ...request.Option) (*CreateCacheClusterOutput, error)

CreateCacheClusterWithContext is the same as CreateCacheCluster with the addition of the ability to pass a context and additional request options.

See CreateCacheCluster for details on how to use this API operation.

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 (*ElastiCache) CreateCacheParameterGroup

func (c *ElastiCache) CreateCacheParameterGroup(input *CreateCacheParameterGroupInput) (*CreateCacheParameterGroupOutput, error)

CreateCacheParameterGroup 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:

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon ElastiCache's API operation CreateCacheParameterGroup for usage and error information.

Returned Error Codes:

  • ErrCodeCacheParameterGroupQuotaExceededFault "CacheParameterGroupQuotaExceeded" The request cannot be processed because it would exceed the maximum number of cache security groups.

  • ErrCodeCacheParameterGroupAlreadyExistsFault "CacheParameterGroupAlreadyExists" A cache parameter group with the requested name already exists.

  • ErrCodeInvalidCacheParameterGroupStateFault "InvalidCacheParameterGroupState" The current state of the cache parameter group does not allow the requested operation to occur.

  • ErrCodeTagQuotaPerResourceExceeded "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.

  • ErrCodeInvalidParameterValueException "InvalidParameterValue" The value for a parameter is invalid.

  • ErrCodeInvalidParameterCombinationException "InvalidParameterCombination" Two or more incompatible parameters were specified.

See also, 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 (
	"fmt"

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

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

	result, err := svc.CreateCacheParameterGroup(input)
	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.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 (*ElastiCache) CreateCacheParameterGroupRequest

func (c *ElastiCache) CreateCacheParameterGroupRequest(input *CreateCacheParameterGroupInput) (req *request.Request, output *CreateCacheParameterGroupOutput)

CreateCacheParameterGroupRequest generates a "aws/request.Request" representing the client's request for the CreateCacheParameterGroup operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateCacheParameterGroup for more information on using the CreateCacheParameterGroup API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the CreateCacheParameterGroupRequest method.
req, resp := client.CreateCacheParameterGroupRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*ElastiCache) CreateCacheParameterGroupWithContext

func (c *ElastiCache) CreateCacheParameterGroupWithContext(ctx aws.Context, input *CreateCacheParameterGroupInput, opts ...request.Option) (*CreateCacheParameterGroupOutput, error)

CreateCacheParameterGroupWithContext is the same as CreateCacheParameterGroup with the addition of the ability to pass a context and additional request options.

See CreateCacheParameterGroup for details on how to use this API operation.

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 (*ElastiCache) CreateCacheSecurityGroup

func (c *ElastiCache) CreateCacheSecurityGroup(input *CreateCacheSecurityGroupInput) (*CreateCacheSecurityGroupOutput, error)

CreateCacheSecurityGroup 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).

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon ElastiCache's API operation CreateCacheSecurityGroup for usage and error information.

Returned Error Codes:

  • ErrCodeCacheSecurityGroupAlreadyExistsFault "CacheSecurityGroupAlreadyExists" A cache security group with the specified name already exists.

  • ErrCodeCacheSecurityGroupQuotaExceededFault "QuotaExceeded.CacheSecurityGroup" The request cannot be processed because it would exceed the allowed number of cache security groups.

  • ErrCodeTagQuotaPerResourceExceeded "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.

  • ErrCodeInvalidParameterValueException "InvalidParameterValue" The value for a parameter is invalid.

  • ErrCodeInvalidParameterCombinationException "InvalidParameterCombination" Two or more incompatible parameters were specified.

See also, 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 (
	"fmt"

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

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

	result, err := svc.CreateCacheSecurityGroup(input)
	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.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 (*ElastiCache) CreateCacheSecurityGroupRequest

func (c *ElastiCache) CreateCacheSecurityGroupRequest(input *CreateCacheSecurityGroupInput) (req *request.Request, output *CreateCacheSecurityGroupOutput)

CreateCacheSecurityGroupRequest generates a "aws/request.Request" representing the client's request for the CreateCacheSecurityGroup operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateCacheSecurityGroup for more information on using the CreateCacheSecurityGroup API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the CreateCacheSecurityGroupRequest method.
req, resp := client.CreateCacheSecurityGroupRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*ElastiCache) CreateCacheSecurityGroupWithContext

func (c *ElastiCache) CreateCacheSecurityGroupWithContext(ctx aws.Context, input *CreateCacheSecurityGroupInput, opts ...request.Option) (*CreateCacheSecurityGroupOutput, error)

CreateCacheSecurityGroupWithContext is the same as CreateCacheSecurityGroup with the addition of the ability to pass a context and additional request options.

See CreateCacheSecurityGroup for details on how to use this API operation.

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 (*ElastiCache) CreateCacheSubnetGroup

func (c *ElastiCache) CreateCacheSubnetGroup(input *CreateCacheSubnetGroupInput) (*CreateCacheSubnetGroupOutput, error)

CreateCacheSubnetGroup 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).

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon ElastiCache's API operation CreateCacheSubnetGroup for usage and error information.

Returned Error Codes:

  • ErrCodeCacheSubnetGroupAlreadyExistsFault "CacheSubnetGroupAlreadyExists" The requested cache subnet group name is already in use by an existing cache subnet group.

  • ErrCodeCacheSubnetGroupQuotaExceededFault "CacheSubnetGroupQuotaExceeded" The request cannot be processed because it would exceed the allowed number of cache subnet groups.

  • ErrCodeCacheSubnetQuotaExceededFault "CacheSubnetQuotaExceededFault" The request cannot be processed because it would exceed the allowed number of subnets in a cache subnet group.

  • ErrCodeTagQuotaPerResourceExceeded "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.

  • ErrCodeInvalidSubnet "InvalidSubnet" An invalid subnet identifier was specified.

  • ErrCodeSubnetNotAllowedFault "SubnetNotAllowedFault" At least one subnet ID does not match the other subnet IDs. This mismatch typically occurs when a user sets one subnet ID to a regional Availability Zone and a different one to an outpost. Or when a user sets the subnet ID to an Outpost when not subscribed on this service.

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

Example (Shared00)

CreateCacheSubnet Creates a new cache subnet group.

package main

import (
	"fmt"

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

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

	result, err := svc.CreateCacheSubnetGroup(input)
	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.ErrCodeTagQuotaPerResourceExceeded:
				fmt.Println(elasticache.ErrCodeTagQuotaPerResourceExceeded, aerr.Error())
			case elasticache.ErrCodeInvalidSubnet:
				fmt.Println(elasticache.ErrCodeInvalidSubnet, aerr.Error())
			case elasticache.ErrCodeSubnetNotAllowedFault:
				fmt.Println(elasticache.ErrCodeSubnetNotAllowedFault, 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 (*ElastiCache) CreateCacheSubnetGroupRequest

func (c *ElastiCache) CreateCacheSubnetGroupRequest(input *CreateCacheSubnetGroupInput) (req *request.Request, output *CreateCacheSubnetGroupOutput)

CreateCacheSubnetGroupRequest generates a "aws/request.Request" representing the client's request for the CreateCacheSubnetGroup operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateCacheSubnetGroup for more information on using the CreateCacheSubnetGroup API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the CreateCacheSubnetGroupRequest method.
req, resp := client.CreateCacheSubnetGroupRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*ElastiCache) CreateCacheSubnetGroupWithContext

func (c *ElastiCache) CreateCacheSubnetGroupWithContext(ctx aws.Context, input *CreateCacheSubnetGroupInput, opts ...request.Option) (*CreateCacheSubnetGroupOutput, error)

CreateCacheSubnetGroupWithContext is the same as CreateCacheSubnetGroup with the addition of the ability to pass a context and additional request options.

See CreateCacheSubnetGroup for details on how to use this API operation.

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 (*ElastiCache) CreateGlobalReplicationGroup

func (c *ElastiCache) CreateGlobalReplicationGroup(input *CreateGlobalReplicationGroupInput) (*CreateGlobalReplicationGroupOutput, error)

CreateGlobalReplicationGroup 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 (https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/Redis-Global-Datastore.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.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon ElastiCache's API operation CreateGlobalReplicationGroup for usage and error information.

Returned Error Codes:

  • ErrCodeReplicationGroupNotFoundFault "ReplicationGroupNotFoundFault" The specified replication group does not exist.

  • ErrCodeInvalidReplicationGroupStateFault "InvalidReplicationGroupState" The requested replication group is not in the available state.

  • ErrCodeGlobalReplicationGroupAlreadyExistsFault "GlobalReplicationGroupAlreadyExistsFault" The Global datastore name already exists.

  • ErrCodeServiceLinkedRoleNotFoundFault "ServiceLinkedRoleNotFoundFault" The specified service linked role (SLR) was not found.

  • ErrCodeInvalidParameterValueException "InvalidParameterValue" The value for a parameter is invalid.

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

func (*ElastiCache) CreateGlobalReplicationGroupRequest

func (c *ElastiCache) CreateGlobalReplicationGroupRequest(input *CreateGlobalReplicationGroupInput) (req *request.Request, output *CreateGlobalReplicationGroupOutput)

CreateGlobalReplicationGroupRequest generates a "aws/request.Request" representing the client's request for the CreateGlobalReplicationGroup operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateGlobalReplicationGroup for more information on using the CreateGlobalReplicationGroup API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the CreateGlobalReplicationGroupRequest method.
req, resp := client.CreateGlobalReplicationGroupRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*ElastiCache) CreateGlobalReplicationGroupWithContext

func (c *ElastiCache) CreateGlobalReplicationGroupWithContext(ctx aws.Context, input *CreateGlobalReplicationGroupInput, opts ...request.Option) (*CreateGlobalReplicationGroupOutput, error)

CreateGlobalReplicationGroupWithContext is the same as CreateGlobalReplicationGroup with the addition of the ability to pass a context and additional request options.

See CreateGlobalReplicationGroup for details on how to use this API operation.

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 (*ElastiCache) CreateReplicationGroup

func (c *ElastiCache) CreateReplicationGroup(input *CreateReplicationGroupInput) (*CreateReplicationGroupOutput, error)

CreateReplicationGroup 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 cluster is comprised of from 1 to 90 shards (API/CLI: node groups). Each shard has a primary node and up to 5 read-only replica nodes. The configuration can range from 90 shards and 0 replicas to 15 shards and 5 replicas, which is the maximum number or replicas allowed.

The node or shard limit can be increased to a maximum of 500 per cluster if the Redis engine version is 5.0.6 or higher. For example, you can choose to configure a 500 node cluster that ranges between 83 shards (one primary and 5 replicas per shard) and 500 shards (single primary and no replicas). Make sure there are enough available IP addresses to accommodate the increase. Common pitfalls include the subnets in the subnet group have too small a CIDR range or the subnets are shared and heavily used by other clusters. For more information, see Creating a Subnet Group (https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/SubnetGroups.Creating.html). For versions below 5.0.6, the limit is 250 per cluster.

To request a limit increase, see Amazon Service Limits (https://docs.aws.amazon.com/general/latest/gr/aws_service_limits.html) and choose the limit type Nodes per cluster per instance type.

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.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon ElastiCache's API operation CreateReplicationGroup for usage and error information.

Returned Error Codes:

  • ErrCodeCacheClusterNotFoundFault "CacheClusterNotFound" The requested cluster ID does not refer to an existing cluster.

  • ErrCodeInvalidCacheClusterStateFault "InvalidCacheClusterState" The requested cluster is not in the available state.

  • ErrCodeReplicationGroupAlreadyExistsFault "ReplicationGroupAlreadyExists" The specified replication group already exists.

  • ErrCodeInvalidUserGroupStateFault "InvalidUserGroupState" The user group is not in an active state.

  • ErrCodeUserGroupNotFoundFault "UserGroupNotFound" The user group was not found or does not exist

  • ErrCodeInsufficientCacheClusterCapacityFault "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.

  • ErrCodeCacheSecurityGroupNotFoundFault "CacheSecurityGroupNotFound" The requested cache security group name does not refer to an existing cache security group.

  • ErrCodeCacheSubnetGroupNotFoundFault "CacheSubnetGroupNotFoundFault" The requested cache subnet group name does not refer to an existing cache subnet group.

  • ErrCodeClusterQuotaForCustomerExceededFault "ClusterQuotaForCustomerExceeded" The request cannot be processed because it would exceed the allowed number of clusters per customer.

  • ErrCodeNodeQuotaForClusterExceededFault "NodeQuotaForClusterExceeded" The request cannot be processed because it would exceed the allowed number of cache nodes in a single cluster.

  • ErrCodeNodeQuotaForCustomerExceededFault "NodeQuotaForCustomerExceeded" The request cannot be processed because it would exceed the allowed number of cache nodes per customer.

  • ErrCodeCacheParameterGroupNotFoundFault "CacheParameterGroupNotFound" The requested cache parameter group name does not refer to an existing cache parameter group.

  • ErrCodeInvalidVPCNetworkStateFault "InvalidVPCNetworkStateFault" The VPC network is in an invalid state.

  • ErrCodeTagQuotaPerResourceExceeded "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.

  • ErrCodeNodeGroupsPerReplicationGroupQuotaExceededFault "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

  • ErrCodeGlobalReplicationGroupNotFoundFault "GlobalReplicationGroupNotFoundFault" The Global datastore does not exist

  • ErrCodeInvalidGlobalReplicationGroupStateFault "InvalidGlobalReplicationGroupState" The Global datastore is not available or in primary-only state.

  • ErrCodeInvalidParameterValueException "InvalidParameterValue" The value for a parameter is invalid.

  • ErrCodeInvalidParameterCombinationException "InvalidParameterCombination" Two or more incompatible parameters were specified.

See also, 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 (
	"fmt"

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

func main() {
	svc := elasticache.New(session.New())
	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),
	}

	result, err := svc.CreateReplicationGroup(input)
	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.ErrCodeInvalidUserGroupStateFault:
				fmt.Println(elasticache.ErrCodeInvalidUserGroupStateFault, aerr.Error())
			case elasticache.ErrCodeUserGroupNotFoundFault:
				fmt.Println(elasticache.ErrCodeUserGroupNotFoundFault, 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 (
	"fmt"

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

func main() {
	svc := elasticache.New(session.New())
	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{
					aws.String("us-east-1b"),
				},
				ReplicaCount: aws.Int64(1),
				Slots:        aws.String("0-8999"),
			},
			{
				PrimaryAvailabilityZone: aws.String("us-east-1a"),
				ReplicaAvailabilityZones: []*string{
					aws.String("us-east-1a"),
					aws.String("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),
	}

	result, err := svc.CreateReplicationGroup(input)
	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.ErrCodeInvalidUserGroupStateFault:
				fmt.Println(elasticache.ErrCodeInvalidUserGroupStateFault, aerr.Error())
			case elasticache.ErrCodeUserGroupNotFoundFault:
				fmt.Println(elasticache.ErrCodeUserGroupNotFoundFault, 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 (*ElastiCache) CreateReplicationGroupRequest

func (c *ElastiCache) CreateReplicationGroupRequest(input *CreateReplicationGroupInput) (req *request.Request, output *CreateReplicationGroupOutput)

CreateReplicationGroupRequest generates a "aws/request.Request" representing the client's request for the CreateReplicationGroup operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateReplicationGroup for more information on using the CreateReplicationGroup API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the CreateReplicationGroupRequest method.
req, resp := client.CreateReplicationGroupRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*ElastiCache) CreateReplicationGroupWithContext

func (c *ElastiCache) CreateReplicationGroupWithContext(ctx aws.Context, input *CreateReplicationGroupInput, opts ...request.Option) (*CreateReplicationGroupOutput, error)

CreateReplicationGroupWithContext is the same as CreateReplicationGroup with the addition of the ability to pass a context and additional request options.

See CreateReplicationGroup for details on how to use this API operation.

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 (*ElastiCache) CreateSnapshot

func (c *ElastiCache) CreateSnapshot(input *CreateSnapshotInput) (*CreateSnapshotOutput, error)

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon ElastiCache's API operation CreateSnapshot for usage and error information.

Returned Error Codes:

  • ErrCodeSnapshotAlreadyExistsFault "SnapshotAlreadyExistsFault" You already have a snapshot with the given name.

  • ErrCodeCacheClusterNotFoundFault "CacheClusterNotFound" The requested cluster ID does not refer to an existing cluster.

  • ErrCodeReplicationGroupNotFoundFault "ReplicationGroupNotFoundFault" The specified replication group does not exist.

  • ErrCodeInvalidCacheClusterStateFault "InvalidCacheClusterState" The requested cluster is not in the available state.

  • ErrCodeInvalidReplicationGroupStateFault "InvalidReplicationGroupState" The requested replication group is not in the available state.

  • ErrCodeSnapshotQuotaExceededFault "SnapshotQuotaExceededFault" The request cannot be processed because it would exceed the maximum number of snapshots.

  • ErrCodeSnapshotFeatureNotSupportedFault "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.

  • ErrCodeTagQuotaPerResourceExceeded "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.

  • ErrCodeInvalidParameterCombinationException "InvalidParameterCombination" Two or more incompatible parameters were specified.

  • ErrCodeInvalidParameterValueException "InvalidParameterValue" The value for a parameter is invalid.

See also, 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 (
	"fmt"

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

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

	result, err := svc.CreateSnapshot(input)
	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.ErrCodeTagQuotaPerResourceExceeded:
				fmt.Println(elasticache.ErrCodeTagQuotaPerResourceExceeded, 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 (
	"fmt"

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

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

	result, err := svc.CreateSnapshot(input)
	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.ErrCodeTagQuotaPerResourceExceeded:
				fmt.Println(elasticache.ErrCodeTagQuotaPerResourceExceeded, 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 (
	"fmt"

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

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

	result, err := svc.CreateSnapshot(input)
	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.ErrCodeTagQuotaPerResourceExceeded:
				fmt.Println(elasticache.ErrCodeTagQuotaPerResourceExceeded, 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 (*ElastiCache) CreateSnapshotRequest

func (c *ElastiCache) CreateSnapshotRequest(input *CreateSnapshotInput) (req *request.Request, output *CreateSnapshotOutput)

CreateSnapshotRequest generates a "aws/request.Request" representing the client's request for the CreateSnapshot operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateSnapshot for more information on using the CreateSnapshot API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the CreateSnapshotRequest method.
req, resp := client.CreateSnapshotRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*ElastiCache) CreateSnapshotWithContext

func (c *ElastiCache) CreateSnapshotWithContext(ctx aws.Context, input *CreateSnapshotInput, opts ...request.Option) (*CreateSnapshotOutput, error)

CreateSnapshotWithContext is the same as CreateSnapshot with the addition of the ability to pass a context and additional request options.

See CreateSnapshot for details on how to use this API operation.

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 (*ElastiCache) CreateUser

func (c *ElastiCache) CreateUser(input *CreateUserInput) (*CreateUserOutput, error)

CreateUser API operation for Amazon ElastiCache.

For Redis engine version 6.0 onwards: Creates a Redis user. For more information, see Using Role Based Access Control (RBAC) (http://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/Clusters.RBAC.html).

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon ElastiCache's API operation CreateUser for usage and error information.

Returned Error Codes:

  • ErrCodeUserAlreadyExistsFault "UserAlreadyExists" A user with this ID already exists.

  • ErrCodeUserQuotaExceededFault "UserQuotaExceeded" The quota of users has been exceeded.

  • ErrCodeDuplicateUserNameFault "DuplicateUserName" A user with this username already exists.

  • ErrCodeServiceLinkedRoleNotFoundFault "ServiceLinkedRoleNotFoundFault" The specified service linked role (SLR) was not found.

  • ErrCodeInvalidParameterValueException "InvalidParameterValue" The value for a parameter is invalid.

  • ErrCodeInvalidParameterCombinationException "InvalidParameterCombination" Two or more incompatible parameters were specified.

  • ErrCodeTagQuotaPerResourceExceeded "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.

See also, https://docs.aws.amazon.com/goto/WebAPI/elasticache-2015-02-02/CreateUser

func (*ElastiCache) CreateUserGroup

func (c *ElastiCache) CreateUserGroup(input *CreateUserGroupInput) (*CreateUserGroupOutput, error)

CreateUserGroup API operation for Amazon ElastiCache.

For Redis engine version 6.0 onwards: Creates a Redis user group. For more information, see Using Role Based Access Control (RBAC) (http://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/Clusters.RBAC.html)

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon ElastiCache's API operation CreateUserGroup for usage and error information.

Returned Error Codes:

  • ErrCodeUserNotFoundFault "UserNotFound" The user does not exist or could not be found.

  • ErrCodeDuplicateUserNameFault "DuplicateUserName" A user with this username already exists.

  • ErrCodeUserGroupAlreadyExistsFault "UserGroupAlreadyExists" The user group with this ID already exists.

  • ErrCodeServiceLinkedRoleNotFoundFault "ServiceLinkedRoleNotFoundFault" The specified service linked role (SLR) was not found.

  • ErrCodeDefaultUserRequired "DefaultUserRequired" You must add default user to a user group.

  • ErrCodeUserGroupQuotaExceededFault "UserGroupQuotaExceeded" The number of users exceeds the user group limit.

  • ErrCodeInvalidParameterValueException "InvalidParameterValue" The value for a parameter is invalid.

  • ErrCodeTagQuotaPerResourceExceeded "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.

See also, https://docs.aws.amazon.com/goto/WebAPI/elasticache-2015-02-02/CreateUserGroup

func (*ElastiCache) CreateUserGroupRequest

func (c *ElastiCache) CreateUserGroupRequest(input *CreateUserGroupInput) (req *request.Request, output *CreateUserGroupOutput)

CreateUserGroupRequest generates a "aws/request.Request" representing the client's request for the CreateUserGroup operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateUserGroup for more information on using the CreateUserGroup API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the CreateUserGroupRequest method.
req, resp := client.CreateUserGroupRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/elasticache-2015-02-02/CreateUserGroup

func (*ElastiCache) CreateUserGroupWithContext

func (c *ElastiCache) CreateUserGroupWithContext(ctx aws.Context, input *CreateUserGroupInput, opts ...request.Option) (*CreateUserGroupOutput, error)

CreateUserGroupWithContext is the same as CreateUserGroup with the addition of the ability to pass a context and additional request options.

See CreateUserGroup for details on how to use this API operation.

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 (*ElastiCache) CreateUserRequest

func (c *ElastiCache) CreateUserRequest(input *CreateUserInput) (req *request.Request, output *CreateUserOutput)

CreateUserRequest generates a "aws/request.Request" representing the client's request for the CreateUser operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateUser for more information on using the CreateUser API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the CreateUserRequest method.
req, resp := client.CreateUserRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/elasticache-2015-02-02/CreateUser

func (*ElastiCache) CreateUserWithContext

func (c *ElastiCache) CreateUserWithContext(ctx aws.Context, input *CreateUserInput, opts ...request.Option) (*CreateUserOutput, error)

CreateUserWithContext is the same as CreateUser with the addition of the ability to pass a context and additional request options.

See CreateUser for details on how to use this API operation.

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 (*ElastiCache) DecreaseNodeGroupsInGlobalReplicationGroup

DecreaseNodeGroupsInGlobalReplicationGroup API operation for Amazon ElastiCache.

Decreases the number of node groups in a Global datastore

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon ElastiCache's API operation DecreaseNodeGroupsInGlobalReplicationGroup for usage and error information.

Returned Error Codes:

  • ErrCodeGlobalReplicationGroupNotFoundFault "GlobalReplicationGroupNotFoundFault" The Global datastore does not exist

  • ErrCodeInvalidGlobalReplicationGroupStateFault "InvalidGlobalReplicationGroupState" The Global datastore is not available or in primary-only state.

  • ErrCodeInvalidParameterValueException "InvalidParameterValue" The value for a parameter is invalid.

  • ErrCodeInvalidParameterCombinationException "InvalidParameterCombination" Two or more incompatible parameters were specified.

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

func (*ElastiCache) DecreaseNodeGroupsInGlobalReplicationGroupRequest

func (c *ElastiCache) DecreaseNodeGroupsInGlobalReplicationGroupRequest(input *DecreaseNodeGroupsInGlobalReplicationGroupInput) (req *request.Request, output *DecreaseNodeGroupsInGlobalReplicationGroupOutput)

DecreaseNodeGroupsInGlobalReplicationGroupRequest generates a "aws/request.Request" representing the client's request for the DecreaseNodeGroupsInGlobalReplicationGroup operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DecreaseNodeGroupsInGlobalReplicationGroup for more information on using the DecreaseNodeGroupsInGlobalReplicationGroup API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DecreaseNodeGroupsInGlobalReplicationGroupRequest method.
req, resp := client.DecreaseNodeGroupsInGlobalReplicationGroupRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*ElastiCache) DecreaseNodeGroupsInGlobalReplicationGroupWithContext

func (c *ElastiCache) DecreaseNodeGroupsInGlobalReplicationGroupWithContext(ctx aws.Context, input *DecreaseNodeGroupsInGlobalReplicationGroupInput, opts ...request.Option) (*DecreaseNodeGroupsInGlobalReplicationGroupOutput, error)

DecreaseNodeGroupsInGlobalReplicationGroupWithContext is the same as DecreaseNodeGroupsInGlobalReplicationGroup with the addition of the ability to pass a context and additional request options.

See DecreaseNodeGroupsInGlobalReplicationGroup for details on how to use this API operation.

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 (*ElastiCache) DecreaseReplicaCount

func (c *ElastiCache) DecreaseReplicaCount(input *DecreaseReplicaCountInput) (*DecreaseReplicaCountOutput, error)

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon ElastiCache's API operation DecreaseReplicaCount for usage and error information.

Returned Error Codes:

  • ErrCodeReplicationGroupNotFoundFault "ReplicationGroupNotFoundFault" The specified replication group does not exist.

  • ErrCodeInvalidReplicationGroupStateFault "InvalidReplicationGroupState" The requested replication group is not in the available state.

  • ErrCodeInvalidCacheClusterStateFault "InvalidCacheClusterState" The requested cluster is not in the available state.

  • ErrCodeInvalidVPCNetworkStateFault "InvalidVPCNetworkStateFault" The VPC network is in an invalid state.

  • ErrCodeInsufficientCacheClusterCapacityFault "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.

  • ErrCodeClusterQuotaForCustomerExceededFault "ClusterQuotaForCustomerExceeded" The request cannot be processed because it would exceed the allowed number of clusters per customer.

  • ErrCodeNodeGroupsPerReplicationGroupQuotaExceededFault "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

  • ErrCodeNodeQuotaForCustomerExceededFault "NodeQuotaForCustomerExceeded" The request cannot be processed because it would exceed the allowed number of cache nodes per customer.

  • ErrCodeServiceLinkedRoleNotFoundFault "ServiceLinkedRoleNotFoundFault" The specified service linked role (SLR) was not found.

  • ErrCodeNoOperationFault "NoOperationFault" The operation was not performed because no changes were required.

  • ErrCodeInvalidParameterValueException "InvalidParameterValue" The value for a parameter is invalid.

  • ErrCodeInvalidParameterCombinationException "InvalidParameterCombination" Two or more incompatible parameters were specified.

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

func (*ElastiCache) DecreaseReplicaCountRequest

func (c *ElastiCache) DecreaseReplicaCountRequest(input *DecreaseReplicaCountInput) (req *request.Request, output *DecreaseReplicaCountOutput)

DecreaseReplicaCountRequest generates a "aws/request.Request" representing the client's request for the DecreaseReplicaCount operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DecreaseReplicaCount for more information on using the DecreaseReplicaCount API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DecreaseReplicaCountRequest method.
req, resp := client.DecreaseReplicaCountRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*ElastiCache) DecreaseReplicaCountWithContext

func (c *ElastiCache) DecreaseReplicaCountWithContext(ctx aws.Context, input *DecreaseReplicaCountInput, opts ...request.Option) (*DecreaseReplicaCountOutput, error)

DecreaseReplicaCountWithContext is the same as DecreaseReplicaCount with the addition of the ability to pass a context and additional request options.

See DecreaseReplicaCount for details on how to use this API operation.

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 (*ElastiCache) DeleteCacheCluster

func (c *ElastiCache) DeleteCacheCluster(input *DeleteCacheClusterInput) (*DeleteCacheClusterOutput, error)

DeleteCacheCluster 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

  • Redis (cluster mode disabled) clusters

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

  • A cluster that is the primary node 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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon ElastiCache's API operation DeleteCacheCluster for usage and error information.

Returned Error Codes:

  • ErrCodeCacheClusterNotFoundFault "CacheClusterNotFound" The requested cluster ID does not refer to an existing cluster.

  • ErrCodeInvalidCacheClusterStateFault "InvalidCacheClusterState" The requested cluster is not in the available state.

  • ErrCodeSnapshotAlreadyExistsFault "SnapshotAlreadyExistsFault" You already have a snapshot with the given name.

  • ErrCodeSnapshotFeatureNotSupportedFault "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.

  • ErrCodeSnapshotQuotaExceededFault "SnapshotQuotaExceededFault" The request cannot be processed because it would exceed the maximum number of snapshots.

  • ErrCodeInvalidParameterValueException "InvalidParameterValue" The value for a parameter is invalid.

  • ErrCodeInvalidParameterCombinationException "InvalidParameterCombination" Two or more incompatible parameters were specified.

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

Example (Shared00)

DeleteCacheCluster Deletes an Amazon ElastiCache cluster.

package main

import (
	"fmt"

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

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

	result, err := svc.DeleteCacheCluster(input)
	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 (*ElastiCache) DeleteCacheClusterRequest

func (c *ElastiCache) DeleteCacheClusterRequest(input *DeleteCacheClusterInput) (req *request.Request, output *DeleteCacheClusterOutput)

DeleteCacheClusterRequest generates a "aws/request.Request" representing the client's request for the DeleteCacheCluster operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteCacheCluster for more information on using the DeleteCacheCluster API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DeleteCacheClusterRequest method.
req, resp := client.DeleteCacheClusterRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*ElastiCache) DeleteCacheClusterWithContext

func (c *ElastiCache) DeleteCacheClusterWithContext(ctx aws.Context, input *DeleteCacheClusterInput, opts ...request.Option) (*DeleteCacheClusterOutput, error)

DeleteCacheClusterWithContext is the same as DeleteCacheCluster with the addition of the ability to pass a context and additional request options.

See DeleteCacheCluster for details on how to use this API operation.

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 (*ElastiCache) DeleteCacheParameterGroup

func (c *ElastiCache) DeleteCacheParameterGroup(input *DeleteCacheParameterGroupInput) (*DeleteCacheParameterGroupOutput, error)

DeleteCacheParameterGroup 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. You cannot delete the default cache parameter groups in your account.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon ElastiCache's API operation DeleteCacheParameterGroup for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidCacheParameterGroupStateFault "InvalidCacheParameterGroupState" The current state of the cache parameter group does not allow the requested operation to occur.

  • ErrCodeCacheParameterGroupNotFoundFault "CacheParameterGroupNotFound" The requested cache parameter group name does not refer to an existing cache parameter group.

  • ErrCodeInvalidParameterValueException "InvalidParameterValue" The value for a parameter is invalid.

  • ErrCodeInvalidParameterCombinationException "InvalidParameterCombination" Two or more incompatible parameters were specified.

See also, 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 (
	"fmt"

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

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

	result, err := svc.DeleteCacheParameterGroup(input)
	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 (*ElastiCache) DeleteCacheParameterGroupRequest

func (c *ElastiCache) DeleteCacheParameterGroupRequest(input *DeleteCacheParameterGroupInput) (req *request.Request, output *DeleteCacheParameterGroupOutput)

DeleteCacheParameterGroupRequest generates a "aws/request.Request" representing the client's request for the DeleteCacheParameterGroup operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteCacheParameterGroup for more information on using the DeleteCacheParameterGroup API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DeleteCacheParameterGroupRequest method.
req, resp := client.DeleteCacheParameterGroupRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*ElastiCache) DeleteCacheParameterGroupWithContext

func (c *ElastiCache) DeleteCacheParameterGroupWithContext(ctx aws.Context, input *DeleteCacheParameterGroupInput, opts ...request.Option) (*DeleteCacheParameterGroupOutput, error)

DeleteCacheParameterGroupWithContext is the same as DeleteCacheParameterGroup with the addition of the ability to pass a context and additional request options.

See DeleteCacheParameterGroup for details on how to use this API operation.

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 (*ElastiCache) DeleteCacheSecurityGroup

func (c *ElastiCache) DeleteCacheSecurityGroup(input *DeleteCacheSecurityGroupInput) (*DeleteCacheSecurityGroupOutput, error)

DeleteCacheSecurityGroup API operation for Amazon ElastiCache.

Deletes a cache security group.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon ElastiCache's API operation DeleteCacheSecurityGroup for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidCacheSecurityGroupStateFault "InvalidCacheSecurityGroupState" The current state of the cache security group does not allow deletion.

  • ErrCodeCacheSecurityGroupNotFoundFault "CacheSecurityGroupNotFound" The requested cache security group name does not refer to an existing cache security group.

  • ErrCodeInvalidParameterValueException "InvalidParameterValue" The value for a parameter is invalid.

  • ErrCodeInvalidParameterCombinationException "InvalidParameterCombination" Two or more incompatible parameters were specified.

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

Example (Shared00)

DeleteCacheSecurityGroup Deletes a cache security group.

package main

import (
	"fmt"

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

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

	result, err := svc.DeleteCacheSecurityGroup(input)
	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 (*ElastiCache) DeleteCacheSecurityGroupRequest

func (c *ElastiCache) DeleteCacheSecurityGroupRequest(input *DeleteCacheSecurityGroupInput) (req *request.Request, output *DeleteCacheSecurityGroupOutput)

DeleteCacheSecurityGroupRequest generates a "aws/request.Request" representing the client's request for the DeleteCacheSecurityGroup operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteCacheSecurityGroup for more information on using the DeleteCacheSecurityGroup API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DeleteCacheSecurityGroupRequest method.
req, resp := client.DeleteCacheSecurityGroupRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*ElastiCache) DeleteCacheSecurityGroupWithContext

func (c *ElastiCache) DeleteCacheSecurityGroupWithContext(ctx aws.Context, input *DeleteCacheSecurityGroupInput, opts ...request.Option) (*DeleteCacheSecurityGroupOutput, error)

DeleteCacheSecurityGroupWithContext is the same as DeleteCacheSecurityGroup with the addition of the ability to pass a context and additional request options.

See DeleteCacheSecurityGroup for details on how to use this API operation.

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 (*ElastiCache) DeleteCacheSubnetGroup

func (c *ElastiCache) DeleteCacheSubnetGroup(input *DeleteCacheSubnetGroupInput) (*DeleteCacheSubnetGroupOutput, error)

DeleteCacheSubnetGroup API operation for Amazon ElastiCache.

Deletes a cache subnet group.

You cannot delete a default cache subnet group or one that is associated with any clusters.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon ElastiCache's API operation DeleteCacheSubnetGroup for usage and error information.

Returned Error Codes:

  • ErrCodeCacheSubnetGroupInUse "CacheSubnetGroupInUse" The requested cache subnet group is currently in use.

  • ErrCodeCacheSubnetGroupNotFoundFault "CacheSubnetGroupNotFoundFault" The requested cache subnet group name does not refer to an existing cache subnet group.

See also, 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 (
	"fmt"

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

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

	result, err := svc.DeleteCacheSubnetGroup(input)
	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 (*ElastiCache) DeleteCacheSubnetGroupRequest

func (c *ElastiCache) DeleteCacheSubnetGroupRequest(input *DeleteCacheSubnetGroupInput) (req *request.Request, output *DeleteCacheSubnetGroupOutput)

DeleteCacheSubnetGroupRequest generates a "aws/request.Request" representing the client's request for the DeleteCacheSubnetGroup operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteCacheSubnetGroup for more information on using the DeleteCacheSubnetGroup API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DeleteCacheSubnetGroupRequest method.
req, resp := client.DeleteCacheSubnetGroupRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*ElastiCache) DeleteCacheSubnetGroupWithContext

func (c *ElastiCache) DeleteCacheSubnetGroupWithContext(ctx aws.Context, input *DeleteCacheSubnetGroupInput, opts ...request.Option) (*DeleteCacheSubnetGroupOutput, error)

DeleteCacheSubnetGroupWithContext is the same as DeleteCacheSubnetGroup with the addition of the ability to pass a context and additional request options.

See DeleteCacheSubnetGroup for details on how to use this API operation.

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 (*ElastiCache) DeleteGlobalReplicationGroup

func (c *ElastiCache) DeleteGlobalReplicationGroup(input *DeleteGlobalReplicationGroupInput) (*DeleteGlobalReplicationGroupOutput, error)

DeleteGlobalReplicationGroup 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 the DeleteGlobalReplicationGroup API to delete the Global datastore while retainining the primary cluster using RetainPrimaryReplicationGroup=true.

Since the Global Datastore has only a primary cluster, you can delete the Global Datastore while retaining the primary by setting RetainPrimaryReplicationGroup=true. The primary cluster is never deleted when deleting a Global Datastore. It can only be deleted when it no longer is associated with any Global Datastore.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon ElastiCache's API operation DeleteGlobalReplicationGroup for usage and error information.

Returned Error Codes:

  • ErrCodeGlobalReplicationGroupNotFoundFault "GlobalReplicationGroupNotFoundFault" The Global datastore does not exist

  • ErrCodeInvalidGlobalReplicationGroupStateFault "InvalidGlobalReplicationGroupState" The Global datastore is not available or in primary-only state.

  • ErrCodeInvalidParameterValueException "InvalidParameterValue" The value for a parameter is invalid.

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

func (*ElastiCache) DeleteGlobalReplicationGroupRequest

func (c *ElastiCache) DeleteGlobalReplicationGroupRequest(input *DeleteGlobalReplicationGroupInput) (req *request.Request, output *DeleteGlobalReplicationGroupOutput)

DeleteGlobalReplicationGroupRequest generates a "aws/request.Request" representing the client's request for the DeleteGlobalReplicationGroup operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteGlobalReplicationGroup for more information on using the DeleteGlobalReplicationGroup API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DeleteGlobalReplicationGroupRequest method.
req, resp := client.DeleteGlobalReplicationGroupRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*ElastiCache) DeleteGlobalReplicationGroupWithContext

func (c *ElastiCache) DeleteGlobalReplicationGroupWithContext(ctx aws.Context, input *DeleteGlobalReplicationGroupInput, opts ...request.Option) (*DeleteGlobalReplicationGroupOutput, error)

DeleteGlobalReplicationGroupWithContext is the same as DeleteGlobalReplicationGroup with the addition of the ability to pass a context and additional request options.

See DeleteGlobalReplicationGroup for details on how to use this API operation.

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 (*ElastiCache) DeleteReplicationGroup

func (c *ElastiCache) DeleteReplicationGroup(input *DeleteReplicationGroupInput) (*DeleteReplicationGroupOutput, error)

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon ElastiCache's API operation DeleteReplicationGroup for usage and error information.

Returned Error Codes:

  • ErrCodeReplicationGroupNotFoundFault "ReplicationGroupNotFoundFault" The specified replication group does not exist.

  • ErrCodeInvalidReplicationGroupStateFault "InvalidReplicationGroupState" The requested replication group is not in the available state.

  • ErrCodeSnapshotAlreadyExistsFault "SnapshotAlreadyExistsFault" You already have a snapshot with the given name.

  • ErrCodeSnapshotFeatureNotSupportedFault "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.

  • ErrCodeSnapshotQuotaExceededFault "SnapshotQuotaExceededFault" The request cannot be processed because it would exceed the maximum number of snapshots.

  • ErrCodeInvalidParameterValueException "InvalidParameterValue" The value for a parameter is invalid.

  • ErrCodeInvalidParameterCombinationException "InvalidParameterCombination" Two or more incompatible parameters were specified.

See also, 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 (
	"fmt"

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

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

	result, err := svc.DeleteReplicationGroup(input)
	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 (*ElastiCache) DeleteReplicationGroupRequest

func (c *ElastiCache) DeleteReplicationGroupRequest(input *DeleteReplicationGroupInput) (req *request.Request, output *DeleteReplicationGroupOutput)

DeleteReplicationGroupRequest generates a "aws/request.Request" representing the client's request for the DeleteReplicationGroup operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteReplicationGroup for more information on using the DeleteReplicationGroup API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DeleteReplicationGroupRequest method.
req, resp := client.DeleteReplicationGroupRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*ElastiCache) DeleteReplicationGroupWithContext

func (c *ElastiCache) DeleteReplicationGroupWithContext(ctx aws.Context, input *DeleteReplicationGroupInput, opts ...request.Option) (*DeleteReplicationGroupOutput, error)

DeleteReplicationGroupWithContext is the same as DeleteReplicationGroup with the addition of the ability to pass a context and additional request options.

See DeleteReplicationGroup for details on how to use this API operation.

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 (*ElastiCache) DeleteSnapshot

func (c *ElastiCache) DeleteSnapshot(input *DeleteSnapshotInput) (*DeleteSnapshotOutput, error)

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon ElastiCache's API operation DeleteSnapshot for usage and error information.

Returned Error Codes:

  • ErrCodeSnapshotNotFoundFault "SnapshotNotFoundFault" The requested snapshot name does not refer to an existing snapshot.

  • ErrCodeInvalidSnapshotStateFault "InvalidSnapshotState" The current state of the snapshot does not allow the requested operation to occur.

  • ErrCodeInvalidParameterValueException "InvalidParameterValue" The value for a parameter is invalid.

  • ErrCodeInvalidParameterCombinationException "InvalidParameterCombination" Two or more incompatible parameters were specified.

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

Example (Shared00)

DeleteSnapshot Deletes the Redis snapshot snapshot-20160822.

package main

import (
	"fmt"

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

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

	result, err := svc.DeleteSnapshot(input)
	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 (*ElastiCache) DeleteSnapshotRequest

func (c *ElastiCache) DeleteSnapshotRequest(input *DeleteSnapshotInput) (req *request.Request, output *DeleteSnapshotOutput)

DeleteSnapshotRequest generates a "aws/request.Request" representing the client's request for the DeleteSnapshot operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteSnapshot for more information on using the DeleteSnapshot API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DeleteSnapshotRequest method.
req, resp := client.DeleteSnapshotRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*ElastiCache) DeleteSnapshotWithContext

func (c *ElastiCache) DeleteSnapshotWithContext(ctx aws.Context, input *DeleteSnapshotInput, opts ...request.Option) (*DeleteSnapshotOutput, error)

DeleteSnapshotWithContext is the same as DeleteSnapshot with the addition of the ability to pass a context and additional request options.

See DeleteSnapshot for details on how to use this API operation.

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 (*ElastiCache) DeleteUser

func (c *ElastiCache) DeleteUser(input *DeleteUserInput) (*DeleteUserOutput, error)

DeleteUser API operation for Amazon ElastiCache.

For Redis engine version 6.0 onwards: Deletes a user. The user will be removed from all user groups and in turn removed from all replication groups. For more information, see Using Role Based Access Control (RBAC) (http://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/Clusters.RBAC.html).

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon ElastiCache's API operation DeleteUser for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidUserStateFault "InvalidUserState" The user is not in active state.

  • ErrCodeUserNotFoundFault "UserNotFound" The user does not exist or could not be found.

  • ErrCodeServiceLinkedRoleNotFoundFault "ServiceLinkedRoleNotFoundFault" The specified service linked role (SLR) was not found.

  • ErrCodeInvalidParameterValueException "InvalidParameterValue" The value for a parameter is invalid.

  • ErrCodeDefaultUserAssociatedToUserGroupFault "DefaultUserAssociatedToUserGroup" The default user assigned to the user group.

See also, https://docs.aws.amazon.com/goto/WebAPI/elasticache-2015-02-02/DeleteUser

func (*ElastiCache) DeleteUserGroup

func (c *ElastiCache) DeleteUserGroup(input *DeleteUserGroupInput) (*DeleteUserGroupOutput, error)

DeleteUserGroup API operation for Amazon ElastiCache.

For Redis engine version 6.0 onwards: Deletes a user group. The user group must first be disassociated from the replication group before it can be deleted. For more information, see Using Role Based Access Control (RBAC) (http://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/Clusters.RBAC.html).

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon ElastiCache's API operation DeleteUserGroup for usage and error information.

Returned Error Codes:

  • ErrCodeUserGroupNotFoundFault "UserGroupNotFound" The user group was not found or does not exist

  • ErrCodeInvalidUserGroupStateFault "InvalidUserGroupState" The user group is not in an active state.

  • ErrCodeServiceLinkedRoleNotFoundFault "ServiceLinkedRoleNotFoundFault" The specified service linked role (SLR) was not found.

  • ErrCodeInvalidParameterValueException "InvalidParameterValue" The value for a parameter is invalid.

See also, https://docs.aws.amazon.com/goto/WebAPI/elasticache-2015-02-02/DeleteUserGroup

func (*ElastiCache) DeleteUserGroupRequest

func (c *ElastiCache) DeleteUserGroupRequest(input *DeleteUserGroupInput) (req *request.Request, output *DeleteUserGroupOutput)

DeleteUserGroupRequest generates a "aws/request.Request" representing the client's request for the DeleteUserGroup operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteUserGroup for more information on using the DeleteUserGroup API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DeleteUserGroupRequest method.
req, resp := client.DeleteUserGroupRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/elasticache-2015-02-02/DeleteUserGroup

func (*ElastiCache) DeleteUserGroupWithContext

func (c *ElastiCache) DeleteUserGroupWithContext(ctx aws.Context, input *DeleteUserGroupInput, opts ...request.Option) (*DeleteUserGroupOutput, error)

DeleteUserGroupWithContext is the same as DeleteUserGroup with the addition of the ability to pass a context and additional request options.

See DeleteUserGroup for details on how to use this API operation.

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 (*ElastiCache) DeleteUserRequest

func (c *ElastiCache) DeleteUserRequest(input *DeleteUserInput) (req *request.Request, output *DeleteUserOutput)

DeleteUserRequest generates a "aws/request.Request" representing the client's request for the DeleteUser operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteUser for more information on using the DeleteUser API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DeleteUserRequest method.
req, resp := client.DeleteUserRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/elasticache-2015-02-02/DeleteUser

func (*ElastiCache) DeleteUserWithContext

func (c *ElastiCache) DeleteUserWithContext(ctx aws.Context, input *DeleteUserInput, opts ...request.Option) (*DeleteUserOutput, error)

DeleteUserWithContext is the same as DeleteUser with the addition of the ability to pass a context and additional request options.

See DeleteUser for details on how to use this API operation.

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 (*ElastiCache) DescribeCacheClusters

func (c *ElastiCache) DescribeCacheClusters(input *DescribeCacheClustersInput) (*DescribeCacheClustersOutput, error)

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon ElastiCache's API operation DescribeCacheClusters for usage and error information.

Returned Error Codes:

  • ErrCodeCacheClusterNotFoundFault "CacheClusterNotFound" The requested cluster ID does not refer to an existing cluster.

  • ErrCodeInvalidParameterValueException "InvalidParameterValue" The value for a parameter is invalid.

  • ErrCodeInvalidParameterCombinationException "InvalidParameterCombination" Two or more incompatible parameters were specified.

See also, 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 (
	"fmt"

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

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

	result, err := svc.DescribeCacheClusters(input)
	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 (
	"fmt"

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

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

	result, err := svc.DescribeCacheClusters(input)
	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 (*ElastiCache) DescribeCacheClustersPages

func (c *ElastiCache) DescribeCacheClustersPages(input *DescribeCacheClustersInput, fn func(*DescribeCacheClustersOutput, bool) bool) error

DescribeCacheClustersPages iterates over the pages of a DescribeCacheClusters operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See DescribeCacheClusters method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a DescribeCacheClusters operation.
pageNum := 0
err := client.DescribeCacheClustersPages(params,
    func(page *elasticache.DescribeCacheClustersOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*ElastiCache) DescribeCacheClustersPagesWithContext

func (c *ElastiCache) DescribeCacheClustersPagesWithContext(ctx aws.Context, input *DescribeCacheClustersInput, fn func(*DescribeCacheClustersOutput, bool) bool, opts ...request.Option) error

DescribeCacheClustersPagesWithContext same as DescribeCacheClustersPages except it takes a Context and allows setting request options on the pages.

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 (*ElastiCache) DescribeCacheClustersRequest

func (c *ElastiCache) DescribeCacheClustersRequest(input *DescribeCacheClustersInput) (req *request.Request, output *DescribeCacheClustersOutput)

DescribeCacheClustersRequest generates a "aws/request.Request" representing the client's request for the DescribeCacheClusters operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeCacheClusters for more information on using the DescribeCacheClusters API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribeCacheClustersRequest method.
req, resp := client.DescribeCacheClustersRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*ElastiCache) DescribeCacheClustersWithContext

func (c *ElastiCache) DescribeCacheClustersWithContext(ctx aws.Context, input *DescribeCacheClustersInput, opts ...request.Option) (*DescribeCacheClustersOutput, error)

DescribeCacheClustersWithContext is the same as DescribeCacheClusters with the addition of the ability to pass a context and additional request options.

See DescribeCacheClusters for details on how to use this API operation.

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 (*ElastiCache) DescribeCacheEngineVersions

func (c *ElastiCache) DescribeCacheEngineVersions(input *DescribeCacheEngineVersionsInput) (*DescribeCacheEngineVersionsOutput, error)

DescribeCacheEngineVersions API operation for Amazon ElastiCache.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon ElastiCache's API operation DescribeCacheEngineVersions for usage and error information. See also, 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 (
	"fmt"

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

func main() {
	svc := elasticache.New(session.New())
	input := &elasticache.DescribeCacheEngineVersionsInput{}

	result, err := svc.DescribeCacheEngineVersions(input)
	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 (
	"fmt"

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

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

	result, err := svc.DescribeCacheEngineVersions(input)
	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 (*ElastiCache) DescribeCacheEngineVersionsPages

func (c *ElastiCache) DescribeCacheEngineVersionsPages(input *DescribeCacheEngineVersionsInput, fn func(*DescribeCacheEngineVersionsOutput, bool) bool) error

DescribeCacheEngineVersionsPages iterates over the pages of a DescribeCacheEngineVersions operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See DescribeCacheEngineVersions method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a DescribeCacheEngineVersions operation.
pageNum := 0
err := client.DescribeCacheEngineVersionsPages(params,
    func(page *elasticache.DescribeCacheEngineVersionsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*ElastiCache) DescribeCacheEngineVersionsPagesWithContext

func (c *ElastiCache) DescribeCacheEngineVersionsPagesWithContext(ctx aws.Context, input *DescribeCacheEngineVersionsInput, fn func(*DescribeCacheEngineVersionsOutput, bool) bool, opts ...request.Option) error

DescribeCacheEngineVersionsPagesWithContext same as DescribeCacheEngineVersionsPages except it takes a Context and allows setting request options on the pages.

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 (*ElastiCache) DescribeCacheEngineVersionsRequest

func (c *ElastiCache) DescribeCacheEngineVersionsRequest(input *DescribeCacheEngineVersionsInput) (req *request.Request, output *DescribeCacheEngineVersionsOutput)

DescribeCacheEngineVersionsRequest generates a "aws/request.Request" representing the client's request for the DescribeCacheEngineVersions operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeCacheEngineVersions for more information on using the DescribeCacheEngineVersions API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribeCacheEngineVersionsRequest method.
req, resp := client.DescribeCacheEngineVersionsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*ElastiCache) DescribeCacheEngineVersionsWithContext

func (c *ElastiCache) DescribeCacheEngineVersionsWithContext(ctx aws.Context, input *DescribeCacheEngineVersionsInput, opts ...request.Option) (*DescribeCacheEngineVersionsOutput, error)

DescribeCacheEngineVersionsWithContext is the same as DescribeCacheEngineVersions with the addition of the ability to pass a context and additional request options.

See DescribeCacheEngineVersions for details on how to use this API operation.

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 (*ElastiCache) DescribeCacheParameterGroups

func (c *ElastiCache) DescribeCacheParameterGroups(input *DescribeCacheParameterGroupsInput) (*DescribeCacheParameterGroupsOutput, error)

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon ElastiCache's API operation DescribeCacheParameterGroups for usage and error information.

Returned Error Codes:

  • ErrCodeCacheParameterGroupNotFoundFault "CacheParameterGroupNotFound" The requested cache parameter group name does not refer to an existing cache parameter group.

  • ErrCodeInvalidParameterValueException "InvalidParameterValue" The value for a parameter is invalid.

  • ErrCodeInvalidParameterCombinationException "InvalidParameterCombination" Two or more incompatible parameters were specified.

See also, 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 (
	"fmt"

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

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

	result, err := svc.DescribeCacheParameterGroups(input)
	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 (*ElastiCache) DescribeCacheParameterGroupsPages

func (c *ElastiCache) DescribeCacheParameterGroupsPages(input *DescribeCacheParameterGroupsInput, fn func(*DescribeCacheParameterGroupsOutput, bool) bool) error

DescribeCacheParameterGroupsPages iterates over the pages of a DescribeCacheParameterGroups operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See DescribeCacheParameterGroups method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a DescribeCacheParameterGroups operation.
pageNum := 0
err := client.DescribeCacheParameterGroupsPages(params,
    func(page *elasticache.DescribeCacheParameterGroupsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*ElastiCache) DescribeCacheParameterGroupsPagesWithContext

func (c *ElastiCache) DescribeCacheParameterGroupsPagesWithContext(ctx aws.Context, input *DescribeCacheParameterGroupsInput, fn func(*DescribeCacheParameterGroupsOutput, bool) bool, opts ...request.Option) error

DescribeCacheParameterGroupsPagesWithContext same as DescribeCacheParameterGroupsPages except it takes a Context and allows setting request options on the pages.

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 (*ElastiCache) DescribeCacheParameterGroupsRequest

func (c *ElastiCache) DescribeCacheParameterGroupsRequest(input *DescribeCacheParameterGroupsInput) (req *request.Request, output *DescribeCacheParameterGroupsOutput)

DescribeCacheParameterGroupsRequest generates a "aws/request.Request" representing the client's request for the DescribeCacheParameterGroups operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeCacheParameterGroups for more information on using the DescribeCacheParameterGroups API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribeCacheParameterGroupsRequest method.
req, resp := client.DescribeCacheParameterGroupsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*ElastiCache) DescribeCacheParameterGroupsWithContext

func (c *ElastiCache) DescribeCacheParameterGroupsWithContext(ctx aws.Context, input *DescribeCacheParameterGroupsInput, opts ...request.Option) (*DescribeCacheParameterGroupsOutput, error)

DescribeCacheParameterGroupsWithContext is the same as DescribeCacheParameterGroups with the addition of the ability to pass a context and additional request options.

See DescribeCacheParameterGroups for details on how to use this API operation.

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 (*ElastiCache) DescribeCacheParameters

func (c *ElastiCache) DescribeCacheParameters(input *DescribeCacheParametersInput) (*DescribeCacheParametersOutput, error)

DescribeCacheParameters API operation for Amazon ElastiCache.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon ElastiCache's API operation DescribeCacheParameters for usage and error information.

Returned Error Codes:

  • ErrCodeCacheParameterGroupNotFoundFault "CacheParameterGroupNotFound" The requested cache parameter group name does not refer to an existing cache parameter group.

  • ErrCodeInvalidParameterValueException "InvalidParameterValue" The value for a parameter is invalid.

  • ErrCodeInvalidParameterCombinationException "InvalidParameterCombination" Two or more incompatible parameters were specified.

See also, 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 (
	"fmt"

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

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

	result, err := svc.DescribeCacheParameters(input)
	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 (*ElastiCache) DescribeCacheParametersPages

func (c *ElastiCache) DescribeCacheParametersPages(input *DescribeCacheParametersInput, fn func(*DescribeCacheParametersOutput, bool) bool) error

DescribeCacheParametersPages iterates over the pages of a DescribeCacheParameters operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See DescribeCacheParameters method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a DescribeCacheParameters operation.
pageNum := 0
err := client.DescribeCacheParametersPages(params,
    func(page *elasticache.DescribeCacheParametersOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*ElastiCache) DescribeCacheParametersPagesWithContext

func (c *ElastiCache) DescribeCacheParametersPagesWithContext(ctx aws.Context, input *DescribeCacheParametersInput, fn func(*DescribeCacheParametersOutput, bool) bool, opts ...request.Option) error

DescribeCacheParametersPagesWithContext same as DescribeCacheParametersPages except it takes a Context and allows setting request options on the pages.

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 (*ElastiCache) DescribeCacheParametersRequest

func (c *ElastiCache) DescribeCacheParametersRequest(input *DescribeCacheParametersInput) (req *request.Request, output *DescribeCacheParametersOutput)

DescribeCacheParametersRequest generates a "aws/request.Request" representing the client's request for the DescribeCacheParameters operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeCacheParameters for more information on using the DescribeCacheParameters API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribeCacheParametersRequest method.
req, resp := client.DescribeCacheParametersRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*ElastiCache) DescribeCacheParametersWithContext

func (c *ElastiCache) DescribeCacheParametersWithContext(ctx aws.Context, input *DescribeCacheParametersInput, opts ...request.Option) (*DescribeCacheParametersOutput, error)

DescribeCacheParametersWithContext is the same as DescribeCacheParameters with the addition of the ability to pass a context and additional request options.

See DescribeCacheParameters for details on how to use this API operation.

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 (*ElastiCache) DescribeCacheSecurityGroups

func (c *ElastiCache) DescribeCacheSecurityGroups(input *DescribeCacheSecurityGroupsInput) (*DescribeCacheSecurityGroupsOutput, error)

DescribeCacheSecurityGroups 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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon ElastiCache's API operation DescribeCacheSecurityGroups for usage and error information.

Returned Error Codes:

  • ErrCodeCacheSecurityGroupNotFoundFault "CacheSecurityGroupNotFound" The requested cache security group name does not refer to an existing cache security group.

  • ErrCodeInvalidParameterValueException "InvalidParameterValue" The value for a parameter is invalid.

  • ErrCodeInvalidParameterCombinationException "InvalidParameterCombination" Two or more incompatible parameters were specified.

See also, 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 (
	"fmt"

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

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

	result, err := svc.DescribeCacheSecurityGroups(input)
	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 (*ElastiCache) DescribeCacheSecurityGroupsPages

func (c *ElastiCache) DescribeCacheSecurityGroupsPages(input *DescribeCacheSecurityGroupsInput, fn func(*DescribeCacheSecurityGroupsOutput, bool) bool) error

DescribeCacheSecurityGroupsPages iterates over the pages of a DescribeCacheSecurityGroups operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See DescribeCacheSecurityGroups method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a DescribeCacheSecurityGroups operation.
pageNum := 0
err := client.DescribeCacheSecurityGroupsPages(params,
    func(page *elasticache.DescribeCacheSecurityGroupsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*ElastiCache) DescribeCacheSecurityGroupsPagesWithContext

func (c *ElastiCache) DescribeCacheSecurityGroupsPagesWithContext(ctx aws.Context, input *DescribeCacheSecurityGroupsInput, fn func(*DescribeCacheSecurityGroupsOutput, bool) bool, opts ...request.Option) error

DescribeCacheSecurityGroupsPagesWithContext same as DescribeCacheSecurityGroupsPages except it takes a Context and allows setting request options on the pages.

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 (*ElastiCache) DescribeCacheSecurityGroupsRequest

func (c *ElastiCache) DescribeCacheSecurityGroupsRequest(input *DescribeCacheSecurityGroupsInput) (req *request.Request, output *DescribeCacheSecurityGroupsOutput)

DescribeCacheSecurityGroupsRequest generates a "aws/request.Request" representing the client's request for the DescribeCacheSecurityGroups operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeCacheSecurityGroups for more information on using the DescribeCacheSecurityGroups API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribeCacheSecurityGroupsRequest method.
req, resp := client.DescribeCacheSecurityGroupsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*ElastiCache) DescribeCacheSecurityGroupsWithContext

func (c *ElastiCache) DescribeCacheSecurityGroupsWithContext(ctx aws.Context, input *DescribeCacheSecurityGroupsInput, opts ...request.Option) (*DescribeCacheSecurityGroupsOutput, error)

DescribeCacheSecurityGroupsWithContext is the same as DescribeCacheSecurityGroups with the addition of the ability to pass a context and additional request options.

See DescribeCacheSecurityGroups for details on how to use this API operation.

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 (*ElastiCache) DescribeCacheSubnetGroups

func (c *ElastiCache) DescribeCacheSubnetGroups(input *DescribeCacheSubnetGroupsInput) (*DescribeCacheSubnetGroupsOutput, error)

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon ElastiCache's API operation DescribeCacheSubnetGroups for usage and error information.

Returned Error Codes:

  • ErrCodeCacheSubnetGroupNotFoundFault "CacheSubnetGroupNotFoundFault" The requested cache subnet group name does not refer to an existing cache subnet group.

See also, 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 (
	"fmt"

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

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

	result, err := svc.DescribeCacheSubnetGroups(input)
	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 (*ElastiCache) DescribeCacheSubnetGroupsPages

func (c *ElastiCache) DescribeCacheSubnetGroupsPages(input *DescribeCacheSubnetGroupsInput, fn func(*DescribeCacheSubnetGroupsOutput, bool) bool) error

DescribeCacheSubnetGroupsPages iterates over the pages of a DescribeCacheSubnetGroups operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See DescribeCacheSubnetGroups method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a DescribeCacheSubnetGroups operation.
pageNum := 0
err := client.DescribeCacheSubnetGroupsPages(params,
    func(page *elasticache.DescribeCacheSubnetGroupsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*ElastiCache) DescribeCacheSubnetGroupsPagesWithContext

func (c *ElastiCache) DescribeCacheSubnetGroupsPagesWithContext(ctx aws.Context, input *DescribeCacheSubnetGroupsInput, fn func(*DescribeCacheSubnetGroupsOutput, bool) bool, opts ...request.Option) error

DescribeCacheSubnetGroupsPagesWithContext same as DescribeCacheSubnetGroupsPages except it takes a Context and allows setting request options on the pages.

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 (*ElastiCache) DescribeCacheSubnetGroupsRequest

func (c *ElastiCache) DescribeCacheSubnetGroupsRequest(input *DescribeCacheSubnetGroupsInput) (req *request.Request, output *DescribeCacheSubnetGroupsOutput)

DescribeCacheSubnetGroupsRequest generates a "aws/request.Request" representing the client's request for the DescribeCacheSubnetGroups operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeCacheSubnetGroups for more information on using the DescribeCacheSubnetGroups API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribeCacheSubnetGroupsRequest method.
req, resp := client.DescribeCacheSubnetGroupsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*ElastiCache) DescribeCacheSubnetGroupsWithContext

func (c *ElastiCache) DescribeCacheSubnetGroupsWithContext(ctx aws.Context, input *DescribeCacheSubnetGroupsInput, opts ...request.Option) (*DescribeCacheSubnetGroupsOutput, error)

DescribeCacheSubnetGroupsWithContext is the same as DescribeCacheSubnetGroups with the addition of the ability to pass a context and additional request options.

See DescribeCacheSubnetGroups for details on how to use this API operation.

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 (*ElastiCache) DescribeEngineDefaultParameters

DescribeEngineDefaultParameters API operation for Amazon ElastiCache.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon ElastiCache's API operation DescribeEngineDefaultParameters for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidParameterValueException "InvalidParameterValue" The value for a parameter is invalid.

  • ErrCodeInvalidParameterCombinationException "InvalidParameterCombination" Two or more incompatible parameters were specified.

See also, 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 (
	"fmt"

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

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

	result, err := svc.DescribeEngineDefaultParameters(input)
	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 (*ElastiCache) DescribeEngineDefaultParametersPages

func (c *ElastiCache) DescribeEngineDefaultParametersPages(input *DescribeEngineDefaultParametersInput, fn func(*DescribeEngineDefaultParametersOutput, bool) bool) error

DescribeEngineDefaultParametersPages iterates over the pages of a DescribeEngineDefaultParameters operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See DescribeEngineDefaultParameters method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a DescribeEngineDefaultParameters operation.
pageNum := 0
err := client.DescribeEngineDefaultParametersPages(params,
    func(page *elasticache.DescribeEngineDefaultParametersOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*ElastiCache) DescribeEngineDefaultParametersPagesWithContext

func (c *ElastiCache) DescribeEngineDefaultParametersPagesWithContext(ctx aws.Context, input *DescribeEngineDefaultParametersInput, fn func(*DescribeEngineDefaultParametersOutput, bool) bool, opts ...request.Option) error

DescribeEngineDefaultParametersPagesWithContext same as DescribeEngineDefaultParametersPages except it takes a Context and allows setting request options on the pages.

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 (*ElastiCache) DescribeEngineDefaultParametersRequest

func (c *ElastiCache) DescribeEngineDefaultParametersRequest(input *DescribeEngineDefaultParametersInput) (req *request.Request, output *DescribeEngineDefaultParametersOutput)

DescribeEngineDefaultParametersRequest generates a "aws/request.Request" representing the client's request for the DescribeEngineDefaultParameters operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeEngineDefaultParameters for more information on using the DescribeEngineDefaultParameters API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribeEngineDefaultParametersRequest method.
req, resp := client.DescribeEngineDefaultParametersRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*ElastiCache) DescribeEngineDefaultParametersWithContext

func (c *ElastiCache) DescribeEngineDefaultParametersWithContext(ctx aws.Context, input *DescribeEngineDefaultParametersInput, opts ...request.Option) (*DescribeEngineDefaultParametersOutput, error)

DescribeEngineDefaultParametersWithContext is the same as DescribeEngineDefaultParameters with the addition of the ability to pass a context and additional request options.

See DescribeEngineDefaultParameters for details on how to use this API operation.

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 (*ElastiCache) DescribeEvents

func (c *ElastiCache) DescribeEvents(input *DescribeEventsInput) (*DescribeEventsOutput, error)

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon ElastiCache's API operation DescribeEvents for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidParameterValueException "InvalidParameterValue" The value for a parameter is invalid.

  • ErrCodeInvalidParameterCombinationException "InvalidParameterCombination" Two or more incompatible parameters were specified.

See also, 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 (
	"fmt"

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

func main() {
	svc := elasticache.New(session.New())
	input := &elasticache.DescribeEventsInput{
		Duration:   aws.Int64(360),
		SourceType: aws.String("cache-cluster"),
	}

	result, err := svc.DescribeEvents(input)
	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 (
	"fmt"
	"time"

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

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

func main() {
	svc := elasticache.New(session.New())
	input := &elasticache.DescribeEventsInput{
		StartTime: parseTime("2006-01-02T15:04:05.999999999Z", "2016-12-22T15:00:00.000Z"),
	}

	result, err := svc.DescribeEvents(input)
	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 (*ElastiCache) DescribeEventsPages

func (c *ElastiCache) DescribeEventsPages(input *DescribeEventsInput, fn func(*DescribeEventsOutput, bool) bool) error

DescribeEventsPages iterates over the pages of a DescribeEvents operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See DescribeEvents method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a DescribeEvents operation.
pageNum := 0
err := client.DescribeEventsPages(params,
    func(page *elasticache.DescribeEventsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*ElastiCache) DescribeEventsPagesWithContext

func (c *ElastiCache) DescribeEventsPagesWithContext(ctx aws.Context, input *DescribeEventsInput, fn func(*DescribeEventsOutput, bool) bool, opts ...request.Option) error

DescribeEventsPagesWithContext same as DescribeEventsPages except it takes a Context and allows setting request options on the pages.

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 (*ElastiCache) DescribeEventsRequest

func (c *ElastiCache) DescribeEventsRequest(input *DescribeEventsInput) (req *request.Request, output *DescribeEventsOutput)

DescribeEventsRequest generates a "aws/request.Request" representing the client's request for the DescribeEvents operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeEvents for more information on using the DescribeEvents API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribeEventsRequest method.
req, resp := client.DescribeEventsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*ElastiCache) DescribeEventsWithContext

func (c *ElastiCache) DescribeEventsWithContext(ctx aws.Context, input *DescribeEventsInput, opts ...request.Option) (*DescribeEventsOutput, error)

DescribeEventsWithContext is the same as DescribeEvents with the addition of the ability to pass a context and additional request options.

See DescribeEvents for details on how to use this API operation.

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 (*ElastiCache) DescribeGlobalReplicationGroups

DescribeGlobalReplicationGroups API operation for Amazon ElastiCache.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon ElastiCache's API operation DescribeGlobalReplicationGroups for usage and error information.

Returned Error Codes:

  • ErrCodeGlobalReplicationGroupNotFoundFault "GlobalReplicationGroupNotFoundFault" The Global datastore does not exist

  • ErrCodeInvalidParameterValueException "InvalidParameterValue" The value for a parameter is invalid.

  • ErrCodeInvalidParameterCombinationException "InvalidParameterCombination" Two or more incompatible parameters were specified.

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

func (*ElastiCache) DescribeGlobalReplicationGroupsPages

func (c *ElastiCache) DescribeGlobalReplicationGroupsPages(input *DescribeGlobalReplicationGroupsInput, fn func(*DescribeGlobalReplicationGroupsOutput, bool) bool) error

DescribeGlobalReplicationGroupsPages iterates over the pages of a DescribeGlobalReplicationGroups operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See DescribeGlobalReplicationGroups method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a DescribeGlobalReplicationGroups operation.
pageNum := 0
err := client.DescribeGlobalReplicationGroupsPages(params,
    func(page *elasticache.DescribeGlobalReplicationGroupsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*ElastiCache) DescribeGlobalReplicationGroupsPagesWithContext

func (c *ElastiCache) DescribeGlobalReplicationGroupsPagesWithContext(ctx aws.Context, input *DescribeGlobalReplicationGroupsInput, fn func(*DescribeGlobalReplicationGroupsOutput, bool) bool, opts ...request.Option) error

DescribeGlobalReplicationGroupsPagesWithContext same as DescribeGlobalReplicationGroupsPages except it takes a Context and allows setting request options on the pages.

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 (*ElastiCache) DescribeGlobalReplicationGroupsRequest

func (c *ElastiCache) DescribeGlobalReplicationGroupsRequest(input *DescribeGlobalReplicationGroupsInput) (req *request.Request, output *DescribeGlobalReplicationGroupsOutput)

DescribeGlobalReplicationGroupsRequest generates a "aws/request.Request" representing the client's request for the DescribeGlobalReplicationGroups operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeGlobalReplicationGroups for more information on using the DescribeGlobalReplicationGroups API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribeGlobalReplicationGroupsRequest method.
req, resp := client.DescribeGlobalReplicationGroupsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*ElastiCache) DescribeGlobalReplicationGroupsWithContext

func (c *ElastiCache) DescribeGlobalReplicationGroupsWithContext(ctx aws.Context, input *DescribeGlobalReplicationGroupsInput, opts ...request.Option) (*DescribeGlobalReplicationGroupsOutput, error)

DescribeGlobalReplicationGroupsWithContext is the same as DescribeGlobalReplicationGroups with the addition of the ability to pass a context and additional request options.

See DescribeGlobalReplicationGroups for details on how to use this API operation.

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 (*ElastiCache) DescribeReplicationGroups

func (c *ElastiCache) DescribeReplicationGroups(input *DescribeReplicationGroupsInput) (*DescribeReplicationGroupsOutput, error)

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon ElastiCache's API operation DescribeReplicationGroups for usage and error information.

Returned Error Codes:

  • ErrCodeReplicationGroupNotFoundFault "ReplicationGroupNotFoundFault" The specified replication group does not exist.

  • ErrCodeInvalidParameterValueException "InvalidParameterValue" The value for a parameter is invalid.

  • ErrCodeInvalidParameterCombinationException "InvalidParameterCombination" Two or more incompatible parameters were specified.

See also, 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 (
	"fmt"

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

func main() {
	svc := elasticache.New(session.New())
	input := &elasticache.DescribeReplicationGroupsInput{}

	result, err := svc.DescribeReplicationGroups(input)
	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 (*ElastiCache) DescribeReplicationGroupsPages

func (c *ElastiCache) DescribeReplicationGroupsPages(input *DescribeReplicationGroupsInput, fn func(*DescribeReplicationGroupsOutput, bool) bool) error

DescribeReplicationGroupsPages iterates over the pages of a DescribeReplicationGroups operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See DescribeReplicationGroups method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a DescribeReplicationGroups operation.
pageNum := 0
err := client.DescribeReplicationGroupsPages(params,
    func(page *elasticache.DescribeReplicationGroupsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*ElastiCache) DescribeReplicationGroupsPagesWithContext

func (c *ElastiCache) DescribeReplicationGroupsPagesWithContext(ctx aws.Context, input *DescribeReplicationGroupsInput, fn func(*DescribeReplicationGroupsOutput, bool) bool, opts ...request.Option) error

DescribeReplicationGroupsPagesWithContext same as DescribeReplicationGroupsPages except it takes a Context and allows setting request options on the pages.

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 (*ElastiCache) DescribeReplicationGroupsRequest

func (c *ElastiCache) DescribeReplicationGroupsRequest(input *DescribeReplicationGroupsInput) (req *request.Request, output *DescribeReplicationGroupsOutput)

DescribeReplicationGroupsRequest generates a "aws/request.Request" representing the client's request for the DescribeReplicationGroups operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeReplicationGroups for more information on using the DescribeReplicationGroups API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribeReplicationGroupsRequest method.
req, resp := client.DescribeReplicationGroupsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*ElastiCache) DescribeReplicationGroupsWithContext

func (c *ElastiCache) DescribeReplicationGroupsWithContext(ctx aws.Context, input *DescribeReplicationGroupsInput, opts ...request.Option) (*DescribeReplicationGroupsOutput, error)

DescribeReplicationGroupsWithContext is the same as DescribeReplicationGroups with the addition of the ability to pass a context and additional request options.

See DescribeReplicationGroups for details on how to use this API operation.

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 (*ElastiCache) DescribeReservedCacheNodes

func (c *ElastiCache) DescribeReservedCacheNodes(input *DescribeReservedCacheNodesInput) (*DescribeReservedCacheNodesOutput, error)

DescribeReservedCacheNodes API operation for Amazon ElastiCache.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon ElastiCache's API operation DescribeReservedCacheNodes for usage and error information.

Returned Error Codes:

  • ErrCodeReservedCacheNodeNotFoundFault "ReservedCacheNodeNotFound" The requested reserved cache node was not found.

  • ErrCodeInvalidParameterValueException "InvalidParameterValue" The value for a parameter is invalid.

  • ErrCodeInvalidParameterCombinationException "InvalidParameterCombination" Two or more incompatible parameters were specified.

See also, 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 (
	"fmt"

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

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

	result, err := svc.DescribeReservedCacheNodes(input)
	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 (*ElastiCache) DescribeReservedCacheNodesOfferings

DescribeReservedCacheNodesOfferings API operation for Amazon ElastiCache.

Lists available reserved cache node offerings.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon ElastiCache's API operation DescribeReservedCacheNodesOfferings for usage and error information.

Returned Error Codes:

  • ErrCodeReservedCacheNodesOfferingNotFoundFault "ReservedCacheNodesOfferingNotFound" The requested cache node offering does not exist.

  • ErrCodeInvalidParameterValueException "InvalidParameterValue" The value for a parameter is invalid.

  • ErrCodeInvalidParameterCombinationException "InvalidParameterCombination" Two or more incompatible parameters were specified.

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

Example (Shared00)

DescribeReseredCacheNodeOfferings Lists available reserved cache node offerings.

package main

import (
	"fmt"

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

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

	result, err := svc.DescribeReservedCacheNodesOfferings(input)
	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 (
	"fmt"

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

func main() {
	svc := elasticache.New(session.New())
	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(""),
	}

	result, err := svc.DescribeReservedCacheNodesOfferings(input)
	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 (
	"fmt"

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

func main() {
	svc := elasticache.New(session.New())
	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"),
	}

	result, err := svc.DescribeReservedCacheNodesOfferings(input)
	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 (*ElastiCache) DescribeReservedCacheNodesOfferingsPages

func (c *ElastiCache) DescribeReservedCacheNodesOfferingsPages(input *DescribeReservedCacheNodesOfferingsInput, fn func(*DescribeReservedCacheNodesOfferingsOutput, bool) bool) error

DescribeReservedCacheNodesOfferingsPages iterates over the pages of a DescribeReservedCacheNodesOfferings operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See DescribeReservedCacheNodesOfferings method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a DescribeReservedCacheNodesOfferings operation.
pageNum := 0
err := client.DescribeReservedCacheNodesOfferingsPages(params,
    func(page *elasticache.DescribeReservedCacheNodesOfferingsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*ElastiCache) DescribeReservedCacheNodesOfferingsPagesWithContext

func (c *ElastiCache) DescribeReservedCacheNodesOfferingsPagesWithContext(ctx aws.Context, input *DescribeReservedCacheNodesOfferingsInput, fn func(*DescribeReservedCacheNodesOfferingsOutput, bool) bool, opts ...request.Option) error

DescribeReservedCacheNodesOfferingsPagesWithContext same as DescribeReservedCacheNodesOfferingsPages except it takes a Context and allows setting request options on the pages.

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 (*ElastiCache) DescribeReservedCacheNodesOfferingsRequest

func (c *ElastiCache) DescribeReservedCacheNodesOfferingsRequest(input *DescribeReservedCacheNodesOfferingsInput) (req *request.Request, output *DescribeReservedCacheNodesOfferingsOutput)

DescribeReservedCacheNodesOfferingsRequest generates a "aws/request.Request" representing the client's request for the DescribeReservedCacheNodesOfferings operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeReservedCacheNodesOfferings for more information on using the DescribeReservedCacheNodesOfferings API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribeReservedCacheNodesOfferingsRequest method.
req, resp := client.DescribeReservedCacheNodesOfferingsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*ElastiCache) DescribeReservedCacheNodesOfferingsWithContext

func (c *ElastiCache) DescribeReservedCacheNodesOfferingsWithContext(ctx aws.Context, input *DescribeReservedCacheNodesOfferingsInput, opts ...request.Option) (*DescribeReservedCacheNodesOfferingsOutput, error)

DescribeReservedCacheNodesOfferingsWithContext is the same as DescribeReservedCacheNodesOfferings with the addition of the ability to pass a context and additional request options.

See DescribeReservedCacheNodesOfferings for details on how to use this API operation.

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 (*ElastiCache) DescribeReservedCacheNodesPages

func (c *ElastiCache) DescribeReservedCacheNodesPages(input *DescribeReservedCacheNodesInput, fn func(*DescribeReservedCacheNodesOutput, bool) bool) error

DescribeReservedCacheNodesPages iterates over the pages of a DescribeReservedCacheNodes operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See DescribeReservedCacheNodes method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a DescribeReservedCacheNodes operation.
pageNum := 0
err := client.DescribeReservedCacheNodesPages(params,
    func(page *elasticache.DescribeReservedCacheNodesOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*ElastiCache) DescribeReservedCacheNodesPagesWithContext

func (c *ElastiCache) DescribeReservedCacheNodesPagesWithContext(ctx aws.Context, input *DescribeReservedCacheNodesInput, fn func(*DescribeReservedCacheNodesOutput, bool) bool, opts ...request.Option) error

DescribeReservedCacheNodesPagesWithContext same as DescribeReservedCacheNodesPages except it takes a Context and allows setting request options on the pages.

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 (*ElastiCache) DescribeReservedCacheNodesRequest

func (c *ElastiCache) DescribeReservedCacheNodesRequest(input *DescribeReservedCacheNodesInput) (req *request.Request, output *DescribeReservedCacheNodesOutput)

DescribeReservedCacheNodesRequest generates a "aws/request.Request" representing the client's request for the DescribeReservedCacheNodes operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeReservedCacheNodes for more information on using the DescribeReservedCacheNodes API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribeReservedCacheNodesRequest method.
req, resp := client.DescribeReservedCacheNodesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*ElastiCache) DescribeReservedCacheNodesWithContext

func (c *ElastiCache) DescribeReservedCacheNodesWithContext(ctx aws.Context, input *DescribeReservedCacheNodesInput, opts ...request.Option) (*DescribeReservedCacheNodesOutput, error)

DescribeReservedCacheNodesWithContext is the same as DescribeReservedCacheNodes with the addition of the ability to pass a context and additional request options.

See DescribeReservedCacheNodes for details on how to use this API operation.

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 (*ElastiCache) DescribeServiceUpdates

func (c *ElastiCache) DescribeServiceUpdates(input *DescribeServiceUpdatesInput) (*DescribeServiceUpdatesOutput, error)

DescribeServiceUpdates API operation for Amazon ElastiCache.

Returns details of the service updates

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon ElastiCache's API operation DescribeServiceUpdates for usage and error information.

Returned Error Codes:

  • ErrCodeServiceUpdateNotFoundFault "ServiceUpdateNotFoundFault" The service update doesn't exist

  • ErrCodeInvalidParameterValueException "InvalidParameterValue" The value for a parameter is invalid.

  • ErrCodeInvalidParameterCombinationException "InvalidParameterCombination" Two or more incompatible parameters were specified.

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

func (*ElastiCache) DescribeServiceUpdatesPages

func (c *ElastiCache) DescribeServiceUpdatesPages(input *DescribeServiceUpdatesInput, fn func(*DescribeServiceUpdatesOutput, bool) bool) error

DescribeServiceUpdatesPages iterates over the pages of a DescribeServiceUpdates operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See DescribeServiceUpdates method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a DescribeServiceUpdates operation.
pageNum := 0
err := client.DescribeServiceUpdatesPages(params,
    func(page *elasticache.DescribeServiceUpdatesOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*ElastiCache) DescribeServiceUpdatesPagesWithContext

func (c *ElastiCache) DescribeServiceUpdatesPagesWithContext(ctx aws.Context, input *DescribeServiceUpdatesInput, fn func(*DescribeServiceUpdatesOutput, bool) bool, opts ...request.Option) error

DescribeServiceUpdatesPagesWithContext same as DescribeServiceUpdatesPages except it takes a Context and allows setting request options on the pages.

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 (*ElastiCache) DescribeServiceUpdatesRequest

func (c *ElastiCache) DescribeServiceUpdatesRequest(input *DescribeServiceUpdatesInput) (req *request.Request, output *DescribeServiceUpdatesOutput)

DescribeServiceUpdatesRequest generates a "aws/request.Request" representing the client's request for the DescribeServiceUpdates operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeServiceUpdates for more information on using the DescribeServiceUpdates API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribeServiceUpdatesRequest method.
req, resp := client.DescribeServiceUpdatesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*ElastiCache) DescribeServiceUpdatesWithContext

func (c *ElastiCache) DescribeServiceUpdatesWithContext(ctx aws.Context, input *DescribeServiceUpdatesInput, opts ...request.Option) (*DescribeServiceUpdatesOutput, error)

DescribeServiceUpdatesWithContext is the same as DescribeServiceUpdates with the addition of the ability to pass a context and additional request options.

See DescribeServiceUpdates for details on how to use this API operation.

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 (*ElastiCache) DescribeSnapshots

func (c *ElastiCache) DescribeSnapshots(input *DescribeSnapshotsInput) (*DescribeSnapshotsOutput, error)

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon ElastiCache's API operation DescribeSnapshots for usage and error information.

Returned Error Codes:

  • ErrCodeCacheClusterNotFoundFault "CacheClusterNotFound" The requested cluster ID does not refer to an existing cluster.

  • ErrCodeSnapshotNotFoundFault "SnapshotNotFoundFault" The requested snapshot name does not refer to an existing snapshot.

  • ErrCodeInvalidParameterValueException "InvalidParameterValue" The value for a parameter is invalid.

  • ErrCodeInvalidParameterCombinationException "InvalidParameterCombination" Two or more incompatible parameters were specified.

See also, 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 (
	"fmt"

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

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

	result, err := svc.DescribeSnapshots(input)
	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 (*ElastiCache) DescribeSnapshotsPages

func (c *ElastiCache) DescribeSnapshotsPages(input *DescribeSnapshotsInput, fn func(*DescribeSnapshotsOutput, bool) bool) error

DescribeSnapshotsPages iterates over the pages of a DescribeSnapshots operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See DescribeSnapshots method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a DescribeSnapshots operation.
pageNum := 0
err := client.DescribeSnapshotsPages(params,
    func(page *elasticache.DescribeSnapshotsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*ElastiCache) DescribeSnapshotsPagesWithContext

func (c *ElastiCache) DescribeSnapshotsPagesWithContext(ctx aws.Context, input *DescribeSnapshotsInput, fn func(*DescribeSnapshotsOutput, bool) bool, opts ...request.Option) error

DescribeSnapshotsPagesWithContext same as DescribeSnapshotsPages except it takes a Context and allows setting request options on the pages.

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 (*ElastiCache) DescribeSnapshotsRequest

func (c *ElastiCache) DescribeSnapshotsRequest(input *DescribeSnapshotsInput) (req *request.Request, output *DescribeSnapshotsOutput)

DescribeSnapshotsRequest generates a "aws/request.Request" representing the client's request for the DescribeSnapshots operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeSnapshots for more information on using the DescribeSnapshots API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribeSnapshotsRequest method.
req, resp := client.DescribeSnapshotsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*ElastiCache) DescribeSnapshotsWithContext

func (c *ElastiCache) DescribeSnapshotsWithContext(ctx aws.Context, input *DescribeSnapshotsInput, opts ...request.Option) (*DescribeSnapshotsOutput, error)

DescribeSnapshotsWithContext is the same as DescribeSnapshots with the addition of the ability to pass a context and additional request options.

See DescribeSnapshots for details on how to use this API operation.

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 (*ElastiCache) DescribeUpdateActions

func (c *ElastiCache) DescribeUpdateActions(input *DescribeUpdateActionsInput) (*DescribeUpdateActionsOutput, error)

DescribeUpdateActions API operation for Amazon ElastiCache.

Returns details of the update actions

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon ElastiCache's API operation DescribeUpdateActions for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidParameterValueException "InvalidParameterValue" The value for a parameter is invalid.

  • ErrCodeInvalidParameterCombinationException "InvalidParameterCombination" Two or more incompatible parameters were specified.

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

func (*ElastiCache) DescribeUpdateActionsPages

func (c *ElastiCache) DescribeUpdateActionsPages(input *DescribeUpdateActionsInput, fn func(*DescribeUpdateActionsOutput, bool) bool) error

DescribeUpdateActionsPages iterates over the pages of a DescribeUpdateActions operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See DescribeUpdateActions method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a DescribeUpdateActions operation.
pageNum := 0
err := client.DescribeUpdateActionsPages(params,
    func(page *elasticache.DescribeUpdateActionsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*ElastiCache) DescribeUpdateActionsPagesWithContext

func (c *ElastiCache) DescribeUpdateActionsPagesWithContext(ctx aws.Context, input *DescribeUpdateActionsInput, fn func(*DescribeUpdateActionsOutput, bool) bool, opts ...request.Option) error

DescribeUpdateActionsPagesWithContext same as DescribeUpdateActionsPages except it takes a Context and allows setting request options on the pages.

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 (*ElastiCache) DescribeUpdateActionsRequest

func (c *ElastiCache) DescribeUpdateActionsRequest(input *DescribeUpdateActionsInput) (req *request.Request, output *DescribeUpdateActionsOutput)

DescribeUpdateActionsRequest generates a "aws/request.Request" representing the client's request for the DescribeUpdateActions operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeUpdateActions for more information on using the DescribeUpdateActions API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribeUpdateActionsRequest method.
req, resp := client.DescribeUpdateActionsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*ElastiCache) DescribeUpdateActionsWithContext

func (c *ElastiCache) DescribeUpdateActionsWithContext(ctx aws.Context, input *DescribeUpdateActionsInput, opts ...request.Option) (*DescribeUpdateActionsOutput, error)

DescribeUpdateActionsWithContext is the same as DescribeUpdateActions with the addition of the ability to pass a context and additional request options.

See DescribeUpdateActions for details on how to use this API operation.

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 (*ElastiCache) DescribeUserGroups

func (c *ElastiCache) DescribeUserGroups(input *DescribeUserGroupsInput) (*DescribeUserGroupsOutput, error)

DescribeUserGroups API operation for Amazon ElastiCache.

Returns a list of user groups.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon ElastiCache's API operation DescribeUserGroups for usage and error information.

Returned Error Codes:

  • ErrCodeUserGroupNotFoundFault "UserGroupNotFound" The user group was not found or does not exist

  • ErrCodeServiceLinkedRoleNotFoundFault "ServiceLinkedRoleNotFoundFault" The specified service linked role (SLR) was not found.

  • ErrCodeInvalidParameterCombinationException "InvalidParameterCombination" Two or more incompatible parameters were specified.

See also, https://docs.aws.amazon.com/goto/WebAPI/elasticache-2015-02-02/DescribeUserGroups

func (*ElastiCache) DescribeUserGroupsPages

func (c *ElastiCache) DescribeUserGroupsPages(input *DescribeUserGroupsInput, fn func(*DescribeUserGroupsOutput, bool) bool) error

DescribeUserGroupsPages iterates over the pages of a DescribeUserGroups operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See DescribeUserGroups method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a DescribeUserGroups operation.
pageNum := 0
err := client.DescribeUserGroupsPages(params,
    func(page *elasticache.DescribeUserGroupsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*ElastiCache) DescribeUserGroupsPagesWithContext

func (c *ElastiCache) DescribeUserGroupsPagesWithContext(ctx aws.Context, input *DescribeUserGroupsInput, fn func(*DescribeUserGroupsOutput, bool) bool, opts ...request.Option) error

DescribeUserGroupsPagesWithContext same as DescribeUserGroupsPages except it takes a Context and allows setting request options on the pages.

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 (*ElastiCache) DescribeUserGroupsRequest

func (c *ElastiCache) DescribeUserGroupsRequest(input *DescribeUserGroupsInput) (req *request.Request, output *DescribeUserGroupsOutput)

DescribeUserGroupsRequest generates a "aws/request.Request" representing the client's request for the DescribeUserGroups operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeUserGroups for more information on using the DescribeUserGroups API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribeUserGroupsRequest method.
req, resp := client.DescribeUserGroupsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/elasticache-2015-02-02/DescribeUserGroups

func (*ElastiCache) DescribeUserGroupsWithContext

func (c *ElastiCache) DescribeUserGroupsWithContext(ctx aws.Context, input *DescribeUserGroupsInput, opts ...request.Option) (*DescribeUserGroupsOutput, error)

DescribeUserGroupsWithContext is the same as DescribeUserGroups with the addition of the ability to pass a context and additional request options.

See DescribeUserGroups for details on how to use this API operation.

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 (*ElastiCache) DescribeUsers

func (c *ElastiCache) DescribeUsers(input *DescribeUsersInput) (*DescribeUsersOutput, error)

DescribeUsers API operation for Amazon ElastiCache.

Returns a list of users.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon ElastiCache's API operation DescribeUsers for usage and error information.

Returned Error Codes:

  • ErrCodeUserNotFoundFault "UserNotFound" The user does not exist or could not be found.

  • ErrCodeServiceLinkedRoleNotFoundFault "ServiceLinkedRoleNotFoundFault" The specified service linked role (SLR) was not found.

  • ErrCodeInvalidParameterCombinationException "InvalidParameterCombination" Two or more incompatible parameters were specified.

See also, https://docs.aws.amazon.com/goto/WebAPI/elasticache-2015-02-02/DescribeUsers

func (*ElastiCache) DescribeUsersPages

func (c *ElastiCache) DescribeUsersPages(input *DescribeUsersInput, fn func(*DescribeUsersOutput, bool) bool) error

DescribeUsersPages iterates over the pages of a DescribeUsers operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See DescribeUsers method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a DescribeUsers operation.
pageNum := 0
err := client.DescribeUsersPages(params,
    func(page *elasticache.DescribeUsersOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*ElastiCache) DescribeUsersPagesWithContext

func (c *ElastiCache) DescribeUsersPagesWithContext(ctx aws.Context, input *DescribeUsersInput, fn func(*DescribeUsersOutput, bool) bool, opts ...request.Option) error

DescribeUsersPagesWithContext same as DescribeUsersPages except it takes a Context and allows setting request options on the pages.

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 (*ElastiCache) DescribeUsersRequest

func (c *ElastiCache) DescribeUsersRequest(input *DescribeUsersInput) (req *request.Request, output *DescribeUsersOutput)

DescribeUsersRequest generates a "aws/request.Request" representing the client's request for the DescribeUsers operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeUsers for more information on using the DescribeUsers API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribeUsersRequest method.
req, resp := client.DescribeUsersRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/elasticache-2015-02-02/DescribeUsers

func (*ElastiCache) DescribeUsersWithContext

func (c *ElastiCache) DescribeUsersWithContext(ctx aws.Context, input *DescribeUsersInput, opts ...request.Option) (*DescribeUsersOutput, error)

DescribeUsersWithContext is the same as DescribeUsers with the addition of the ability to pass a context and additional request options.

See DescribeUsers for details on how to use this API operation.

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 (*ElastiCache) DisassociateGlobalReplicationGroup

DisassociateGlobalReplicationGroup 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 Amazon region.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon ElastiCache's API operation DisassociateGlobalReplicationGroup for usage and error information.

Returned Error Codes:

  • ErrCodeGlobalReplicationGroupNotFoundFault "GlobalReplicationGroupNotFoundFault" The Global datastore does not exist

  • ErrCodeInvalidGlobalReplicationGroupStateFault "InvalidGlobalReplicationGroupState" The Global datastore is not available or in primary-only state.

  • ErrCodeInvalidParameterValueException "InvalidParameterValue" The value for a parameter is invalid.

  • ErrCodeInvalidParameterCombinationException "InvalidParameterCombination" Two or more incompatible parameters were specified.

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

func (*ElastiCache) DisassociateGlobalReplicationGroupRequest

func (c *ElastiCache) DisassociateGlobalReplicationGroupRequest(input *DisassociateGlobalReplicationGroupInput) (req *request.Request, output *DisassociateGlobalReplicationGroupOutput)

DisassociateGlobalReplicationGroupRequest generates a "aws/request.Request" representing the client's request for the DisassociateGlobalReplicationGroup operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DisassociateGlobalReplicationGroup for more information on using the DisassociateGlobalReplicationGroup API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DisassociateGlobalReplicationGroupRequest method.
req, resp := client.DisassociateGlobalReplicationGroupRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*ElastiCache) DisassociateGlobalReplicationGroupWithContext

func (c *ElastiCache) DisassociateGlobalReplicationGroupWithContext(ctx aws.Context, input *DisassociateGlobalReplicationGroupInput, opts ...request.Option) (*DisassociateGlobalReplicationGroupOutput, error)

DisassociateGlobalReplicationGroupWithContext is the same as DisassociateGlobalReplicationGroup with the addition of the ability to pass a context and additional request options.

See DisassociateGlobalReplicationGroup for details on how to use this API operation.

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 (*ElastiCache) FailoverGlobalReplicationGroup

func (c *ElastiCache) FailoverGlobalReplicationGroup(input *FailoverGlobalReplicationGroupInput) (*FailoverGlobalReplicationGroupOutput, error)

FailoverGlobalReplicationGroup API operation for Amazon ElastiCache.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon ElastiCache's API operation FailoverGlobalReplicationGroup for usage and error information.

Returned Error Codes:

  • ErrCodeGlobalReplicationGroupNotFoundFault "GlobalReplicationGroupNotFoundFault" The Global datastore does not exist

  • ErrCodeInvalidGlobalReplicationGroupStateFault "InvalidGlobalReplicationGroupState" The Global datastore is not available or in primary-only state.

  • ErrCodeInvalidParameterValueException "InvalidParameterValue" The value for a parameter is invalid.

  • ErrCodeInvalidParameterCombinationException "InvalidParameterCombination" Two or more incompatible parameters were specified.

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

func (*ElastiCache) FailoverGlobalReplicationGroupRequest

func (c *ElastiCache) FailoverGlobalReplicationGroupRequest(input *FailoverGlobalReplicationGroupInput) (req *request.Request, output *FailoverGlobalReplicationGroupOutput)

FailoverGlobalReplicationGroupRequest generates a "aws/request.Request" representing the client's request for the FailoverGlobalReplicationGroup operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See FailoverGlobalReplicationGroup for more information on using the FailoverGlobalReplicationGroup API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the FailoverGlobalReplicationGroupRequest method.
req, resp := client.FailoverGlobalReplicationGroupRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*ElastiCache) FailoverGlobalReplicationGroupWithContext

func (c *ElastiCache) FailoverGlobalReplicationGroupWithContext(ctx aws.Context, input *FailoverGlobalReplicationGroupInput, opts ...request.Option) (*FailoverGlobalReplicationGroupOutput, error)

FailoverGlobalReplicationGroupWithContext is the same as FailoverGlobalReplicationGroup with the addition of the ability to pass a context and additional request options.

See FailoverGlobalReplicationGroup for details on how to use this API operation.

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 (*ElastiCache) IncreaseNodeGroupsInGlobalReplicationGroup

IncreaseNodeGroupsInGlobalReplicationGroup API operation for Amazon ElastiCache.

Increase the number of node groups in the Global datastore

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon ElastiCache's API operation IncreaseNodeGroupsInGlobalReplicationGroup for usage and error information.

Returned Error Codes:

  • ErrCodeGlobalReplicationGroupNotFoundFault "GlobalReplicationGroupNotFoundFault" The Global datastore does not exist

  • ErrCodeInvalidGlobalReplicationGroupStateFault "InvalidGlobalReplicationGroupState" The Global datastore is not available or in primary-only state.

  • ErrCodeInvalidParameterValueException "InvalidParameterValue" The value for a parameter is invalid.

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

func (*ElastiCache) IncreaseNodeGroupsInGlobalReplicationGroupRequest

func (c *ElastiCache) IncreaseNodeGroupsInGlobalReplicationGroupRequest(input *IncreaseNodeGroupsInGlobalReplicationGroupInput) (req *request.Request, output *IncreaseNodeGroupsInGlobalReplicationGroupOutput)

IncreaseNodeGroupsInGlobalReplicationGroupRequest generates a "aws/request.Request" representing the client's request for the IncreaseNodeGroupsInGlobalReplicationGroup operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See IncreaseNodeGroupsInGlobalReplicationGroup for more information on using the IncreaseNodeGroupsInGlobalReplicationGroup API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the IncreaseNodeGroupsInGlobalReplicationGroupRequest method.
req, resp := client.IncreaseNodeGroupsInGlobalReplicationGroupRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*ElastiCache) IncreaseNodeGroupsInGlobalReplicationGroupWithContext

func (c *ElastiCache) IncreaseNodeGroupsInGlobalReplicationGroupWithContext(ctx aws.Context, input *IncreaseNodeGroupsInGlobalReplicationGroupInput, opts ...request.Option) (*IncreaseNodeGroupsInGlobalReplicationGroupOutput, error)

IncreaseNodeGroupsInGlobalReplicationGroupWithContext is the same as IncreaseNodeGroupsInGlobalReplicationGroup with the addition of the ability to pass a context and additional request options.

See IncreaseNodeGroupsInGlobalReplicationGroup for details on how to use this API operation.

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 (*ElastiCache) IncreaseReplicaCount

func (c *ElastiCache) IncreaseReplicaCount(input *IncreaseReplicaCountInput) (*IncreaseReplicaCountOutput, error)

IncreaseReplicaCount API operation for Amazon ElastiCache.

Dynamically increases 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.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon ElastiCache's API operation IncreaseReplicaCount for usage and error information.

Returned Error Codes:

  • ErrCodeReplicationGroupNotFoundFault "ReplicationGroupNotFoundFault" The specified replication group does not exist.

  • ErrCodeInvalidReplicationGroupStateFault "InvalidReplicationGroupState" The requested replication group is not in the available state.

  • ErrCodeInvalidCacheClusterStateFault "InvalidCacheClusterState" The requested cluster is not in the available state.

  • ErrCodeInvalidVPCNetworkStateFault "InvalidVPCNetworkStateFault" The VPC network is in an invalid state.

  • ErrCodeInsufficientCacheClusterCapacityFault "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.

  • ErrCodeClusterQuotaForCustomerExceededFault "ClusterQuotaForCustomerExceeded" The request cannot be processed because it would exceed the allowed number of clusters per customer.

  • ErrCodeNodeGroupsPerReplicationGroupQuotaExceededFault "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

  • ErrCodeNodeQuotaForCustomerExceededFault "NodeQuotaForCustomerExceeded" The request cannot be processed because it would exceed the allowed number of cache nodes per customer.

  • ErrCodeNoOperationFault "NoOperationFault" The operation was not performed because no changes were required.

  • ErrCodeInvalidKMSKeyFault "InvalidKMSKeyFault" The KMS key supplied is not valid.

  • ErrCodeInvalidParameterValueException "InvalidParameterValue" The value for a parameter is invalid.

  • ErrCodeInvalidParameterCombinationException "InvalidParameterCombination" Two or more incompatible parameters were specified.

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

func (*ElastiCache) IncreaseReplicaCountRequest

func (c *ElastiCache) IncreaseReplicaCountRequest(input *IncreaseReplicaCountInput) (req *request.Request, output *IncreaseReplicaCountOutput)

IncreaseReplicaCountRequest generates a "aws/request.Request" representing the client's request for the IncreaseReplicaCount operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See IncreaseReplicaCount for more information on using the IncreaseReplicaCount API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the IncreaseReplicaCountRequest method.
req, resp := client.IncreaseReplicaCountRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*ElastiCache) IncreaseReplicaCountWithContext

func (c *ElastiCache) IncreaseReplicaCountWithContext(ctx aws.Context, input *IncreaseReplicaCountInput, opts ...request.Option) (*IncreaseReplicaCountOutput, error)

IncreaseReplicaCountWithContext is the same as IncreaseReplicaCount with the addition of the ability to pass a context and additional request options.

See IncreaseReplicaCount for details on how to use this API operation.

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 (*ElastiCache) ListAllowedNodeTypeModifications

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon ElastiCache's API operation ListAllowedNodeTypeModifications for usage and error information.

Returned Error Codes:

  • ErrCodeCacheClusterNotFoundFault "CacheClusterNotFound" The requested cluster ID does not refer to an existing cluster.

  • ErrCodeReplicationGroupNotFoundFault "ReplicationGroupNotFoundFault" The specified replication group does not exist.

  • ErrCodeInvalidParameterCombinationException "InvalidParameterCombination" Two or more incompatible parameters were specified.

  • ErrCodeInvalidParameterValueException "InvalidParameterValue" The value for a parameter is invalid.

See also, 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 (
	"fmt"

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

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

	result, err := svc.ListAllowedNodeTypeModifications(input)
	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 (
	"fmt"

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

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

	result, err := svc.ListAllowedNodeTypeModifications(input)
	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 (*ElastiCache) ListAllowedNodeTypeModificationsRequest

func (c *ElastiCache) ListAllowedNodeTypeModificationsRequest(input *ListAllowedNodeTypeModificationsInput) (req *request.Request, output *ListAllowedNodeTypeModificationsOutput)

ListAllowedNodeTypeModificationsRequest generates a "aws/request.Request" representing the client's request for the ListAllowedNodeTypeModifications operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListAllowedNodeTypeModifications for more information on using the ListAllowedNodeTypeModifications API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ListAllowedNodeTypeModificationsRequest method.
req, resp := client.ListAllowedNodeTypeModificationsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*ElastiCache) ListAllowedNodeTypeModificationsWithContext

func (c *ElastiCache) ListAllowedNodeTypeModificationsWithContext(ctx aws.Context, input *ListAllowedNodeTypeModificationsInput, opts ...request.Option) (*ListAllowedNodeTypeModificationsOutput, error)

ListAllowedNodeTypeModificationsWithContext is the same as ListAllowedNodeTypeModifications with the addition of the ability to pass a context and additional request options.

See ListAllowedNodeTypeModifications for details on how to use this API operation.

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 (*ElastiCache) ListTagsForResource

func (c *ElastiCache) ListTagsForResource(input *ListTagsForResourceInput) (*TagListMessage, error)

ListTagsForResource API operation for Amazon ElastiCache.

Lists all tags currently on a named resource.

A tag is a key-value pair where the key and value are case-sensitive. You can use tags to categorize and track all your ElastiCache resources, with the exception of global replication group. When you add or remove tags on replication groups, those actions will be replicated to all nodes in the replication group. For more information, see Resource-level permissions (http://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/IAM.ResourceLevelPermissions.html).

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon ElastiCache's API operation ListTagsForResource for usage and error information.

Returned Error Codes:

  • ErrCodeCacheClusterNotFoundFault "CacheClusterNotFound" The requested cluster ID does not refer to an existing cluster.

  • ErrCodeCacheParameterGroupNotFoundFault "CacheParameterGroupNotFound" The requested cache parameter group name does not refer to an existing cache parameter group.

  • ErrCodeCacheSecurityGroupNotFoundFault "CacheSecurityGroupNotFound" The requested cache security group name does not refer to an existing cache security group.

  • ErrCodeCacheSubnetGroupNotFoundFault "CacheSubnetGroupNotFoundFault" The requested cache subnet group name does not refer to an existing cache subnet group.

  • ErrCodeInvalidReplicationGroupStateFault "InvalidReplicationGroupState" The requested replication group is not in the available state.

  • ErrCodeReplicationGroupNotFoundFault "ReplicationGroupNotFoundFault" The specified replication group does not exist.

  • ErrCodeReservedCacheNodeNotFoundFault "ReservedCacheNodeNotFound" The requested reserved cache node was not found.

  • ErrCodeSnapshotNotFoundFault "SnapshotNotFoundFault" The requested snapshot name does not refer to an existing snapshot.

  • ErrCodeUserNotFoundFault "UserNotFound" The user does not exist or could not be found.

  • ErrCodeUserGroupNotFoundFault "UserGroupNotFound" The user group was not found or does not exist

  • ErrCodeInvalidARNFault "InvalidARN" The requested Amazon Resource Name (ARN) does not refer to an existing resource.

See also, 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 (
	"fmt"

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

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

	result, err := svc.ListTagsForResource(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case elasticache.ErrCodeCacheClusterNotFoundFault:
				fmt.Println(elasticache.ErrCodeCacheClusterNotFoundFault, aerr.Error())
			case elasticache.ErrCodeCacheParameterGroupNotFoundFault:
				fmt.Println(elasticache.ErrCodeCacheParameterGroupNotFoundFault, aerr.Error())
			case elasticache.ErrCodeCacheSecurityGroupNotFoundFault:
				fmt.Println(elasticache.ErrCodeCacheSecurityGroupNotFoundFault, aerr.Error())
			case elasticache.ErrCodeCacheSubnetGroupNotFoundFault:
				fmt.Println(elasticache.ErrCodeCacheSubnetGroupNotFoundFault, aerr.Error())
			case elasticache.ErrCodeInvalidReplicationGroupStateFault:
				fmt.Println(elasticache.ErrCodeInvalidReplicationGroupStateFault, aerr.Error())
			case elasticache.ErrCodeReplicationGroupNotFoundFault:
				fmt.Println(elasticache.ErrCodeReplicationGroupNotFoundFault, aerr.Error())
			case elasticache.ErrCodeReservedCacheNodeNotFoundFault:
				fmt.Println(elasticache.ErrCodeReservedCacheNodeNotFoundFault, aerr.Error())
			case elasticache.ErrCodeSnapshotNotFoundFault:
				fmt.Println(elasticache.ErrCodeSnapshotNotFoundFault, aerr.Error())
			case elasticache.ErrCodeUserNotFoundFault:
				fmt.Println(elasticache.ErrCodeUserNotFoundFault, aerr.Error())
			case elasticache.ErrCodeUserGroupNotFoundFault:
				fmt.Println(elasticache.ErrCodeUserGroupNotFoundFault, 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 (*ElastiCache) ListTagsForResourceRequest

func (c *ElastiCache) ListTagsForResourceRequest(input *ListTagsForResourceInput) (req *request.Request, output *TagListMessage)

ListTagsForResourceRequest generates a "aws/request.Request" representing the client's request for the ListTagsForResource operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListTagsForResource for more information on using the ListTagsForResource API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ListTagsForResourceRequest method.
req, resp := client.ListTagsForResourceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*ElastiCache) ListTagsForResourceWithContext

func (c *ElastiCache) ListTagsForResourceWithContext(ctx aws.Context, input *ListTagsForResourceInput, opts ...request.Option) (*TagListMessage, error)

ListTagsForResourceWithContext is the same as ListTagsForResource with the addition of the ability to pass a context and additional request options.

See ListTagsForResource for details on how to use this API operation.

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 (*ElastiCache) ModifyCacheCluster

func (c *ElastiCache) ModifyCacheCluster(input *ModifyCacheClusterInput) (*ModifyCacheClusterOutput, error)

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon ElastiCache's API operation ModifyCacheCluster for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidCacheClusterStateFault "InvalidCacheClusterState" The requested cluster is not in the available state.

  • ErrCodeInvalidCacheSecurityGroupStateFault "InvalidCacheSecurityGroupState" The current state of the cache security group does not allow deletion.

  • ErrCodeInsufficientCacheClusterCapacityFault "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.

  • ErrCodeCacheClusterNotFoundFault "CacheClusterNotFound" The requested cluster ID does not refer to an existing cluster.

  • ErrCodeNodeQuotaForClusterExceededFault "NodeQuotaForClusterExceeded" The request cannot be processed because it would exceed the allowed number of cache nodes in a single cluster.

  • ErrCodeNodeQuotaForCustomerExceededFault "NodeQuotaForCustomerExceeded" The request cannot be processed because it would exceed the allowed number of cache nodes per customer.

  • ErrCodeCacheSecurityGroupNotFoundFault "CacheSecurityGroupNotFound" The requested cache security group name does not refer to an existing cache security group.

  • ErrCodeCacheParameterGroupNotFoundFault "CacheParameterGroupNotFound" The requested cache parameter group name does not refer to an existing cache parameter group.

  • ErrCodeInvalidVPCNetworkStateFault "InvalidVPCNetworkStateFault" The VPC network is in an invalid state.

  • ErrCodeInvalidParameterValueException "InvalidParameterValue" The value for a parameter is invalid.

  • ErrCodeInvalidParameterCombinationException "InvalidParameterCombination" Two or more incompatible parameters were specified.

See also, 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 (
	"fmt"

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

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

	result, err := svc.ModifyCacheCluster(input)
	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 (*ElastiCache) ModifyCacheClusterRequest

func (c *ElastiCache) ModifyCacheClusterRequest(input *ModifyCacheClusterInput) (req *request.Request, output *ModifyCacheClusterOutput)

ModifyCacheClusterRequest generates a "aws/request.Request" representing the client's request for the ModifyCacheCluster operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ModifyCacheCluster for more information on using the ModifyCacheCluster API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ModifyCacheClusterRequest method.
req, resp := client.ModifyCacheClusterRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*ElastiCache) ModifyCacheClusterWithContext

func (c *ElastiCache) ModifyCacheClusterWithContext(ctx aws.Context, input *ModifyCacheClusterInput, opts ...request.Option) (*ModifyCacheClusterOutput, error)

ModifyCacheClusterWithContext is the same as ModifyCacheCluster with the addition of the ability to pass a context and additional request options.

See ModifyCacheCluster for details on how to use this API operation.

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 (*ElastiCache) ModifyCacheParameterGroup

func (c *ElastiCache) ModifyCacheParameterGroup(input *ModifyCacheParameterGroupInput) (*CacheParameterGroupNameMessage, error)

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon ElastiCache's API operation ModifyCacheParameterGroup for usage and error information.

Returned Error Codes:

  • ErrCodeCacheParameterGroupNotFoundFault "CacheParameterGroupNotFound" The requested cache parameter group name does not refer to an existing cache parameter group.

  • ErrCodeInvalidCacheParameterGroupStateFault "InvalidCacheParameterGroupState" The current state of the cache parameter group does not allow the requested operation to occur.

  • ErrCodeInvalidParameterValueException "InvalidParameterValue" The value for a parameter is invalid.

  • ErrCodeInvalidParameterCombinationException "InvalidParameterCombination" Two or more incompatible parameters were specified.

  • ErrCodeInvalidGlobalReplicationGroupStateFault "InvalidGlobalReplicationGroupState" The Global datastore is not available or in primary-only state.

See also, 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 (
	"fmt"

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

func main() {
	svc := elasticache.New(session.New())
	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"),
			},
		},
	}

	result, err := svc.ModifyCacheParameterGroup(input)
	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 (*ElastiCache) ModifyCacheParameterGroupRequest

func (c *ElastiCache) ModifyCacheParameterGroupRequest(input *ModifyCacheParameterGroupInput) (req *request.Request, output *CacheParameterGroupNameMessage)

ModifyCacheParameterGroupRequest generates a "aws/request.Request" representing the client's request for the ModifyCacheParameterGroup operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ModifyCacheParameterGroup for more information on using the ModifyCacheParameterGroup API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ModifyCacheParameterGroupRequest method.
req, resp := client.ModifyCacheParameterGroupRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*ElastiCache) ModifyCacheParameterGroupWithContext

func (c *ElastiCache) ModifyCacheParameterGroupWithContext(ctx aws.Context, input *ModifyCacheParameterGroupInput, opts ...request.Option) (*CacheParameterGroupNameMessage, error)

ModifyCacheParameterGroupWithContext is the same as ModifyCacheParameterGroup with the addition of the ability to pass a context and additional request options.

See ModifyCacheParameterGroup for details on how to use this API operation.

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 (*ElastiCache) ModifyCacheSubnetGroup

func (c *ElastiCache) ModifyCacheSubnetGroup(input *ModifyCacheSubnetGroupInput) (*ModifyCacheSubnetGroupOutput, error)

ModifyCacheSubnetGroup API operation for Amazon ElastiCache.

Modifies an existing cache subnet group.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon ElastiCache's API operation ModifyCacheSubnetGroup for usage and error information.

Returned Error Codes:

  • ErrCodeCacheSubnetGroupNotFoundFault "CacheSubnetGroupNotFoundFault" The requested cache subnet group name does not refer to an existing cache subnet group.

  • ErrCodeCacheSubnetQuotaExceededFault "CacheSubnetQuotaExceededFault" The request cannot be processed because it would exceed the allowed number of subnets in a cache subnet group.

  • ErrCodeSubnetInUse "SubnetInUse" The requested subnet is being used by another cache subnet group.

  • ErrCodeInvalidSubnet "InvalidSubnet" An invalid subnet identifier was specified.

  • ErrCodeSubnetNotAllowedFault "SubnetNotAllowedFault" At least one subnet ID does not match the other subnet IDs. This mismatch typically occurs when a user sets one subnet ID to a regional Availability Zone and a different one to an outpost. Or when a user sets the subnet ID to an Outpost when not subscribed on this service.

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

Example (Shared00)

ModifyCacheSubnetGroup Modifies an existing ElastiCache subnet group.

package main

import (
	"fmt"

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

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

	result, err := svc.ModifyCacheSubnetGroup(input)
	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())
			case elasticache.ErrCodeSubnetNotAllowedFault:
				fmt.Println(elasticache.ErrCodeSubnetNotAllowedFault, 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 (*ElastiCache) ModifyCacheSubnetGroupRequest

func (c *ElastiCache) ModifyCacheSubnetGroupRequest(input *ModifyCacheSubnetGroupInput) (req *request.Request, output *ModifyCacheSubnetGroupOutput)

ModifyCacheSubnetGroupRequest generates a "aws/request.Request" representing the client's request for the ModifyCacheSubnetGroup operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ModifyCacheSubnetGroup for more information on using the ModifyCacheSubnetGroup API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ModifyCacheSubnetGroupRequest method.
req, resp := client.ModifyCacheSubnetGroupRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*ElastiCache) ModifyCacheSubnetGroupWithContext

func (c *ElastiCache) ModifyCacheSubnetGroupWithContext(ctx aws.Context, input *ModifyCacheSubnetGroupInput, opts ...request.Option) (*ModifyCacheSubnetGroupOutput, error)

ModifyCacheSubnetGroupWithContext is the same as ModifyCacheSubnetGroup with the addition of the ability to pass a context and additional request options.

See ModifyCacheSubnetGroup for details on how to use this API operation.

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 (*ElastiCache) ModifyGlobalReplicationGroup

func (c *ElastiCache) ModifyGlobalReplicationGroup(input *ModifyGlobalReplicationGroupInput) (*ModifyGlobalReplicationGroupOutput, error)

ModifyGlobalReplicationGroup API operation for Amazon ElastiCache.

Modifies the settings for a Global datastore.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon ElastiCache's API operation ModifyGlobalReplicationGroup for usage and error information.

Returned Error Codes:

  • ErrCodeGlobalReplicationGroupNotFoundFault "GlobalReplicationGroupNotFoundFault" The Global datastore does not exist

  • ErrCodeInvalidGlobalReplicationGroupStateFault "InvalidGlobalReplicationGroupState" The Global datastore is not available or in primary-only state.

  • ErrCodeInvalidParameterValueException "InvalidParameterValue" The value for a parameter is invalid.

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

func (*ElastiCache) ModifyGlobalReplicationGroupRequest

func (c *ElastiCache) ModifyGlobalReplicationGroupRequest(input *ModifyGlobalReplicationGroupInput) (req *request.Request, output *ModifyGlobalReplicationGroupOutput)

ModifyGlobalReplicationGroupRequest generates a "aws/request.Request" representing the client's request for the ModifyGlobalReplicationGroup operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ModifyGlobalReplicationGroup for more information on using the ModifyGlobalReplicationGroup API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ModifyGlobalReplicationGroupRequest method.
req, resp := client.ModifyGlobalReplicationGroupRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*ElastiCache) ModifyGlobalReplicationGroupWithContext

func (c *ElastiCache) ModifyGlobalReplicationGroupWithContext(ctx aws.Context, input *ModifyGlobalReplicationGroupInput, opts ...request.Option) (*ModifyGlobalReplicationGroupOutput, error)

ModifyGlobalReplicationGroupWithContext is the same as ModifyGlobalReplicationGroup with the addition of the ability to pass a context and additional request options.

See ModifyGlobalReplicationGroup for details on how to use this API operation.

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 (*ElastiCache) ModifyReplicationGroup

func (c *ElastiCache) ModifyReplicationGroup(input *ModifyReplicationGroupInput) (*ModifyReplicationGroupOutput, error)

ModifyReplicationGroup API operation for Amazon ElastiCache.

Modifies the settings for a replication group.

This operation is valid for Redis only.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon ElastiCache's API operation ModifyReplicationGroup for usage and error information.

Returned Error Codes:

  • ErrCodeReplicationGroupNotFoundFault "ReplicationGroupNotFoundFault" The specified replication group does not exist.

  • ErrCodeInvalidReplicationGroupStateFault "InvalidReplicationGroupState" The requested replication group is not in the available state.

  • ErrCodeInvalidUserGroupStateFault "InvalidUserGroupState" The user group is not in an active state.

  • ErrCodeUserGroupNotFoundFault "UserGroupNotFound" The user group was not found or does not exist

  • ErrCodeInvalidCacheClusterStateFault "InvalidCacheClusterState" The requested cluster is not in the available state.

  • ErrCodeInvalidCacheSecurityGroupStateFault "InvalidCacheSecurityGroupState" The current state of the cache security group does not allow deletion.

  • ErrCodeInsufficientCacheClusterCapacityFault "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.

  • ErrCodeCacheClusterNotFoundFault "CacheClusterNotFound" The requested cluster ID does not refer to an existing cluster.

  • ErrCodeNodeQuotaForClusterExceededFault "NodeQuotaForClusterExceeded" The request cannot be processed because it would exceed the allowed number of cache nodes in a single cluster.

  • ErrCodeNodeQuotaForCustomerExceededFault "NodeQuotaForCustomerExceeded" The request cannot be processed because it would exceed the allowed number of cache nodes per customer.

  • ErrCodeCacheSecurityGroupNotFoundFault "CacheSecurityGroupNotFound" The requested cache security group name does not refer to an existing cache security group.

  • ErrCodeCacheParameterGroupNotFoundFault "CacheParameterGroupNotFound" The requested cache parameter group name does not refer to an existing cache parameter group.

  • ErrCodeInvalidVPCNetworkStateFault "InvalidVPCNetworkStateFault" The VPC network is in an invalid state.

  • ErrCodeInvalidKMSKeyFault "InvalidKMSKeyFault" The KMS key supplied is not valid.

  • ErrCodeInvalidParameterValueException "InvalidParameterValue" The value for a parameter is invalid.

  • ErrCodeInvalidParameterCombinationException "InvalidParameterCombination" Two or more incompatible parameters were specified.

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

Example (Shared00)
package main

import (
	"fmt"

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

func main() {
	svc := elasticache.New(session.New())
	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"),
	}

	result, err := svc.ModifyReplicationGroup(input)
	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.ErrCodeInvalidUserGroupStateFault:
				fmt.Println(elasticache.ErrCodeInvalidUserGroupStateFault, aerr.Error())
			case elasticache.ErrCodeUserGroupNotFoundFault:
				fmt.Println(elasticache.ErrCodeUserGroupNotFoundFault, 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 (*ElastiCache) ModifyReplicationGroupRequest

func (c *ElastiCache) ModifyReplicationGroupRequest(input *ModifyReplicationGroupInput) (req *request.Request, output *ModifyReplicationGroupOutput)

ModifyReplicationGroupRequest generates a "aws/request.Request" representing the client's request for the ModifyReplicationGroup operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ModifyReplicationGroup for more information on using the ModifyReplicationGroup API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ModifyReplicationGroupRequest method.
req, resp := client.ModifyReplicationGroupRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*ElastiCache) ModifyReplicationGroupShardConfiguration

ModifyReplicationGroupShardConfiguration 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 existing shards.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon ElastiCache's API operation ModifyReplicationGroupShardConfiguration for usage and error information.

Returned Error Codes:

  • ErrCodeReplicationGroupNotFoundFault "ReplicationGroupNotFoundFault" The specified replication group does not exist.

  • ErrCodeInvalidReplicationGroupStateFault "InvalidReplicationGroupState" The requested replication group is not in the available state.

  • ErrCodeInvalidCacheClusterStateFault "InvalidCacheClusterState" The requested cluster is not in the available state.

  • ErrCodeInvalidVPCNetworkStateFault "InvalidVPCNetworkStateFault" The VPC network is in an invalid state.

  • ErrCodeInsufficientCacheClusterCapacityFault "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.

  • ErrCodeNodeGroupsPerReplicationGroupQuotaExceededFault "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

  • ErrCodeNodeQuotaForCustomerExceededFault "NodeQuotaForCustomerExceeded" The request cannot be processed because it would exceed the allowed number of cache nodes per customer.

  • ErrCodeInvalidKMSKeyFault "InvalidKMSKeyFault" The KMS key supplied is not valid.

  • ErrCodeInvalidParameterValueException "InvalidParameterValue" The value for a parameter is invalid.

  • ErrCodeInvalidParameterCombinationException "InvalidParameterCombination" Two or more incompatible parameters were specified.

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

func (*ElastiCache) ModifyReplicationGroupShardConfigurationRequest

func (c *ElastiCache) ModifyReplicationGroupShardConfigurationRequest(input *ModifyReplicationGroupShardConfigurationInput) (req *request.Request, output *ModifyReplicationGroupShardConfigurationOutput)

ModifyReplicationGroupShardConfigurationRequest generates a "aws/request.Request" representing the client's request for the ModifyReplicationGroupShardConfiguration operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ModifyReplicationGroupShardConfiguration for more information on using the ModifyReplicationGroupShardConfiguration API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ModifyReplicationGroupShardConfigurationRequest method.
req, resp := client.ModifyReplicationGroupShardConfigurationRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*ElastiCache) ModifyReplicationGroupShardConfigurationWithContext

func (c *ElastiCache) ModifyReplicationGroupShardConfigurationWithContext(ctx aws.Context, input *ModifyReplicationGroupShardConfigurationInput, opts ...request.Option) (*ModifyReplicationGroupShardConfigurationOutput, error)

ModifyReplicationGroupShardConfigurationWithContext is the same as ModifyReplicationGroupShardConfiguration with the addition of the ability to pass a context and additional request options.

See ModifyReplicationGroupShardConfiguration for details on how to use this API operation.

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 (*ElastiCache) ModifyReplicationGroupWithContext

func (c *ElastiCache) ModifyReplicationGroupWithContext(ctx aws.Context, input *ModifyReplicationGroupInput, opts ...request.Option) (*ModifyReplicationGroupOutput, error)

ModifyReplicationGroupWithContext is the same as ModifyReplicationGroup with the addition of the ability to pass a context and additional request options.

See ModifyReplicationGroup for details on how to use this API operation.

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 (*ElastiCache) ModifyUser

func (c *ElastiCache) ModifyUser(input *ModifyUserInput) (*ModifyUserOutput, error)

ModifyUser API operation for Amazon ElastiCache.

Changes user password(s) and/or access string.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon ElastiCache's API operation ModifyUser for usage and error information.

Returned Error Codes:

  • ErrCodeUserNotFoundFault "UserNotFound" The user does not exist or could not be found.

  • ErrCodeInvalidUserStateFault "InvalidUserState" The user is not in active state.

  • ErrCodeServiceLinkedRoleNotFoundFault "ServiceLinkedRoleNotFoundFault" The specified service linked role (SLR) was not found.

  • ErrCodeInvalidParameterValueException "InvalidParameterValue" The value for a parameter is invalid.

  • ErrCodeInvalidParameterCombinationException "InvalidParameterCombination" Two or more incompatible parameters were specified.

See also, https://docs.aws.amazon.com/goto/WebAPI/elasticache-2015-02-02/ModifyUser

func (*ElastiCache) ModifyUserGroup

func (c *ElastiCache) ModifyUserGroup(input *ModifyUserGroupInput) (*ModifyUserGroupOutput, error)

ModifyUserGroup API operation for Amazon ElastiCache.

Changes the list of users that belong to the user group.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon ElastiCache's API operation ModifyUserGroup for usage and error information.

Returned Error Codes:

  • ErrCodeUserGroupNotFoundFault "UserGroupNotFound" The user group was not found or does not exist

  • ErrCodeUserNotFoundFault "UserNotFound" The user does not exist or could not be found.

  • ErrCodeDuplicateUserNameFault "DuplicateUserName" A user with this username already exists.

  • ErrCodeServiceLinkedRoleNotFoundFault "ServiceLinkedRoleNotFoundFault" The specified service linked role (SLR) was not found.

  • ErrCodeDefaultUserRequired "DefaultUserRequired" You must add default user to a user group.

  • ErrCodeInvalidUserGroupStateFault "InvalidUserGroupState" The user group is not in an active state.

  • ErrCodeInvalidParameterValueException "InvalidParameterValue" The value for a parameter is invalid.

  • ErrCodeInvalidParameterCombinationException "InvalidParameterCombination" Two or more incompatible parameters were specified.

See also, https://docs.aws.amazon.com/goto/WebAPI/elasticache-2015-02-02/ModifyUserGroup

func (*ElastiCache) ModifyUserGroupRequest

func (c *ElastiCache) ModifyUserGroupRequest(input *ModifyUserGroupInput) (req *request.Request, output *ModifyUserGroupOutput)

ModifyUserGroupRequest generates a "aws/request.Request" representing the client's request for the ModifyUserGroup operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ModifyUserGroup for more information on using the ModifyUserGroup API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ModifyUserGroupRequest method.
req, resp := client.ModifyUserGroupRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/elasticache-2015-02-02/ModifyUserGroup

func (*ElastiCache) ModifyUserGroupWithContext

func (c *ElastiCache) ModifyUserGroupWithContext(ctx aws.Context, input *ModifyUserGroupInput, opts ...request.Option) (*ModifyUserGroupOutput, error)

ModifyUserGroupWithContext is the same as ModifyUserGroup with the addition of the ability to pass a context and additional request options.

See ModifyUserGroup for details on how to use this API operation.

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 (*ElastiCache) ModifyUserRequest

func (c *ElastiCache) ModifyUserRequest(input *ModifyUserInput) (req *request.Request, output *ModifyUserOutput)

ModifyUserRequest generates a "aws/request.Request" representing the client's request for the ModifyUser operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ModifyUser for more information on using the ModifyUser API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ModifyUserRequest method.
req, resp := client.ModifyUserRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/elasticache-2015-02-02/ModifyUser

func (*ElastiCache) ModifyUserWithContext

func (c *ElastiCache) ModifyUserWithContext(ctx aws.Context, input *ModifyUserInput, opts ...request.Option) (*ModifyUserOutput, error)

ModifyUserWithContext is the same as ModifyUser with the addition of the ability to pass a context and additional request options.

See ModifyUser for details on how to use this API operation.

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 (*ElastiCache) PurchaseReservedCacheNodesOffering

PurchaseReservedCacheNodesOffering API operation for Amazon ElastiCache.

Allows you to purchase a reserved cache node offering. Reserved nodes are not eligible for cancellation and are non-refundable. For more information, see Managing Costs with Reserved Nodes (https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/reserved-nodes.html) for Redis or Managing Costs with Reserved Nodes (https://docs.aws.amazon.com/AmazonElastiCache/latest/mem-ug/reserved-nodes.html) for Memcached.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon ElastiCache's API operation PurchaseReservedCacheNodesOffering for usage and error information.

Returned Error Codes:

  • ErrCodeReservedCacheNodesOfferingNotFoundFault "ReservedCacheNodesOfferingNotFound" The requested cache node offering does not exist.

  • ErrCodeReservedCacheNodeAlreadyExistsFault "ReservedCacheNodeAlreadyExists" You already have a reservation with the given identifier.

  • ErrCodeReservedCacheNodeQuotaExceededFault "ReservedCacheNodeQuotaExceeded" The request cannot be processed because it would exceed the user's cache node quota.

  • ErrCodeTagQuotaPerResourceExceeded "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.

  • ErrCodeInvalidParameterValueException "InvalidParameterValue" The value for a parameter is invalid.

  • ErrCodeInvalidParameterCombinationException "InvalidParameterCombination" Two or more incompatible parameters were specified.

See also, 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 (
	"fmt"

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

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

	result, err := svc.PurchaseReservedCacheNodesOffering(input)
	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.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 (*ElastiCache) PurchaseReservedCacheNodesOfferingRequest

func (c *ElastiCache) PurchaseReservedCacheNodesOfferingRequest(input *PurchaseReservedCacheNodesOfferingInput) (req *request.Request, output *PurchaseReservedCacheNodesOfferingOutput)

PurchaseReservedCacheNodesOfferingRequest generates a "aws/request.Request" representing the client's request for the PurchaseReservedCacheNodesOffering operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See PurchaseReservedCacheNodesOffering for more information on using the PurchaseReservedCacheNodesOffering API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the PurchaseReservedCacheNodesOfferingRequest method.
req, resp := client.PurchaseReservedCacheNodesOfferingRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*ElastiCache) PurchaseReservedCacheNodesOfferingWithContext

func (c *ElastiCache) PurchaseReservedCacheNodesOfferingWithContext(ctx aws.Context, input *PurchaseReservedCacheNodesOfferingInput, opts ...request.Option) (*PurchaseReservedCacheNodesOfferingOutput, error)

PurchaseReservedCacheNodesOfferingWithContext is the same as PurchaseReservedCacheNodesOffering with the addition of the ability to pass a context and additional request options.

See PurchaseReservedCacheNodesOffering for details on how to use this API operation.

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 (*ElastiCache) RebalanceSlotsInGlobalReplicationGroup

RebalanceSlotsInGlobalReplicationGroup API operation for Amazon ElastiCache.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon ElastiCache's API operation RebalanceSlotsInGlobalReplicationGroup for usage and error information.

Returned Error Codes:

  • ErrCodeGlobalReplicationGroupNotFoundFault "GlobalReplicationGroupNotFoundFault" The Global datastore does not exist

  • ErrCodeInvalidGlobalReplicationGroupStateFault "InvalidGlobalReplicationGroupState" The Global datastore is not available or in primary-only state.

  • ErrCodeInvalidParameterValueException "InvalidParameterValue" The value for a parameter is invalid.

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

func (*ElastiCache) RebalanceSlotsInGlobalReplicationGroupRequest

func (c *ElastiCache) RebalanceSlotsInGlobalReplicationGroupRequest(input *RebalanceSlotsInGlobalReplicationGroupInput) (req *request.Request, output *RebalanceSlotsInGlobalReplicationGroupOutput)

RebalanceSlotsInGlobalReplicationGroupRequest generates a "aws/request.Request" representing the client's request for the RebalanceSlotsInGlobalReplicationGroup operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See RebalanceSlotsInGlobalReplicationGroup for more information on using the RebalanceSlotsInGlobalReplicationGroup API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the RebalanceSlotsInGlobalReplicationGroupRequest method.
req, resp := client.RebalanceSlotsInGlobalReplicationGroupRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*ElastiCache) RebalanceSlotsInGlobalReplicationGroupWithContext

func (c *ElastiCache) RebalanceSlotsInGlobalReplicationGroupWithContext(ctx aws.Context, input *RebalanceSlotsInGlobalReplicationGroupInput, opts ...request.Option) (*RebalanceSlotsInGlobalReplicationGroupOutput, error)

RebalanceSlotsInGlobalReplicationGroupWithContext is the same as RebalanceSlotsInGlobalReplicationGroup with the addition of the ability to pass a context and additional request options.

See RebalanceSlotsInGlobalReplicationGroup for details on how to use this API operation.

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 (*ElastiCache) RebootCacheCluster

func (c *ElastiCache) RebootCacheCluster(input *RebootCacheClusterInput) (*RebootCacheClusterOutput, error)

RebootCacheCluster 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/nodes.rebooting.html) for an alternate process.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon ElastiCache's API operation RebootCacheCluster for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidCacheClusterStateFault "InvalidCacheClusterState" The requested cluster is not in the available state.

  • ErrCodeCacheClusterNotFoundFault "CacheClusterNotFound" The requested cluster ID does not refer to an existing cluster.

See also, 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 (
	"fmt"

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

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

	result, err := svc.RebootCacheCluster(input)
	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 (*ElastiCache) RebootCacheClusterRequest

func (c *ElastiCache) RebootCacheClusterRequest(input *RebootCacheClusterInput) (req *request.Request, output *RebootCacheClusterOutput)

RebootCacheClusterRequest generates a "aws/request.Request" representing the client's request for the RebootCacheCluster operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See RebootCacheCluster for more information on using the RebootCacheCluster API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the RebootCacheClusterRequest method.
req, resp := client.RebootCacheClusterRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*ElastiCache) RebootCacheClusterWithContext

func (c *ElastiCache) RebootCacheClusterWithContext(ctx aws.Context, input *RebootCacheClusterInput, opts ...request.Option) (*RebootCacheClusterOutput, error)

RebootCacheClusterWithContext is the same as RebootCacheCluster with the addition of the ability to pass a context and additional request options.

See RebootCacheCluster for details on how to use this API operation.

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 (*ElastiCache) RemoveTagsFromResource

func (c *ElastiCache) RemoveTagsFromResource(input *RemoveTagsFromResourceInput) (*TagListMessage, error)

RemoveTagsFromResource API operation for Amazon ElastiCache.

Removes the tags identified by the TagKeys list from the named resource. A tag is a key-value pair where the key and value are case-sensitive. You can use tags to categorize and track all your ElastiCache resources, with the exception of global replication group. When you add or remove tags on replication groups, those actions will be replicated to all nodes in the replication group. For more information, see Resource-level permissions (http://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/IAM.ResourceLevelPermissions.html).

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon ElastiCache's API operation RemoveTagsFromResource for usage and error information.

Returned Error Codes:

  • ErrCodeCacheClusterNotFoundFault "CacheClusterNotFound" The requested cluster ID does not refer to an existing cluster.

  • ErrCodeCacheParameterGroupNotFoundFault "CacheParameterGroupNotFound" The requested cache parameter group name does not refer to an existing cache parameter group.

  • ErrCodeCacheSecurityGroupNotFoundFault "CacheSecurityGroupNotFound" The requested cache security group name does not refer to an existing cache security group.

  • ErrCodeCacheSubnetGroupNotFoundFault "CacheSubnetGroupNotFoundFault" The requested cache subnet group name does not refer to an existing cache subnet group.

  • ErrCodeInvalidReplicationGroupStateFault "InvalidReplicationGroupState" The requested replication group is not in the available state.

  • ErrCodeReplicationGroupNotFoundFault "ReplicationGroupNotFoundFault" The specified replication group does not exist.

  • ErrCodeReservedCacheNodeNotFoundFault "ReservedCacheNodeNotFound" The requested reserved cache node was not found.

  • ErrCodeSnapshotNotFoundFault "SnapshotNotFoundFault" The requested snapshot name does not refer to an existing snapshot.

  • ErrCodeUserNotFoundFault "UserNotFound" The user does not exist or could not be found.

  • ErrCodeUserGroupNotFoundFault "UserGroupNotFound" The user group was not found or does not exist

  • ErrCodeInvalidARNFault "InvalidARN" The requested Amazon Resource Name (ARN) does not refer to an existing resource.

  • ErrCodeTagNotFoundFault "TagNotFound" The requested tag was not found on this resource.

See also, 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 (
	"fmt"

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

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

	result, err := svc.RemoveTagsFromResource(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case elasticache.ErrCodeCacheClusterNotFoundFault:
				fmt.Println(elasticache.ErrCodeCacheClusterNotFoundFault, aerr.Error())
			case elasticache.ErrCodeCacheParameterGroupNotFoundFault:
				fmt.Println(elasticache.ErrCodeCacheParameterGroupNotFoundFault, aerr.Error())
			case elasticache.ErrCodeCacheSecurityGroupNotFoundFault:
				fmt.Println(elasticache.ErrCodeCacheSecurityGroupNotFoundFault, aerr.Error())
			case elasticache.ErrCodeCacheSubnetGroupNotFoundFault:
				fmt.Println(elasticache.ErrCodeCacheSubnetGroupNotFoundFault, aerr.Error())
			case elasticache.ErrCodeInvalidReplicationGroupStateFault:
				fmt.Println(elasticache.ErrCodeInvalidReplicationGroupStateFault, aerr.Error())
			case elasticache.ErrCodeReplicationGroupNotFoundFault:
				fmt.Println(elasticache.ErrCodeReplicationGroupNotFoundFault, aerr.Error())
			case elasticache.ErrCodeReservedCacheNodeNotFoundFault:
				fmt.Println(elasticache.ErrCodeReservedCacheNodeNotFoundFault, aerr.Error())
			case elasticache.ErrCodeSnapshotNotFoundFault:
				fmt.Println(elasticache.ErrCodeSnapshotNotFoundFault, aerr.Error())
			case elasticache.ErrCodeUserNotFoundFault:
				fmt.Println(elasticache.ErrCodeUserNotFoundFault, aerr.Error())
			case elasticache.ErrCodeUserGroupNotFoundFault:
				fmt.Println(elasticache.ErrCodeUserGroupNotFoundFault, 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 (*ElastiCache) RemoveTagsFromResourceRequest

func (c *ElastiCache) RemoveTagsFromResourceRequest(input *RemoveTagsFromResourceInput) (req *request.Request, output *TagListMessage)

RemoveTagsFromResourceRequest generates a "aws/request.Request" representing the client's request for the RemoveTagsFromResource operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See RemoveTagsFromResource for more information on using the RemoveTagsFromResource API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the RemoveTagsFromResourceRequest method.
req, resp := client.RemoveTagsFromResourceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*ElastiCache) RemoveTagsFromResourceWithContext

func (c *ElastiCache) RemoveTagsFromResourceWithContext(ctx aws.Context, input *RemoveTagsFromResourceInput, opts ...request.Option) (*TagListMessage, error)

RemoveTagsFromResourceWithContext is the same as RemoveTagsFromResource with the addition of the ability to pass a context and additional request options.

See RemoveTagsFromResource for details on how to use this API operation.

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 (*ElastiCache) ResetCacheParameterGroup

func (c *ElastiCache) ResetCacheParameterGroup(input *ResetCacheParameterGroupInput) (*CacheParameterGroupNameMessage, error)

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon ElastiCache's API operation ResetCacheParameterGroup for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidCacheParameterGroupStateFault "InvalidCacheParameterGroupState" The current state of the cache parameter group does not allow the requested operation to occur.

  • ErrCodeCacheParameterGroupNotFoundFault "CacheParameterGroupNotFound" The requested cache parameter group name does not refer to an existing cache parameter group.

  • ErrCodeInvalidParameterValueException "InvalidParameterValue" The value for a parameter is invalid.

  • ErrCodeInvalidParameterCombinationException "InvalidParameterCombination" Two or more incompatible parameters were specified.

  • ErrCodeInvalidGlobalReplicationGroupStateFault "InvalidGlobalReplicationGroupState" The Global datastore is not available or in primary-only state.

See also, 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 (
	"fmt"

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

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

	result, err := svc.ResetCacheParameterGroup(input)
	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 (*ElastiCache) ResetCacheParameterGroupRequest

func (c *ElastiCache) ResetCacheParameterGroupRequest(input *ResetCacheParameterGroupInput) (req *request.Request, output *CacheParameterGroupNameMessage)

ResetCacheParameterGroupRequest generates a "aws/request.Request" representing the client's request for the ResetCacheParameterGroup operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ResetCacheParameterGroup for more information on using the ResetCacheParameterGroup API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ResetCacheParameterGroupRequest method.
req, resp := client.ResetCacheParameterGroupRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*ElastiCache) ResetCacheParameterGroupWithContext

func (c *ElastiCache) ResetCacheParameterGroupWithContext(ctx aws.Context, input *ResetCacheParameterGroupInput, opts ...request.Option) (*CacheParameterGroupNameMessage, error)

ResetCacheParameterGroupWithContext is the same as ResetCacheParameterGroup with the addition of the ability to pass a context and additional request options.

See ResetCacheParameterGroup for details on how to use this API operation.

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 (*ElastiCache) RevokeCacheSecurityGroupIngress

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon ElastiCache's API operation RevokeCacheSecurityGroupIngress for usage and error information.

Returned Error Codes:

  • ErrCodeCacheSecurityGroupNotFoundFault "CacheSecurityGroupNotFound" The requested cache security group name does not refer to an existing cache security group.

  • ErrCodeAuthorizationNotFoundFault "AuthorizationNotFound" The specified Amazon EC2 security group is not authorized for the specified cache security group.

  • ErrCodeInvalidCacheSecurityGroupStateFault "InvalidCacheSecurityGroupState" The current state of the cache security group does not allow deletion.

  • ErrCodeInvalidParameterValueException "InvalidParameterValue" The value for a parameter is invalid.

  • ErrCodeInvalidParameterCombinationException "InvalidParameterCombination" Two or more incompatible parameters were specified.

See also, 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 (
	"fmt"

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

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

	result, err := svc.RevokeCacheSecurityGroupIngress(input)
	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 (*ElastiCache) RevokeCacheSecurityGroupIngressRequest

func (c *ElastiCache) RevokeCacheSecurityGroupIngressRequest(input *RevokeCacheSecurityGroupIngressInput) (req *request.Request, output *RevokeCacheSecurityGroupIngressOutput)

RevokeCacheSecurityGroupIngressRequest generates a "aws/request.Request" representing the client's request for the RevokeCacheSecurityGroupIngress operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See RevokeCacheSecurityGroupIngress for more information on using the RevokeCacheSecurityGroupIngress API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the RevokeCacheSecurityGroupIngressRequest method.
req, resp := client.RevokeCacheSecurityGroupIngressRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*ElastiCache) RevokeCacheSecurityGroupIngressWithContext

func (c *ElastiCache) RevokeCacheSecurityGroupIngressWithContext(ctx aws.Context, input *RevokeCacheSecurityGroupIngressInput, opts ...request.Option) (*RevokeCacheSecurityGroupIngressOutput, error)

RevokeCacheSecurityGroupIngressWithContext is the same as RevokeCacheSecurityGroupIngress with the addition of the ability to pass a context and additional request options.

See RevokeCacheSecurityGroupIngress for details on how to use this API operation.

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 (*ElastiCache) StartMigration

func (c *ElastiCache) StartMigration(input *StartMigrationInput) (*StartMigrationOutput, error)

StartMigration API operation for Amazon ElastiCache.

Start the migration of data.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon ElastiCache's API operation StartMigration for usage and error information.

Returned Error Codes:

  • ErrCodeReplicationGroupNotFoundFault "ReplicationGroupNotFoundFault" The specified replication group does not exist.

  • ErrCodeInvalidReplicationGroupStateFault "InvalidReplicationGroupState" The requested replication group is not in the available state.

  • ErrCodeReplicationGroupAlreadyUnderMigrationFault "ReplicationGroupAlreadyUnderMigrationFault" The targeted replication group is not available.

  • ErrCodeInvalidParameterValueException "InvalidParameterValue" The value for a parameter is invalid.

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

func (*ElastiCache) StartMigrationRequest

func (c *ElastiCache) StartMigrationRequest(input *StartMigrationInput) (req *request.Request, output *StartMigrationOutput)

StartMigrationRequest generates a "aws/request.Request" representing the client's request for the StartMigration operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See StartMigration for more information on using the StartMigration API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the StartMigrationRequest method.
req, resp := client.StartMigrationRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*ElastiCache) StartMigrationWithContext

func (c *ElastiCache) StartMigrationWithContext(ctx aws.Context, input *StartMigrationInput, opts ...request.Option) (*StartMigrationOutput, error)

StartMigrationWithContext is the same as StartMigration with the addition of the ability to pass a context and additional request options.

See StartMigration for details on how to use this API operation.

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 (*ElastiCache) TestFailover

func (c *ElastiCache) TestFailover(input *TestFailoverInput) (*TestFailoverOutput, error)

TestFailover 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).

This API is designed for testing the behavior of your application in case of ElastiCache failover. It is not designed to be an operational tool for initiating a failover to overcome a problem you may have with the cluster. Moreover, in certain conditions such as large-scale operational events, Amazon may block this API.

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 Amazon 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 Amazon 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 primary node <primary-node-id> to replica node <node-id> completed Replication group message: Failover from primary 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.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon ElastiCache's API operation TestFailover for usage and error information.

Returned Error Codes:

  • ErrCodeAPICallRateForCustomerExceededFault "APICallRateForCustomerExceeded" The customer has exceeded the allowed rate of API calls.

  • ErrCodeInvalidCacheClusterStateFault "InvalidCacheClusterState" The requested cluster is not in the available state.

  • ErrCodeInvalidReplicationGroupStateFault "InvalidReplicationGroupState" The requested replication group is not in the available state.

  • ErrCodeNodeGroupNotFoundFault "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.

  • ErrCodeReplicationGroupNotFoundFault "ReplicationGroupNotFoundFault" The specified replication group does not exist.

  • ErrCodeTestFailoverNotAvailableFault "TestFailoverNotAvailableFault" The TestFailover action is not available.

  • ErrCodeInvalidKMSKeyFault "InvalidKMSKeyFault" The KMS key supplied is not valid.

  • ErrCodeInvalidParameterValueException "InvalidParameterValue" The value for a parameter is invalid.

  • ErrCodeInvalidParameterCombinationException "InvalidParameterCombination" Two or more incompatible parameters were specified.

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

func (*ElastiCache) TestFailoverRequest

func (c *ElastiCache) TestFailoverRequest(input *TestFailoverInput) (req *request.Request, output *TestFailoverOutput)

TestFailoverRequest generates a "aws/request.Request" representing the client's request for the TestFailover operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See TestFailover for more information on using the TestFailover API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the TestFailoverRequest method.
req, resp := client.TestFailoverRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*ElastiCache) TestFailoverWithContext

func (c *ElastiCache) TestFailoverWithContext(ctx aws.Context, input *TestFailoverInput, opts ...request.Option) (*TestFailoverOutput, error)

TestFailoverWithContext is the same as TestFailover with the addition of the ability to pass a context and additional request options.

See TestFailover for details on how to use this API operation.

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 (*ElastiCache) WaitUntilCacheClusterAvailable

func (c *ElastiCache) WaitUntilCacheClusterAvailable(input *DescribeCacheClustersInput) 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.

func (*ElastiCache) WaitUntilCacheClusterAvailableWithContext

func (c *ElastiCache) WaitUntilCacheClusterAvailableWithContext(ctx aws.Context, input *DescribeCacheClustersInput, opts ...request.WaiterOption) error

WaitUntilCacheClusterAvailableWithContext is an extended version of WaitUntilCacheClusterAvailable. With the support for passing in a context and options to configure the Waiter and the underlying request options.

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 (*ElastiCache) WaitUntilCacheClusterDeleted

func (c *ElastiCache) WaitUntilCacheClusterDeleted(input *DescribeCacheClustersInput) 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.

func (*ElastiCache) WaitUntilCacheClusterDeletedWithContext

func (c *ElastiCache) WaitUntilCacheClusterDeletedWithContext(ctx aws.Context, input *DescribeCacheClustersInput, opts ...request.WaiterOption) error

WaitUntilCacheClusterDeletedWithContext is an extended version of WaitUntilCacheClusterDeleted. With the support for passing in a context and options to configure the Waiter and the underlying request options.

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 (*ElastiCache) WaitUntilReplicationGroupAvailable

func (c *ElastiCache) WaitUntilReplicationGroupAvailable(input *DescribeReplicationGroupsInput) 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.

func (*ElastiCache) WaitUntilReplicationGroupAvailableWithContext

func (c *ElastiCache) WaitUntilReplicationGroupAvailableWithContext(ctx aws.Context, input *DescribeReplicationGroupsInput, opts ...request.WaiterOption) error

WaitUntilReplicationGroupAvailableWithContext is an extended version of WaitUntilReplicationGroupAvailable. With the support for passing in a context and options to configure the Waiter and the underlying request options.

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 (*ElastiCache) WaitUntilReplicationGroupDeleted

func (c *ElastiCache) WaitUntilReplicationGroupDeleted(input *DescribeReplicationGroupsInput) 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.

func (*ElastiCache) WaitUntilReplicationGroupDeletedWithContext

func (c *ElastiCache) WaitUntilReplicationGroupDeletedWithContext(ctx aws.Context, input *DescribeReplicationGroupsInput, opts ...request.WaiterOption) error

WaitUntilReplicationGroupDeletedWithContext is an extended version of WaitUntilReplicationGroupDeleted. With the support for passing in a context and options to configure the Waiter and the underlying request options.

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 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) GoString

func (s Endpoint) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Endpoint) SetAddress

func (s *Endpoint) SetAddress(v string) *Endpoint

SetAddress sets the Address field's value.

func (*Endpoint) SetPort

func (s *Endpoint) SetPort(v int64) *Endpoint

SetPort sets the Port field's value.

func (Endpoint) String

func (s Endpoint) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 | memcached1.6 | redis2.6 |
	// redis2.8 | redis3.2 | redis4.0 | redis5.0 | redis6.0 | redis6.x | redis7
	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) GoString

func (s EngineDefaults) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*EngineDefaults) SetCacheNodeTypeSpecificParameters

func (s *EngineDefaults) SetCacheNodeTypeSpecificParameters(v []*CacheNodeTypeSpecificParameter) *EngineDefaults

SetCacheNodeTypeSpecificParameters sets the CacheNodeTypeSpecificParameters field's value.

func (*EngineDefaults) SetCacheParameterGroupFamily

func (s *EngineDefaults) SetCacheParameterGroupFamily(v string) *EngineDefaults

SetCacheParameterGroupFamily sets the CacheParameterGroupFamily field's value.

func (*EngineDefaults) SetMarker

func (s *EngineDefaults) SetMarker(v string) *EngineDefaults

SetMarker sets the Marker field's value.

func (*EngineDefaults) SetParameters

func (s *EngineDefaults) SetParameters(v []*Parameter) *EngineDefaults

SetParameters sets the Parameters field's value.

func (EngineDefaults) String

func (s EngineDefaults) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 *string `type:"string" enum:"SourceType"`
	// 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) GoString

func (s Event) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Event) SetDate

func (s *Event) SetDate(v time.Time) *Event

SetDate sets the Date field's value.

func (*Event) SetMessage

func (s *Event) SetMessage(v string) *Event

SetMessage sets the Message field's value.

func (*Event) SetSourceIdentifier

func (s *Event) SetSourceIdentifier(v string) *Event

SetSourceIdentifier sets the SourceIdentifier field's value.

func (*Event) SetSourceType

func (s *Event) SetSourceType(v string) *Event

SetSourceType sets the SourceType field's value.

func (Event) String

func (s Event) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type FailoverGlobalReplicationGroupInput

type FailoverGlobalReplicationGroupInput struct {

	// The name of the Global datastore
	//
	// GlobalReplicationGroupId is a required field
	GlobalReplicationGroupId *string `type:"string" required:"true"`

	// The Amazon 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) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*FailoverGlobalReplicationGroupInput) SetGlobalReplicationGroupId

SetGlobalReplicationGroupId sets the GlobalReplicationGroupId field's value.

func (*FailoverGlobalReplicationGroupInput) SetPrimaryRegion

SetPrimaryRegion sets the PrimaryRegion field's value.

func (*FailoverGlobalReplicationGroupInput) SetPrimaryReplicationGroupId

SetPrimaryReplicationGroupId sets the PrimaryReplicationGroupId field's value.

func (FailoverGlobalReplicationGroupInput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*FailoverGlobalReplicationGroupInput) Validate

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

type FailoverGlobalReplicationGroupOutput

type FailoverGlobalReplicationGroupOutput struct {

	// Consists of a primary cluster that accepts writes and an associated secondary
	// cluster that resides in a different Amazon 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) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*FailoverGlobalReplicationGroupOutput) SetGlobalReplicationGroup

SetGlobalReplicationGroup sets the GlobalReplicationGroup field's value.

func (FailoverGlobalReplicationGroupOutput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type Filter

type Filter struct {

	// The property being filtered. For example, UserId.
	//
	// Name is a required field
	Name *string `type:"string" required:"true"`

	// The property values to filter on. For example, "user-123".
	//
	// Values is a required field
	Values []*string `min:"1" type:"list" required:"true"`
	// contains filtered or unexported fields
}

Used to streamline results of a search based on the property being filtered.

func (Filter) GoString

func (s Filter) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Filter) SetName

func (s *Filter) SetName(v string) *Filter

SetName sets the Name field's value.

func (*Filter) SetValues

func (s *Filter) SetValues(v []*string) *Filter

SetValues sets the Values field's value.

func (Filter) String

func (s Filter) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Filter) Validate

func (s *Filter) Validate() error

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

type GlobalNodeGroup

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) GoString

func (s GlobalNodeGroup) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GlobalNodeGroup) SetGlobalNodeGroupId

func (s *GlobalNodeGroup) SetGlobalNodeGroupId(v string) *GlobalNodeGroup

SetGlobalNodeGroupId sets the GlobalNodeGroupId field's value.

func (*GlobalNodeGroup) SetSlots

func (s *GlobalNodeGroup) SetSlots(v string) *GlobalNodeGroup

SetSlots sets the Slots field's value.

func (GlobalNodeGroup) String

func (s GlobalNodeGroup) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GlobalReplicationGroup

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.
	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.
	//
	// Required: Only available when creating a replication group in an Amazon VPC
	// using redis version 3.2.6, 4.x or later.
	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 Amazon 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) GoString

func (s GlobalReplicationGroup) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GlobalReplicationGroup) SetARN

SetARN sets the ARN field's value.

func (*GlobalReplicationGroup) SetAtRestEncryptionEnabled

func (s *GlobalReplicationGroup) SetAtRestEncryptionEnabled(v bool) *GlobalReplicationGroup

SetAtRestEncryptionEnabled sets the AtRestEncryptionEnabled field's value.

func (*GlobalReplicationGroup) SetAuthTokenEnabled

func (s *GlobalReplicationGroup) SetAuthTokenEnabled(v bool) *GlobalReplicationGroup

SetAuthTokenEnabled sets the AuthTokenEnabled field's value.

func (*GlobalReplicationGroup) SetCacheNodeType

func (s *GlobalReplicationGroup) SetCacheNodeType(v string) *GlobalReplicationGroup

SetCacheNodeType sets the CacheNodeType field's value.

func (*GlobalReplicationGroup) SetClusterEnabled

func (s *GlobalReplicationGroup) SetClusterEnabled(v bool) *GlobalReplicationGroup

SetClusterEnabled sets the ClusterEnabled field's value.

func (*GlobalReplicationGroup) SetEngine

SetEngine sets the Engine field's value.

func (*GlobalReplicationGroup) SetEngineVersion

func (s *GlobalReplicationGroup) SetEngineVersion(v string) *GlobalReplicationGroup

SetEngineVersion sets the EngineVersion field's value.

func (*GlobalReplicationGroup) SetGlobalNodeGroups

func (s *GlobalReplicationGroup) SetGlobalNodeGroups(v []*GlobalNodeGroup) *GlobalReplicationGroup

SetGlobalNodeGroups sets the GlobalNodeGroups field's value.

func (*GlobalReplicationGroup) SetGlobalReplicationGroupDescription

func (s *GlobalReplicationGroup) SetGlobalReplicationGroupDescription(v string) *GlobalReplicationGroup

SetGlobalReplicationGroupDescription sets the GlobalReplicationGroupDescription field's value.

func (*GlobalReplicationGroup) SetGlobalReplicationGroupId

func (s *GlobalReplicationGroup) SetGlobalReplicationGroupId(v string) *GlobalReplicationGroup

SetGlobalReplicationGroupId sets the GlobalReplicationGroupId field's value.

func (*GlobalReplicationGroup) SetMembers

SetMembers sets the Members field's value.

func (*GlobalReplicationGroup) SetStatus

SetStatus sets the Status field's value.

func (*GlobalReplicationGroup) SetTransitEncryptionEnabled

func (s *GlobalReplicationGroup) SetTransitEncryptionEnabled(v bool) *GlobalReplicationGroup

SetTransitEncryptionEnabled sets the TransitEncryptionEnabled field's value.

func (GlobalReplicationGroup) String

func (s GlobalReplicationGroup) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GlobalReplicationGroupInfo

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) GoString

func (s GlobalReplicationGroupInfo) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GlobalReplicationGroupInfo) SetGlobalReplicationGroupId

func (s *GlobalReplicationGroupInfo) SetGlobalReplicationGroupId(v string) *GlobalReplicationGroupInfo

SetGlobalReplicationGroupId sets the GlobalReplicationGroupId field's value.

func (*GlobalReplicationGroupInfo) SetGlobalReplicationGroupMemberRole

func (s *GlobalReplicationGroupInfo) SetGlobalReplicationGroupMemberRole(v string) *GlobalReplicationGroupInfo

SetGlobalReplicationGroupMemberRole sets the GlobalReplicationGroupMemberRole field's value.

func (GlobalReplicationGroupInfo) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GlobalReplicationGroupMember

type GlobalReplicationGroupMember struct {

	// Indicates whether automatic failover is enabled for the replication group.
	AutomaticFailover *string `type:"string" enum:"AutomaticFailoverStatus"`

	// The replication group id of the Global datastore member.
	ReplicationGroupId *string `type:"string"`

	// The Amazon 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 Amazon region and the role of the replication group.

func (GlobalReplicationGroupMember) GoString

func (s GlobalReplicationGroupMember) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GlobalReplicationGroupMember) SetAutomaticFailover

SetAutomaticFailover sets the AutomaticFailover field's value.

func (*GlobalReplicationGroupMember) SetReplicationGroupId

SetReplicationGroupId sets the ReplicationGroupId field's value.

func (*GlobalReplicationGroupMember) SetReplicationGroupRegion

func (s *GlobalReplicationGroupMember) SetReplicationGroupRegion(v string) *GlobalReplicationGroupMember

SetReplicationGroupRegion sets the ReplicationGroupRegion field's value.

func (*GlobalReplicationGroupMember) SetRole

SetRole sets the Role field's value.

func (*GlobalReplicationGroupMember) SetStatus

SetStatus sets the Status field's value.

func (GlobalReplicationGroupMember) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type IncreaseNodeGroupsInGlobalReplicationGroupInput

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 Amazon 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) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*IncreaseNodeGroupsInGlobalReplicationGroupInput) SetApplyImmediately

SetApplyImmediately sets the ApplyImmediately field's value.

func (*IncreaseNodeGroupsInGlobalReplicationGroupInput) SetGlobalReplicationGroupId

SetGlobalReplicationGroupId sets the GlobalReplicationGroupId field's value.

func (*IncreaseNodeGroupsInGlobalReplicationGroupInput) SetNodeGroupCount

SetNodeGroupCount sets the NodeGroupCount field's value.

func (*IncreaseNodeGroupsInGlobalReplicationGroupInput) SetRegionalConfigurations

SetRegionalConfigurations sets the RegionalConfigurations field's value.

func (IncreaseNodeGroupsInGlobalReplicationGroupInput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*IncreaseNodeGroupsInGlobalReplicationGroupInput) Validate

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

type IncreaseNodeGroupsInGlobalReplicationGroupOutput

type IncreaseNodeGroupsInGlobalReplicationGroupOutput struct {

	// Consists of a primary cluster that accepts writes and an associated secondary
	// cluster that resides in a different Amazon 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) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*IncreaseNodeGroupsInGlobalReplicationGroupOutput) SetGlobalReplicationGroup

SetGlobalReplicationGroup sets the GlobalReplicationGroup field's value.

func (IncreaseNodeGroupsInGlobalReplicationGroupOutput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type IncreaseReplicaCountInput

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) GoString

func (s IncreaseReplicaCountInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*IncreaseReplicaCountInput) SetApplyImmediately

func (s *IncreaseReplicaCountInput) SetApplyImmediately(v bool) *IncreaseReplicaCountInput

SetApplyImmediately sets the ApplyImmediately field's value.

func (*IncreaseReplicaCountInput) SetNewReplicaCount

func (s *IncreaseReplicaCountInput) SetNewReplicaCount(v int64) *IncreaseReplicaCountInput

SetNewReplicaCount sets the NewReplicaCount field's value.

func (*IncreaseReplicaCountInput) SetReplicaConfiguration

func (s *IncreaseReplicaCountInput) SetReplicaConfiguration(v []*ConfigureShard) *IncreaseReplicaCountInput

SetReplicaConfiguration sets the ReplicaConfiguration field's value.

func (*IncreaseReplicaCountInput) SetReplicationGroupId

func (s *IncreaseReplicaCountInput) SetReplicationGroupId(v string) *IncreaseReplicaCountInput

SetReplicationGroupId sets the ReplicationGroupId field's value.

func (IncreaseReplicaCountInput) String

func (s IncreaseReplicaCountInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*IncreaseReplicaCountInput) Validate

func (s *IncreaseReplicaCountInput) Validate() error

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

type IncreaseReplicaCountOutput

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) GoString

func (s IncreaseReplicaCountOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*IncreaseReplicaCountOutput) SetReplicationGroup

SetReplicationGroup sets the ReplicationGroup field's value.

func (IncreaseReplicaCountOutput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type KinesisFirehoseDestinationDetails

type KinesisFirehoseDestinationDetails struct {

	// The name of the Kinesis Data Firehose delivery stream.
	DeliveryStream *string `type:"string"`
	// contains filtered or unexported fields
}

The configuration details of the Kinesis Data Firehose destination.

func (KinesisFirehoseDestinationDetails) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*KinesisFirehoseDestinationDetails) SetDeliveryStream

SetDeliveryStream sets the DeliveryStream field's value.

func (KinesisFirehoseDestinationDetails) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListAllowedNodeTypeModificationsInput) SetCacheClusterId

SetCacheClusterId sets the CacheClusterId field's value.

func (*ListAllowedNodeTypeModificationsInput) SetReplicationGroupId

SetReplicationGroupId sets the ReplicationGroupId field's value.

func (ListAllowedNodeTypeModificationsInput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListAllowedNodeTypeModificationsOutput) SetScaleDownModifications

SetScaleDownModifications sets the ScaleDownModifications field's value.

func (*ListAllowedNodeTypeModificationsOutput) SetScaleUpModifications

SetScaleUpModifications sets the ScaleUpModifications field's value.

func (ListAllowedNodeTypeModificationsOutput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 Amazon
	// Web Services 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) GoString

func (s ListTagsForResourceInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListTagsForResourceInput) SetResourceName

SetResourceName sets the ResourceName field's value.

func (ListTagsForResourceInput) String

func (s ListTagsForResourceInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListTagsForResourceInput) Validate

func (s *ListTagsForResourceInput) Validate() error

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

type LogDeliveryConfiguration

type LogDeliveryConfiguration struct {

	// Configuration details of either a CloudWatch Logs destination or Kinesis
	// Data Firehose destination.
	DestinationDetails *DestinationDetails `type:"structure"`

	// Returns the destination type, either cloudwatch-logs or kinesis-firehose.
	DestinationType *string `type:"string" enum:"DestinationType"`

	// Returns the log format, either JSON or TEXT.
	LogFormat *string `type:"string" enum:"LogFormat"`

	// Refers to slow-log (https://redis.io/commands/slowlog) or engine-log.
	LogType *string `type:"string" enum:"LogType"`

	// Returns an error message for the log delivery configuration.
	Message *string `type:"string"`

	// Returns the log delivery configuration status. Values are one of enabling
	// | disabling | modifying | active | error
	Status *string `type:"string" enum:"LogDeliveryConfigurationStatus"`
	// contains filtered or unexported fields
}

Returns the destination, format and type of the logs.

func (LogDeliveryConfiguration) GoString

func (s LogDeliveryConfiguration) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*LogDeliveryConfiguration) SetDestinationDetails

SetDestinationDetails sets the DestinationDetails field's value.

func (*LogDeliveryConfiguration) SetDestinationType

func (s *LogDeliveryConfiguration) SetDestinationType(v string) *LogDeliveryConfiguration

SetDestinationType sets the DestinationType field's value.

func (*LogDeliveryConfiguration) SetLogFormat

SetLogFormat sets the LogFormat field's value.

func (*LogDeliveryConfiguration) SetLogType

SetLogType sets the LogType field's value.

func (*LogDeliveryConfiguration) SetMessage

SetMessage sets the Message field's value.

func (*LogDeliveryConfiguration) SetStatus

SetStatus sets the Status field's value.

func (LogDeliveryConfiguration) String

func (s LogDeliveryConfiguration) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type LogDeliveryConfigurationRequest

type LogDeliveryConfigurationRequest struct {

	// Configuration details of either a CloudWatch Logs destination or Kinesis
	// Data Firehose destination.
	DestinationDetails *DestinationDetails `type:"structure"`

	// Specify either cloudwatch-logs or kinesis-firehose as the destination type.
	DestinationType *string `type:"string" enum:"DestinationType"`

	// Specify if log delivery is enabled. Default true.
	Enabled *bool `type:"boolean"`

	// Specifies either JSON or TEXT
	LogFormat *string `type:"string" enum:"LogFormat"`

	// Refers to slow-log (https://redis.io/commands/slowlog) or engine-log..
	LogType *string `type:"string" enum:"LogType"`
	// contains filtered or unexported fields
}

Specifies the destination, format and type of the logs.

func (LogDeliveryConfigurationRequest) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*LogDeliveryConfigurationRequest) SetDestinationDetails

SetDestinationDetails sets the DestinationDetails field's value.

func (*LogDeliveryConfigurationRequest) SetDestinationType

SetDestinationType sets the DestinationType field's value.

func (*LogDeliveryConfigurationRequest) SetEnabled

SetEnabled sets the Enabled field's value.

func (*LogDeliveryConfigurationRequest) SetLogFormat

SetLogFormat sets the LogFormat field's value.

func (*LogDeliveryConfigurationRequest) SetLogType

SetLogType sets the LogType field's value.

func (LogDeliveryConfigurationRequest) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 *string `type:"string" enum:"AZMode"`

	// 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 (http://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/auth.html)
	AuthTokenUpdateStrategy *string `type:"string" enum:"AuthTokenUpdateStrategyType"`

	// If you are running Redis engine version 6.0 or later, set this parameter
	// to yes if you want to opt-in to the next auto minor version upgrade campaign.
	// This parameter is disabled for previous versions.
	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 network type you choose when modifying a cluster, either ipv4 | ipv6.
	// IPv6 is supported for workloads using Redis engine version 6.2 onward or
	// Memcached engine version 1.6.6 on all instances built on the Nitro system
	// (http://aws.amazon.com/ec2/nitro/).
	IpDiscovery *string `type:"string" enum:"IpDiscovery"`

	// Specifies the destination, format and type of the logs.
	LogDeliveryConfigurations []*LogDeliveryConfigurationRequest `locationNameList:"LogDeliveryConfigurationRequest" type:"list"`

	//
	// This option is only supported on Memcached clusters.
	//
	// 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.
	//
	// 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 40.
	//
	// 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) GoString

func (s ModifyCacheClusterInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ModifyCacheClusterInput) SetAZMode

SetAZMode sets the AZMode field's value.

func (*ModifyCacheClusterInput) SetApplyImmediately

func (s *ModifyCacheClusterInput) SetApplyImmediately(v bool) *ModifyCacheClusterInput

SetApplyImmediately sets the ApplyImmediately field's value.

func (*ModifyCacheClusterInput) SetAuthToken

SetAuthToken sets the AuthToken field's value.

func (*ModifyCacheClusterInput) SetAuthTokenUpdateStrategy

func (s *ModifyCacheClusterInput) SetAuthTokenUpdateStrategy(v string) *ModifyCacheClusterInput

SetAuthTokenUpdateStrategy sets the AuthTokenUpdateStrategy field's value.

func (*ModifyCacheClusterInput) SetAutoMinorVersionUpgrade

func (s *ModifyCacheClusterInput) SetAutoMinorVersionUpgrade(v bool) *ModifyCacheClusterInput

SetAutoMinorVersionUpgrade sets the AutoMinorVersionUpgrade field's value.

func (*ModifyCacheClusterInput) SetCacheClusterId

func (s *ModifyCacheClusterInput) SetCacheClusterId(v string) *ModifyCacheClusterInput

SetCacheClusterId sets the CacheClusterId field's value.

func (*ModifyCacheClusterInput) SetCacheNodeIdsToRemove

func (s *ModifyCacheClusterInput) SetCacheNodeIdsToRemove(v []*string) *ModifyCacheClusterInput

SetCacheNodeIdsToRemove sets the CacheNodeIdsToRemove field's value.

func (*ModifyCacheClusterInput) SetCacheNodeType

func (s *ModifyCacheClusterInput) SetCacheNodeType(v string) *ModifyCacheClusterInput

SetCacheNodeType sets the CacheNodeType field's value.

func (*ModifyCacheClusterInput) SetCacheParameterGroupName

func (s *ModifyCacheClusterInput) SetCacheParameterGroupName(v string) *ModifyCacheClusterInput

SetCacheParameterGroupName sets the CacheParameterGroupName field's value.

func (*ModifyCacheClusterInput) SetCacheSecurityGroupNames

func (s *ModifyCacheClusterInput) SetCacheSecurityGroupNames(v []*string) *ModifyCacheClusterInput

SetCacheSecurityGroupNames sets the CacheSecurityGroupNames field's value.

func (*ModifyCacheClusterInput) SetEngineVersion

func (s *ModifyCacheClusterInput) SetEngineVersion(v string) *ModifyCacheClusterInput

SetEngineVersion sets the EngineVersion field's value.

func (*ModifyCacheClusterInput) SetIpDiscovery added in v1.42.9

SetIpDiscovery sets the IpDiscovery field's value.

func (*ModifyCacheClusterInput) SetLogDeliveryConfigurations

SetLogDeliveryConfigurations sets the LogDeliveryConfigurations field's value.

func (*ModifyCacheClusterInput) SetNewAvailabilityZones

func (s *ModifyCacheClusterInput) SetNewAvailabilityZones(v []*string) *ModifyCacheClusterInput

SetNewAvailabilityZones sets the NewAvailabilityZones field's value.

func (*ModifyCacheClusterInput) SetNotificationTopicArn

func (s *ModifyCacheClusterInput) SetNotificationTopicArn(v string) *ModifyCacheClusterInput

SetNotificationTopicArn sets the NotificationTopicArn field's value.

func (*ModifyCacheClusterInput) SetNotificationTopicStatus

func (s *ModifyCacheClusterInput) SetNotificationTopicStatus(v string) *ModifyCacheClusterInput

SetNotificationTopicStatus sets the NotificationTopicStatus field's value.

func (*ModifyCacheClusterInput) SetNumCacheNodes

func (s *ModifyCacheClusterInput) SetNumCacheNodes(v int64) *ModifyCacheClusterInput

SetNumCacheNodes sets the NumCacheNodes field's value.

func (*ModifyCacheClusterInput) SetPreferredMaintenanceWindow

func (s *ModifyCacheClusterInput) SetPreferredMaintenanceWindow(v string) *ModifyCacheClusterInput

SetPreferredMaintenanceWindow sets the PreferredMaintenanceWindow field's value.

func (*ModifyCacheClusterInput) SetSecurityGroupIds

func (s *ModifyCacheClusterInput) SetSecurityGroupIds(v []*string) *ModifyCacheClusterInput

SetSecurityGroupIds sets the SecurityGroupIds field's value.

func (*ModifyCacheClusterInput) SetSnapshotRetentionLimit

func (s *ModifyCacheClusterInput) SetSnapshotRetentionLimit(v int64) *ModifyCacheClusterInput

SetSnapshotRetentionLimit sets the SnapshotRetentionLimit field's value.

func (*ModifyCacheClusterInput) SetSnapshotWindow

func (s *ModifyCacheClusterInput) SetSnapshotWindow(v string) *ModifyCacheClusterInput

SetSnapshotWindow sets the SnapshotWindow field's value.

func (ModifyCacheClusterInput) String

func (s ModifyCacheClusterInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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) GoString

func (s ModifyCacheClusterOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ModifyCacheClusterOutput) SetCacheCluster

SetCacheCluster sets the CacheCluster field's value.

func (ModifyCacheClusterOutput) String

func (s ModifyCacheClusterOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ModifyCacheParameterGroupInput) SetCacheParameterGroupName

func (s *ModifyCacheParameterGroupInput) SetCacheParameterGroupName(v string) *ModifyCacheParameterGroupInput

SetCacheParameterGroupName sets the CacheParameterGroupName field's value.

func (*ModifyCacheParameterGroupInput) SetParameterNameValues

SetParameterNameValues sets the ParameterNameValues field's value.

func (ModifyCacheParameterGroupInput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ModifyCacheParameterGroupInput) Validate

func (s *ModifyCacheParameterGroupInput) Validate() error

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

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) GoString

func (s ModifyCacheSubnetGroupInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ModifyCacheSubnetGroupInput) SetCacheSubnetGroupDescription

func (s *ModifyCacheSubnetGroupInput) SetCacheSubnetGroupDescription(v string) *ModifyCacheSubnetGroupInput

SetCacheSubnetGroupDescription sets the CacheSubnetGroupDescription field's value.

func (*ModifyCacheSubnetGroupInput) SetCacheSubnetGroupName

func (s *ModifyCacheSubnetGroupInput) SetCacheSubnetGroupName(v string) *ModifyCacheSubnetGroupInput

SetCacheSubnetGroupName sets the CacheSubnetGroupName field's value.

func (*ModifyCacheSubnetGroupInput) SetSubnetIds

SetSubnetIds sets the SubnetIds field's value.

func (ModifyCacheSubnetGroupInput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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) GoString

func (s ModifyCacheSubnetGroupOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ModifyCacheSubnetGroupOutput) SetCacheSubnetGroup

SetCacheSubnetGroup sets the CacheSubnetGroup field's value.

func (ModifyCacheSubnetGroupOutput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ModifyGlobalReplicationGroupInput

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 name of the cache parameter group to use with the Global datastore. It
	// must be compatible with the major engine version used by the Global datastore.
	CacheParameterGroupName *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) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ModifyGlobalReplicationGroupInput) SetApplyImmediately

SetApplyImmediately sets the ApplyImmediately field's value.

func (*ModifyGlobalReplicationGroupInput) SetAutomaticFailoverEnabled

SetAutomaticFailoverEnabled sets the AutomaticFailoverEnabled field's value.

func (*ModifyGlobalReplicationGroupInput) SetCacheNodeType

SetCacheNodeType sets the CacheNodeType field's value.

func (*ModifyGlobalReplicationGroupInput) SetCacheParameterGroupName

SetCacheParameterGroupName sets the CacheParameterGroupName field's value.

func (*ModifyGlobalReplicationGroupInput) SetEngineVersion

SetEngineVersion sets the EngineVersion field's value.

func (*ModifyGlobalReplicationGroupInput) SetGlobalReplicationGroupDescription

func (s *ModifyGlobalReplicationGroupInput) SetGlobalReplicationGroupDescription(v string) *ModifyGlobalReplicationGroupInput

SetGlobalReplicationGroupDescription sets the GlobalReplicationGroupDescription field's value.

func (*ModifyGlobalReplicationGroupInput) SetGlobalReplicationGroupId

SetGlobalReplicationGroupId sets the GlobalReplicationGroupId field's value.

func (ModifyGlobalReplicationGroupInput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ModifyGlobalReplicationGroupInput) Validate

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

type ModifyGlobalReplicationGroupOutput

type ModifyGlobalReplicationGroupOutput struct {

	// Consists of a primary cluster that accepts writes and an associated secondary
	// cluster that resides in a different Amazon 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) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ModifyGlobalReplicationGroupOutput) SetGlobalReplicationGroup

SetGlobalReplicationGroup sets the GlobalReplicationGroup field's value.

func (ModifyGlobalReplicationGroupOutput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 (http://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/auth.html)
	AuthTokenUpdateStrategy *string `type:"string" enum:"AuthTokenUpdateStrategyType"`

	// If you are running Redis engine version 6.0 or later, set this parameter
	// to yes if you want to opt-in to the next auto minor version upgrade campaign.
	// This parameter is disabled for previous versions.
	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"`

	// Enabled or Disabled. To modify cluster mode from Disabled to Enabled, you
	// must first set the cluster mode to Compatible. Compatible mode allows your
	// Redis clients to connect using both cluster mode enabled and cluster mode
	// disabled. After you migrate all Redis clients to use cluster mode enabled,
	// you can then complete cluster mode configuration and set the cluster mode
	// to Enabled.
	ClusterMode *string `type:"string" enum:"ClusterMode"`

	// 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"`

	// The network type you choose when modifying a cluster, either ipv4 | ipv6.
	// IPv6 is supported for workloads using Redis engine version 6.2 onward or
	// Memcached engine version 1.6.6 on all instances built on the Nitro system
	// (http://aws.amazon.com/ec2/nitro/).
	IpDiscovery *string `type:"string" enum:"IpDiscovery"`

	// Specifies the destination, format and type of the logs.
	LogDeliveryConfigurations []*LogDeliveryConfigurationRequest `locationNameList:"LogDeliveryConfigurationRequest" type:"list"`

	// A flag to indicate MultiAZ is enabled.
	MultiAZEnabled *bool `type:"boolean"`

	// Deprecated. This parameter is not used.
	//
	// Deprecated: NodeGroupId has been deprecated
	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"`

	// Removes the user group associated with this replication group.
	RemoveUserGroups *bool `type:"boolean"`

	// 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"`

	// A flag that enables in-transit encryption when set to true. If you are enabling
	// in-transit encryption for an existing cluster, you must also set TransitEncryptionMode
	// to preferred.
	TransitEncryptionEnabled *bool `type:"boolean"`

	// A setting that allows you to migrate your clients to use in-transit encryption,
	// with no downtime.
	//
	// You must set TransitEncryptionEnabled to true, for your existing cluster,
	// and set TransitEncryptionMode to preferred in the same request to allow both
	// encrypted and unencrypted connections at the same time. Once you migrate
	// all your Redis clients to use encrypted connections you can set the value
	// to required to allow encrypted connections only.
	//
	// Setting TransitEncryptionMode to required is a two-step process that requires
	// you to first set the TransitEncryptionMode to preferred, after that you can
	// set TransitEncryptionMode to required.
	TransitEncryptionMode *string `type:"string" enum:"TransitEncryptionMode"`

	// The ID of the user group you are associating with the replication group.
	UserGroupIdsToAdd []*string `type:"list"`

	// The ID of the user group to disassociate from the replication group, meaning
	// the users in the group no longer can access the replication group.
	UserGroupIdsToRemove []*string `type:"list"`
	// contains filtered or unexported fields
}

Represents the input of a ModifyReplicationGroups operation.

func (ModifyReplicationGroupInput) GoString

func (s ModifyReplicationGroupInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ModifyReplicationGroupInput) SetApplyImmediately

SetApplyImmediately sets the ApplyImmediately field's value.

func (*ModifyReplicationGroupInput) SetAuthToken

SetAuthToken sets the AuthToken field's value.

func (*ModifyReplicationGroupInput) SetAuthTokenUpdateStrategy

func (s *ModifyReplicationGroupInput) SetAuthTokenUpdateStrategy(v string) *ModifyReplicationGroupInput

SetAuthTokenUpdateStrategy sets the AuthTokenUpdateStrategy field's value.

func (*ModifyReplicationGroupInput) SetAutoMinorVersionUpgrade

func (s *ModifyReplicationGroupInput) SetAutoMinorVersionUpgrade(v bool) *ModifyReplicationGroupInput

SetAutoMinorVersionUpgrade sets the AutoMinorVersionUpgrade field's value.

func (*ModifyReplicationGroupInput) SetAutomaticFailoverEnabled

func (s *ModifyReplicationGroupInput) SetAutomaticFailoverEnabled(v bool) *ModifyReplicationGroupInput

SetAutomaticFailoverEnabled sets the AutomaticFailoverEnabled field's value.

func (*ModifyReplicationGroupInput) SetCacheNodeType

SetCacheNodeType sets the CacheNodeType field's value.

func (*ModifyReplicationGroupInput) SetCacheParameterGroupName

func (s *ModifyReplicationGroupInput) SetCacheParameterGroupName(v string) *ModifyReplicationGroupInput

SetCacheParameterGroupName sets the CacheParameterGroupName field's value.

func (*ModifyReplicationGroupInput) SetCacheSecurityGroupNames

func (s *ModifyReplicationGroupInput) SetCacheSecurityGroupNames(v []*string) *ModifyReplicationGroupInput

SetCacheSecurityGroupNames sets the CacheSecurityGroupNames field's value.

func (*ModifyReplicationGroupInput) SetClusterMode added in v1.42.9

SetClusterMode sets the ClusterMode field's value.

func (*ModifyReplicationGroupInput) SetEngineVersion

SetEngineVersion sets the EngineVersion field's value.

func (*ModifyReplicationGroupInput) SetIpDiscovery added in v1.42.9

SetIpDiscovery sets the IpDiscovery field's value.

func (*ModifyReplicationGroupInput) SetLogDeliveryConfigurations

SetLogDeliveryConfigurations sets the LogDeliveryConfigurations field's value.

func (*ModifyReplicationGroupInput) SetMultiAZEnabled

SetMultiAZEnabled sets the MultiAZEnabled field's value.

func (*ModifyReplicationGroupInput) SetNodeGroupId

SetNodeGroupId sets the NodeGroupId field's value.

func (*ModifyReplicationGroupInput) SetNotificationTopicArn

func (s *ModifyReplicationGroupInput) SetNotificationTopicArn(v string) *ModifyReplicationGroupInput

SetNotificationTopicArn sets the NotificationTopicArn field's value.

func (*ModifyReplicationGroupInput) SetNotificationTopicStatus

func (s *ModifyReplicationGroupInput) SetNotificationTopicStatus(v string) *ModifyReplicationGroupInput

SetNotificationTopicStatus sets the NotificationTopicStatus field's value.

func (*ModifyReplicationGroupInput) SetPreferredMaintenanceWindow

func (s *ModifyReplicationGroupInput) SetPreferredMaintenanceWindow(v string) *ModifyReplicationGroupInput

SetPreferredMaintenanceWindow sets the PreferredMaintenanceWindow field's value.

func (*ModifyReplicationGroupInput) SetPrimaryClusterId

SetPrimaryClusterId sets the PrimaryClusterId field's value.

func (*ModifyReplicationGroupInput) SetRemoveUserGroups

SetRemoveUserGroups sets the RemoveUserGroups field's value.

func (*ModifyReplicationGroupInput) SetReplicationGroupDescription

func (s *ModifyReplicationGroupInput) SetReplicationGroupDescription(v string) *ModifyReplicationGroupInput

SetReplicationGroupDescription sets the ReplicationGroupDescription field's value.

func (*ModifyReplicationGroupInput) SetReplicationGroupId

func (s *ModifyReplicationGroupInput) SetReplicationGroupId(v string) *ModifyReplicationGroupInput

SetReplicationGroupId sets the ReplicationGroupId field's value.

func (*ModifyReplicationGroupInput) SetSecurityGroupIds

func (s *ModifyReplicationGroupInput) SetSecurityGroupIds(v []*string) *ModifyReplicationGroupInput

SetSecurityGroupIds sets the SecurityGroupIds field's value.

func (*ModifyReplicationGroupInput) SetSnapshotRetentionLimit

func (s *ModifyReplicationGroupInput) SetSnapshotRetentionLimit(v int64) *ModifyReplicationGroupInput

SetSnapshotRetentionLimit sets the SnapshotRetentionLimit field's value.

func (*ModifyReplicationGroupInput) SetSnapshotWindow

SetSnapshotWindow sets the SnapshotWindow field's value.

func (*ModifyReplicationGroupInput) SetSnapshottingClusterId

func (s *ModifyReplicationGroupInput) SetSnapshottingClusterId(v string) *ModifyReplicationGroupInput

SetSnapshottingClusterId sets the SnapshottingClusterId field's value.

func (*ModifyReplicationGroupInput) SetTransitEncryptionEnabled added in v1.42.9

func (s *ModifyReplicationGroupInput) SetTransitEncryptionEnabled(v bool) *ModifyReplicationGroupInput

SetTransitEncryptionEnabled sets the TransitEncryptionEnabled field's value.

func (*ModifyReplicationGroupInput) SetTransitEncryptionMode added in v1.42.9

func (s *ModifyReplicationGroupInput) SetTransitEncryptionMode(v string) *ModifyReplicationGroupInput

SetTransitEncryptionMode sets the TransitEncryptionMode field's value.

func (*ModifyReplicationGroupInput) SetUserGroupIdsToAdd

func (s *ModifyReplicationGroupInput) SetUserGroupIdsToAdd(v []*string) *ModifyReplicationGroupInput

SetUserGroupIdsToAdd sets the UserGroupIdsToAdd field's value.

func (*ModifyReplicationGroupInput) SetUserGroupIdsToRemove

func (s *ModifyReplicationGroupInput) SetUserGroupIdsToRemove(v []*string) *ModifyReplicationGroupInput

SetUserGroupIdsToRemove sets the UserGroupIdsToRemove field's value.

func (ModifyReplicationGroupInput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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) GoString

func (s ModifyReplicationGroupOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ModifyReplicationGroupOutput) SetReplicationGroup

SetReplicationGroup sets the ReplicationGroup field's value.

func (ModifyReplicationGroupOutput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ModifyReplicationGroupShardConfigurationInput

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) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ModifyReplicationGroupShardConfigurationInput) SetApplyImmediately

SetApplyImmediately sets the ApplyImmediately field's value.

func (*ModifyReplicationGroupShardConfigurationInput) SetNodeGroupCount

SetNodeGroupCount sets the NodeGroupCount field's value.

func (*ModifyReplicationGroupShardConfigurationInput) SetNodeGroupsToRemove

SetNodeGroupsToRemove sets the NodeGroupsToRemove field's value.

func (*ModifyReplicationGroupShardConfigurationInput) SetNodeGroupsToRetain

SetNodeGroupsToRetain sets the NodeGroupsToRetain field's value.

func (*ModifyReplicationGroupShardConfigurationInput) SetReplicationGroupId

SetReplicationGroupId sets the ReplicationGroupId field's value.

func (*ModifyReplicationGroupShardConfigurationInput) SetReshardingConfiguration

SetReshardingConfiguration sets the ReshardingConfiguration field's value.

func (ModifyReplicationGroupShardConfigurationInput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ModifyReplicationGroupShardConfigurationInput) Validate

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

type ModifyReplicationGroupShardConfigurationOutput

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) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ModifyReplicationGroupShardConfigurationOutput) SetReplicationGroup

SetReplicationGroup sets the ReplicationGroup field's value.

func (ModifyReplicationGroupShardConfigurationOutput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ModifyUserGroupInput

type ModifyUserGroupInput struct {

	// The ID of the user group.
	//
	// UserGroupId is a required field
	UserGroupId *string `type:"string" required:"true"`

	// The list of user IDs to add to the user group.
	UserIdsToAdd []*string `min:"1" type:"list"`

	// The list of user IDs to remove from the user group.
	UserIdsToRemove []*string `min:"1" type:"list"`
	// contains filtered or unexported fields
}

func (ModifyUserGroupInput) GoString

func (s ModifyUserGroupInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ModifyUserGroupInput) SetUserGroupId

func (s *ModifyUserGroupInput) SetUserGroupId(v string) *ModifyUserGroupInput

SetUserGroupId sets the UserGroupId field's value.

func (*ModifyUserGroupInput) SetUserIdsToAdd

func (s *ModifyUserGroupInput) SetUserIdsToAdd(v []*string) *ModifyUserGroupInput

SetUserIdsToAdd sets the UserIdsToAdd field's value.

func (*ModifyUserGroupInput) SetUserIdsToRemove

func (s *ModifyUserGroupInput) SetUserIdsToRemove(v []*string) *ModifyUserGroupInput

SetUserIdsToRemove sets the UserIdsToRemove field's value.

func (ModifyUserGroupInput) String

func (s ModifyUserGroupInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ModifyUserGroupInput) Validate

func (s *ModifyUserGroupInput) Validate() error

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

type ModifyUserGroupOutput

type ModifyUserGroupOutput struct {

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

	// The current supported value is Redis.
	Engine *string `type:"string"`

	// The minimum engine version required, which is Redis 6.0
	MinimumEngineVersion *string `type:"string"`

	// A list of updates being applied to the user group.
	PendingChanges *UserGroupPendingChanges `type:"structure"`

	// A list of replication groups that the user group can access.
	ReplicationGroups []*string `type:"list"`

	// Indicates user group status. Can be "creating", "active", "modifying", "deleting".
	Status *string `type:"string"`

	// The ID of the user group.
	UserGroupId *string `type:"string"`

	// The list of user IDs that belong to the user group.
	UserIds []*string `type:"list"`
	// contains filtered or unexported fields
}

func (ModifyUserGroupOutput) GoString

func (s ModifyUserGroupOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ModifyUserGroupOutput) SetARN

SetARN sets the ARN field's value.

func (*ModifyUserGroupOutput) SetEngine

SetEngine sets the Engine field's value.

func (*ModifyUserGroupOutput) SetMinimumEngineVersion added in v1.42.9

func (s *ModifyUserGroupOutput) SetMinimumEngineVersion(v string) *ModifyUserGroupOutput

SetMinimumEngineVersion sets the MinimumEngineVersion field's value.

func (*ModifyUserGroupOutput) SetPendingChanges

SetPendingChanges sets the PendingChanges field's value.

func (*ModifyUserGroupOutput) SetReplicationGroups

func (s *ModifyUserGroupOutput) SetReplicationGroups(v []*string) *ModifyUserGroupOutput

SetReplicationGroups sets the ReplicationGroups field's value.

func (*ModifyUserGroupOutput) SetStatus

SetStatus sets the Status field's value.

func (*ModifyUserGroupOutput) SetUserGroupId

func (s *ModifyUserGroupOutput) SetUserGroupId(v string) *ModifyUserGroupOutput

SetUserGroupId sets the UserGroupId field's value.

func (*ModifyUserGroupOutput) SetUserIds

func (s *ModifyUserGroupOutput) SetUserIds(v []*string) *ModifyUserGroupOutput

SetUserIds sets the UserIds field's value.

func (ModifyUserGroupOutput) String

func (s ModifyUserGroupOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ModifyUserInput

type ModifyUserInput struct {

	// Access permissions string used for this user.
	AccessString *string `type:"string"`

	// Adds additional user permissions to the access string.
	AppendAccessString *string `type:"string"`

	// Specifies how to authenticate the user.
	AuthenticationMode *AuthenticationMode `type:"structure"`

	// Indicates no password is required for the user.
	NoPasswordRequired *bool `type:"boolean"`

	// The passwords belonging to the user. You are allowed up to two.
	Passwords []*string `min:"1" type:"list"`

	// The ID of the user.
	//
	// UserId is a required field
	UserId *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (ModifyUserInput) GoString

func (s ModifyUserInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ModifyUserInput) SetAccessString

func (s *ModifyUserInput) SetAccessString(v string) *ModifyUserInput

SetAccessString sets the AccessString field's value.

func (*ModifyUserInput) SetAppendAccessString

func (s *ModifyUserInput) SetAppendAccessString(v string) *ModifyUserInput

SetAppendAccessString sets the AppendAccessString field's value.

func (*ModifyUserInput) SetAuthenticationMode added in v1.42.9

func (s *ModifyUserInput) SetAuthenticationMode(v *AuthenticationMode) *ModifyUserInput

SetAuthenticationMode sets the AuthenticationMode field's value.

func (*ModifyUserInput) SetNoPasswordRequired

func (s *ModifyUserInput) SetNoPasswordRequired(v bool) *ModifyUserInput

SetNoPasswordRequired sets the NoPasswordRequired field's value.

func (*ModifyUserInput) SetPasswords

func (s *ModifyUserInput) SetPasswords(v []*string) *ModifyUserInput

SetPasswords sets the Passwords field's value.

func (*ModifyUserInput) SetUserId

func (s *ModifyUserInput) SetUserId(v string) *ModifyUserInput

SetUserId sets the UserId field's value.

func (ModifyUserInput) String

func (s ModifyUserInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ModifyUserInput) Validate

func (s *ModifyUserInput) Validate() error

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

type ModifyUserOutput

type ModifyUserOutput struct {

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

	// Access permissions string used for this user.
	AccessString *string `type:"string"`

	// Denotes whether the user requires a password to authenticate.
	Authentication *Authentication `type:"structure"`

	// The current supported value is Redis.
	Engine *string `type:"string"`

	// The minimum engine version required, which is Redis 6.0
	MinimumEngineVersion *string `type:"string"`

	// Indicates the user status. Can be "active", "modifying" or "deleting".
	Status *string `type:"string"`

	// Returns a list of the user group IDs the user belongs to.
	UserGroupIds []*string `type:"list"`

	// The ID of the user.
	UserId *string `type:"string"`

	// The username of the user.
	UserName *string `type:"string"`
	// contains filtered or unexported fields
}

func (ModifyUserOutput) GoString

func (s ModifyUserOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ModifyUserOutput) SetARN

SetARN sets the ARN field's value.

func (*ModifyUserOutput) SetAccessString

func (s *ModifyUserOutput) SetAccessString(v string) *ModifyUserOutput

SetAccessString sets the AccessString field's value.

func (*ModifyUserOutput) SetAuthentication

func (s *ModifyUserOutput) SetAuthentication(v *Authentication) *ModifyUserOutput

SetAuthentication sets the Authentication field's value.

func (*ModifyUserOutput) SetEngine

func (s *ModifyUserOutput) SetEngine(v string) *ModifyUserOutput

SetEngine sets the Engine field's value.

func (*ModifyUserOutput) SetMinimumEngineVersion added in v1.42.9

func (s *ModifyUserOutput) SetMinimumEngineVersion(v string) *ModifyUserOutput

SetMinimumEngineVersion sets the MinimumEngineVersion field's value.

func (*ModifyUserOutput) SetStatus

func (s *ModifyUserOutput) SetStatus(v string) *ModifyUserOutput

SetStatus sets the Status field's value.

func (*ModifyUserOutput) SetUserGroupIds

func (s *ModifyUserOutput) SetUserGroupIds(v []*string) *ModifyUserOutput

SetUserGroupIds sets the UserGroupIds field's value.

func (*ModifyUserOutput) SetUserId

func (s *ModifyUserOutput) SetUserId(v string) *ModifyUserOutput

SetUserId sets the UserId field's value.

func (*ModifyUserOutput) SetUserName

func (s *ModifyUserOutput) SetUserName(v string) *ModifyUserOutput

SetUserName sets the UserName field's value.

func (ModifyUserOutput) String

func (s ModifyUserOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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) GoString

func (s NodeGroup) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*NodeGroup) SetNodeGroupId

func (s *NodeGroup) SetNodeGroupId(v string) *NodeGroup

SetNodeGroupId sets the NodeGroupId field's value.

func (*NodeGroup) SetNodeGroupMembers

func (s *NodeGroup) SetNodeGroupMembers(v []*NodeGroupMember) *NodeGroup

SetNodeGroupMembers sets the NodeGroupMembers field's value.

func (*NodeGroup) SetPrimaryEndpoint

func (s *NodeGroup) SetPrimaryEndpoint(v *Endpoint) *NodeGroup

SetPrimaryEndpoint sets the PrimaryEndpoint field's value.

func (*NodeGroup) SetReaderEndpoint

func (s *NodeGroup) SetReaderEndpoint(v *Endpoint) *NodeGroup

SetReaderEndpoint sets the ReaderEndpoint field's value.

func (*NodeGroup) SetSlots

func (s *NodeGroup) SetSlots(v string) *NodeGroup

SetSlots sets the Slots field's value.

func (*NodeGroup) SetStatus

func (s *NodeGroup) SetStatus(v string) *NodeGroup

SetStatus sets the Status field's value.

func (NodeGroup) String

func (s NodeGroup) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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"`

	// The outpost ARN of the primary node.
	PrimaryOutpostArn *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"`

	// The outpost ARN of the node replicas.
	ReplicaOutpostArns []*string `locationNameList:"OutpostArn" type:"list"`

	// 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) GoString

func (s NodeGroupConfiguration) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*NodeGroupConfiguration) SetNodeGroupId

SetNodeGroupId sets the NodeGroupId field's value.

func (*NodeGroupConfiguration) SetPrimaryAvailabilityZone

func (s *NodeGroupConfiguration) SetPrimaryAvailabilityZone(v string) *NodeGroupConfiguration

SetPrimaryAvailabilityZone sets the PrimaryAvailabilityZone field's value.

func (*NodeGroupConfiguration) SetPrimaryOutpostArn

func (s *NodeGroupConfiguration) SetPrimaryOutpostArn(v string) *NodeGroupConfiguration

SetPrimaryOutpostArn sets the PrimaryOutpostArn field's value.

func (*NodeGroupConfiguration) SetReplicaAvailabilityZones

func (s *NodeGroupConfiguration) SetReplicaAvailabilityZones(v []*string) *NodeGroupConfiguration

SetReplicaAvailabilityZones sets the ReplicaAvailabilityZones field's value.

func (*NodeGroupConfiguration) SetReplicaCount

func (s *NodeGroupConfiguration) SetReplicaCount(v int64) *NodeGroupConfiguration

SetReplicaCount sets the ReplicaCount field's value.

func (*NodeGroupConfiguration) SetReplicaOutpostArns

func (s *NodeGroupConfiguration) SetReplicaOutpostArns(v []*string) *NodeGroupConfiguration

SetReplicaOutpostArns sets the ReplicaOutpostArns field's value.

func (*NodeGroupConfiguration) SetSlots

SetSlots sets the Slots field's value.

func (NodeGroupConfiguration) String

func (s NodeGroupConfiguration) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*NodeGroupConfiguration) Validate

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 outpost ARN of the node group member.
	PreferredOutpostArn *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) GoString

func (s NodeGroupMember) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*NodeGroupMember) SetCacheClusterId

func (s *NodeGroupMember) SetCacheClusterId(v string) *NodeGroupMember

SetCacheClusterId sets the CacheClusterId field's value.

func (*NodeGroupMember) SetCacheNodeId

func (s *NodeGroupMember) SetCacheNodeId(v string) *NodeGroupMember

SetCacheNodeId sets the CacheNodeId field's value.

func (*NodeGroupMember) SetCurrentRole

func (s *NodeGroupMember) SetCurrentRole(v string) *NodeGroupMember

SetCurrentRole sets the CurrentRole field's value.

func (*NodeGroupMember) SetPreferredAvailabilityZone

func (s *NodeGroupMember) SetPreferredAvailabilityZone(v string) *NodeGroupMember

SetPreferredAvailabilityZone sets the PreferredAvailabilityZone field's value.

func (*NodeGroupMember) SetPreferredOutpostArn

func (s *NodeGroupMember) SetPreferredOutpostArn(v string) *NodeGroupMember

SetPreferredOutpostArn sets the PreferredOutpostArn field's value.

func (*NodeGroupMember) SetReadEndpoint

func (s *NodeGroupMember) SetReadEndpoint(v *Endpoint) *NodeGroupMember

SetReadEndpoint sets the ReadEndpoint field's value.

func (NodeGroupMember) String

func (s NodeGroupMember) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type NodeGroupMemberUpdateStatus

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 *string `type:"string" enum:"NodeUpdateInitiatedBy"`

	// 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 *string `type:"string" enum:"NodeUpdateStatus"`

	// 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) GoString

func (s NodeGroupMemberUpdateStatus) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*NodeGroupMemberUpdateStatus) SetCacheClusterId

SetCacheClusterId sets the CacheClusterId field's value.

func (*NodeGroupMemberUpdateStatus) SetCacheNodeId

SetCacheNodeId sets the CacheNodeId field's value.

func (*NodeGroupMemberUpdateStatus) SetNodeDeletionDate

SetNodeDeletionDate sets the NodeDeletionDate field's value.

func (*NodeGroupMemberUpdateStatus) SetNodeUpdateEndDate

SetNodeUpdateEndDate sets the NodeUpdateEndDate field's value.

func (*NodeGroupMemberUpdateStatus) SetNodeUpdateInitiatedBy

func (s *NodeGroupMemberUpdateStatus) SetNodeUpdateInitiatedBy(v string) *NodeGroupMemberUpdateStatus

SetNodeUpdateInitiatedBy sets the NodeUpdateInitiatedBy field's value.

func (*NodeGroupMemberUpdateStatus) SetNodeUpdateInitiatedDate

func (s *NodeGroupMemberUpdateStatus) SetNodeUpdateInitiatedDate(v time.Time) *NodeGroupMemberUpdateStatus

SetNodeUpdateInitiatedDate sets the NodeUpdateInitiatedDate field's value.

func (*NodeGroupMemberUpdateStatus) SetNodeUpdateStartDate

func (s *NodeGroupMemberUpdateStatus) SetNodeUpdateStartDate(v time.Time) *NodeGroupMemberUpdateStatus

SetNodeUpdateStartDate sets the NodeUpdateStartDate field's value.

func (*NodeGroupMemberUpdateStatus) SetNodeUpdateStatus

SetNodeUpdateStatus sets the NodeUpdateStatus field's value.

func (*NodeGroupMemberUpdateStatus) SetNodeUpdateStatusModifiedDate

func (s *NodeGroupMemberUpdateStatus) SetNodeUpdateStatusModifiedDate(v time.Time) *NodeGroupMemberUpdateStatus

SetNodeUpdateStatusModifiedDate sets the NodeUpdateStatusModifiedDate field's value.

func (NodeGroupMemberUpdateStatus) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type NodeGroupUpdateStatus

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) GoString

func (s NodeGroupUpdateStatus) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*NodeGroupUpdateStatus) SetNodeGroupId

func (s *NodeGroupUpdateStatus) SetNodeGroupId(v string) *NodeGroupUpdateStatus

SetNodeGroupId sets the NodeGroupId field's value.

func (*NodeGroupUpdateStatus) SetNodeGroupMemberUpdateStatus

func (s *NodeGroupUpdateStatus) SetNodeGroupMemberUpdateStatus(v []*NodeGroupMemberUpdateStatus) *NodeGroupUpdateStatus

SetNodeGroupMemberUpdateStatus sets the NodeGroupMemberUpdateStatus field's value.

func (NodeGroupUpdateStatus) String

func (s NodeGroupUpdateStatus) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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) GoString

func (s NodeSnapshot) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*NodeSnapshot) SetCacheClusterId

func (s *NodeSnapshot) SetCacheClusterId(v string) *NodeSnapshot

SetCacheClusterId sets the CacheClusterId field's value.

func (*NodeSnapshot) SetCacheNodeCreateTime

func (s *NodeSnapshot) SetCacheNodeCreateTime(v time.Time) *NodeSnapshot

SetCacheNodeCreateTime sets the CacheNodeCreateTime field's value.

func (*NodeSnapshot) SetCacheNodeId

func (s *NodeSnapshot) SetCacheNodeId(v string) *NodeSnapshot

SetCacheNodeId sets the CacheNodeId field's value.

func (*NodeSnapshot) SetCacheSize

func (s *NodeSnapshot) SetCacheSize(v string) *NodeSnapshot

SetCacheSize sets the CacheSize field's value.

func (*NodeSnapshot) SetNodeGroupConfiguration

func (s *NodeSnapshot) SetNodeGroupConfiguration(v *NodeGroupConfiguration) *NodeSnapshot

SetNodeGroupConfiguration sets the NodeGroupConfiguration field's value.

func (*NodeSnapshot) SetNodeGroupId

func (s *NodeSnapshot) SetNodeGroupId(v string) *NodeSnapshot

SetNodeGroupId sets the NodeGroupId field's value.

func (*NodeSnapshot) SetSnapshotCreateTime

func (s *NodeSnapshot) SetSnapshotCreateTime(v time.Time) *NodeSnapshot

SetSnapshotCreateTime sets the SnapshotCreateTime field's value.

func (NodeSnapshot) String

func (s NodeSnapshot) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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) GoString

func (s NotificationConfiguration) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*NotificationConfiguration) SetTopicArn

SetTopicArn sets the TopicArn field's value.

func (*NotificationConfiguration) SetTopicStatus

SetTopicStatus sets the TopicStatus field's value.

func (NotificationConfiguration) String

func (s NotificationConfiguration) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 *string `type:"string" enum:"ChangeType"`

	// 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) GoString

func (s Parameter) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Parameter) SetAllowedValues

func (s *Parameter) SetAllowedValues(v string) *Parameter

SetAllowedValues sets the AllowedValues field's value.

func (*Parameter) SetChangeType

func (s *Parameter) SetChangeType(v string) *Parameter

SetChangeType sets the ChangeType field's value.

func (*Parameter) SetDataType

func (s *Parameter) SetDataType(v string) *Parameter

SetDataType sets the DataType field's value.

func (*Parameter) SetDescription

func (s *Parameter) SetDescription(v string) *Parameter

SetDescription sets the Description field's value.

func (*Parameter) SetIsModifiable

func (s *Parameter) SetIsModifiable(v bool) *Parameter

SetIsModifiable sets the IsModifiable field's value.

func (*Parameter) SetMinimumEngineVersion

func (s *Parameter) SetMinimumEngineVersion(v string) *Parameter

SetMinimumEngineVersion sets the MinimumEngineVersion field's value.

func (*Parameter) SetParameterName

func (s *Parameter) SetParameterName(v string) *Parameter

SetParameterName sets the ParameterName field's value.

func (*Parameter) SetParameterValue

func (s *Parameter) SetParameterValue(v string) *Parameter

SetParameterValue sets the ParameterValue field's value.

func (*Parameter) SetSource

func (s *Parameter) SetSource(v string) *Parameter

SetSource sets the Source field's value.

func (Parameter) String

func (s Parameter) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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) GoString

func (s ParameterNameValue) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ParameterNameValue) SetParameterName

func (s *ParameterNameValue) SetParameterName(v string) *ParameterNameValue

SetParameterName sets the ParameterName field's value.

func (*ParameterNameValue) SetParameterValue

func (s *ParameterNameValue) SetParameterValue(v string) *ParameterNameValue

SetParameterValue sets the ParameterValue field's value.

func (ParameterNameValue) String

func (s ParameterNameValue) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type PendingLogDeliveryConfiguration

type PendingLogDeliveryConfiguration struct {

	// Configuration details of either a CloudWatch Logs destination or Kinesis
	// Data Firehose destination.
	DestinationDetails *DestinationDetails `type:"structure"`

	// Returns the destination type, either CloudWatch Logs or Kinesis Data Firehose.
	DestinationType *string `type:"string" enum:"DestinationType"`

	// Returns the log format, either JSON or TEXT
	LogFormat *string `type:"string" enum:"LogFormat"`

	// Refers to slow-log (https://redis.io/commands/slowlog) or engine-log..
	LogType *string `type:"string" enum:"LogType"`
	// contains filtered or unexported fields
}

The log delivery configurations being modified

func (PendingLogDeliveryConfiguration) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PendingLogDeliveryConfiguration) SetDestinationDetails

SetDestinationDetails sets the DestinationDetails field's value.

func (*PendingLogDeliveryConfiguration) SetDestinationType

SetDestinationType sets the DestinationType field's value.

func (*PendingLogDeliveryConfiguration) SetLogFormat

SetLogFormat sets the LogFormat field's value.

func (*PendingLogDeliveryConfiguration) SetLogType

SetLogType sets the LogType field's value.

func (PendingLogDeliveryConfiguration) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type PendingModifiedValues

type PendingModifiedValues struct {

	// The auth token status
	AuthTokenStatus *string `type:"string" enum:"AuthTokenUpdateStatus"`

	// 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 log delivery configurations being modified
	LogDeliveryConfigurations []*PendingLogDeliveryConfiguration `locationName:"PendingLogDeliveryConfiguration" type:"list"`

	// 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 40.
	NumCacheNodes *int64 `type:"integer"`

	// A flag that enables in-transit encryption when set to true.
	TransitEncryptionEnabled *bool `type:"boolean"`

	// A setting that allows you to migrate your clients to use in-transit encryption,
	// with no downtime.
	TransitEncryptionMode *string `type:"string" enum:"TransitEncryptionMode"`
	// 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) GoString

func (s PendingModifiedValues) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PendingModifiedValues) SetAuthTokenStatus

func (s *PendingModifiedValues) SetAuthTokenStatus(v string) *PendingModifiedValues

SetAuthTokenStatus sets the AuthTokenStatus field's value.

func (*PendingModifiedValues) SetCacheNodeIdsToRemove

func (s *PendingModifiedValues) SetCacheNodeIdsToRemove(v []*string) *PendingModifiedValues

SetCacheNodeIdsToRemove sets the CacheNodeIdsToRemove field's value.

func (*PendingModifiedValues) SetCacheNodeType

func (s *PendingModifiedValues) SetCacheNodeType(v string) *PendingModifiedValues

SetCacheNodeType sets the CacheNodeType field's value.

func (*PendingModifiedValues) SetEngineVersion

func (s *PendingModifiedValues) SetEngineVersion(v string) *PendingModifiedValues

SetEngineVersion sets the EngineVersion field's value.

func (*PendingModifiedValues) SetLogDeliveryConfigurations

func (s *PendingModifiedValues) SetLogDeliveryConfigurations(v []*PendingLogDeliveryConfiguration) *PendingModifiedValues

SetLogDeliveryConfigurations sets the LogDeliveryConfigurations field's value.

func (*PendingModifiedValues) SetNumCacheNodes

func (s *PendingModifiedValues) SetNumCacheNodes(v int64) *PendingModifiedValues

SetNumCacheNodes sets the NumCacheNodes field's value.

func (*PendingModifiedValues) SetTransitEncryptionEnabled added in v1.42.9

func (s *PendingModifiedValues) SetTransitEncryptionEnabled(v bool) *PendingModifiedValues

SetTransitEncryptionEnabled sets the TransitEncryptionEnabled field's value.

func (*PendingModifiedValues) SetTransitEncryptionMode added in v1.42.9

func (s *PendingModifiedValues) SetTransitEncryptionMode(v string) *PendingModifiedValues

SetTransitEncryptionMode sets the TransitEncryptionMode field's value.

func (PendingModifiedValues) String

func (s PendingModifiedValues) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ProcessedUpdateAction

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 *string `type:"string" enum:"UpdateActionStatus"`
	// contains filtered or unexported fields
}

Update action that has been processed for the corresponding apply/stop request

func (ProcessedUpdateAction) GoString

func (s ProcessedUpdateAction) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ProcessedUpdateAction) SetCacheClusterId

func (s *ProcessedUpdateAction) SetCacheClusterId(v string) *ProcessedUpdateAction

SetCacheClusterId sets the CacheClusterId field's value.

func (*ProcessedUpdateAction) SetReplicationGroupId

func (s *ProcessedUpdateAction) SetReplicationGroupId(v string) *ProcessedUpdateAction

SetReplicationGroupId sets the ReplicationGroupId field's value.

func (*ProcessedUpdateAction) SetServiceUpdateName

func (s *ProcessedUpdateAction) SetServiceUpdateName(v string) *ProcessedUpdateAction

SetServiceUpdateName sets the ServiceUpdateName field's value.

func (*ProcessedUpdateAction) SetUpdateActionStatus

func (s *ProcessedUpdateAction) SetUpdateActionStatus(v string) *ProcessedUpdateAction

SetUpdateActionStatus sets the UpdateActionStatus field's value.

func (ProcessedUpdateAction) String

func (s ProcessedUpdateAction) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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"`

	// A list of tags to be added to this resource. A tag is a key-value pair. A
	// tag key must be accompanied by a tag value, although null is accepted.
	Tags []*Tag `locationNameList:"Tag" type:"list"`
	// contains filtered or unexported fields
}

Represents the input of a PurchaseReservedCacheNodesOffering operation.

func (PurchaseReservedCacheNodesOfferingInput) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PurchaseReservedCacheNodesOfferingInput) SetCacheNodeCount

SetCacheNodeCount sets the CacheNodeCount field's value.

func (*PurchaseReservedCacheNodesOfferingInput) SetReservedCacheNodeId

SetReservedCacheNodeId sets the ReservedCacheNodeId field's value.

func (*PurchaseReservedCacheNodesOfferingInput) SetReservedCacheNodesOfferingId

SetReservedCacheNodesOfferingId sets the ReservedCacheNodesOfferingId field's value.

func (*PurchaseReservedCacheNodesOfferingInput) SetTags

SetTags sets the Tags field's value.

func (PurchaseReservedCacheNodesOfferingInput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PurchaseReservedCacheNodesOfferingOutput) SetReservedCacheNode

SetReservedCacheNode sets the ReservedCacheNode field's value.

func (PurchaseReservedCacheNodesOfferingOutput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type RebalanceSlotsInGlobalReplicationGroupInput

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) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RebalanceSlotsInGlobalReplicationGroupInput) SetApplyImmediately

SetApplyImmediately sets the ApplyImmediately field's value.

func (*RebalanceSlotsInGlobalReplicationGroupInput) SetGlobalReplicationGroupId

SetGlobalReplicationGroupId sets the GlobalReplicationGroupId field's value.

func (RebalanceSlotsInGlobalReplicationGroupInput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RebalanceSlotsInGlobalReplicationGroupInput) Validate

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

type RebalanceSlotsInGlobalReplicationGroupOutput

type RebalanceSlotsInGlobalReplicationGroupOutput struct {

	// Consists of a primary cluster that accepts writes and an associated secondary
	// cluster that resides in a different Amazon 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) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RebalanceSlotsInGlobalReplicationGroupOutput) SetGlobalReplicationGroup

SetGlobalReplicationGroup sets the GlobalReplicationGroup field's value.

func (RebalanceSlotsInGlobalReplicationGroupOutput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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) GoString

func (s RebootCacheClusterInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RebootCacheClusterInput) SetCacheClusterId

func (s *RebootCacheClusterInput) SetCacheClusterId(v string) *RebootCacheClusterInput

SetCacheClusterId sets the CacheClusterId field's value.

func (*RebootCacheClusterInput) SetCacheNodeIdsToReboot

func (s *RebootCacheClusterInput) SetCacheNodeIdsToReboot(v []*string) *RebootCacheClusterInput

SetCacheNodeIdsToReboot sets the CacheNodeIdsToReboot field's value.

func (RebootCacheClusterInput) String

func (s RebootCacheClusterInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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) GoString

func (s RebootCacheClusterOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RebootCacheClusterOutput) SetCacheCluster

SetCacheCluster sets the CacheCluster field's value.

func (RebootCacheClusterOutput) String

func (s RebootCacheClusterOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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) GoString

func (s RecurringCharge) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RecurringCharge) SetRecurringChargeAmount

func (s *RecurringCharge) SetRecurringChargeAmount(v float64) *RecurringCharge

SetRecurringChargeAmount sets the RecurringChargeAmount field's value.

func (*RecurringCharge) SetRecurringChargeFrequency

func (s *RecurringCharge) SetRecurringChargeFrequency(v string) *RecurringCharge

SetRecurringChargeFrequency sets the RecurringChargeFrequency field's value.

func (RecurringCharge) String

func (s RecurringCharge) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type RegionalConfiguration

type RegionalConfiguration struct {

	// The name of the secondary cluster
	//
	// ReplicationGroupId is a required field
	ReplicationGroupId *string `type:"string" required:"true"`

	// The Amazon 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) GoString

func (s RegionalConfiguration) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RegionalConfiguration) SetReplicationGroupId

func (s *RegionalConfiguration) SetReplicationGroupId(v string) *RegionalConfiguration

SetReplicationGroupId sets the ReplicationGroupId field's value.

func (*RegionalConfiguration) SetReplicationGroupRegion

func (s *RegionalConfiguration) SetReplicationGroupRegion(v string) *RegionalConfiguration

SetReplicationGroupRegion sets the ReplicationGroupRegion field's value.

func (*RegionalConfiguration) SetReshardingConfiguration

func (s *RegionalConfiguration) SetReshardingConfiguration(v []*ReshardingConfiguration) *RegionalConfiguration

SetReshardingConfiguration sets the ReshardingConfiguration field's value.

func (RegionalConfiguration) String

func (s RegionalConfiguration) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RegionalConfiguration) Validate

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 Amazon
	// 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) GoString

func (s RemoveTagsFromResourceInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RemoveTagsFromResourceInput) SetResourceName

SetResourceName sets the ResourceName field's value.

func (*RemoveTagsFromResourceInput) SetTagKeys

SetTagKeys sets the TagKeys field's value.

func (RemoveTagsFromResourceInput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RemoveTagsFromResourceInput) Validate

func (s *RemoveTagsFromResourceInput) Validate() error

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

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"`

	// If you are running Redis engine version 6.0 or later, set this parameter
	// to yes if you want to opt-in to the next auto minor version upgrade campaign.
	// This parameter is disabled for previous versions.
	AutoMinorVersionUpgrade *bool `type:"boolean"`

	// Indicates the status of automatic failover for this Redis replication group.
	AutomaticFailover *string `type:"string" enum:"AutomaticFailoverStatus"`

	// 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"`

	// Enabled or Disabled. To modify cluster mode from Disabled to Enabled, you
	// must first set the cluster mode to Compatible. Compatible mode allows your
	// Redis clients to connect using both cluster mode enabled and cluster mode
	// disabled. After you migrate all Redis clients to use cluster mode enabled,
	// you can then complete cluster mode configuration and set the cluster mode
	// to Enabled.
	ClusterMode *string `type:"string" enum:"ClusterMode"`

	// The configuration endpoint for this replication group. Use the configuration
	// endpoint to connect to this replication group.
	ConfigurationEndpoint *Endpoint `type:"structure"`

	// Enables data tiering. Data tiering is only supported for replication groups
	// using the r6gd node type. This parameter must be set to true when using r6gd
	// nodes. For more information, see Data tiering (https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/data-tiering.html).
	DataTiering *string `type:"string" enum:"DataTieringStatus"`

	// 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 network type you choose when modifying a cluster, either ipv4 | ipv6.
	// IPv6 is supported for workloads using Redis engine version 6.2 onward or
	// Memcached engine version 1.6.6 on all instances built on the Nitro system
	// (http://aws.amazon.com/ec2/nitro/).
	IpDiscovery *string `type:"string" enum:"IpDiscovery"`

	// The ID of the KMS key used to encrypt the disk in the cluster.
	KmsKeyId *string `type:"string"`

	// Returns the destination, format and type of the logs.
	LogDeliveryConfigurations []*LogDeliveryConfiguration `locationNameList:"LogDeliveryConfiguration" type:"list"`

	// The names of all the cache clusters that are part of this replication group.
	MemberClusters []*string `locationNameList:"ClusterId" type:"list"`

	// The outpost ARNs of the replication group's member clusters.
	MemberClustersOutpostArns []*string `locationNameList:"ReplicationGroupOutpostArn" 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 *string `type:"string" enum:"MultiAZStatus"`

	// Must be either ipv4 | ipv6 | dual_stack. IPv6 is supported for workloads
	// using Redis engine version 6.2 onward or Memcached engine version 1.6.6 on
	// all instances built on the Nitro system (http://aws.amazon.com/ec2/nitro/).
	NetworkType *string `type:"string" enum:"NetworkType"`

	// 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 date and time when the cluster was created.
	ReplicationGroupCreateTime *time.Time `type:"timestamp"`

	// 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.
	//
	// 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"`

	// A setting that allows you to migrate your clients to use in-transit encryption,
	// with no downtime.
	TransitEncryptionMode *string `type:"string" enum:"TransitEncryptionMode"`

	// The ID of the user group associated to the replication group.
	UserGroupIds []*string `type:"list"`
	// contains filtered or unexported fields
}

Contains all of the attributes of a specific Redis replication group.

func (ReplicationGroup) GoString

func (s ReplicationGroup) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ReplicationGroup) SetARN

SetARN sets the ARN field's value.

func (*ReplicationGroup) SetAtRestEncryptionEnabled

func (s *ReplicationGroup) SetAtRestEncryptionEnabled(v bool) *ReplicationGroup

SetAtRestEncryptionEnabled sets the AtRestEncryptionEnabled field's value.

func (*ReplicationGroup) SetAuthTokenEnabled

func (s *ReplicationGroup) SetAuthTokenEnabled(v bool) *ReplicationGroup

SetAuthTokenEnabled sets the AuthTokenEnabled field's value.

func (*ReplicationGroup) SetAuthTokenLastModifiedDate

func (s *ReplicationGroup) SetAuthTokenLastModifiedDate(v time.Time) *ReplicationGroup

SetAuthTokenLastModifiedDate sets the AuthTokenLastModifiedDate field's value.

func (*ReplicationGroup) SetAutoMinorVersionUpgrade added in v1.42.9

func (s *ReplicationGroup) SetAutoMinorVersionUpgrade(v bool) *ReplicationGroup

SetAutoMinorVersionUpgrade sets the AutoMinorVersionUpgrade field's value.

func (*ReplicationGroup) SetAutomaticFailover

func (s *ReplicationGroup) SetAutomaticFailover(v string) *ReplicationGroup

SetAutomaticFailover sets the AutomaticFailover field's value.

func (*ReplicationGroup) SetCacheNodeType

func (s *ReplicationGroup) SetCacheNodeType(v string) *ReplicationGroup

SetCacheNodeType sets the CacheNodeType field's value.

func (*ReplicationGroup) SetClusterEnabled

func (s *ReplicationGroup) SetClusterEnabled(v bool) *ReplicationGroup

SetClusterEnabled sets the ClusterEnabled field's value.

func (*ReplicationGroup) SetClusterMode added in v1.42.9

func (s *ReplicationGroup) SetClusterMode(v string) *ReplicationGroup

SetClusterMode sets the ClusterMode field's value.

func (*ReplicationGroup) SetConfigurationEndpoint

func (s *ReplicationGroup) SetConfigurationEndpoint(v *Endpoint) *ReplicationGroup

SetConfigurationEndpoint sets the ConfigurationEndpoint field's value.

func (*ReplicationGroup) SetDataTiering added in v1.42.9

func (s *ReplicationGroup) SetDataTiering(v string) *ReplicationGroup

SetDataTiering sets the DataTiering field's value.

func (*ReplicationGroup) SetDescription

func (s *ReplicationGroup) SetDescription(v string) *ReplicationGroup

SetDescription sets the Description field's value.

func (*ReplicationGroup) SetGlobalReplicationGroupInfo

func (s *ReplicationGroup) SetGlobalReplicationGroupInfo(v *GlobalReplicationGroupInfo) *ReplicationGroup

SetGlobalReplicationGroupInfo sets the GlobalReplicationGroupInfo field's value.

func (*ReplicationGroup) SetIpDiscovery added in v1.42.9

func (s *ReplicationGroup) SetIpDiscovery(v string) *ReplicationGroup

SetIpDiscovery sets the IpDiscovery field's value.

func (*ReplicationGroup) SetKmsKeyId

func (s *ReplicationGroup) SetKmsKeyId(v string) *ReplicationGroup

SetKmsKeyId sets the KmsKeyId field's value.

func (*ReplicationGroup) SetLogDeliveryConfigurations

func (s *ReplicationGroup) SetLogDeliveryConfigurations(v []*LogDeliveryConfiguration) *ReplicationGroup

SetLogDeliveryConfigurations sets the LogDeliveryConfigurations field's value.

func (*ReplicationGroup) SetMemberClusters

func (s *ReplicationGroup) SetMemberClusters(v []*string) *ReplicationGroup

SetMemberClusters sets the MemberClusters field's value.

func (*ReplicationGroup) SetMemberClustersOutpostArns

func (s *ReplicationGroup) SetMemberClustersOutpostArns(v []*string) *ReplicationGroup

SetMemberClustersOutpostArns sets the MemberClustersOutpostArns field's value.

func (*ReplicationGroup) SetMultiAZ

func (s *ReplicationGroup) SetMultiAZ(v string) *ReplicationGroup

SetMultiAZ sets the MultiAZ field's value.

func (*ReplicationGroup) SetNetworkType added in v1.42.9

func (s *ReplicationGroup) SetNetworkType(v string) *ReplicationGroup

SetNetworkType sets the NetworkType field's value.

func (*ReplicationGroup) SetNodeGroups

func (s *ReplicationGroup) SetNodeGroups(v []*NodeGroup) *ReplicationGroup

SetNodeGroups sets the NodeGroups field's value.

func (*ReplicationGroup) SetPendingModifiedValues

SetPendingModifiedValues sets the PendingModifiedValues field's value.

func (*ReplicationGroup) SetReplicationGroupCreateTime

func (s *ReplicationGroup) SetReplicationGroupCreateTime(v time.Time) *ReplicationGroup

SetReplicationGroupCreateTime sets the ReplicationGroupCreateTime field's value.

func (*ReplicationGroup) SetReplicationGroupId

func (s *ReplicationGroup) SetReplicationGroupId(v string) *ReplicationGroup

SetReplicationGroupId sets the ReplicationGroupId field's value.

func (*ReplicationGroup) SetSnapshotRetentionLimit

func (s *ReplicationGroup) SetSnapshotRetentionLimit(v int64) *ReplicationGroup

SetSnapshotRetentionLimit sets the SnapshotRetentionLimit field's value.

func (*ReplicationGroup) SetSnapshotWindow

func (s *ReplicationGroup) SetSnapshotWindow(v string) *ReplicationGroup

SetSnapshotWindow sets the SnapshotWindow field's value.

func (*ReplicationGroup) SetSnapshottingClusterId

func (s *ReplicationGroup) SetSnapshottingClusterId(v string) *ReplicationGroup

SetSnapshottingClusterId sets the SnapshottingClusterId field's value.

func (*ReplicationGroup) SetStatus

func (s *ReplicationGroup) SetStatus(v string) *ReplicationGroup

SetStatus sets the Status field's value.

func (*ReplicationGroup) SetTransitEncryptionEnabled

func (s *ReplicationGroup) SetTransitEncryptionEnabled(v bool) *ReplicationGroup

SetTransitEncryptionEnabled sets the TransitEncryptionEnabled field's value.

func (*ReplicationGroup) SetTransitEncryptionMode added in v1.42.9

func (s *ReplicationGroup) SetTransitEncryptionMode(v string) *ReplicationGroup

SetTransitEncryptionMode sets the TransitEncryptionMode field's value.

func (*ReplicationGroup) SetUserGroupIds

func (s *ReplicationGroup) SetUserGroupIds(v []*string) *ReplicationGroup

SetUserGroupIds sets the UserGroupIds field's value.

func (ReplicationGroup) String

func (s ReplicationGroup) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ReplicationGroupPendingModifiedValues

type ReplicationGroupPendingModifiedValues struct {

	// The auth token status
	AuthTokenStatus *string `type:"string" enum:"AuthTokenUpdateStatus"`

	// Indicates the status of automatic failover for this Redis replication group.
	AutomaticFailoverStatus *string `type:"string" enum:"PendingAutomaticFailoverStatus"`

	// Enabled or Disabled. To modify cluster mode from Disabled to Enabled, you
	// must first set the cluster mode to Compatible. Compatible mode allows your
	// Redis clients to connect using both cluster mode enabled and cluster mode
	// disabled. After you migrate all Redis clients to use cluster mode enabled,
	// you can then complete cluster mode configuration and set the cluster mode
	// to Enabled.
	ClusterMode *string `type:"string" enum:"ClusterMode"`

	// The log delivery configurations being modified
	LogDeliveryConfigurations []*PendingLogDeliveryConfiguration `locationName:"PendingLogDeliveryConfiguration" type:"list"`

	// 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"`

	// A flag that enables in-transit encryption when set to true.
	TransitEncryptionEnabled *bool `type:"boolean"`

	// A setting that allows you to migrate your clients to use in-transit encryption,
	// with no downtime.
	TransitEncryptionMode *string `type:"string" enum:"TransitEncryptionMode"`

	// The user group being modified.
	UserGroups *UserGroupsUpdateStatus `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) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ReplicationGroupPendingModifiedValues) SetAuthTokenStatus

SetAuthTokenStatus sets the AuthTokenStatus field's value.

func (*ReplicationGroupPendingModifiedValues) SetAutomaticFailoverStatus

SetAutomaticFailoverStatus sets the AutomaticFailoverStatus field's value.

func (*ReplicationGroupPendingModifiedValues) SetClusterMode added in v1.42.9

SetClusterMode sets the ClusterMode field's value.

func (*ReplicationGroupPendingModifiedValues) SetLogDeliveryConfigurations

SetLogDeliveryConfigurations sets the LogDeliveryConfigurations field's value.

func (*ReplicationGroupPendingModifiedValues) SetPrimaryClusterId

SetPrimaryClusterId sets the PrimaryClusterId field's value.

func (*ReplicationGroupPendingModifiedValues) SetResharding

SetResharding sets the Resharding field's value.

func (*ReplicationGroupPendingModifiedValues) SetTransitEncryptionEnabled added in v1.42.9

SetTransitEncryptionEnabled sets the TransitEncryptionEnabled field's value.

func (*ReplicationGroupPendingModifiedValues) SetTransitEncryptionMode added in v1.42.9

SetTransitEncryptionMode sets the TransitEncryptionMode field's value.

func (*ReplicationGroupPendingModifiedValues) SetUserGroups

SetUserGroups sets the UserGroups field's value.

func (ReplicationGroupPendingModifiedValues) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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: M6g node types (available only
	//    for Redis engine version 5.0.6 onward and for Memcached engine version
	//    1.5.16 onward): cache.m6g.large, cache.m6g.xlarge, cache.m6g.2xlarge,
	//    cache.m6g.4xlarge, cache.m6g.8xlarge, cache.m6g.12xlarge, cache.m6g.16xlarge
	//    For region availability, see Supported Node Types (https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/CacheNodes.SupportedTypes.html#CacheNodes.SupportedTypesByRegion)
	//    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 T4g node types (available
	//    only for Redis engine version 5.0.6 onward and Memcached engine version
	//    1.5.16 onward): cache.t4g.micro, cache.t4g.small, cache.t4g.medium 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. Existing clusters are still supported but creation of new
	//    clusters is not supported for these types.) 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. Existing clusters
	//    are still supported but creation of new clusters is not supported for
	//    these types.) C1 node types: cache.c1.xlarge
	//
	//    * Memory optimized: Current generation: R6g node types (available only
	//    for Redis engine version 5.0.6 onward and for Memcached engine version
	//    1.5.16 onward). cache.r6g.large, cache.r6g.xlarge, cache.r6g.2xlarge,
	//    cache.r6g.4xlarge, cache.r6g.8xlarge, cache.r6g.12xlarge, cache.r6g.16xlarge
	//    For region availability, see Supported Node Types (https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/CacheNodes.SupportedTypes.html#CacheNodes.SupportedTypesByRegion)
	//    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. Existing clusters are still supported
	//    but creation of new clusters is not supported for these types.) 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) GoString

func (s ReservedCacheNode) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ReservedCacheNode) SetCacheNodeCount

func (s *ReservedCacheNode) SetCacheNodeCount(v int64) *ReservedCacheNode

SetCacheNodeCount sets the CacheNodeCount field's value.

func (*ReservedCacheNode) SetCacheNodeType

func (s *ReservedCacheNode) SetCacheNodeType(v string) *ReservedCacheNode

SetCacheNodeType sets the CacheNodeType field's value.

func (*ReservedCacheNode) SetDuration

func (s *ReservedCacheNode) SetDuration(v int64) *ReservedCacheNode

SetDuration sets the Duration field's value.

func (*ReservedCacheNode) SetFixedPrice

func (s *ReservedCacheNode) SetFixedPrice(v float64) *ReservedCacheNode

SetFixedPrice sets the FixedPrice field's value.

func (*ReservedCacheNode) SetOfferingType

func (s *ReservedCacheNode) SetOfferingType(v string) *ReservedCacheNode

SetOfferingType sets the OfferingType field's value.

func (*ReservedCacheNode) SetProductDescription

func (s *ReservedCacheNode) SetProductDescription(v string) *ReservedCacheNode

SetProductDescription sets the ProductDescription field's value.

func (*ReservedCacheNode) SetRecurringCharges

func (s *ReservedCacheNode) SetRecurringCharges(v []*RecurringCharge) *ReservedCacheNode

SetRecurringCharges sets the RecurringCharges field's value.

func (*ReservedCacheNode) SetReservationARN

func (s *ReservedCacheNode) SetReservationARN(v string) *ReservedCacheNode

SetReservationARN sets the ReservationARN field's value.

func (*ReservedCacheNode) SetReservedCacheNodeId

func (s *ReservedCacheNode) SetReservedCacheNodeId(v string) *ReservedCacheNode

SetReservedCacheNodeId sets the ReservedCacheNodeId field's value.

func (*ReservedCacheNode) SetReservedCacheNodesOfferingId

func (s *ReservedCacheNode) SetReservedCacheNodesOfferingId(v string) *ReservedCacheNode

SetReservedCacheNodesOfferingId sets the ReservedCacheNodesOfferingId field's value.

func (*ReservedCacheNode) SetStartTime

func (s *ReservedCacheNode) SetStartTime(v time.Time) *ReservedCacheNode

SetStartTime sets the StartTime field's value.

func (*ReservedCacheNode) SetState

func (s *ReservedCacheNode) SetState(v string) *ReservedCacheNode

SetState sets the State field's value.

func (*ReservedCacheNode) SetUsagePrice

func (s *ReservedCacheNode) SetUsagePrice(v float64) *ReservedCacheNode

SetUsagePrice sets the UsagePrice field's value.

func (ReservedCacheNode) String

func (s ReservedCacheNode) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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: M6g node types (available only
	//    for Redis engine version 5.0.6 onward and for Memcached engine version
	//    1.5.16 onward): cache.m6g.large, cache.m6g.xlarge, cache.m6g.2xlarge,
	//    cache.m6g.4xlarge, cache.m6g.8xlarge, cache.m6g.12xlarge, cache.m6g.16xlarge
	//    For region availability, see Supported Node Types (https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/CacheNodes.SupportedTypes.html#CacheNodes.SupportedTypesByRegion)
	//    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 T4g node types (available
	//    only for Redis engine version 5.0.6 onward and Memcached engine version
	//    1.5.16 onward): cache.t4g.micro, cache.t4g.small, cache.t4g.medium 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. Existing clusters are still supported but creation of new
	//    clusters is not supported for these types.) 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. Existing clusters
	//    are still supported but creation of new clusters is not supported for
	//    these types.) C1 node types: cache.c1.xlarge
	//
	//    * Memory optimized: Current generation: R6g node types (available only
	//    for Redis engine version 5.0.6 onward and for Memcached engine version
	//    1.5.16 onward). cache.r6g.large, cache.r6g.xlarge, cache.r6g.2xlarge,
	//    cache.r6g.4xlarge, cache.r6g.8xlarge, cache.r6g.12xlarge, cache.r6g.16xlarge
	//    For region availability, see Supported Node Types (https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/CacheNodes.SupportedTypes.html#CacheNodes.SupportedTypesByRegion)
	//    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. Existing clusters are still supported
	//    but creation of new clusters is not supported for these types.) 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) GoString

func (s ReservedCacheNodesOffering) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ReservedCacheNodesOffering) SetCacheNodeType

SetCacheNodeType sets the CacheNodeType field's value.

func (*ReservedCacheNodesOffering) SetDuration

SetDuration sets the Duration field's value.

func (*ReservedCacheNodesOffering) SetFixedPrice

SetFixedPrice sets the FixedPrice field's value.

func (*ReservedCacheNodesOffering) SetOfferingType

SetOfferingType sets the OfferingType field's value.

func (*ReservedCacheNodesOffering) SetProductDescription

func (s *ReservedCacheNodesOffering) SetProductDescription(v string) *ReservedCacheNodesOffering

SetProductDescription sets the ProductDescription field's value.

func (*ReservedCacheNodesOffering) SetRecurringCharges

SetRecurringCharges sets the RecurringCharges field's value.

func (*ReservedCacheNodesOffering) SetReservedCacheNodesOfferingId

func (s *ReservedCacheNodesOffering) SetReservedCacheNodesOfferingId(v string) *ReservedCacheNodesOffering

SetReservedCacheNodesOfferingId sets the ReservedCacheNodesOfferingId field's value.

func (*ReservedCacheNodesOffering) SetUsagePrice

SetUsagePrice sets the UsagePrice field's value.

func (ReservedCacheNodesOffering) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ResetCacheParameterGroupInput) SetCacheParameterGroupName

func (s *ResetCacheParameterGroupInput) SetCacheParameterGroupName(v string) *ResetCacheParameterGroupInput

SetCacheParameterGroupName sets the CacheParameterGroupName field's value.

func (*ResetCacheParameterGroupInput) SetParameterNameValues

SetParameterNameValues sets the ParameterNameValues field's value.

func (*ResetCacheParameterGroupInput) SetResetAllParameters

SetResetAllParameters sets the ResetAllParameters field's value.

func (ResetCacheParameterGroupInput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ResetCacheParameterGroupInput) Validate

func (s *ResetCacheParameterGroupInput) Validate() error

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

type ReshardingConfiguration

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) GoString

func (s ReshardingConfiguration) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ReshardingConfiguration) SetNodeGroupId

SetNodeGroupId sets the NodeGroupId field's value.

func (*ReshardingConfiguration) SetPreferredAvailabilityZones

func (s *ReshardingConfiguration) SetPreferredAvailabilityZones(v []*string) *ReshardingConfiguration

SetPreferredAvailabilityZones sets the PreferredAvailabilityZones field's value.

func (ReshardingConfiguration) String

func (s ReshardingConfiguration) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ReshardingConfiguration) Validate

func (s *ReshardingConfiguration) Validate() error

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

type ReshardingStatus

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) GoString

func (s ReshardingStatus) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ReshardingStatus) SetSlotMigration

func (s *ReshardingStatus) SetSlotMigration(v *SlotMigration) *ReshardingStatus

SetSlotMigration sets the SlotMigration field's value.

func (ReshardingStatus) String

func (s ReshardingStatus) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 Amazon account number of the Amazon EC2 security group owner. Note that
	// this is not the same thing as an Amazon access key ID - you must provide
	// a valid Amazon 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) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RevokeCacheSecurityGroupIngressInput) SetCacheSecurityGroupName

SetCacheSecurityGroupName sets the CacheSecurityGroupName field's value.

func (*RevokeCacheSecurityGroupIngressInput) SetEC2SecurityGroupName

SetEC2SecurityGroupName sets the EC2SecurityGroupName field's value.

func (*RevokeCacheSecurityGroupIngressInput) SetEC2SecurityGroupOwnerId

SetEC2SecurityGroupOwnerId sets the EC2SecurityGroupOwnerId field's value.

func (RevokeCacheSecurityGroupIngressInput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RevokeCacheSecurityGroupIngressOutput) SetCacheSecurityGroup

SetCacheSecurityGroup sets the CacheSecurityGroup field's value.

func (RevokeCacheSecurityGroupIngressOutput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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) GoString

func (s SecurityGroupMembership) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SecurityGroupMembership) SetSecurityGroupId

func (s *SecurityGroupMembership) SetSecurityGroupId(v string) *SecurityGroupMembership

SetSecurityGroupId sets the SecurityGroupId field's value.

func (*SecurityGroupMembership) SetStatus

SetStatus sets the Status field's value.

func (SecurityGroupMembership) String

func (s SecurityGroupMembership) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ServiceUpdate

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 *string `type:"string" enum:"ServiceUpdateSeverity"`

	// The status of the service update
	ServiceUpdateStatus *string `type:"string" enum:"ServiceUpdateStatus"`

	// Reflects the nature of the service update
	ServiceUpdateType *string `type:"string" enum:"ServiceUpdateType"`
	// contains filtered or unexported fields
}

An update that you can apply to your Redis clusters.

func (ServiceUpdate) GoString

func (s ServiceUpdate) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ServiceUpdate) SetAutoUpdateAfterRecommendedApplyByDate

func (s *ServiceUpdate) SetAutoUpdateAfterRecommendedApplyByDate(v bool) *ServiceUpdate

SetAutoUpdateAfterRecommendedApplyByDate sets the AutoUpdateAfterRecommendedApplyByDate field's value.

func (*ServiceUpdate) SetEngine

func (s *ServiceUpdate) SetEngine(v string) *ServiceUpdate

SetEngine sets the Engine field's value.

func (*ServiceUpdate) SetEngineVersion

func (s *ServiceUpdate) SetEngineVersion(v string) *ServiceUpdate

SetEngineVersion sets the EngineVersion field's value.

func (*ServiceUpdate) SetEstimatedUpdateTime

func (s *ServiceUpdate) SetEstimatedUpdateTime(v string) *ServiceUpdate

SetEstimatedUpdateTime sets the EstimatedUpdateTime field's value.

func (*ServiceUpdate) SetServiceUpdateDescription

func (s *ServiceUpdate) SetServiceUpdateDescription(v string) *ServiceUpdate

SetServiceUpdateDescription sets the ServiceUpdateDescription field's value.

func (*ServiceUpdate) SetServiceUpdateEndDate

func (s *ServiceUpdate) SetServiceUpdateEndDate(v time.Time) *ServiceUpdate

SetServiceUpdateEndDate sets the ServiceUpdateEndDate field's value.

func (*ServiceUpdate) SetServiceUpdateName

func (s *ServiceUpdate) SetServiceUpdateName(v string) *ServiceUpdate

SetServiceUpdateName sets the ServiceUpdateName field's value.

func (*ServiceUpdate) SetServiceUpdateRecommendedApplyByDate

func (s *ServiceUpdate) SetServiceUpdateRecommendedApplyByDate(v time.Time) *ServiceUpdate

SetServiceUpdateRecommendedApplyByDate sets the ServiceUpdateRecommendedApplyByDate field's value.

func (*ServiceUpdate) SetServiceUpdateReleaseDate

func (s *ServiceUpdate) SetServiceUpdateReleaseDate(v time.Time) *ServiceUpdate

SetServiceUpdateReleaseDate sets the ServiceUpdateReleaseDate field's value.

func (*ServiceUpdate) SetServiceUpdateSeverity

func (s *ServiceUpdate) SetServiceUpdateSeverity(v string) *ServiceUpdate

SetServiceUpdateSeverity sets the ServiceUpdateSeverity field's value.

func (*ServiceUpdate) SetServiceUpdateStatus

func (s *ServiceUpdate) SetServiceUpdateStatus(v string) *ServiceUpdate

SetServiceUpdateStatus sets the ServiceUpdateStatus field's value.

func (*ServiceUpdate) SetServiceUpdateType

func (s *ServiceUpdate) SetServiceUpdateType(v string) *ServiceUpdate

SetServiceUpdateType sets the ServiceUpdateType field's value.

func (ServiceUpdate) String

func (s ServiceUpdate) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type SlotMigration

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) GoString

func (s SlotMigration) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SlotMigration) SetProgressPercentage

func (s *SlotMigration) SetProgressPercentage(v float64) *SlotMigration

SetProgressPercentage sets the ProgressPercentage field's value.

func (SlotMigration) String

func (s SlotMigration) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type Snapshot

type Snapshot struct {

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

	// If you are running Redis engine version 6.0 or later, set this parameter
	// to yes if you want to opt-in to the next auto minor version upgrade campaign.
	// This parameter is disabled for previous versions.
	AutoMinorVersionUpgrade *bool `type:"boolean"`

	// Indicates the status of automatic failover for the source Redis replication
	// group.
	AutomaticFailover *string `type:"string" enum:"AutomaticFailoverStatus"`

	// 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: M6g node types (available only
	//    for Redis engine version 5.0.6 onward and for Memcached engine version
	//    1.5.16 onward): cache.m6g.large, cache.m6g.xlarge, cache.m6g.2xlarge,
	//    cache.m6g.4xlarge, cache.m6g.8xlarge, cache.m6g.12xlarge, cache.m6g.16xlarge
	//    For region availability, see Supported Node Types (https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/CacheNodes.SupportedTypes.html#CacheNodes.SupportedTypesByRegion)
	//    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 T4g node types (available
	//    only for Redis engine version 5.0.6 onward and Memcached engine version
	//    1.5.16 onward): cache.t4g.micro, cache.t4g.small, cache.t4g.medium 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. Existing clusters are still supported but creation of new
	//    clusters is not supported for these types.) 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. Existing clusters
	//    are still supported but creation of new clusters is not supported for
	//    these types.) C1 node types: cache.c1.xlarge
	//
	//    * Memory optimized: Current generation: R6g node types (available only
	//    for Redis engine version 5.0.6 onward and for Memcached engine version
	//    1.5.16 onward). cache.r6g.large, cache.r6g.xlarge, cache.r6g.2xlarge,
	//    cache.r6g.4xlarge, cache.r6g.8xlarge, cache.r6g.12xlarge, cache.r6g.16xlarge
	//    For region availability, see Supported Node Types (https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/CacheNodes.SupportedTypes.html#CacheNodes.SupportedTypesByRegion)
	//    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. Existing clusters are still supported
	//    but creation of new clusters is not supported for these types.) 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"`

	// Enables data tiering. Data tiering is only supported for replication groups
	// using the r6gd node type. This parameter must be set to true when using r6gd
	// nodes. For more information, see Data tiering (https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/data-tiering.html).
	DataTiering *string `type:"string" enum:"DataTieringStatus"`

	// 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 40.
	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"`

	// The ARN (Amazon Resource Name) of the preferred outpost.
	PreferredOutpostArn *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) GoString

func (s Snapshot) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Snapshot) SetARN

func (s *Snapshot) SetARN(v string) *Snapshot

SetARN sets the ARN field's value.

func (*Snapshot) SetAutoMinorVersionUpgrade

func (s *Snapshot) SetAutoMinorVersionUpgrade(v bool) *Snapshot

SetAutoMinorVersionUpgrade sets the AutoMinorVersionUpgrade field's value.

func (*Snapshot) SetAutomaticFailover

func (s *Snapshot) SetAutomaticFailover(v string) *Snapshot

SetAutomaticFailover sets the AutomaticFailover field's value.

func (*Snapshot) SetCacheClusterCreateTime

func (s *Snapshot) SetCacheClusterCreateTime(v time.Time) *Snapshot

SetCacheClusterCreateTime sets the CacheClusterCreateTime field's value.

func (*Snapshot) SetCacheClusterId

func (s *Snapshot) SetCacheClusterId(v string) *Snapshot

SetCacheClusterId sets the CacheClusterId field's value.

func (*Snapshot) SetCacheNodeType

func (s *Snapshot) SetCacheNodeType(v string) *Snapshot

SetCacheNodeType sets the CacheNodeType field's value.

func (*Snapshot) SetCacheParameterGroupName

func (s *Snapshot) SetCacheParameterGroupName(v string) *Snapshot

SetCacheParameterGroupName sets the CacheParameterGroupName field's value.

func (*Snapshot) SetCacheSubnetGroupName

func (s *Snapshot) SetCacheSubnetGroupName(v string) *Snapshot

SetCacheSubnetGroupName sets the CacheSubnetGroupName field's value.

func (*Snapshot) SetDataTiering added in v1.42.9

func (s *Snapshot) SetDataTiering(v string) *Snapshot

SetDataTiering sets the DataTiering field's value.

func (*Snapshot) SetEngine

func (s *Snapshot) SetEngine(v string) *Snapshot

SetEngine sets the Engine field's value.

func (*Snapshot) SetEngineVersion

func (s *Snapshot) SetEngineVersion(v string) *Snapshot

SetEngineVersion sets the EngineVersion field's value.

func (*Snapshot) SetKmsKeyId

func (s *Snapshot) SetKmsKeyId(v string) *Snapshot

SetKmsKeyId sets the KmsKeyId field's value.

func (*Snapshot) SetNodeSnapshots

func (s *Snapshot) SetNodeSnapshots(v []*NodeSnapshot) *Snapshot

SetNodeSnapshots sets the NodeSnapshots field's value.

func (*Snapshot) SetNumCacheNodes

func (s *Snapshot) SetNumCacheNodes(v int64) *Snapshot

SetNumCacheNodes sets the NumCacheNodes field's value.

func (*Snapshot) SetNumNodeGroups

func (s *Snapshot) SetNumNodeGroups(v int64) *Snapshot

SetNumNodeGroups sets the NumNodeGroups field's value.

func (*Snapshot) SetPort

func (s *Snapshot) SetPort(v int64) *Snapshot

SetPort sets the Port field's value.

func (*Snapshot) SetPreferredAvailabilityZone

func (s *Snapshot) SetPreferredAvailabilityZone(v string) *Snapshot

SetPreferredAvailabilityZone sets the PreferredAvailabilityZone field's value.

func (*Snapshot) SetPreferredMaintenanceWindow

func (s *Snapshot) SetPreferredMaintenanceWindow(v string) *Snapshot

SetPreferredMaintenanceWindow sets the PreferredMaintenanceWindow field's value.

func (*Snapshot) SetPreferredOutpostArn

func (s *Snapshot) SetPreferredOutpostArn(v string) *Snapshot

SetPreferredOutpostArn sets the PreferredOutpostArn field's value.

func (*Snapshot) SetReplicationGroupDescription

func (s *Snapshot) SetReplicationGroupDescription(v string) *Snapshot

SetReplicationGroupDescription sets the ReplicationGroupDescription field's value.

func (*Snapshot) SetReplicationGroupId

func (s *Snapshot) SetReplicationGroupId(v string) *Snapshot

SetReplicationGroupId sets the ReplicationGroupId field's value.

func (*Snapshot) SetSnapshotName

func (s *Snapshot) SetSnapshotName(v string) *Snapshot

SetSnapshotName sets the SnapshotName field's value.

func (*Snapshot) SetSnapshotRetentionLimit

func (s *Snapshot) SetSnapshotRetentionLimit(v int64) *Snapshot

SetSnapshotRetentionLimit sets the SnapshotRetentionLimit field's value.

func (*Snapshot) SetSnapshotSource

func (s *Snapshot) SetSnapshotSource(v string) *Snapshot

SetSnapshotSource sets the SnapshotSource field's value.

func (*Snapshot) SetSnapshotStatus

func (s *Snapshot) SetSnapshotStatus(v string) *Snapshot

SetSnapshotStatus sets the SnapshotStatus field's value.

func (*Snapshot) SetSnapshotWindow

func (s *Snapshot) SetSnapshotWindow(v string) *Snapshot

SetSnapshotWindow sets the SnapshotWindow field's value.

func (*Snapshot) SetTopicArn

func (s *Snapshot) SetTopicArn(v string) *Snapshot

SetTopicArn sets the TopicArn field's value.

func (*Snapshot) SetVpcId

func (s *Snapshot) SetVpcId(v string) *Snapshot

SetVpcId sets the VpcId field's value.

func (Snapshot) String

func (s Snapshot) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type StartMigrationInput

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) GoString

func (s StartMigrationInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StartMigrationInput) SetCustomerNodeEndpointList

func (s *StartMigrationInput) SetCustomerNodeEndpointList(v []*CustomerNodeEndpoint) *StartMigrationInput

SetCustomerNodeEndpointList sets the CustomerNodeEndpointList field's value.

func (*StartMigrationInput) SetReplicationGroupId

func (s *StartMigrationInput) SetReplicationGroupId(v string) *StartMigrationInput

SetReplicationGroupId sets the ReplicationGroupId field's value.

func (StartMigrationInput) String

func (s StartMigrationInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StartMigrationInput) Validate

func (s *StartMigrationInput) Validate() error

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

type StartMigrationOutput

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) GoString

func (s StartMigrationOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StartMigrationOutput) SetReplicationGroup

func (s *StartMigrationOutput) SetReplicationGroup(v *ReplicationGroup) *StartMigrationOutput

SetReplicationGroup sets the ReplicationGroup field's value.

func (StartMigrationOutput) String

func (s StartMigrationOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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"`

	// The outpost ARN of the subnet.
	SubnetOutpost *SubnetOutpost `type:"structure"`

	// Either ipv4 | ipv6 | dual_stack. IPv6 is supported for workloads using Redis
	// engine version 6.2 onward or Memcached engine version 1.6.6 on all instances
	// built on the Nitro system (http://aws.amazon.com/ec2/nitro/).
	SupportedNetworkTypes []*string `type:"list" enum:"NetworkType"`
	// 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) GoString

func (s Subnet) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Subnet) SetSubnetAvailabilityZone

func (s *Subnet) SetSubnetAvailabilityZone(v *AvailabilityZone) *Subnet

SetSubnetAvailabilityZone sets the SubnetAvailabilityZone field's value.

func (*Subnet) SetSubnetIdentifier

func (s *Subnet) SetSubnetIdentifier(v string) *Subnet

SetSubnetIdentifier sets the SubnetIdentifier field's value.

func (*Subnet) SetSubnetOutpost

func (s *Subnet) SetSubnetOutpost(v *SubnetOutpost) *Subnet

SetSubnetOutpost sets the SubnetOutpost field's value.

func (*Subnet) SetSupportedNetworkTypes added in v1.42.9

func (s *Subnet) SetSupportedNetworkTypes(v []*string) *Subnet

SetSupportedNetworkTypes sets the SupportedNetworkTypes field's value.

func (Subnet) String

func (s Subnet) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type SubnetOutpost

type SubnetOutpost struct {

	// The outpost ARN of the subnet.
	SubnetOutpostArn *string `type:"string"`
	// contains filtered or unexported fields
}

The ID of the outpost subnet.

func (SubnetOutpost) GoString

func (s SubnetOutpost) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SubnetOutpost) SetSubnetOutpostArn

func (s *SubnetOutpost) SetSubnetOutpostArn(v string) *SubnetOutpost

SetSubnetOutpostArn sets the SubnetOutpostArn field's value.

func (SubnetOutpost) String

func (s SubnetOutpost) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 tag that can be added to an ElastiCache cluster or replication group. Tags are composed of a Key/Value pair. You can use tags to categorize and track all your ElastiCache resources, with the exception of global replication group. When you add or remove tags on replication groups, those actions will be replicated to all nodes in the replication group. A tag with a null Value is permitted.

func (Tag) GoString

func (s Tag) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Tag) SetKey

func (s *Tag) SetKey(v string) *Tag

SetKey sets the Key field's value.

func (*Tag) SetValue

func (s *Tag) SetValue(v string) *Tag

SetValue sets the Value field's value.

func (Tag) String

func (s Tag) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type TagListMessage

type TagListMessage struct {

	// A list of 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 (TagListMessage) GoString

func (s TagListMessage) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TagListMessage) SetTagList

func (s *TagListMessage) SetTagList(v []*Tag) *TagListMessage

SetTagList sets the TagList field's value.

func (TagListMessage) String

func (s TagListMessage) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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) GoString

func (s TestFailoverInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TestFailoverInput) SetNodeGroupId

func (s *TestFailoverInput) SetNodeGroupId(v string) *TestFailoverInput

SetNodeGroupId sets the NodeGroupId field's value.

func (*TestFailoverInput) SetReplicationGroupId

func (s *TestFailoverInput) SetReplicationGroupId(v string) *TestFailoverInput

SetReplicationGroupId sets the ReplicationGroupId field's value.

func (TestFailoverInput) String

func (s TestFailoverInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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) GoString

func (s TestFailoverOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TestFailoverOutput) SetReplicationGroup

func (s *TestFailoverOutput) SetReplicationGroup(v *ReplicationGroup) *TestFailoverOutput

SetReplicationGroup sets the ReplicationGroup field's value.

func (TestFailoverOutput) String

func (s TestFailoverOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type TimeRangeFilter

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) GoString

func (s TimeRangeFilter) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TimeRangeFilter) SetEndTime

func (s *TimeRangeFilter) SetEndTime(v time.Time) *TimeRangeFilter

SetEndTime sets the EndTime field's value.

func (*TimeRangeFilter) SetStartTime

func (s *TimeRangeFilter) SetStartTime(v time.Time) *TimeRangeFilter

SetStartTime sets the StartTime field's value.

func (TimeRangeFilter) String

func (s TimeRangeFilter) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UnprocessedUpdateAction

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) GoString

func (s UnprocessedUpdateAction) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UnprocessedUpdateAction) SetCacheClusterId

func (s *UnprocessedUpdateAction) SetCacheClusterId(v string) *UnprocessedUpdateAction

SetCacheClusterId sets the CacheClusterId field's value.

func (*UnprocessedUpdateAction) SetErrorMessage

SetErrorMessage sets the ErrorMessage field's value.

func (*UnprocessedUpdateAction) SetErrorType

SetErrorType sets the ErrorType field's value.

func (*UnprocessedUpdateAction) SetReplicationGroupId

func (s *UnprocessedUpdateAction) SetReplicationGroupId(v string) *UnprocessedUpdateAction

SetReplicationGroupId sets the ReplicationGroupId field's value.

func (*UnprocessedUpdateAction) SetServiceUpdateName

func (s *UnprocessedUpdateAction) SetServiceUpdateName(v string) *UnprocessedUpdateAction

SetServiceUpdateName sets the ServiceUpdateName field's value.

func (UnprocessedUpdateAction) String

func (s UnprocessedUpdateAction) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UpdateAction

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 *string `type:"string" enum:"ServiceUpdateSeverity"`

	// The status of the service update
	ServiceUpdateStatus *string `type:"string" enum:"ServiceUpdateStatus"`

	// Reflects the nature of the service update
	ServiceUpdateType *string `type:"string" enum:"ServiceUpdateType"`

	// 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 *string `type:"string" enum:"SlaMet"`

	// The date that the service update is available to a replication group
	UpdateActionAvailableDate *time.Time `type:"timestamp"`

	// The status of the update action
	UpdateActionStatus *string `type:"string" enum:"UpdateActionStatus"`

	// 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) GoString

func (s UpdateAction) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateAction) SetCacheClusterId

func (s *UpdateAction) SetCacheClusterId(v string) *UpdateAction

SetCacheClusterId sets the CacheClusterId field's value.

func (*UpdateAction) SetCacheNodeUpdateStatus

func (s *UpdateAction) SetCacheNodeUpdateStatus(v []*CacheNodeUpdateStatus) *UpdateAction

SetCacheNodeUpdateStatus sets the CacheNodeUpdateStatus field's value.

func (*UpdateAction) SetEngine

func (s *UpdateAction) SetEngine(v string) *UpdateAction

SetEngine sets the Engine field's value.

func (*UpdateAction) SetEstimatedUpdateTime

func (s *UpdateAction) SetEstimatedUpdateTime(v string) *UpdateAction

SetEstimatedUpdateTime sets the EstimatedUpdateTime field's value.

func (*UpdateAction) SetNodeGroupUpdateStatus

func (s *UpdateAction) SetNodeGroupUpdateStatus(v []*NodeGroupUpdateStatus) *UpdateAction

SetNodeGroupUpdateStatus sets the NodeGroupUpdateStatus field's value.

func (*UpdateAction) SetNodesUpdated

func (s *UpdateAction) SetNodesUpdated(v string) *UpdateAction

SetNodesUpdated sets the NodesUpdated field's value.

func (*UpdateAction) SetReplicationGroupId

func (s *UpdateAction) SetReplicationGroupId(v string) *UpdateAction

SetReplicationGroupId sets the ReplicationGroupId field's value.

func (*UpdateAction) SetServiceUpdateName

func (s *UpdateAction) SetServiceUpdateName(v string) *UpdateAction

SetServiceUpdateName sets the ServiceUpdateName field's value.

func (*UpdateAction) SetServiceUpdateRecommendedApplyByDate

func (s *UpdateAction) SetServiceUpdateRecommendedApplyByDate(v time.Time) *UpdateAction

SetServiceUpdateRecommendedApplyByDate sets the ServiceUpdateRecommendedApplyByDate field's value.

func (*UpdateAction) SetServiceUpdateReleaseDate

func (s *UpdateAction) SetServiceUpdateReleaseDate(v time.Time) *UpdateAction

SetServiceUpdateReleaseDate sets the ServiceUpdateReleaseDate field's value.

func (*UpdateAction) SetServiceUpdateSeverity

func (s *UpdateAction) SetServiceUpdateSeverity(v string) *UpdateAction

SetServiceUpdateSeverity sets the ServiceUpdateSeverity field's value.

func (*UpdateAction) SetServiceUpdateStatus

func (s *UpdateAction) SetServiceUpdateStatus(v string) *UpdateAction

SetServiceUpdateStatus sets the ServiceUpdateStatus field's value.

func (*UpdateAction) SetServiceUpdateType

func (s *UpdateAction) SetServiceUpdateType(v string) *UpdateAction

SetServiceUpdateType sets the ServiceUpdateType field's value.

func (*UpdateAction) SetSlaMet

func (s *UpdateAction) SetSlaMet(v string) *UpdateAction

SetSlaMet sets the SlaMet field's value.

func (*UpdateAction) SetUpdateActionAvailableDate

func (s *UpdateAction) SetUpdateActionAvailableDate(v time.Time) *UpdateAction

SetUpdateActionAvailableDate sets the UpdateActionAvailableDate field's value.

func (*UpdateAction) SetUpdateActionStatus

func (s *UpdateAction) SetUpdateActionStatus(v string) *UpdateAction

SetUpdateActionStatus sets the UpdateActionStatus field's value.

func (*UpdateAction) SetUpdateActionStatusModifiedDate

func (s *UpdateAction) SetUpdateActionStatusModifiedDate(v time.Time) *UpdateAction

SetUpdateActionStatusModifiedDate sets the UpdateActionStatusModifiedDate field's value.

func (UpdateAction) String

func (s UpdateAction) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type User

type User struct {

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

	// Access permissions string used for this user.
	AccessString *string `type:"string"`

	// Denotes whether the user requires a password to authenticate.
	Authentication *Authentication `type:"structure"`

	// The current supported value is Redis.
	Engine *string `type:"string"`

	// The minimum engine version required, which is Redis 6.0
	MinimumEngineVersion *string `type:"string"`

	// Indicates the user status. Can be "active", "modifying" or "deleting".
	Status *string `type:"string"`

	// Returns a list of the user group IDs the user belongs to.
	UserGroupIds []*string `type:"list"`

	// The ID of the user.
	UserId *string `type:"string"`

	// The username of the user.
	UserName *string `type:"string"`
	// contains filtered or unexported fields
}

func (User) GoString

func (s User) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*User) SetARN

func (s *User) SetARN(v string) *User

SetARN sets the ARN field's value.

func (*User) SetAccessString

func (s *User) SetAccessString(v string) *User

SetAccessString sets the AccessString field's value.

func (*User) SetAuthentication

func (s *User) SetAuthentication(v *Authentication) *User

SetAuthentication sets the Authentication field's value.

func (*User) SetEngine

func (s *User) SetEngine(v string) *User

SetEngine sets the Engine field's value.

func (*User) SetMinimumEngineVersion added in v1.42.9

func (s *User) SetMinimumEngineVersion(v string) *User

SetMinimumEngineVersion sets the MinimumEngineVersion field's value.

func (*User) SetStatus

func (s *User) SetStatus(v string) *User

SetStatus sets the Status field's value.

func (*User) SetUserGroupIds

func (s *User) SetUserGroupIds(v []*string) *User

SetUserGroupIds sets the UserGroupIds field's value.

func (*User) SetUserId

func (s *User) SetUserId(v string) *User

SetUserId sets the UserId field's value.

func (*User) SetUserName

func (s *User) SetUserName(v string) *User

SetUserName sets the UserName field's value.

func (User) String

func (s User) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UserGroup

type UserGroup struct {

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

	// The current supported value is Redis.
	Engine *string `type:"string"`

	// The minimum engine version required, which is Redis 6.0
	MinimumEngineVersion *string `type:"string"`

	// A list of updates being applied to the user group.
	PendingChanges *UserGroupPendingChanges `type:"structure"`

	// A list of replication groups that the user group can access.
	ReplicationGroups []*string `type:"list"`

	// Indicates user group status. Can be "creating", "active", "modifying", "deleting".
	Status *string `type:"string"`

	// The ID of the user group.
	UserGroupId *string `type:"string"`

	// The list of user IDs that belong to the user group.
	UserIds []*string `type:"list"`
	// contains filtered or unexported fields
}

func (UserGroup) GoString

func (s UserGroup) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UserGroup) SetARN

func (s *UserGroup) SetARN(v string) *UserGroup

SetARN sets the ARN field's value.

func (*UserGroup) SetEngine

func (s *UserGroup) SetEngine(v string) *UserGroup

SetEngine sets the Engine field's value.

func (*UserGroup) SetMinimumEngineVersion added in v1.42.9

func (s *UserGroup) SetMinimumEngineVersion(v string) *UserGroup

SetMinimumEngineVersion sets the MinimumEngineVersion field's value.

func (*UserGroup) SetPendingChanges

func (s *UserGroup) SetPendingChanges(v *UserGroupPendingChanges) *UserGroup

SetPendingChanges sets the PendingChanges field's value.

func (*UserGroup) SetReplicationGroups

func (s *UserGroup) SetReplicationGroups(v []*string) *UserGroup

SetReplicationGroups sets the ReplicationGroups field's value.

func (*UserGroup) SetStatus

func (s *UserGroup) SetStatus(v string) *UserGroup

SetStatus sets the Status field's value.

func (*UserGroup) SetUserGroupId

func (s *UserGroup) SetUserGroupId(v string) *UserGroup

SetUserGroupId sets the UserGroupId field's value.

func (*UserGroup) SetUserIds

func (s *UserGroup) SetUserIds(v []*string) *UserGroup

SetUserIds sets the UserIds field's value.

func (UserGroup) String

func (s UserGroup) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UserGroupPendingChanges

type UserGroupPendingChanges struct {

	// The list of user IDs to add.
	UserIdsToAdd []*string `type:"list"`

	// The list of user IDs to remove.
	UserIdsToRemove []*string `type:"list"`
	// contains filtered or unexported fields
}

Returns the updates being applied to the user group.

func (UserGroupPendingChanges) GoString

func (s UserGroupPendingChanges) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UserGroupPendingChanges) SetUserIdsToAdd

func (s *UserGroupPendingChanges) SetUserIdsToAdd(v []*string) *UserGroupPendingChanges

SetUserIdsToAdd sets the UserIdsToAdd field's value.

func (*UserGroupPendingChanges) SetUserIdsToRemove

func (s *UserGroupPendingChanges) SetUserIdsToRemove(v []*string) *UserGroupPendingChanges

SetUserIdsToRemove sets the UserIdsToRemove field's value.

func (UserGroupPendingChanges) String

func (s UserGroupPendingChanges) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UserGroupsUpdateStatus

type UserGroupsUpdateStatus struct {

	// The ID of the user group to add.
	UserGroupIdsToAdd []*string `type:"list"`

	// The ID of the user group to remove.
	UserGroupIdsToRemove []*string `type:"list"`
	// contains filtered or unexported fields
}

The status of the user group update.

func (UserGroupsUpdateStatus) GoString

func (s UserGroupsUpdateStatus) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UserGroupsUpdateStatus) SetUserGroupIdsToAdd

func (s *UserGroupsUpdateStatus) SetUserGroupIdsToAdd(v []*string) *UserGroupsUpdateStatus

SetUserGroupIdsToAdd sets the UserGroupIdsToAdd field's value.

func (*UserGroupsUpdateStatus) SetUserGroupIdsToRemove

func (s *UserGroupsUpdateStatus) SetUserGroupIdsToRemove(v []*string) *UserGroupsUpdateStatus

SetUserGroupIdsToRemove sets the UserGroupIdsToRemove field's value.

func (UserGroupsUpdateStatus) String

func (s UserGroupsUpdateStatus) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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