elasticache

package
v1.54.17 Latest Latest
Warning

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

 Go to latest Published: Jul 9, 2024 License: Apache-2.0 Imports: 10 Imported by: 422

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"

	// SourceTypeServerlessCache is a SourceType enum value
	SourceTypeServerlessCache = "serverless-cache"

	// SourceTypeServerlessCacheSnapshot is a SourceType enum value
	SourceTypeServerlessCacheSnapshot = "serverless-cache-snapshot"

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

	// ErrCodeInvalidCredentialsException for service response error code
	// "InvalidCredentialsException".
	//
	// You must enter valid credentials.
	ErrCodeInvalidCredentialsException = "InvalidCredentialsException"

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

	// ErrCodeInvalidServerlessCacheSnapshotStateFault for service response error code
	// "InvalidServerlessCacheSnapshotStateFault".
	//
	// The state of the serverless cache snapshot was not received. Available for
	// Redis only.
	ErrCodeInvalidServerlessCacheSnapshotStateFault = "InvalidServerlessCacheSnapshotStateFault"

	// ErrCodeInvalidServerlessCacheStateFault for service response error code
	// "InvalidServerlessCacheStateFault".
	//
	// The account for these credentials is not currently active.
	ErrCodeInvalidServerlessCacheStateFault = "InvalidServerlessCacheStateFault"

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

	// ErrCodeServerlessCacheAlreadyExistsFault for service response error code
	// "ServerlessCacheAlreadyExistsFault".
	//
	// A serverless cache with this name already exists.
	ErrCodeServerlessCacheAlreadyExistsFault = "ServerlessCacheAlreadyExistsFault"

	// ErrCodeServerlessCacheNotFoundFault for service response error code
	// "ServerlessCacheNotFoundFault".
	//
	// The serverless cache was not found or does not exist.
	ErrCodeServerlessCacheNotFoundFault = "ServerlessCacheNotFoundFault"

	// ErrCodeServerlessCacheQuotaForCustomerExceededFault for service response error code
	// "ServerlessCacheQuotaForCustomerExceededFault".
	//
	// The number of serverless caches exceeds the customer quota.
	ErrCodeServerlessCacheQuotaForCustomerExceededFault = "ServerlessCacheQuotaForCustomerExceededFault"

	// ErrCodeServerlessCacheSnapshotAlreadyExistsFault for service response error code
	// "ServerlessCacheSnapshotAlreadyExistsFault".
	//
	// A serverless cache snapshot with this name already exists. Available for
	// Redis only.
	ErrCodeServerlessCacheSnapshotAlreadyExistsFault = "ServerlessCacheSnapshotAlreadyExistsFault"

	// ErrCodeServerlessCacheSnapshotNotFoundFault for service response error code
	// "ServerlessCacheSnapshotNotFoundFault".
	//
	// This serverless cache snapshot could not be found or does not exist. Available
	// for Redis only.
	ErrCodeServerlessCacheSnapshotNotFoundFault = "ServerlessCacheSnapshotNotFoundFault"

	// ErrCodeServerlessCacheSnapshotQuotaExceededFault for service response error code
	// "ServerlessCacheSnapshotQuotaExceededFault".
	//
	// The number of serverless cache snapshots exceeds the customer snapshot quota.
	// Available for Redis only.
	ErrCodeServerlessCacheSnapshotQuotaExceededFault = "ServerlessCacheSnapshotQuotaExceededFault"

	// 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 (
	// DataStorageUnitGb is a DataStorageUnit enum value
	DataStorageUnitGb = "GB"
)
View Source 
const (
	// ServiceUpdateTypeSecurityUpdate is a ServiceUpdateType enum value
	ServiceUpdateTypeSecurityUpdate = "security-update"
)

Variables

This section is empty.

Functions

func AZMode_Values added in v1.34.3 

func AZMode_Values() []string

AZMode_Values returns all elements of the AZMode enum

func AuthTokenUpdateStatus_Values added in v1.34.3 

func AuthTokenUpdateStatus_Values() []string

AuthTokenUpdateStatus_Values returns all elements of the AuthTokenUpdateStatus enum

func AuthTokenUpdateStrategyType_Values added in v1.34.3 

func AuthTokenUpdateStrategyType_Values() []string

AuthTokenUpdateStrategyType_Values returns all elements of the AuthTokenUpdateStrategyType enum

func AuthenticationType_Values added in v1.35.5 

func AuthenticationType_Values() []string

AuthenticationType_Values returns all elements of the AuthenticationType enum

func AutomaticFailoverStatus_Values added in v1.34.3 

func AutomaticFailoverStatus_Values() []string

AutomaticFailoverStatus_Values returns all elements of the AutomaticFailoverStatus enum

func ChangeType_Values added in v1.34.3 

func ChangeType_Values() []string

ChangeType_Values returns all elements of the ChangeType enum

func ClusterMode_Values added in v1.44.262 

func ClusterMode_Values() []string

ClusterMode_Values returns all elements of the ClusterMode enum

func DataStorageUnit_Values added in v1.48.6 

func DataStorageUnit_Values() []string

DataStorageUnit_Values returns all elements of the DataStorageUnit enum

func DataTieringStatus_Values added in v1.42.11 

func DataTieringStatus_Values() []string

DataTieringStatus_Values returns all elements of the DataTieringStatus enum

func DestinationType_Values added in v1.38.24 

func DestinationType_Values() []string

DestinationType_Values returns all elements of the DestinationType enum

func InputAuthenticationType_Values added in v1.44.139 

func InputAuthenticationType_Values() []string

InputAuthenticationType_Values returns all elements of the InputAuthenticationType enum

func IpDiscovery_Values added in v1.44.132 

func IpDiscovery_Values() []string

IpDiscovery_Values returns all elements of the IpDiscovery enum

func LogDeliveryConfigurationStatus_Values added in v1.38.24 

func LogDeliveryConfigurationStatus_Values() []string

LogDeliveryConfigurationStatus_Values returns all elements of the LogDeliveryConfigurationStatus enum

func LogFormat_Values added in v1.38.24 

func LogFormat_Values() []string

LogFormat_Values returns all elements of the LogFormat enum

func LogType_Values added in v1.38.24 

func LogType_Values() []string

LogType_Values returns all elements of the LogType enum

func MultiAZStatus_Values added in v1.34.3 

func MultiAZStatus_Values() []string

MultiAZStatus_Values returns all elements of the MultiAZStatus enum

func NetworkType_Values added in v1.44.132 

func NetworkType_Values() []string

NetworkType_Values returns all elements of the NetworkType enum

func NodeUpdateInitiatedBy_Values added in v1.34.3 

func NodeUpdateInitiatedBy_Values() []string

NodeUpdateInitiatedBy_Values returns all elements of the NodeUpdateInitiatedBy enum

func NodeUpdateStatus_Values added in v1.34.3 

func NodeUpdateStatus_Values() []string

NodeUpdateStatus_Values returns all elements of the NodeUpdateStatus enum

func OutpostMode_Values added in v1.35.5 

func OutpostMode_Values() []string

OutpostMode_Values returns all elements of the OutpostMode enum

func PendingAutomaticFailoverStatus_Values added in v1.34.3 

func PendingAutomaticFailoverStatus_Values() []string

PendingAutomaticFailoverStatus_Values returns all elements of the PendingAutomaticFailoverStatus enum

func ServiceUpdateSeverity_Values added in v1.34.3 

func ServiceUpdateSeverity_Values() []string

ServiceUpdateSeverity_Values returns all elements of the ServiceUpdateSeverity enum

func ServiceUpdateStatus_Values added in v1.34.3 

func ServiceUpdateStatus_Values() []string

ServiceUpdateStatus_Values returns all elements of the ServiceUpdateStatus enum

func ServiceUpdateType_Values added in v1.34.3 

func ServiceUpdateType_Values() []string

ServiceUpdateType_Values returns all elements of the ServiceUpdateType enum

func SlaMet_Values added in v1.34.3 

func SlaMet_Values() []string

SlaMet_Values returns all elements of the SlaMet enum

func SourceType_Values added in v1.34.3 

func SourceType_Values() []string

SourceType_Values returns all elements of the SourceType enum

func TransitEncryptionMode_Values added in v1.44.169 

func TransitEncryptionMode_Values() []string

TransitEncryptionMode_Values returns all elements of the TransitEncryptionMode enum

func UpdateActionStatus_Values added in v1.34.3 

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 added in v0.6.5 

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 added in v1.5.0 

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

SetResourceName sets the ResourceName field's value.

func (*AddTagsToResourceInput) SetTags added in v1.5.0 

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

SetTags sets the Tags field's value.

func (AddTagsToResourceInput) String added in v0.6.5 

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 added in v1.1.21 

func (s *AddTagsToResourceInput) Validate() error

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

type Authentication added in v1.35.5 

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 added in v1.35.5 

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 added in v1.35.5 

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

SetPasswordCount sets the PasswordCount field's value.

func (*Authentication) SetType added in v1.35.5 

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

SetType sets the Type field's value.

func (Authentication) String added in v1.35.5 

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

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

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

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

SetPasswords sets the Passwords field's value.

func (*AuthenticationMode) SetType added in v1.44.139 

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

SetType sets the Type field's value.

func (AuthenticationMode) String added in v1.44.139 

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

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 added in v0.6.5 

func (s AuthorizeCacheSecurityGroupIngressInput) 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 (*AuthorizeCacheSecurityGroupIngressInput) SetCacheSecurityGroupName added in v1.5.0 

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

SetCacheSecurityGroupName sets the CacheSecurityGroupName field's value.

func (*AuthorizeCacheSecurityGroupIngressInput) SetEC2SecurityGroupName added in v1.5.0 

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

SetEC2SecurityGroupName sets the EC2SecurityGroupName field's value.

func (*AuthorizeCacheSecurityGroupIngressInput) SetEC2SecurityGroupOwnerId added in v1.5.0 

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

SetEC2SecurityGroupOwnerId sets the EC2SecurityGroupOwnerId field's value.

func (AuthorizeCacheSecurityGroupIngressInput) String added in v0.6.5 

func (s AuthorizeCacheSecurityGroupIngressInput) 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 (*AuthorizeCacheSecurityGroupIngressInput) Validate added in v1.1.21 

func (s *AuthorizeCacheSecurityGroupIngressInput) Validate() error

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 added in v0.6.5 

func (s AuthorizeCacheSecurityGroupIngressOutput) 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 (*AuthorizeCacheSecurityGroupIngressOutput) SetCacheSecurityGroup added in v1.5.0 

func (s *AuthorizeCacheSecurityGroupIngressOutput) SetCacheSecurityGroup(v *CacheSecurityGroup) *AuthorizeCacheSecurityGroupIngressOutput

SetCacheSecurityGroup sets the CacheSecurityGroup field's value.

func (AuthorizeCacheSecurityGroupIngressOutput) String added in v0.6.5 

func (s AuthorizeCacheSecurityGroupIngressOutput) 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 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 added in v0.6.5 

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 added in v1.5.0 

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

SetName sets the Name field's value.

func (AvailabilityZone) String added in v0.6.5 

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 added in v1.19.43 

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 added in v1.19.43 

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 added in v1.25.9 

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

SetCacheClusterIds sets the CacheClusterIds field's value.

func (*BatchApplyUpdateActionInput) SetReplicationGroupIds added in v1.19.43 

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

SetReplicationGroupIds sets the ReplicationGroupIds field's value.

func (*BatchApplyUpdateActionInput) SetServiceUpdateName added in v1.19.43 

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

SetServiceUpdateName sets the ServiceUpdateName field's value.

func (BatchApplyUpdateActionInput) String added in v1.19.43 

func (s BatchApplyUpdateActionInput) 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 (*BatchApplyUpdateActionInput) Validate added in v1.19.43 

func (s *BatchApplyUpdateActionInput) Validate() error

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

type BatchApplyUpdateActionOutput added in v1.19.43 

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 added in v1.19.43 

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 added in v1.19.43 

func (s *BatchApplyUpdateActionOutput) SetProcessedUpdateActions(v []*ProcessedUpdateAction) *BatchApplyUpdateActionOutput

SetProcessedUpdateActions sets the ProcessedUpdateActions field's value.

func (*BatchApplyUpdateActionOutput) SetUnprocessedUpdateActions added in v1.19.43 

func (s *BatchApplyUpdateActionOutput) SetUnprocessedUpdateActions(v []*UnprocessedUpdateAction) *BatchApplyUpdateActionOutput

SetUnprocessedUpdateActions sets the UnprocessedUpdateActions field's value.

func (BatchApplyUpdateActionOutput) String added in v1.19.43 

func (s BatchApplyUpdateActionOutput) 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 BatchStopUpdateActionInput added in v1.19.43 

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 added in v1.19.43 

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 added in v1.25.9 

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

SetCacheClusterIds sets the CacheClusterIds field's value.

func (*BatchStopUpdateActionInput) SetReplicationGroupIds added in v1.19.43 

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

SetReplicationGroupIds sets the ReplicationGroupIds field's value.

func (*BatchStopUpdateActionInput) SetServiceUpdateName added in v1.19.43 

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

SetServiceUpdateName sets the ServiceUpdateName field's value.

func (BatchStopUpdateActionInput) String added in v1.19.43 

func (s BatchStopUpdateActionInput) 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 (*BatchStopUpdateActionInput) Validate added in v1.19.43 

func (s *BatchStopUpdateActionInput) Validate() error

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

type BatchStopUpdateActionOutput added in v1.19.43 

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 added in v1.19.43 

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 added in v1.19.43 

func (s *BatchStopUpdateActionOutput) SetProcessedUpdateActions(v []*ProcessedUpdateAction) *BatchStopUpdateActionOutput

SetProcessedUpdateActions sets the ProcessedUpdateActions field's value.

func (*BatchStopUpdateActionOutput) SetUnprocessedUpdateActions added in v1.19.43 

func (s *BatchStopUpdateActionOutput) SetUnprocessedUpdateActions(v []*UnprocessedUpdateAction) *BatchStopUpdateActionOutput

SetUnprocessedUpdateActions sets the UnprocessedUpdateActions field's value.

func (BatchStopUpdateActionOutput) String added in v1.19.43 

func (s BatchStopUpdateActionOutput) 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 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: M7g node types: cache.m7g.large,
	//    cache.m7g.xlarge, cache.m7g.2xlarge, cache.m7g.4xlarge, cache.m7g.8xlarge,
	//    cache.m7g.12xlarge, cache.m7g.16xlarge For region availability, see Supported
	//    Node Types (https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/CacheNodes.SupportedTypes.html#CacheNodes.SupportedTypesByRegion)
	//    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 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: R7g node types: cache.r7g.large,
	//    cache.r7g.xlarge, cache.r7g.2xlarge, cache.r7g.4xlarge, cache.r7g.8xlarge,
	//    cache.r7g.12xlarge, cache.r7g.16xlarge For region availability, see Supported
	//    Node Types (https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/CacheNodes.SupportedTypes.html#CacheNodes.SupportedTypesByRegion)
	//    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 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 added in v0.6.5 

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 added in v1.31.5 

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

SetARN sets the ARN field's value.

func (*CacheCluster) SetAtRestEncryptionEnabled added in v1.12.17 

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

SetAtRestEncryptionEnabled sets the AtRestEncryptionEnabled field's value.

func (*CacheCluster) SetAuthTokenEnabled added in v1.12.17 

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

SetAuthTokenEnabled sets the AuthTokenEnabled field's value.

func (*CacheCluster) SetAuthTokenLastModifiedDate added in v1.25.23 

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

SetAuthTokenLastModifiedDate sets the AuthTokenLastModifiedDate field's value.

func (*CacheCluster) SetAutoMinorVersionUpgrade added in v1.5.0 

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

SetAutoMinorVersionUpgrade sets the AutoMinorVersionUpgrade field's value.

func (*CacheCluster) SetCacheClusterCreateTime added in v1.5.0 

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

SetCacheClusterCreateTime sets the CacheClusterCreateTime field's value.

func (*CacheCluster) SetCacheClusterId added in v1.5.0 

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

SetCacheClusterId sets the CacheClusterId field's value.

func (*CacheCluster) SetCacheClusterStatus added in v1.5.0 

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

SetCacheClusterStatus sets the CacheClusterStatus field's value.

func (*CacheCluster) SetCacheNodeType added in v1.5.0 

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

SetCacheNodeType sets the CacheNodeType field's value.

func (*CacheCluster) SetCacheNodes added in v1.5.0 

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

SetCacheNodes sets the CacheNodes field's value.

func (*CacheCluster) SetCacheParameterGroup added in v1.5.0 

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

SetCacheParameterGroup sets the CacheParameterGroup field's value.

func (*CacheCluster) SetCacheSecurityGroups added in v1.5.0 

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

SetCacheSecurityGroups sets the CacheSecurityGroups field's value.

func (*CacheCluster) SetCacheSubnetGroupName added in v1.5.0 

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

SetCacheSubnetGroupName sets the CacheSubnetGroupName field's value.

func (*CacheCluster) SetClientDownloadLandingPage added in v1.5.0 

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

SetClientDownloadLandingPage sets the ClientDownloadLandingPage field's value.

func (*CacheCluster) SetConfigurationEndpoint added in v1.5.0 

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

SetConfigurationEndpoint sets the ConfigurationEndpoint field's value.

func (*CacheCluster) SetEngine added in v1.5.0 

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

SetEngine sets the Engine field's value.

func (*CacheCluster) SetEngineVersion added in v1.5.0 

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

SetEngineVersion sets the EngineVersion field's value.

func (*CacheCluster) SetIpDiscovery added in v1.44.132 

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

SetIpDiscovery sets the IpDiscovery field's value.

func (*CacheCluster) SetLogDeliveryConfigurations added in v1.38.24 

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

SetLogDeliveryConfigurations sets the LogDeliveryConfigurations field's value.

func (*CacheCluster) SetNetworkType added in v1.44.132 

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

SetNetworkType sets the NetworkType field's value.

func (*CacheCluster) SetNotificationConfiguration added in v1.5.0 

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

SetNotificationConfiguration sets the NotificationConfiguration field's value.

func (*CacheCluster) SetNumCacheNodes added in v1.5.0 

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

SetNumCacheNodes sets the NumCacheNodes field's value.

func (*CacheCluster) SetPendingModifiedValues added in v1.5.0 

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

SetPendingModifiedValues sets the PendingModifiedValues field's value.

func (*CacheCluster) SetPreferredAvailabilityZone added in v1.5.0 

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

SetPreferredAvailabilityZone sets the PreferredAvailabilityZone field's value.

func (*CacheCluster) SetPreferredMaintenanceWindow added in v1.5.0 

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

SetPreferredMaintenanceWindow sets the PreferredMaintenanceWindow field's value.

func (*CacheCluster) SetPreferredOutpostArn added in v1.35.5 

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

SetPreferredOutpostArn sets the PreferredOutpostArn field's value.

func (*CacheCluster) SetReplicationGroupId added in v1.5.0 

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

SetReplicationGroupId sets the ReplicationGroupId field's value.

func (*CacheCluster) SetReplicationGroupLogDeliveryEnabled added in v1.38.24 

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

SetReplicationGroupLogDeliveryEnabled sets the ReplicationGroupLogDeliveryEnabled field's value.

func (*CacheCluster) SetSecurityGroups added in v1.5.0 

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

SetSecurityGroups sets the SecurityGroups field's value.

func (*CacheCluster) SetSnapshotRetentionLimit added in v1.5.0 

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

SetSnapshotRetentionLimit sets the SnapshotRetentionLimit field's value.

func (*CacheCluster) SetSnapshotWindow added in v1.5.0 

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

SetSnapshotWindow sets the SnapshotWindow field's value.

func (*CacheCluster) SetTransitEncryptionEnabled added in v1.12.17 

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

SetTransitEncryptionEnabled sets the TransitEncryptionEnabled field's value.

func (*CacheCluster) SetTransitEncryptionMode added in v1.44.169 

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

SetTransitEncryptionMode sets the TransitEncryptionMode field's value.

func (CacheCluster) String added in v0.6.5 

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 added in v0.6.5 

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 added in v1.5.0 

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

SetCacheEngineDescription sets the CacheEngineDescription field's value.

func (*CacheEngineVersion) SetCacheEngineVersionDescription added in v1.5.0 

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

SetCacheEngineVersionDescription sets the CacheEngineVersionDescription field's value.

func (*CacheEngineVersion) SetCacheParameterGroupFamily added in v1.5.0 

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

SetCacheParameterGroupFamily sets the CacheParameterGroupFamily field's value.

func (*CacheEngineVersion) SetEngine added in v1.5.0 

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

SetEngine sets the Engine field's value.

func (*CacheEngineVersion) SetEngineVersion added in v1.5.0 

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

SetEngineVersion sets the EngineVersion field's value.

func (CacheEngineVersion) String added in v0.6.5 

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: M7g node types: cache.m7g.large, cache.m7g.xlarge, cache.m7g.2xlarge, cache.m7g.4xlarge, cache.m7g.8xlarge, cache.m7g.12xlarge, cache.m7g.16xlarge For region availability, see Supported Node Types (https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/CacheNodes.SupportedTypes.html#CacheNodes.SupportedTypesByRegion) 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 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: R7g node types: cache.r7g.large, cache.r7g.xlarge, cache.r7g.2xlarge, cache.r7g.4xlarge, cache.r7g.8xlarge, cache.r7g.12xlarge, cache.r7g.16xlarge For region availability, see Supported Node Types (https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/CacheNodes.SupportedTypes.html#CacheNodes.SupportedTypesByRegion) 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 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 added in v0.6.5 

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 added in v1.5.0 

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

SetCacheNodeCreateTime sets the CacheNodeCreateTime field's value.

func (*CacheNode) SetCacheNodeId added in v1.5.0 

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

SetCacheNodeId sets the CacheNodeId field's value.

func (*CacheNode) SetCacheNodeStatus added in v1.5.0 

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

SetCacheNodeStatus sets the CacheNodeStatus field's value.

func (*CacheNode) SetCustomerAvailabilityZone added in v1.5.0 

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

SetCustomerAvailabilityZone sets the CustomerAvailabilityZone field's value.

func (*CacheNode) SetCustomerOutpostArn added in v1.35.5 

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

SetCustomerOutpostArn sets the CustomerOutpostArn field's value.

func (*CacheNode) SetEndpoint added in v1.5.0 

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

SetEndpoint sets the Endpoint field's value.

func (*CacheNode) SetParameterGroupStatus added in v1.5.0 

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

SetParameterGroupStatus sets the ParameterGroupStatus field's value.

func (*CacheNode) SetSourceCacheNodeId added in v1.5.0 

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

SetSourceCacheNodeId sets the SourceCacheNodeId field's value.

func (CacheNode) String added in v0.6.5 

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 added in v0.6.5 

func (s CacheNodeTypeSpecificParameter) 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 (*CacheNodeTypeSpecificParameter) SetAllowedValues added in v1.5.0 

func (s *CacheNodeTypeSpecificParameter) SetAllowedValues(v string) *CacheNodeTypeSpecificParameter

SetAllowedValues sets the AllowedValues field's value.

func (*CacheNodeTypeSpecificParameter) SetCacheNodeTypeSpecificValues added in v1.5.0 

func (s *CacheNodeTypeSpecificParameter) SetCacheNodeTypeSpecificValues(v []*CacheNodeTypeSpecificValue) *CacheNodeTypeSpecificParameter

SetCacheNodeTypeSpecificValues sets the CacheNodeTypeSpecificValues field's value.

func (*CacheNodeTypeSpecificParameter) SetChangeType added in v1.5.0 

func (s *CacheNodeTypeSpecificParameter) SetChangeType(v string) *CacheNodeTypeSpecificParameter

SetChangeType sets the ChangeType field's value.

func (*CacheNodeTypeSpecificParameter) SetDataType added in v1.5.0 

func (s *CacheNodeTypeSpecificParameter) SetDataType(v string) *CacheNodeTypeSpecificParameter

SetDataType sets the DataType field's value.

func (*CacheNodeTypeSpecificParameter) SetDescription added in v1.5.0 

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

SetDescription sets the Description field's value.

func (*CacheNodeTypeSpecificParameter) SetIsModifiable added in v1.5.0 

func (s *CacheNodeTypeSpecificParameter) SetIsModifiable(v bool) *CacheNodeTypeSpecificParameter

SetIsModifiable sets the IsModifiable field's value.

func (*CacheNodeTypeSpecificParameter) SetMinimumEngineVersion added in v1.5.0 

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

SetMinimumEngineVersion sets the MinimumEngineVersion field's value.

func (*CacheNodeTypeSpecificParameter) SetParameterName added in v1.5.0 

func (s *CacheNodeTypeSpecificParameter) SetParameterName(v string) *CacheNodeTypeSpecificParameter

SetParameterName sets the ParameterName field's value.

func (*CacheNodeTypeSpecificParameter) SetSource added in v1.5.0 

func (s *CacheNodeTypeSpecificParameter) SetSource(v string) *CacheNodeTypeSpecificParameter

SetSource sets the Source field's value.

func (CacheNodeTypeSpecificParameter) String added in v0.6.5 

func (s CacheNodeTypeSpecificParameter) 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 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 added in v0.6.5 

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 added in v1.5.0 

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

SetCacheNodeType sets the CacheNodeType field's value.

func (*CacheNodeTypeSpecificValue) SetValue added in v1.5.0 

func (s *CacheNodeTypeSpecificValue) SetValue(v string) *CacheNodeTypeSpecificValue

SetValue sets the Value field's value.

func (CacheNodeTypeSpecificValue) String added in v0.6.5 

func (s CacheNodeTypeSpecificValue) 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 CacheNodeUpdateStatus added in v1.25.9 

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 added in v1.25.9 

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 added in v1.25.9 

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

SetCacheNodeId sets the CacheNodeId field's value.

func (*CacheNodeUpdateStatus) SetNodeDeletionDate added in v1.25.9 

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

SetNodeDeletionDate sets the NodeDeletionDate field's value.

func (*CacheNodeUpdateStatus) SetNodeUpdateEndDate added in v1.25.9 

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

SetNodeUpdateEndDate sets the NodeUpdateEndDate field's value.

func (*CacheNodeUpdateStatus) SetNodeUpdateInitiatedBy added in v1.25.9 

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

SetNodeUpdateInitiatedBy sets the NodeUpdateInitiatedBy field's value.

func (*CacheNodeUpdateStatus) SetNodeUpdateInitiatedDate added in v1.25.9 

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

SetNodeUpdateInitiatedDate sets the NodeUpdateInitiatedDate field's value.

func (*CacheNodeUpdateStatus) SetNodeUpdateStartDate added in v1.25.9 

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

SetNodeUpdateStartDate sets the NodeUpdateStartDate field's value.

func (*CacheNodeUpdateStatus) SetNodeUpdateStatus added in v1.25.9 

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

SetNodeUpdateStatus sets the NodeUpdateStatus field's value.

func (*CacheNodeUpdateStatus) SetNodeUpdateStatusModifiedDate added in v1.25.9 

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

SetNodeUpdateStatusModifiedDate sets the NodeUpdateStatusModifiedDate field's value.

func (CacheNodeUpdateStatus) String added in v1.25.9 

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 added in v0.6.5 

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 added in v1.31.5 

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

SetARN sets the ARN field's value.

func (*CacheParameterGroup) SetCacheParameterGroupFamily added in v1.5.0 

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

SetCacheParameterGroupFamily sets the CacheParameterGroupFamily field's value.

func (*CacheParameterGroup) SetCacheParameterGroupName added in v1.5.0 

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

SetCacheParameterGroupName sets the CacheParameterGroupName field's value.

func (*CacheParameterGroup) SetDescription added in v1.5.0 

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

SetDescription sets the Description field's value.

func (*CacheParameterGroup) SetIsGlobal added in v1.29.25 

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

SetIsGlobal sets the IsGlobal field's value.

func (CacheParameterGroup) String added in v0.6.5 

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 added in v0.6.5 

func (s CacheParameterGroupNameMessage) 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 (*CacheParameterGroupNameMessage) SetCacheParameterGroupName added in v1.5.0 

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

SetCacheParameterGroupName sets the CacheParameterGroupName field's value.

func (CacheParameterGroupNameMessage) String added in v0.6.5 

func (s CacheParameterGroupNameMessage) 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 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 added in v0.6.5 

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 added in v1.5.0 

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

SetCacheNodeIdsToReboot sets the CacheNodeIdsToReboot field's value.

func (*CacheParameterGroupStatus) SetCacheParameterGroupName added in v1.5.0 

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

SetCacheParameterGroupName sets the CacheParameterGroupName field's value.

func (*CacheParameterGroupStatus) SetParameterApplyStatus added in v1.5.0 

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

SetParameterApplyStatus sets the ParameterApplyStatus field's value.

func (CacheParameterGroupStatus) String added in v0.6.5 

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 added in v0.6.5 

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 added in v1.31.5 

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

SetARN sets the ARN field's value.

func (*CacheSecurityGroup) SetCacheSecurityGroupName added in v1.5.0 

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

SetCacheSecurityGroupName sets the CacheSecurityGroupName field's value.

func (*CacheSecurityGroup) SetDescription added in v1.5.0 

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

SetDescription sets the Description field's value.

func (*CacheSecurityGroup) SetEC2SecurityGroups added in v1.5.0 

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

SetEC2SecurityGroups sets the EC2SecurityGroups field's value.

func (*CacheSecurityGroup) SetOwnerId added in v1.5.0 

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

SetOwnerId sets the OwnerId field's value.

func (CacheSecurityGroup) String added in v0.6.5 

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 added in v0.6.5 

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 added in v1.5.0 

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

SetCacheSecurityGroupName sets the CacheSecurityGroupName field's value.

func (*CacheSecurityGroupMembership) SetStatus added in v1.5.0 

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

SetStatus sets the Status field's value.

func (CacheSecurityGroupMembership) String added in v0.6.5 

func (s CacheSecurityGroupMembership) 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 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 added in v0.6.5 

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 added in v1.31.5 

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

SetARN sets the ARN field's value.

func (*CacheSubnetGroup) SetCacheSubnetGroupDescription added in v1.5.0 

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

SetCacheSubnetGroupDescription sets the CacheSubnetGroupDescription field's value.

func (*CacheSubnetGroup) SetCacheSubnetGroupName added in v1.5.0 

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

SetCacheSubnetGroupName sets the CacheSubnetGroupName field's value.

func (*CacheSubnetGroup) SetSubnets added in v1.5.0 

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

SetSubnets sets the Subnets field's value.

func (*CacheSubnetGroup) SetSupportedNetworkTypes added in v1.44.132 

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

SetSupportedNetworkTypes sets the SupportedNetworkTypes field's value.

func (*CacheSubnetGroup) SetVpcId added in v1.5.0 

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

SetVpcId sets the VpcId field's value.

func (CacheSubnetGroup) String added in v0.6.5 

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 CacheUsageLimits added in v1.48.6 

type CacheUsageLimits struct {

	// The maximum data storage limit in the cache, expressed in Gigabytes.
	DataStorage *DataStorage `type:"structure"`

	// The configuration for the number of ElastiCache Processing Units (ECPU) the
	// cache can consume per second.
	ECPUPerSecond *ECPUPerSecond `type:"structure"`
	// contains filtered or unexported fields
}

The usage limits for storage and ElastiCache Processing Units for the cache.

func (CacheUsageLimits) GoString added in v1.48.6 

func (s CacheUsageLimits) 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 (*CacheUsageLimits) SetDataStorage added in v1.48.6 

func (s *CacheUsageLimits) SetDataStorage(v *DataStorage) *CacheUsageLimits

SetDataStorage sets the DataStorage field's value.

func (*CacheUsageLimits) SetECPUPerSecond added in v1.48.6 

func (s *CacheUsageLimits) SetECPUPerSecond(v *ECPUPerSecond) *CacheUsageLimits

SetECPUPerSecond sets the ECPUPerSecond field's value.

func (CacheUsageLimits) String added in v1.48.6 

func (s CacheUsageLimits) 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 (*CacheUsageLimits) Validate added in v1.48.6 

func (s *CacheUsageLimits) Validate() error

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

type CloudWatchLogsDestinationDetails added in v1.38.24 

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 added in v1.38.24 

func (s CloudWatchLogsDestinationDetails) 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 (*CloudWatchLogsDestinationDetails) SetLogGroup added in v1.38.24 

func (s *CloudWatchLogsDestinationDetails) SetLogGroup(v string) *CloudWatchLogsDestinationDetails

SetLogGroup sets the LogGroup field's value.

func (CloudWatchLogsDestinationDetails) String added in v1.38.24 

func (s CloudWatchLogsDestinationDetails) 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 CompleteMigrationInput added in v1.25.20 

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 added in v1.25.20 

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 added in v1.25.20 

func (s *CompleteMigrationInput) SetForce(v bool) *CompleteMigrationInput

SetForce sets the Force field's value.

func (*CompleteMigrationInput) SetReplicationGroupId added in v1.25.20 

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

SetReplicationGroupId sets the ReplicationGroupId field's value.

func (CompleteMigrationInput) String added in v1.25.20 

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 added in v1.25.20 

func (s *CompleteMigrationInput) Validate() error

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

type CompleteMigrationOutput added in v1.25.20 

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 added in v1.25.20 

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 added in v1.25.20 

func (s *CompleteMigrationOutput) SetReplicationGroup(v *ReplicationGroup) *CompleteMigrationOutput

SetReplicationGroup sets the ReplicationGroup field's value.

func (CompleteMigrationOutput) String added in v1.25.20 

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 added in v1.15.29 

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 added in v1.15.29 

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 added in v1.15.29 

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

SetNewReplicaCount sets the NewReplicaCount field's value.

func (*ConfigureShard) SetNodeGroupId added in v1.15.29 

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

SetNodeGroupId sets the NodeGroupId field's value.

func (*ConfigureShard) SetPreferredAvailabilityZones added in v1.15.29 

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

SetPreferredAvailabilityZones sets the PreferredAvailabilityZones field's value.

func (*ConfigureShard) SetPreferredOutpostArns added in v1.35.5 

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

SetPreferredOutpostArns sets the PreferredOutpostArns field's value.

func (ConfigureShard) String added in v1.15.29 

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 added in v1.15.29 

func (s *ConfigureShard) Validate() error

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

type CopyServerlessCacheSnapshotInput added in v1.48.6 

type CopyServerlessCacheSnapshotInput struct {

	// The identifier of the KMS key used to encrypt the target snapshot. Available
	// for Redis only.
	KmsKeyId *string `type:"string"`

	// The identifier of the existing serverless cache’s snapshot to be copied.
	// Available for Redis only.
	//
	// SourceServerlessCacheSnapshotName is a required field
	SourceServerlessCacheSnapshotName *string `type:"string" required:"true"`

	// A list of tags to be added to the target snapshot resource. A tag is a key-value
	// pair. Available for Redis only. Default: NULL
	Tags []*Tag `locationNameList:"Tag" type:"list"`

	// The identifier for the snapshot to be created. Available for Redis only.
	//
	// TargetServerlessCacheSnapshotName is a required field
	TargetServerlessCacheSnapshotName *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (CopyServerlessCacheSnapshotInput) GoString added in v1.48.6 

func (s CopyServerlessCacheSnapshotInput) 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 (*CopyServerlessCacheSnapshotInput) SetKmsKeyId added in v1.48.6 

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

SetKmsKeyId sets the KmsKeyId field's value.

func (*CopyServerlessCacheSnapshotInput) SetSourceServerlessCacheSnapshotName added in v1.48.6 

func (s *CopyServerlessCacheSnapshotInput) SetSourceServerlessCacheSnapshotName(v string) *CopyServerlessCacheSnapshotInput

SetSourceServerlessCacheSnapshotName sets the SourceServerlessCacheSnapshotName field's value.

func (*CopyServerlessCacheSnapshotInput) SetTags added in v1.48.6 

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

SetTags sets the Tags field's value.

func (*CopyServerlessCacheSnapshotInput) SetTargetServerlessCacheSnapshotName added in v1.48.6 

func (s *CopyServerlessCacheSnapshotInput) SetTargetServerlessCacheSnapshotName(v string) *CopyServerlessCacheSnapshotInput

SetTargetServerlessCacheSnapshotName sets the TargetServerlessCacheSnapshotName field's value.

func (CopyServerlessCacheSnapshotInput) String added in v1.48.6 

func (s CopyServerlessCacheSnapshotInput) 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 (*CopyServerlessCacheSnapshotInput) Validate added in v1.48.6 

func (s *CopyServerlessCacheSnapshotInput) Validate() error

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

type CopyServerlessCacheSnapshotOutput added in v1.48.6 

type CopyServerlessCacheSnapshotOutput struct {

	// The response for the attempt to copy the serverless cache snapshot. Available
	// for Redis only.
	ServerlessCacheSnapshot *ServerlessCacheSnapshot `type:"structure"`
	// contains filtered or unexported fields
}

func (CopyServerlessCacheSnapshotOutput) GoString added in v1.48.6 

func (s CopyServerlessCacheSnapshotOutput) 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 (*CopyServerlessCacheSnapshotOutput) SetServerlessCacheSnapshot added in v1.48.6 

func (s *CopyServerlessCacheSnapshotOutput) SetServerlessCacheSnapshot(v *ServerlessCacheSnapshot) *CopyServerlessCacheSnapshotOutput

SetServerlessCacheSnapshot sets the ServerlessCacheSnapshot field's value.

func (CopyServerlessCacheSnapshotOutput) String added in v1.48.6 

func (s CopyServerlessCacheSnapshotOutput) 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 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 added in v0.6.5 

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 added in v1.23.12 

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

SetKmsKeyId sets the KmsKeyId field's value.

func (*CopySnapshotInput) SetSourceSnapshotName added in v1.5.0 

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

SetSourceSnapshotName sets the SourceSnapshotName field's value.

func (*CopySnapshotInput) SetTags added in v1.38.15 

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

SetTags sets the Tags field's value.

func (*CopySnapshotInput) SetTargetBucket added in v1.5.0 

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

SetTargetBucket sets the TargetBucket field's value.

func (*CopySnapshotInput) SetTargetSnapshotName added in v1.5.0 

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

SetTargetSnapshotName sets the TargetSnapshotName field's value.

func (CopySnapshotInput) String added in v0.6.5 

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 added in v1.1.21 

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 added in v0.6.5 

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 added in v1.5.0 

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

SetSnapshot sets the Snapshot field's value.

func (CopySnapshotOutput) String added in v0.6.5 

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: M7g node types: cache.m7g.large,
	//    cache.m7g.xlarge, cache.m7g.2xlarge, cache.m7g.4xlarge, cache.m7g.8xlarge,
	//    cache.m7g.12xlarge, cache.m7g.16xlarge For region availability, see Supported
	//    Node Types (https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/CacheNodes.SupportedTypes.html#CacheNodes.SupportedTypesByRegion)
	//    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 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: R7g node types: cache.r7g.large,
	//    cache.r7g.xlarge, cache.r7g.2xlarge, cache.r7g.4xlarge, cache.r7g.8xlarge,
	//    cache.r7g.12xlarge, cache.r7g.16xlarge For region availability, see Supported
	//    Node Types (https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/CacheNodes.SupportedTypes.html#CacheNodes.SupportedTypesByRegion)
	//    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 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 added in v0.6.5 

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 added in v1.5.0 

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

SetAZMode sets the AZMode field's value.

func (*CreateCacheClusterInput) SetAuthToken added in v1.5.5 

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

SetAuthToken sets the AuthToken field's value.

func (*CreateCacheClusterInput) SetAutoMinorVersionUpgrade added in v1.5.0 

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

SetAutoMinorVersionUpgrade sets the AutoMinorVersionUpgrade field's value.

func (*CreateCacheClusterInput) SetCacheClusterId added in v1.5.0 

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

SetCacheClusterId sets the CacheClusterId field's value.

func (*CreateCacheClusterInput) SetCacheNodeType added in v1.5.0 

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

SetCacheNodeType sets the CacheNodeType field's value.

func (*CreateCacheClusterInput) SetCacheParameterGroupName added in v1.5.0 

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

SetCacheParameterGroupName sets the CacheParameterGroupName field's value.

func (*CreateCacheClusterInput) SetCacheSecurityGroupNames added in v1.5.0 

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

SetCacheSecurityGroupNames sets the CacheSecurityGroupNames field's value.

func (*CreateCacheClusterInput) SetCacheSubnetGroupName added in v1.5.0 

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

SetCacheSubnetGroupName sets the CacheSubnetGroupName field's value.

func (*CreateCacheClusterInput) SetEngine added in v1.5.0 

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

SetEngine sets the Engine field's value.

func (*CreateCacheClusterInput) SetEngineVersion added in v1.5.0 

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

SetEngineVersion sets the EngineVersion field's value.

func (*CreateCacheClusterInput) SetIpDiscovery added in v1.44.132 

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

SetIpDiscovery sets the IpDiscovery field's value.

func (*CreateCacheClusterInput) SetLogDeliveryConfigurations added in v1.38.24 

func (s *CreateCacheClusterInput) SetLogDeliveryConfigurations(v []*LogDeliveryConfigurationRequest) *CreateCacheClusterInput

SetLogDeliveryConfigurations sets the LogDeliveryConfigurations field's value.

func (*CreateCacheClusterInput) SetNetworkType added in v1.44.132 

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

SetNetworkType sets the NetworkType field's value.

func (*CreateCacheClusterInput) SetNotificationTopicArn added in v1.5.0 

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

SetNotificationTopicArn sets the NotificationTopicArn field's value.

func (*CreateCacheClusterInput) SetNumCacheNodes added in v1.5.0 

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

SetNumCacheNodes sets the NumCacheNodes field's value.

func (*CreateCacheClusterInput) SetOutpostMode added in v1.35.5 

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

SetOutpostMode sets the OutpostMode field's value.

func (*CreateCacheClusterInput) SetPort added in v1.5.0 

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

SetPort sets the Port field's value.

func (*CreateCacheClusterInput) SetPreferredAvailabilityZone added in v1.5.0 

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

SetPreferredAvailabilityZone sets the PreferredAvailabilityZone field's value.

func (*CreateCacheClusterInput) SetPreferredAvailabilityZones added in v1.5.0 

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

SetPreferredAvailabilityZones sets the PreferredAvailabilityZones field's value.

func (*CreateCacheClusterInput) SetPreferredMaintenanceWindow added in v1.5.0 

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

SetPreferredMaintenanceWindow sets the PreferredMaintenanceWindow field's value.

func (*CreateCacheClusterInput) SetPreferredOutpostArn added in v1.35.5 

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

SetPreferredOutpostArn sets the PreferredOutpostArn field's value.

func (*CreateCacheClusterInput) SetPreferredOutpostArns added in v1.35.5 

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

SetPreferredOutpostArns sets the PreferredOutpostArns field's value.

func (*CreateCacheClusterInput) SetReplicationGroupId added in v1.5.0 

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

SetReplicationGroupId sets the ReplicationGroupId field's value.

func (*CreateCacheClusterInput) SetSecurityGroupIds added in v1.5.0 

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

SetSecurityGroupIds sets the SecurityGroupIds field's value.

func (*CreateCacheClusterInput) SetSnapshotArns added in v1.5.0 

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

SetSnapshotArns sets the SnapshotArns field's value.

func (*CreateCacheClusterInput) SetSnapshotName added in v1.5.0 

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

SetSnapshotName sets the SnapshotName field's value.

func (*CreateCacheClusterInput) SetSnapshotRetentionLimit added in v1.5.0 

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

SetSnapshotRetentionLimit sets the SnapshotRetentionLimit field's value.

func (*CreateCacheClusterInput) SetSnapshotWindow added in v1.5.0 

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

SetSnapshotWindow sets the SnapshotWindow field's value.

func (*CreateCacheClusterInput) SetTags added in v1.5.0 

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

SetTags sets the Tags field's value.

func (*CreateCacheClusterInput) SetTransitEncryptionEnabled added in v1.44.20 

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

SetTransitEncryptionEnabled sets the TransitEncryptionEnabled field's value.

func (CreateCacheClusterInput) String added in v0.6.5 

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 added in v1.1.21 

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 added in v0.6.5 

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 added in v1.5.0 

func (s *CreateCacheClusterOutput) SetCacheCluster(v *CacheCluster) *CreateCacheClusterOutput

SetCacheCluster sets the CacheCluster field's value.

func (CreateCacheClusterOutput) String added in v0.6.5 

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 added in v0.6.5 

func (s CreateCacheParameterGroupInput) 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 (*CreateCacheParameterGroupInput) SetCacheParameterGroupFamily added in v1.5.0 

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

SetCacheParameterGroupFamily sets the CacheParameterGroupFamily field's value.

func (*CreateCacheParameterGroupInput) SetCacheParameterGroupName added in v1.5.0 

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

SetCacheParameterGroupName sets the CacheParameterGroupName field's value.

func (*CreateCacheParameterGroupInput) SetDescription added in v1.5.0 

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

SetDescription sets the Description field's value.

func (*CreateCacheParameterGroupInput) SetTags added in v1.38.15 

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

SetTags sets the Tags field's value.

func (CreateCacheParameterGroupInput) String added in v0.6.5 

func (s CreateCacheParameterGroupInput) 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 (*CreateCacheParameterGroupInput) Validate added in v1.1.21 

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 added in v0.6.5 

func (s CreateCacheParameterGroupOutput) 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 (*CreateCacheParameterGroupOutput) SetCacheParameterGroup added in v1.5.0 

func (s *CreateCacheParameterGroupOutput) SetCacheParameterGroup(v *CacheParameterGroup) *CreateCacheParameterGroupOutput

SetCacheParameterGroup sets the CacheParameterGroup field's value.

func (CreateCacheParameterGroupOutput) String added in v0.6.5 

func (s CreateCacheParameterGroupOutput) 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 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 added in v0.6.5 

func (s CreateCacheSecurityGroupInput) 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 (*CreateCacheSecurityGroupInput) SetCacheSecurityGroupName added in v1.5.0 

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

SetCacheSecurityGroupName sets the CacheSecurityGroupName field's value.

func (*CreateCacheSecurityGroupInput) SetDescription added in v1.5.0 

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

SetDescription sets the Description field's value.

func (*CreateCacheSecurityGroupInput) SetTags added in v1.38.15 

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

SetTags sets the Tags field's value.

func (CreateCacheSecurityGroupInput) String added in v0.6.5 

func (s CreateCacheSecurityGroupInput) 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 (*CreateCacheSecurityGroupInput) Validate added in v1.1.21 

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 added in v0.6.5 

func (s CreateCacheSecurityGroupOutput) 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 (*CreateCacheSecurityGroupOutput) SetCacheSecurityGroup added in v1.5.0 

func (s *CreateCacheSecurityGroupOutput) SetCacheSecurityGroup(v *CacheSecurityGroup) *CreateCacheSecurityGroupOutput

SetCacheSecurityGroup sets the CacheSecurityGroup field's value.

func (CreateCacheSecurityGroupOutput) String added in v0.6.5 

func (s CreateCacheSecurityGroupOutput) 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 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 added in v0.6.5 

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 added in v1.5.0 

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

SetCacheSubnetGroupDescription sets the CacheSubnetGroupDescription field's value.

func (*CreateCacheSubnetGroupInput) SetCacheSubnetGroupName added in v1.5.0 

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

SetCacheSubnetGroupName sets the CacheSubnetGroupName field's value.

func (*CreateCacheSubnetGroupInput) SetSubnetIds added in v1.5.0 

func (s *CreateCacheSubnetGroupInput) SetSubnetIds(v []*string) *CreateCacheSubnetGroupInput

SetSubnetIds sets the SubnetIds field's value.

func (*CreateCacheSubnetGroupInput) SetTags added in v1.38.15 

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

SetTags sets the Tags field's value.

func (CreateCacheSubnetGroupInput) String added in v0.6.5 

func (s CreateCacheSubnetGroupInput) 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 (*CreateCacheSubnetGroupInput) Validate added in v1.1.21 

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 added in v0.6.5 

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 added in v1.5.0 

func (s *CreateCacheSubnetGroupOutput) SetCacheSubnetGroup(v *CacheSubnetGroup) *CreateCacheSubnetGroupOutput

SetCacheSubnetGroup sets the CacheSubnetGroup field's value.

func (CreateCacheSubnetGroupOutput) String added in v0.6.5 

func (s CreateCacheSubnetGroupOutput) 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 CreateGlobalReplicationGroupInput added in v1.29.25 

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 added in v1.29.25 

func (s CreateGlobalReplicationGroupInput) 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 (*CreateGlobalReplicationGroupInput) SetGlobalReplicationGroupDescription added in v1.29.25 

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

SetGlobalReplicationGroupDescription sets the GlobalReplicationGroupDescription field's value.

func (*CreateGlobalReplicationGroupInput) SetGlobalReplicationGroupIdSuffix added in v1.29.25 

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

SetGlobalReplicationGroupIdSuffix sets the GlobalReplicationGroupIdSuffix field's value.

func (*CreateGlobalReplicationGroupInput) SetPrimaryReplicationGroupId added in v1.29.25 

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

SetPrimaryReplicationGroupId sets the PrimaryReplicationGroupId field's value.

func (CreateGlobalReplicationGroupInput) String added in v1.29.25 

func (s CreateGlobalReplicationGroupInput) 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 (*CreateGlobalReplicationGroupInput) Validate added in v1.29.25 

func (s *CreateGlobalReplicationGroupInput) Validate() error

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

type CreateGlobalReplicationGroupOutput added in v1.29.25 

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 added in v1.29.25 

func (s CreateGlobalReplicationGroupOutput) 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 (*CreateGlobalReplicationGroupOutput) SetGlobalReplicationGroup added in v1.29.25 

func (s *CreateGlobalReplicationGroupOutput) SetGlobalReplicationGroup(v *GlobalReplicationGroup) *CreateGlobalReplicationGroupOutput

SetGlobalReplicationGroup sets the GlobalReplicationGroup field's value.

func (CreateGlobalReplicationGroupOutput) String added in v1.29.25 

func (s CreateGlobalReplicationGroupOutput) 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 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: M7g node types: cache.m7g.large,
	//    cache.m7g.xlarge, cache.m7g.2xlarge, cache.m7g.4xlarge, cache.m7g.8xlarge,
	//    cache.m7g.12xlarge, cache.m7g.16xlarge For region availability, see Supported
	//    Node Types (https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/CacheNodes.SupportedTypes.html#CacheNodes.SupportedTypesByRegion)
	//    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 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: R7g node types: cache.r7g.large,
	//    cache.r7g.xlarge, cache.r7g.2xlarge, cache.r7g.4xlarge, cache.r7g.8xlarge,
	//    cache.r7g.12xlarge, cache.r7g.16xlarge For region availability, see Supported
	//    Node Types (https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/CacheNodes.SupportedTypes.html#CacheNodes.SupportedTypesByRegion)
	//    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 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:
	//
	//    * 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"`

	// The name of the snapshot used to create a replication group. Available for
	// Redis only.
	ServerlessCacheSnapshotName *string `type:"string"`

	// 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 added in v0.6.5 

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 added in v1.12.17 

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

SetAtRestEncryptionEnabled sets the AtRestEncryptionEnabled field's value.

func (*CreateReplicationGroupInput) SetAuthToken added in v1.5.5 

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

SetAuthToken sets the AuthToken field's value.

func (*CreateReplicationGroupInput) SetAutoMinorVersionUpgrade added in v1.5.0 

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

SetAutoMinorVersionUpgrade sets the AutoMinorVersionUpgrade field's value.

func (*CreateReplicationGroupInput) SetAutomaticFailoverEnabled added in v1.5.0 

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

SetAutomaticFailoverEnabled sets the AutomaticFailoverEnabled field's value.

func (*CreateReplicationGroupInput) SetCacheNodeType added in v1.5.0 

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

SetCacheNodeType sets the CacheNodeType field's value.

func (*CreateReplicationGroupInput) SetCacheParameterGroupName added in v1.5.0 

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

SetCacheParameterGroupName sets the CacheParameterGroupName field's value.

func (*CreateReplicationGroupInput) SetCacheSecurityGroupNames added in v1.5.0 

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

SetCacheSecurityGroupNames sets the CacheSecurityGroupNames field's value.

func (*CreateReplicationGroupInput) SetCacheSubnetGroupName added in v1.5.0 

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

SetCacheSubnetGroupName sets the CacheSubnetGroupName field's value.

func (*CreateReplicationGroupInput) SetClusterMode added in v1.44.262 

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

SetClusterMode sets the ClusterMode field's value.

func (*CreateReplicationGroupInput) SetDataTieringEnabled added in v1.42.11 

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

SetDataTieringEnabled sets the DataTieringEnabled field's value.

func (*CreateReplicationGroupInput) SetEngine added in v1.5.0 

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

SetEngine sets the Engine field's value.

func (*CreateReplicationGroupInput) SetEngineVersion added in v1.5.0 

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

SetEngineVersion sets the EngineVersion field's value.

func (*CreateReplicationGroupInput) SetGlobalReplicationGroupId added in v1.29.25 

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

SetGlobalReplicationGroupId sets the GlobalReplicationGroupId field's value.

func (*CreateReplicationGroupInput) SetIpDiscovery added in v1.44.132 

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

SetIpDiscovery sets the IpDiscovery field's value.

func (*CreateReplicationGroupInput) SetKmsKeyId added in v1.23.12 

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

SetKmsKeyId sets the KmsKeyId field's value.

func (*CreateReplicationGroupInput) SetLogDeliveryConfigurations added in v1.38.24 

func (s *CreateReplicationGroupInput) SetLogDeliveryConfigurations(v []*LogDeliveryConfigurationRequest) *CreateReplicationGroupInput

SetLogDeliveryConfigurations sets the LogDeliveryConfigurations field's value.

func (*CreateReplicationGroupInput) SetMultiAZEnabled added in v1.31.10 

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

SetMultiAZEnabled sets the MultiAZEnabled field's value.

func (*CreateReplicationGroupInput) SetNetworkType added in v1.44.132 

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

SetNetworkType sets the NetworkType field's value.

func (*CreateReplicationGroupInput) SetNodeGroupConfiguration added in v1.5.0 

func (s *CreateReplicationGroupInput) SetNodeGroupConfiguration(v []*NodeGroupConfiguration) *CreateReplicationGroupInput

SetNodeGroupConfiguration sets the NodeGroupConfiguration field's value.

func (*CreateReplicationGroupInput) SetNotificationTopicArn added in v1.5.0 

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

SetNotificationTopicArn sets the NotificationTopicArn field's value.

func (*CreateReplicationGroupInput) SetNumCacheClusters added in v1.5.0 

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

SetNumCacheClusters sets the NumCacheClusters field's value.

func (*CreateReplicationGroupInput) SetNumNodeGroups added in v1.5.0 

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

SetNumNodeGroups sets the NumNodeGroups field's value.

func (*CreateReplicationGroupInput) SetPort added in v1.5.0 

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

SetPort sets the Port field's value.

func (*CreateReplicationGroupInput) SetPreferredCacheClusterAZs added in v1.5.0 

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

SetPreferredCacheClusterAZs sets the PreferredCacheClusterAZs field's value.

func (*CreateReplicationGroupInput) SetPreferredMaintenanceWindow added in v1.5.0 

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

SetPreferredMaintenanceWindow sets the PreferredMaintenanceWindow field's value.

func (*CreateReplicationGroupInput) SetPrimaryClusterId added in v1.5.0 

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

SetPrimaryClusterId sets the PrimaryClusterId field's value.

func (*CreateReplicationGroupInput) SetReplicasPerNodeGroup added in v1.5.0 

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

SetReplicasPerNodeGroup sets the ReplicasPerNodeGroup field's value.

func (*CreateReplicationGroupInput) SetReplicationGroupDescription added in v1.5.0 

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

SetReplicationGroupDescription sets the ReplicationGroupDescription field's value.

func (*CreateReplicationGroupInput) SetReplicationGroupId added in v1.5.0 

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

SetReplicationGroupId sets the ReplicationGroupId field's value.

func (*CreateReplicationGroupInput) SetSecurityGroupIds added in v1.5.0 

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

SetSecurityGroupIds sets the SecurityGroupIds field's value.

func (*CreateReplicationGroupInput) SetServerlessCacheSnapshotName added in v1.48.6 

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

SetServerlessCacheSnapshotName sets the ServerlessCacheSnapshotName field's value.

func (*CreateReplicationGroupInput) SetSnapshotArns added in v1.5.0 

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

SetSnapshotArns sets the SnapshotArns field's value.

func (*CreateReplicationGroupInput) SetSnapshotName added in v1.5.0 

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

SetSnapshotName sets the SnapshotName field's value.

func (*CreateReplicationGroupInput) SetSnapshotRetentionLimit added in v1.5.0 

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

SetSnapshotRetentionLimit sets the SnapshotRetentionLimit field's value.

func (*CreateReplicationGroupInput) SetSnapshotWindow added in v1.5.0 

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

SetSnapshotWindow sets the SnapshotWindow field's value.

func (*CreateReplicationGroupInput) SetTags added in v1.5.0 

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

SetTags sets the Tags field's value.

func (*CreateReplicationGroupInput) SetTransitEncryptionEnabled added in v1.12.17 

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

SetTransitEncryptionEnabled sets the TransitEncryptionEnabled field's value.

func (*CreateReplicationGroupInput) SetTransitEncryptionMode added in v1.44.169 

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

SetTransitEncryptionMode sets the TransitEncryptionMode field's value.

func (*CreateReplicationGroupInput) SetUserGroupIds added in v1.35.5 

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

SetUserGroupIds sets the UserGroupIds field's value.

func (CreateReplicationGroupInput) String added in v0.6.5 

func (s CreateReplicationGroupInput) 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 (*CreateReplicationGroupInput) Validate added in v1.1.21 

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 added in v0.6.5 

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 added in v1.5.0 

func (s *CreateReplicationGroupOutput) SetReplicationGroup(v *ReplicationGroup) *CreateReplicationGroupOutput

SetReplicationGroup sets the ReplicationGroup field's value.

func (CreateReplicationGroupOutput) String added in v0.6.5 

func (s CreateReplicationGroupOutput) 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 CreateServerlessCacheInput added in v1.48.6 

type CreateServerlessCacheInput struct {

	// Sets the cache usage limits for storage and ElastiCache Processing Units
	// for the cache.
	CacheUsageLimits *CacheUsageLimits `type:"structure"`

	// The daily time that snapshots will be created from the new serverless cache.
	// By default this number is populated with 0, i.e. no snapshots will be created
	// on an automatic daily basis. Available for Redis only.
	DailySnapshotTime *string `type:"string"`

	// User-provided description for the serverless cache. The default is NULL,
	// i.e. if no description is provided then an empty string will be returned.
	// The maximum length is 255 characters.
	Description *string `type:"string"`

	// The name of the cache engine to be used for creating the serverless cache.
	//
	// Engine is a required field
	Engine *string `type:"string" required:"true"`

	// ARN of the customer managed key for encrypting the data at rest. If no KMS
	// key is provided, a default service key is used.
	KmsKeyId *string `type:"string"`

	// The version of the cache engine that will be used to create the serverless
	// cache.
	MajorEngineVersion *string `type:"string"`

	// A list of the one or more VPC security groups to be associated with the serverless
	// cache. The security group will authorize traffic access for the VPC end-point
	// (private-link). If no other information is given this will be the VPC’s
	// Default Security Group that is associated with the cluster VPC end-point.
	SecurityGroupIds []*string `locationNameList:"SecurityGroupId" type:"list"`

	// User-provided identifier for the serverless cache. This parameter is stored
	// as a lowercase string.
	//
	// ServerlessCacheName is a required field
	ServerlessCacheName *string `type:"string" required:"true"`

	// The ARN(s) of the snapshot that the new serverless cache will be created
	// from. Available for Redis only.
	SnapshotArnsToRestore []*string `locationNameList:"SnapshotArn" type:"list"`

	// The number of snapshots that will be retained for the serverless cache that
	// is being created. As new snapshots beyond this limit are added, the oldest
	// snapshots will be deleted on a rolling basis. Available for Redis only.
	SnapshotRetentionLimit *int64 `type:"integer"`

	// A list of the identifiers of the subnets where the VPC endpoint for the serverless
	// cache will be deployed. All the subnetIds must belong to the same VPC.
	SubnetIds []*string `locationNameList:"SubnetId" type:"list"`

	// The list of tags (key, value) pairs to be added to the serverless cache resource.
	// Default is NULL.
	Tags []*Tag `locationNameList:"Tag" type:"list"`

	// The identifier of the UserGroup to be associated with the serverless cache.
	// Available for Redis only. Default is NULL.
	UserGroupId *string `type:"string"`
	// contains filtered or unexported fields
}

func (CreateServerlessCacheInput) GoString added in v1.48.6 

func (s CreateServerlessCacheInput) 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 (*CreateServerlessCacheInput) SetCacheUsageLimits added in v1.48.6 

func (s *CreateServerlessCacheInput) SetCacheUsageLimits(v *CacheUsageLimits) *CreateServerlessCacheInput

SetCacheUsageLimits sets the CacheUsageLimits field's value.

func (*CreateServerlessCacheInput) SetDailySnapshotTime added in v1.48.6 

func (s *CreateServerlessCacheInput) SetDailySnapshotTime(v string) *CreateServerlessCacheInput

SetDailySnapshotTime sets the DailySnapshotTime field's value.

func (*CreateServerlessCacheInput) SetDescription added in v1.48.6 

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

SetDescription sets the Description field's value.

func (*CreateServerlessCacheInput) SetEngine added in v1.48.6 

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

SetEngine sets the Engine field's value.

func (*CreateServerlessCacheInput) SetKmsKeyId added in v1.48.6 

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

SetKmsKeyId sets the KmsKeyId field's value.

func (*CreateServerlessCacheInput) SetMajorEngineVersion added in v1.48.6 

func (s *CreateServerlessCacheInput) SetMajorEngineVersion(v string) *CreateServerlessCacheInput

SetMajorEngineVersion sets the MajorEngineVersion field's value.

func (*CreateServerlessCacheInput) SetSecurityGroupIds added in v1.48.6 

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

SetSecurityGroupIds sets the SecurityGroupIds field's value.

func (*CreateServerlessCacheInput) SetServerlessCacheName added in v1.48.6 

func (s *CreateServerlessCacheInput) SetServerlessCacheName(v string) *CreateServerlessCacheInput

SetServerlessCacheName sets the ServerlessCacheName field's value.

func (*CreateServerlessCacheInput) SetSnapshotArnsToRestore added in v1.48.6 

func (s *CreateServerlessCacheInput) SetSnapshotArnsToRestore(v []*string) *CreateServerlessCacheInput

SetSnapshotArnsToRestore sets the SnapshotArnsToRestore field's value.

func (*CreateServerlessCacheInput) SetSnapshotRetentionLimit added in v1.48.6 

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

SetSnapshotRetentionLimit sets the SnapshotRetentionLimit field's value.

func (*CreateServerlessCacheInput) SetSubnetIds added in v1.48.6 

func (s *CreateServerlessCacheInput) SetSubnetIds(v []*string) *CreateServerlessCacheInput

SetSubnetIds sets the SubnetIds field's value.

func (*CreateServerlessCacheInput) SetTags added in v1.48.6 

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

SetTags sets the Tags field's value.

func (*CreateServerlessCacheInput) SetUserGroupId added in v1.48.6 

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

SetUserGroupId sets the UserGroupId field's value.

func (CreateServerlessCacheInput) String added in v1.48.6 

func (s CreateServerlessCacheInput) 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 (*CreateServerlessCacheInput) Validate added in v1.48.6 

func (s *CreateServerlessCacheInput) Validate() error

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

type CreateServerlessCacheOutput added in v1.48.6 

type CreateServerlessCacheOutput struct {

	// The response for the attempt to create the serverless cache.
	ServerlessCache *ServerlessCache `type:"structure"`
	// contains filtered or unexported fields
}

func (CreateServerlessCacheOutput) GoString added in v1.48.6 

func (s CreateServerlessCacheOutput) 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 (*CreateServerlessCacheOutput) SetServerlessCache added in v1.48.6 

func (s *CreateServerlessCacheOutput) SetServerlessCache(v *ServerlessCache) *CreateServerlessCacheOutput

SetServerlessCache sets the ServerlessCache field's value.

func (CreateServerlessCacheOutput) String added in v1.48.6 

func (s CreateServerlessCacheOutput) 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 CreateServerlessCacheSnapshotInput added in v1.48.6 

type CreateServerlessCacheSnapshotInput struct {

	// The ID of the KMS key used to encrypt the snapshot. Available for Redis only.
	// Default: NULL
	KmsKeyId *string `type:"string"`

	// The name of an existing serverless cache. The snapshot is created from this
	// cache. Available for Redis only.
	//
	// ServerlessCacheName is a required field
	ServerlessCacheName *string `type:"string" required:"true"`

	// The name for the snapshot being created. Must be unique for the customer
	// account. Available for Redis only. Must be between 1 and 255 characters.
	//
	// ServerlessCacheSnapshotName is a required field
	ServerlessCacheSnapshotName *string `type:"string" required:"true"`

	// A list of tags to be added to the snapshot resource. A tag is a key-value
	// pair. Available for Redis only.
	Tags []*Tag `locationNameList:"Tag" type:"list"`
	// contains filtered or unexported fields
}

func (CreateServerlessCacheSnapshotInput) GoString added in v1.48.6 

func (s CreateServerlessCacheSnapshotInput) 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 (*CreateServerlessCacheSnapshotInput) SetKmsKeyId added in v1.48.6 

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

SetKmsKeyId sets the KmsKeyId field's value.

func (*CreateServerlessCacheSnapshotInput) SetServerlessCacheName added in v1.48.6 

func (s *CreateServerlessCacheSnapshotInput) SetServerlessCacheName(v string) *CreateServerlessCacheSnapshotInput

SetServerlessCacheName sets the ServerlessCacheName field's value.

func (*CreateServerlessCacheSnapshotInput) SetServerlessCacheSnapshotName added in v1.48.6 

func (s *CreateServerlessCacheSnapshotInput) SetServerlessCacheSnapshotName(v string) *CreateServerlessCacheSnapshotInput

SetServerlessCacheSnapshotName sets the ServerlessCacheSnapshotName field's value.

func (*CreateServerlessCacheSnapshotInput) SetTags added in v1.48.6 

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

SetTags sets the Tags field's value.

func (CreateServerlessCacheSnapshotInput) String added in v1.48.6 

func (s CreateServerlessCacheSnapshotInput) 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 (*CreateServerlessCacheSnapshotInput) Validate added in v1.48.6 

func (s *CreateServerlessCacheSnapshotInput) Validate() error

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

type CreateServerlessCacheSnapshotOutput added in v1.48.6 

type CreateServerlessCacheSnapshotOutput struct {

	// The state of a serverless cache snapshot at a specific point in time, to
	// the millisecond. Available for Redis only.
	ServerlessCacheSnapshot *ServerlessCacheSnapshot `type:"structure"`
	// contains filtered or unexported fields
}

func (CreateServerlessCacheSnapshotOutput) GoString added in v1.48.6 

func (s CreateServerlessCacheSnapshotOutput) 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 (*CreateServerlessCacheSnapshotOutput) SetServerlessCacheSnapshot added in v1.48.6 

func (s *CreateServerlessCacheSnapshotOutput) SetServerlessCacheSnapshot(v *ServerlessCacheSnapshot) *CreateServerlessCacheSnapshotOutput

SetServerlessCacheSnapshot sets the ServerlessCacheSnapshot field's value.

func (CreateServerlessCacheSnapshotOutput) String added in v1.48.6 

func (s CreateServerlessCacheSnapshotOutput) 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 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 added in v0.6.5 

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 added in v1.5.0 

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

SetCacheClusterId sets the CacheClusterId field's value.

func (*CreateSnapshotInput) SetKmsKeyId added in v1.23.12 

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

SetKmsKeyId sets the KmsKeyId field's value.

func (*CreateSnapshotInput) SetReplicationGroupId added in v1.5.0 

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

SetReplicationGroupId sets the ReplicationGroupId field's value.

func (*CreateSnapshotInput) SetSnapshotName added in v1.5.0 

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

SetSnapshotName sets the SnapshotName field's value.

func (*CreateSnapshotInput) SetTags added in v1.38.15 

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

SetTags sets the Tags field's value.

func (CreateSnapshotInput) String added in v0.6.5 

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 added in v1.1.21 

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 added in v0.6.5 

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 added in v1.5.0 

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

SetSnapshot sets the Snapshot field's value.

func (CreateSnapshotOutput) String added in v0.6.5 

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 added in v1.35.5 

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. Available
	// for Redis only.
	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 added in v1.35.5 

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 added in v1.35.5 

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

SetEngine sets the Engine field's value.

func (*CreateUserGroupInput) SetTags added in v1.38.15 

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

SetTags sets the Tags field's value.

func (*CreateUserGroupInput) SetUserGroupId added in v1.35.5 

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

SetUserGroupId sets the UserGroupId field's value.

func (*CreateUserGroupInput) SetUserIds added in v1.35.5 

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

SetUserIds sets the UserIds field's value.

func (CreateUserGroupInput) String added in v1.35.5 

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 added in v1.35.5 

func (s *CreateUserGroupInput) Validate() error

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

type CreateUserGroupOutput added in v1.35.5 

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 which serverless caches the specified user group is associated
	// with. Available for Redis only.
	ServerlessCaches []*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 added in v1.35.5 

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 added in v1.35.5 

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

SetARN sets the ARN field's value.

func (*CreateUserGroupOutput) SetEngine added in v1.35.5 

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

SetEngine sets the Engine field's value.

func (*CreateUserGroupOutput) SetMinimumEngineVersion added in v1.42.11 

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

SetMinimumEngineVersion sets the MinimumEngineVersion field's value.

func (*CreateUserGroupOutput) SetPendingChanges added in v1.35.5 

func (s *CreateUserGroupOutput) SetPendingChanges(v *UserGroupPendingChanges) *CreateUserGroupOutput

SetPendingChanges sets the PendingChanges field's value.

func (*CreateUserGroupOutput) SetReplicationGroups added in v1.35.5 

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

SetReplicationGroups sets the ReplicationGroups field's value.

func (*CreateUserGroupOutput) SetServerlessCaches added in v1.48.6 

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

SetServerlessCaches sets the ServerlessCaches field's value.

func (*CreateUserGroupOutput) SetStatus added in v1.35.5 

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

SetStatus sets the Status field's value.

func (*CreateUserGroupOutput) SetUserGroupId added in v1.35.5 

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

SetUserGroupId sets the UserGroupId field's value.

func (*CreateUserGroupOutput) SetUserIds added in v1.35.5 

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

SetUserIds sets the UserIds field's value.

func (CreateUserGroupOutput) String added in v1.35.5 

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 added in v1.35.5 

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 added in v1.35.5 

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 added in v1.35.5 

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

SetAccessString sets the AccessString field's value.

func (*CreateUserInput) SetAuthenticationMode added in v1.44.139 

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

SetAuthenticationMode sets the AuthenticationMode field's value.

func (*CreateUserInput) SetEngine added in v1.35.5 

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

SetEngine sets the Engine field's value.

func (*CreateUserInput) SetNoPasswordRequired added in v1.35.5 

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

SetNoPasswordRequired sets the NoPasswordRequired field's value.

func (*CreateUserInput) SetPasswords added in v1.35.5 

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

SetPasswords sets the Passwords field's value.

func (*CreateUserInput) SetTags added in v1.38.15 

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

SetTags sets the Tags field's value.

func (*CreateUserInput) SetUserId added in v1.35.5 

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

SetUserId sets the UserId field's value.

func (*CreateUserInput) SetUserName added in v1.35.5 

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

SetUserName sets the UserName field's value.

func (CreateUserInput) String added in v1.35.5 

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 added in v1.35.5 

func (s *CreateUserInput) Validate() error

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

type CreateUserOutput added in v1.35.5 

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 added in v1.35.5 

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 added in v1.35.5 

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

SetARN sets the ARN field's value.

func (*CreateUserOutput) SetAccessString added in v1.35.5 

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

SetAccessString sets the AccessString field's value.

func (*CreateUserOutput) SetAuthentication added in v1.35.5 

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

SetAuthentication sets the Authentication field's value.

func (*CreateUserOutput) SetEngine added in v1.35.5 

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

SetEngine sets the Engine field's value.

func (*CreateUserOutput) SetMinimumEngineVersion added in v1.42.11 

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

SetMinimumEngineVersion sets the MinimumEngineVersion field's value.

func (*CreateUserOutput) SetStatus added in v1.35.5 

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

SetStatus sets the Status field's value.

func (*CreateUserOutput) SetUserGroupIds added in v1.35.5 

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

SetUserGroupIds sets the UserGroupIds field's value.

func (*CreateUserOutput) SetUserId added in v1.35.5 

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

SetUserId sets the UserId field's value.

func (*CreateUserOutput) SetUserName added in v1.35.5 

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

SetUserName sets the UserName field's value.

func (CreateUserOutput) String added in v1.35.5 

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 added in v1.25.20 

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 added in v1.25.20 

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 added in v1.25.20 

func (s *CustomerNodeEndpoint) SetAddress(v string) *CustomerNodeEndpoint

SetAddress sets the Address field's value.

func (*CustomerNodeEndpoint) SetPort added in v1.25.20 

func (s *CustomerNodeEndpoint) SetPort(v int64) *CustomerNodeEndpoint

SetPort sets the Port field's value.

func (CustomerNodeEndpoint) String added in v1.25.20 

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 DataStorage added in v1.48.6 

type DataStorage struct {

	// The upper limit for data storage the cache is set to use.
	Maximum *int64 `type:"integer"`

	// The lower limit for data storage the cache is set to use.
	Minimum *int64 `type:"integer"`

	// The unit that the storage is measured in, in GB.
	//
	// Unit is a required field
	Unit *string `type:"string" required:"true" enum:"DataStorageUnit"`
	// contains filtered or unexported fields
}

The data storage limit.

func (DataStorage) GoString added in v1.48.6 

func (s DataStorage) 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 (*DataStorage) SetMaximum added in v1.48.6 

func (s *DataStorage) SetMaximum(v int64) *DataStorage

SetMaximum sets the Maximum field's value.

func (*DataStorage) SetMinimum added in v1.51.9 

func (s *DataStorage) SetMinimum(v int64) *DataStorage

SetMinimum sets the Minimum field's value.

func (*DataStorage) SetUnit added in v1.48.6 

func (s *DataStorage) SetUnit(v string) *DataStorage

SetUnit sets the Unit field's value.

func (DataStorage) String added in v1.48.6 

func (s DataStorage) 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 (*DataStorage) Validate added in v1.48.6 

func (s *DataStorage) Validate() error

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

type DecreaseNodeGroupsInGlobalReplicationGroupInput added in v1.29.25 

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 added in v1.29.25 

func (s DecreaseNodeGroupsInGlobalReplicationGroupInput) 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 (*DecreaseNodeGroupsInGlobalReplicationGroupInput) SetApplyImmediately added in v1.29.25 

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

SetApplyImmediately sets the ApplyImmediately field's value.

func (*DecreaseNodeGroupsInGlobalReplicationGroupInput) SetGlobalNodeGroupsToRemove added in v1.29.25 

func (s *DecreaseNodeGroupsInGlobalReplicationGroupInput) SetGlobalNodeGroupsToRemove(v []*string) *DecreaseNodeGroupsInGlobalReplicationGroupInput

SetGlobalNodeGroupsToRemove sets the GlobalNodeGroupsToRemove field's value.

func (*DecreaseNodeGroupsInGlobalReplicationGroupInput) SetGlobalNodeGroupsToRetain added in v1.29.25 

func (s *DecreaseNodeGroupsInGlobalReplicationGroupInput) SetGlobalNodeGroupsToRetain(v []*string) *DecreaseNodeGroupsInGlobalReplicationGroupInput

SetGlobalNodeGroupsToRetain sets the GlobalNodeGroupsToRetain field's value.

func (*DecreaseNodeGroupsInGlobalReplicationGroupInput) SetGlobalReplicationGroupId added in v1.29.25 

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

SetGlobalReplicationGroupId sets the GlobalReplicationGroupId field's value.

func (*DecreaseNodeGroupsInGlobalReplicationGroupInput) SetNodeGroupCount added in v1.29.25 

func (s *DecreaseNodeGroupsInGlobalReplicationGroupInput) SetNodeGroupCount(v int64) *DecreaseNodeGroupsInGlobalReplicationGroupInput

SetNodeGroupCount sets the NodeGroupCount field's value.

func (DecreaseNodeGroupsInGlobalReplicationGroupInput) String added in v1.29.25 

func (s DecreaseNodeGroupsInGlobalReplicationGroupInput) 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 (*DecreaseNodeGroupsInGlobalReplicationGroupInput) Validate added in v1.29.25 

func (s *DecreaseNodeGroupsInGlobalReplicationGroupInput) Validate() error

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

type DecreaseNodeGroupsInGlobalReplicationGroupOutput added in v1.29.25 

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 added in v1.29.25 

func (s DecreaseNodeGroupsInGlobalReplicationGroupOutput) 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 (*DecreaseNodeGroupsInGlobalReplicationGroupOutput) SetGlobalReplicationGroup added in v1.29.25 

func (s *DecreaseNodeGroupsInGlobalReplicationGroupOutput) SetGlobalReplicationGroup(v *GlobalReplicationGroup) *DecreaseNodeGroupsInGlobalReplicationGroupOutput

SetGlobalReplicationGroup sets the GlobalReplicationGroup field's value.

func (DecreaseNodeGroupsInGlobalReplicationGroupOutput) String added in v1.29.25 

func (s DecreaseNodeGroupsInGlobalReplicationGroupOutput) 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 DecreaseReplicaCountInput added in v1.15.29 

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 added in v1.15.29 

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 added in v1.15.29 

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

SetApplyImmediately sets the ApplyImmediately field's value.

func (*DecreaseReplicaCountInput) SetNewReplicaCount added in v1.15.29 

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

SetNewReplicaCount sets the NewReplicaCount field's value.

func (*DecreaseReplicaCountInput) SetReplicaConfiguration added in v1.15.29 

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

SetReplicaConfiguration sets the ReplicaConfiguration field's value.

func (*DecreaseReplicaCountInput) SetReplicasToRemove added in v1.15.29 

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

SetReplicasToRemove sets the ReplicasToRemove field's value.

func (*DecreaseReplicaCountInput) SetReplicationGroupId added in v1.15.29 

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

SetReplicationGroupId sets the ReplicationGroupId field's value.

func (DecreaseReplicaCountInput) String added in v1.15.29 

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 added in v1.15.29 

func (s *DecreaseReplicaCountInput) Validate() error

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

type DecreaseReplicaCountOutput added in v1.15.29 

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 added in v1.15.29 

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 added in v1.15.29 

func (s *DecreaseReplicaCountOutput) SetReplicationGroup(v *ReplicationGroup) *DecreaseReplicaCountOutput

SetReplicationGroup sets the ReplicationGroup field's value.

func (DecreaseReplicaCountOutput) String added in v1.15.29 

func (s DecreaseReplicaCountOutput) 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 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 added in v0.6.5 

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 added in v1.5.0 

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

SetCacheClusterId sets the CacheClusterId field's value.

func (*DeleteCacheClusterInput) SetFinalSnapshotIdentifier added in v1.5.0 

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

SetFinalSnapshotIdentifier sets the FinalSnapshotIdentifier field's value.

func (DeleteCacheClusterInput) String added in v0.6.5 

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 added in v1.1.21 

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 added in v0.6.5 

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 added in v1.5.0 

func (s *DeleteCacheClusterOutput) SetCacheCluster(v *CacheCluster) *DeleteCacheClusterOutput

SetCacheCluster sets the CacheCluster field's value.

func (DeleteCacheClusterOutput) String added in v0.6.5 

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 added in v0.6.5 

func (s DeleteCacheParameterGroupInput) 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 (*DeleteCacheParameterGroupInput) SetCacheParameterGroupName added in v1.5.0 

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

SetCacheParameterGroupName sets the CacheParameterGroupName field's value.

func (DeleteCacheParameterGroupInput) String added in v0.6.5 

func (s DeleteCacheParameterGroupInput) 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 (*DeleteCacheParameterGroupInput) Validate added in v1.1.21 

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 added in v0.6.5 

func (s DeleteCacheParameterGroupOutput) 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 (DeleteCacheParameterGroupOutput) String added in v0.6.5 

func (s DeleteCacheParameterGroupOutput) 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 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 added in v0.6.5 

func (s DeleteCacheSecurityGroupInput) 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 (*DeleteCacheSecurityGroupInput) SetCacheSecurityGroupName added in v1.5.0 

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

SetCacheSecurityGroupName sets the CacheSecurityGroupName field's value.

func (DeleteCacheSecurityGroupInput) String added in v0.6.5 

func (s DeleteCacheSecurityGroupInput) 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 (*DeleteCacheSecurityGroupInput) Validate added in v1.1.21 

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 added in v0.6.5 

func (s DeleteCacheSecurityGroupOutput) 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 (DeleteCacheSecurityGroupOutput) String added in v0.6.5 

func (s DeleteCacheSecurityGroupOutput) 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 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 added in v0.6.5 

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 added in v1.5.0 

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

SetCacheSubnetGroupName sets the CacheSubnetGroupName field's value.

func (DeleteCacheSubnetGroupInput) String added in v0.6.5 

func (s DeleteCacheSubnetGroupInput) 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 (*DeleteCacheSubnetGroupInput) Validate added in v1.1.21 

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 added in v0.6.5 

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 added in v0.6.5 

func (s DeleteCacheSubnetGroupOutput) 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 DeleteGlobalReplicationGroupInput added in v1.29.25 

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 added in v1.29.25 

func (s DeleteGlobalReplicationGroupInput) 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 (*DeleteGlobalReplicationGroupInput) SetGlobalReplicationGroupId added in v1.29.25 

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

SetGlobalReplicationGroupId sets the GlobalReplicationGroupId field's value.

func (*DeleteGlobalReplicationGroupInput) SetRetainPrimaryReplicationGroup added in v1.29.25 

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

SetRetainPrimaryReplicationGroup sets the RetainPrimaryReplicationGroup field's value.

func (DeleteGlobalReplicationGroupInput) String added in v1.29.25 

func (s DeleteGlobalReplicationGroupInput) 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 (*DeleteGlobalReplicationGroupInput) Validate added in v1.29.25 

func (s *DeleteGlobalReplicationGroupInput) Validate() error

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

type DeleteGlobalReplicationGroupOutput added in v1.29.25 

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 added in v1.29.25 

func (s DeleteGlobalReplicationGroupOutput) 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 (*DeleteGlobalReplicationGroupOutput) SetGlobalReplicationGroup added in v1.29.25 

func (s *DeleteGlobalReplicationGroupOutput) SetGlobalReplicationGroup(v *GlobalReplicationGroup) *DeleteGlobalReplicationGroupOutput

SetGlobalReplicationGroup sets the GlobalReplicationGroup field's value.

func (DeleteGlobalReplicationGroupOutput) String added in v1.29.25 

func (s DeleteGlobalReplicationGroupOutput) 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 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 added in v0.6.5 

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 added in v1.5.0 

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

SetFinalSnapshotIdentifier sets the FinalSnapshotIdentifier field's value.

func (*DeleteReplicationGroupInput) SetReplicationGroupId added in v1.5.0 

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

SetReplicationGroupId sets the ReplicationGroupId field's value.

func (*DeleteReplicationGroupInput) SetRetainPrimaryCluster added in v1.5.0 

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

SetRetainPrimaryCluster sets the RetainPrimaryCluster field's value.

func (DeleteReplicationGroupInput) String added in v0.6.5 

func (s DeleteReplicationGroupInput) 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 (*DeleteReplicationGroupInput) Validate added in v1.1.21 

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 added in v0.6.5 

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 added in v1.5.0 

func (s *DeleteReplicationGroupOutput) SetReplicationGroup(v *ReplicationGroup) *DeleteReplicationGroupOutput

SetReplicationGroup sets the ReplicationGroup field's value.

func (DeleteReplicationGroupOutput) String added in v0.6.5 

func (s DeleteReplicationGroupOutput) 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 DeleteServerlessCacheInput added in v1.48.6 

type DeleteServerlessCacheInput struct {

	// Name of the final snapshot to be taken before the serverless cache is deleted.
	// Available for Redis only. Default: NULL, i.e. a final snapshot is not taken.
	FinalSnapshotName *string `type:"string"`

	// The identifier of the serverless cache to be deleted.
	//
	// ServerlessCacheName is a required field
	ServerlessCacheName *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteServerlessCacheInput) GoString added in v1.48.6 

func (s DeleteServerlessCacheInput) 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 (*DeleteServerlessCacheInput) SetFinalSnapshotName added in v1.48.6 

func (s *DeleteServerlessCacheInput) SetFinalSnapshotName(v string) *DeleteServerlessCacheInput

SetFinalSnapshotName sets the FinalSnapshotName field's value.

func (*DeleteServerlessCacheInput) SetServerlessCacheName added in v1.48.6 

func (s *DeleteServerlessCacheInput) SetServerlessCacheName(v string) *DeleteServerlessCacheInput

SetServerlessCacheName sets the ServerlessCacheName field's value.

func (DeleteServerlessCacheInput) String added in v1.48.6 

func (s DeleteServerlessCacheInput) 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 (*DeleteServerlessCacheInput) Validate added in v1.48.6 

func (s *DeleteServerlessCacheInput) Validate() error

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

type DeleteServerlessCacheOutput added in v1.48.6 

type DeleteServerlessCacheOutput struct {

	// Provides the details of the specified serverless cache that is about to be
	// deleted.
	ServerlessCache *ServerlessCache `type:"structure"`
	// contains filtered or unexported fields
}

func (DeleteServerlessCacheOutput) GoString added in v1.48.6 

func (s DeleteServerlessCacheOutput) 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 (*DeleteServerlessCacheOutput) SetServerlessCache added in v1.48.6 

func (s *DeleteServerlessCacheOutput) SetServerlessCache(v *ServerlessCache) *DeleteServerlessCacheOutput

SetServerlessCache sets the ServerlessCache field's value.

func (DeleteServerlessCacheOutput) String added in v1.48.6 

func (s DeleteServerlessCacheOutput) 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 DeleteServerlessCacheSnapshotInput added in v1.48.6 

type DeleteServerlessCacheSnapshotInput struct {

	// Idenfitier of the snapshot to be deleted. Available for Redis only.
	//
	// ServerlessCacheSnapshotName is a required field
	ServerlessCacheSnapshotName *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteServerlessCacheSnapshotInput) GoString added in v1.48.6 

func (s DeleteServerlessCacheSnapshotInput) 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 (*DeleteServerlessCacheSnapshotInput) SetServerlessCacheSnapshotName added in v1.48.6 

func (s *DeleteServerlessCacheSnapshotInput) SetServerlessCacheSnapshotName(v string) *DeleteServerlessCacheSnapshotInput

SetServerlessCacheSnapshotName sets the ServerlessCacheSnapshotName field's value.

func (DeleteServerlessCacheSnapshotInput) String added in v1.48.6 

func (s DeleteServerlessCacheSnapshotInput) 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 (*DeleteServerlessCacheSnapshotInput) Validate added in v1.48.6 

func (s *DeleteServerlessCacheSnapshotInput) Validate() error

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

type DeleteServerlessCacheSnapshotOutput added in v1.48.6 

type DeleteServerlessCacheSnapshotOutput struct {

	// The snapshot to be deleted. Available for Redis only.
	ServerlessCacheSnapshot *ServerlessCacheSnapshot `type:"structure"`
	// contains filtered or unexported fields
}

func (DeleteServerlessCacheSnapshotOutput) GoString added in v1.48.6 

func (s DeleteServerlessCacheSnapshotOutput) 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 (*DeleteServerlessCacheSnapshotOutput) SetServerlessCacheSnapshot added in v1.48.6 

func (s *DeleteServerlessCacheSnapshotOutput) SetServerlessCacheSnapshot(v *ServerlessCacheSnapshot) *DeleteServerlessCacheSnapshotOutput

SetServerlessCacheSnapshot sets the ServerlessCacheSnapshot field's value.

func (DeleteServerlessCacheSnapshotOutput) String added in v1.48.6 

func (s DeleteServerlessCacheSnapshotOutput) 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 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 added in v0.6.5 

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 added in v1.5.0 

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

SetSnapshotName sets the SnapshotName field's value.

func (DeleteSnapshotInput) String added in v0.6.5 

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 added in v1.1.21 

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 added in v0.6.5 

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 added in v1.5.0 

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

SetSnapshot sets the Snapshot field's value.

func (DeleteSnapshotOutput) String added in v0.6.5 

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 added in v1.35.5 

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 added in v1.35.5 

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 added in v1.35.5 

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

SetUserGroupId sets the UserGroupId field's value.

func (DeleteUserGroupInput) String added in v1.35.5 

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 added in v1.35.5 

func (s *DeleteUserGroupInput) Validate() error

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

type DeleteUserGroupOutput added in v1.35.5 

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 which serverless caches the specified user group is associated
	// with. Available for Redis only.
	ServerlessCaches []*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 added in v1.35.5 

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 added in v1.35.5 

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

SetARN sets the ARN field's value.

func (*DeleteUserGroupOutput) SetEngine added in v1.35.5 

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

SetEngine sets the Engine field's value.

func (*DeleteUserGroupOutput) SetMinimumEngineVersion added in v1.42.11 

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

SetMinimumEngineVersion sets the MinimumEngineVersion field's value.

func (*DeleteUserGroupOutput) SetPendingChanges added in v1.35.5 

func (s *DeleteUserGroupOutput) SetPendingChanges(v *UserGroupPendingChanges) *DeleteUserGroupOutput

SetPendingChanges sets the PendingChanges field's value.

func (*DeleteUserGroupOutput) SetReplicationGroups added in v1.35.5 

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

SetReplicationGroups sets the ReplicationGroups field's value.

func (*DeleteUserGroupOutput) SetServerlessCaches added in v1.48.6 

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

SetServerlessCaches sets the ServerlessCaches field's value.

func (*DeleteUserGroupOutput) SetStatus added in v1.35.5 

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

SetStatus sets the Status field's value.

func (*DeleteUserGroupOutput) SetUserGroupId added in v1.35.5 

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

SetUserGroupId sets the UserGroupId field's value.

func (*DeleteUserGroupOutput) SetUserIds added in v1.35.5 

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

SetUserIds sets the UserIds field's value.

func (DeleteUserGroupOutput) String added in v1.35.5 

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 added in v1.35.5 

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 added in v1.35.5 

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 added in v1.35.5 

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

SetUserId sets the UserId field's value.

func (DeleteUserInput) String added in v1.35.5 

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 added in v1.35.5 

func (s *DeleteUserInput) Validate() error

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

type DeleteUserOutput added in v1.35.5 

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 added in v1.35.5 

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 added in v1.35.5 

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

SetARN sets the ARN field's value.

func (*DeleteUserOutput) SetAccessString added in v1.35.5 

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

SetAccessString sets the AccessString field's value.

func (*DeleteUserOutput) SetAuthentication added in v1.35.5 

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

SetAuthentication sets the Authentication field's value.

func (*DeleteUserOutput) SetEngine added in v1.35.5 

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

SetEngine sets the Engine field's value.

func (*DeleteUserOutput) SetMinimumEngineVersion added in v1.42.11 

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

SetMinimumEngineVersion sets the MinimumEngineVersion field's value.

func (*DeleteUserOutput) SetStatus added in v1.35.5 

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

SetStatus sets the Status field's value.

func (*DeleteUserOutput) SetUserGroupIds added in v1.35.5 

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

SetUserGroupIds sets the UserGroupIds field's value.

func (*DeleteUserOutput) SetUserId added in v1.35.5 

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

SetUserId sets the UserId field's value.

func (*DeleteUserOutput) SetUserName added in v1.35.5 

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

SetUserName sets the UserName field's value.

func (DeleteUserOutput) String added in v1.35.5 

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 added in v0.6.5 

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 added in v1.5.0 

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

SetCacheClusterId sets the CacheClusterId field's value.

func (*DescribeCacheClustersInput) SetMarker added in v1.5.0 

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

SetMarker sets the Marker field's value.

func (*DescribeCacheClustersInput) SetMaxRecords added in v1.5.0 

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

SetMaxRecords sets the MaxRecords field's value.

func (*DescribeCacheClustersInput) SetShowCacheClustersNotInReplicationGroups added in v1.8.9 

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

SetShowCacheClustersNotInReplicationGroups sets the ShowCacheClustersNotInReplicationGroups field's value.

func (*DescribeCacheClustersInput) SetShowCacheNodeInfo added in v1.5.0 

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

SetShowCacheNodeInfo sets the ShowCacheNodeInfo field's value.

func (DescribeCacheClustersInput) String added in v0.6.5 

func (s DescribeCacheClustersInput) 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 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 added in v0.6.5 

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 added in v1.5.0 

func (s *DescribeCacheClustersOutput) SetCacheClusters(v []*CacheCluster) *DescribeCacheClustersOutput

SetCacheClusters sets the CacheClusters field's value.

func (*DescribeCacheClustersOutput) SetMarker added in v1.5.0 

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

SetMarker sets the Marker field's value.

func (DescribeCacheClustersOutput) String added in v0.6.5 

func (s DescribeCacheClustersOutput) 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 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 added in v0.6.5 

func (s DescribeCacheEngineVersionsInput) 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 (*DescribeCacheEngineVersionsInput) SetCacheParameterGroupFamily added in v1.5.0 

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

SetCacheParameterGroupFamily sets the CacheParameterGroupFamily field's value.

func (*DescribeCacheEngineVersionsInput) SetDefaultOnly added in v1.5.0 

func (s *DescribeCacheEngineVersionsInput) SetDefaultOnly(v bool) *DescribeCacheEngineVersionsInput

SetDefaultOnly sets the DefaultOnly field's value.

func (*DescribeCacheEngineVersionsInput) SetEngine added in v1.5.0 

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

SetEngine sets the Engine field's value.

func (*DescribeCacheEngineVersionsInput) SetEngineVersion added in v1.5.0 

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

SetEngineVersion sets the EngineVersion field's value.

func (*DescribeCacheEngineVersionsInput) SetMarker added in v1.5.0 

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

SetMarker sets the Marker field's value.

func (*DescribeCacheEngineVersionsInput) SetMaxRecords added in v1.5.0 

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

SetMaxRecords sets the MaxRecords field's value.

func (DescribeCacheEngineVersionsInput) String added in v0.6.5 

func (s DescribeCacheEngineVersionsInput) 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 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 added in v0.6.5 

func (s DescribeCacheEngineVersionsOutput) 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 (*DescribeCacheEngineVersionsOutput) SetCacheEngineVersions added in v1.5.0 

func (s *DescribeCacheEngineVersionsOutput) SetCacheEngineVersions(v []*CacheEngineVersion) *DescribeCacheEngineVersionsOutput

SetCacheEngineVersions sets the CacheEngineVersions field's value.

func (*DescribeCacheEngineVersionsOutput) SetMarker added in v1.5.0 

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

SetMarker sets the Marker field's value.

func (DescribeCacheEngineVersionsOutput) String added in v0.6.5 

func (s DescribeCacheEngineVersionsOutput) 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 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 added in v0.6.5 

func (s DescribeCacheParameterGroupsInput) 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 (*DescribeCacheParameterGroupsInput) SetCacheParameterGroupName added in v1.5.0 

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

SetCacheParameterGroupName sets the CacheParameterGroupName field's value.

func (*DescribeCacheParameterGroupsInput) SetMarker added in v1.5.0 

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

SetMarker sets the Marker field's value.

func (*DescribeCacheParameterGroupsInput) SetMaxRecords added in v1.5.0 

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

SetMaxRecords sets the MaxRecords field's value.

func (DescribeCacheParameterGroupsInput) String added in v0.6.5 

func (s DescribeCacheParameterGroupsInput) 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 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 added in v0.6.5 

func (s DescribeCacheParameterGroupsOutput) 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 (*DescribeCacheParameterGroupsOutput) SetCacheParameterGroups added in v1.5.0 

func (s *DescribeCacheParameterGroupsOutput) SetCacheParameterGroups(v []*CacheParameterGroup) *DescribeCacheParameterGroupsOutput

SetCacheParameterGroups sets the CacheParameterGroups field's value.

func (*DescribeCacheParameterGroupsOutput) SetMarker added in v1.5.0 

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

SetMarker sets the Marker field's value.

func (DescribeCacheParameterGroupsOutput) String added in v0.6.5 

func (s DescribeCacheParameterGroupsOutput) 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 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 added in v0.6.5 

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 added in v1.5.0 

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

SetCacheParameterGroupName sets the CacheParameterGroupName field's value.

func (*DescribeCacheParametersInput) SetMarker added in v1.5.0 

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

SetMarker sets the Marker field's value.

func (*DescribeCacheParametersInput) SetMaxRecords added in v1.5.0 

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

SetMaxRecords sets the MaxRecords field's value.

func (*DescribeCacheParametersInput) SetSource added in v1.5.0 

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

SetSource sets the Source field's value.

func (DescribeCacheParametersInput) String added in v0.6.5 

func (s DescribeCacheParametersInput) 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 (*DescribeCacheParametersInput) Validate added in v1.1.21 

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 added in v0.6.5 

func (s DescribeCacheParametersOutput) 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 (*DescribeCacheParametersOutput) SetCacheNodeTypeSpecificParameters added in v1.5.0 

func (s *DescribeCacheParametersOutput) SetCacheNodeTypeSpecificParameters(v []*CacheNodeTypeSpecificParameter) *DescribeCacheParametersOutput

SetCacheNodeTypeSpecificParameters sets the CacheNodeTypeSpecificParameters field's value.

func (*DescribeCacheParametersOutput) SetMarker added in v1.5.0 

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

SetMarker sets the Marker field's value.

func (*DescribeCacheParametersOutput) SetParameters added in v1.5.0 

func (s *DescribeCacheParametersOutput) SetParameters(v []*Parameter) *DescribeCacheParametersOutput

SetParameters sets the Parameters field's value.

func (DescribeCacheParametersOutput) String added in v0.6.5 

func (s DescribeCacheParametersOutput) 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 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 added in v0.6.5 

func (s DescribeCacheSecurityGroupsInput) 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 (*DescribeCacheSecurityGroupsInput) SetCacheSecurityGroupName added in v1.5.0 

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

SetCacheSecurityGroupName sets the CacheSecurityGroupName field's value.

func (*DescribeCacheSecurityGroupsInput) SetMarker added in v1.5.0 

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

SetMarker sets the Marker field's value.

func (*DescribeCacheSecurityGroupsInput) SetMaxRecords added in v1.5.0 

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

SetMaxRecords sets the MaxRecords field's value.

func (DescribeCacheSecurityGroupsInput) String added in v0.6.5 

func (s DescribeCacheSecurityGroupsInput) 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 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 added in v0.6.5 

func (s DescribeCacheSecurityGroupsOutput) 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 (*DescribeCacheSecurityGroupsOutput) SetCacheSecurityGroups added in v1.5.0 

func (s *DescribeCacheSecurityGroupsOutput) SetCacheSecurityGroups(v []*CacheSecurityGroup) *DescribeCacheSecurityGroupsOutput

SetCacheSecurityGroups sets the CacheSecurityGroups field's value.

func (*DescribeCacheSecurityGroupsOutput) SetMarker added in v1.5.0 

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

SetMarker sets the Marker field's value.

func (DescribeCacheSecurityGroupsOutput) String added in v0.6.5 

func (s DescribeCacheSecurityGroupsOutput) 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 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 added in v0.6.5 

func (s DescribeCacheSubnetGroupsInput) 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 (*DescribeCacheSubnetGroupsInput) SetCacheSubnetGroupName added in v1.5.0 

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

SetCacheSubnetGroupName sets the CacheSubnetGroupName field's value.

func (*DescribeCacheSubnetGroupsInput) SetMarker added in v1.5.0 

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

SetMarker sets the Marker field's value.

func (*DescribeCacheSubnetGroupsInput) SetMaxRecords added in v1.5.0 

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

SetMaxRecords sets the MaxRecords field's value.

func (DescribeCacheSubnetGroupsInput) String added in v0.6.5 

func (s DescribeCacheSubnetGroupsInput) 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 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 added in v0.6.5 

func (s DescribeCacheSubnetGroupsOutput) 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 (*DescribeCacheSubnetGroupsOutput) SetCacheSubnetGroups added in v1.5.0 

func (s *DescribeCacheSubnetGroupsOutput) SetCacheSubnetGroups(v []*CacheSubnetGroup) *DescribeCacheSubnetGroupsOutput

SetCacheSubnetGroups sets the CacheSubnetGroups field's value.

func (*DescribeCacheSubnetGroupsOutput) SetMarker added in v1.5.0 

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

SetMarker sets the Marker field's value.

func (DescribeCacheSubnetGroupsOutput) String added in v0.6.5 

func (s DescribeCacheSubnetGroupsOutput) 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 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 added in v0.6.5 

func (s DescribeEngineDefaultParametersInput) 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 (*DescribeEngineDefaultParametersInput) SetCacheParameterGroupFamily added in v1.5.0 

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

SetCacheParameterGroupFamily sets the CacheParameterGroupFamily field's value.

func (*DescribeEngineDefaultParametersInput) SetMarker added in v1.5.0 

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

SetMarker sets the Marker field's value.

func (*DescribeEngineDefaultParametersInput) SetMaxRecords added in v1.5.0 

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

SetMaxRecords sets the MaxRecords field's value.

func (DescribeEngineDefaultParametersInput) String added in v0.6.5 

func (s DescribeEngineDefaultParametersInput) 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 (*DescribeEngineDefaultParametersInput) Validate added in v1.1.21 

func (s *DescribeEngineDefaultParametersInput) Validate() error

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 added in v0.6.5 

func (s DescribeEngineDefaultParametersOutput) 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 (*DescribeEngineDefaultParametersOutput) SetEngineDefaults added in v1.5.0 

func (s *DescribeEngineDefaultParametersOutput) SetEngineDefaults(v *EngineDefaults) *DescribeEngineDefaultParametersOutput

SetEngineDefaults sets the EngineDefaults field's value.

func (DescribeEngineDefaultParametersOutput) String added in v0.6.5 

func (s DescribeEngineDefaultParametersOutput) 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 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 added in v0.6.5 

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 added in v1.5.0 

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

SetDuration sets the Duration field's value.

func (*DescribeEventsInput) SetEndTime added in v1.5.0 

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

SetEndTime sets the EndTime field's value.

func (*DescribeEventsInput) SetMarker added in v1.5.0 

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

SetMarker sets the Marker field's value.

func (*DescribeEventsInput) SetMaxRecords added in v1.5.0 

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

SetMaxRecords sets the MaxRecords field's value.

func (*DescribeEventsInput) SetSourceIdentifier added in v1.5.0 

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

SetSourceIdentifier sets the SourceIdentifier field's value.

func (*DescribeEventsInput) SetSourceType added in v1.5.0 

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

SetSourceType sets the SourceType field's value.

func (*DescribeEventsInput) SetStartTime added in v1.5.0 

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

SetStartTime sets the StartTime field's value.

func (DescribeEventsInput) String added in v0.6.5 

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 added in v0.6.5 

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 added in v1.5.0 

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

SetEvents sets the Events field's value.

func (*DescribeEventsOutput) SetMarker added in v1.5.0 

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

SetMarker sets the Marker field's value.

func (DescribeEventsOutput) String added in v0.6.5 

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 added in v1.29.25 

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 added in v1.29.25 

func (s DescribeGlobalReplicationGroupsInput) 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 (*DescribeGlobalReplicationGroupsInput) SetGlobalReplicationGroupId added in v1.29.25 

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

SetGlobalReplicationGroupId sets the GlobalReplicationGroupId field's value.

func (*DescribeGlobalReplicationGroupsInput) SetMarker added in v1.29.25 

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

SetMarker sets the Marker field's value.

func (*DescribeGlobalReplicationGroupsInput) SetMaxRecords added in v1.29.25 

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

SetMaxRecords sets the MaxRecords field's value.

func (*DescribeGlobalReplicationGroupsInput) SetShowMemberInfo added in v1.29.25 

func (s *DescribeGlobalReplicationGroupsInput) SetShowMemberInfo(v bool) *DescribeGlobalReplicationGroupsInput

SetShowMemberInfo sets the ShowMemberInfo field's value.

func (DescribeGlobalReplicationGroupsInput) String added in v1.29.25 

func (s DescribeGlobalReplicationGroupsInput) 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 DescribeGlobalReplicationGroupsOutput added in v1.29.25 

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 added in v1.29.25 

func (s DescribeGlobalReplicationGroupsOutput) 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 (*DescribeGlobalReplicationGroupsOutput) SetGlobalReplicationGroups added in v1.29.25 

func (s *DescribeGlobalReplicationGroupsOutput) SetGlobalReplicationGroups(v []*GlobalReplicationGroup) *DescribeGlobalReplicationGroupsOutput

SetGlobalReplicationGroups sets the GlobalReplicationGroups field's value.

func (*DescribeGlobalReplicationGroupsOutput) SetMarker added in v1.29.25 

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

SetMarker sets the Marker field's value.

func (DescribeGlobalReplicationGroupsOutput) String added in v1.29.25 

func (s DescribeGlobalReplicationGroupsOutput) 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 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 added in v0.6.5 

func (s DescribeReplicationGroupsInput) 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 (*DescribeReplicationGroupsInput) SetMarker added in v1.5.0 

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

SetMarker sets the Marker field's value.

func (*DescribeReplicationGroupsInput) SetMaxRecords added in v1.5.0 

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

SetMaxRecords sets the MaxRecords field's value.

func (*DescribeReplicationGroupsInput) SetReplicationGroupId added in v1.5.0 

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

SetReplicationGroupId sets the ReplicationGroupId field's value.

func (DescribeReplicationGroupsInput) String added in v0.6.5 

func (s DescribeReplicationGroupsInput) 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 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 added in v0.6.5 

func (s DescribeReplicationGroupsOutput) 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 (*DescribeReplicationGroupsOutput) SetMarker added in v1.5.0 

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

SetMarker sets the Marker field's value.

func (*DescribeReplicationGroupsOutput) SetReplicationGroups added in v1.5.0 

func (s *DescribeReplicationGroupsOutput) SetReplicationGroups(v []*ReplicationGroup) *DescribeReplicationGroupsOutput

SetReplicationGroups sets the ReplicationGroups field's value.

func (DescribeReplicationGroupsOutput) String added in v0.6.5 

func (s DescribeReplicationGroupsOutput) 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 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: M7g node types: cache.m7g.large,
	//    cache.m7g.xlarge, cache.m7g.2xlarge, cache.m7g.4xlarge, cache.m7g.8xlarge,
	//    cache.m7g.12xlarge, cache.m7g.16xlarge For region availability, see Supported
	//    Node Types (https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/CacheNodes.SupportedTypes.html#CacheNodes.SupportedTypesByRegion)
	//    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 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: R7g node types: cache.r7g.large,
	//    cache.r7g.xlarge, cache.r7g.2xlarge, cache.r7g.4xlarge, cache.r7g.8xlarge,
	//    cache.r7g.12xlarge, cache.r7g.16xlarge For region availability, see Supported
	//    Node Types (https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/CacheNodes.SupportedTypes.html#CacheNodes.SupportedTypesByRegion)
	//    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 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 added in v0.6.5 

func (s DescribeReservedCacheNodesInput) 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 (*DescribeReservedCacheNodesInput) SetCacheNodeType added in v1.5.0 

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

SetCacheNodeType sets the CacheNodeType field's value.

func (*DescribeReservedCacheNodesInput) SetDuration added in v1.5.0 

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

SetDuration sets the Duration field's value.

func (*DescribeReservedCacheNodesInput) SetMarker added in v1.5.0 

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

SetMarker sets the Marker field's value.

func (*DescribeReservedCacheNodesInput) SetMaxRecords added in v1.5.0 

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

SetMaxRecords sets the MaxRecords field's value.

func (*DescribeReservedCacheNodesInput) SetOfferingType added in v1.5.0 

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

SetOfferingType sets the OfferingType field's value.

func (*DescribeReservedCacheNodesInput) SetProductDescription added in v1.5.0 

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

SetProductDescription sets the ProductDescription field's value.

func (*DescribeReservedCacheNodesInput) SetReservedCacheNodeId added in v1.5.0 

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

SetReservedCacheNodeId sets the ReservedCacheNodeId field's value.

func (*DescribeReservedCacheNodesInput) SetReservedCacheNodesOfferingId added in v1.5.0 

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

SetReservedCacheNodesOfferingId sets the ReservedCacheNodesOfferingId field's value.

func (DescribeReservedCacheNodesInput) String added in v0.6.5 

func (s DescribeReservedCacheNodesInput) 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 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: M7g node types: cache.m7g.large,
	//    cache.m7g.xlarge, cache.m7g.2xlarge, cache.m7g.4xlarge, cache.m7g.8xlarge,
	//    cache.m7g.12xlarge, cache.m7g.16xlarge For region availability, see Supported
	//    Node Types (https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/CacheNodes.SupportedTypes.html#CacheNodes.SupportedTypesByRegion)
	//    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 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: R7g node types: cache.r7g.large,
	//    cache.r7g.xlarge, cache.r7g.2xlarge, cache.r7g.4xlarge, cache.r7g.8xlarge,
	//    cache.r7g.12xlarge, cache.r7g.16xlarge For region availability, see Supported
	//    Node Types (https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/CacheNodes.SupportedTypes.html#CacheNodes.SupportedTypesByRegion)
	//    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 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 added in v0.6.5 

func (s DescribeReservedCacheNodesOfferingsInput) 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 (*DescribeReservedCacheNodesOfferingsInput) SetCacheNodeType added in v1.5.0 

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

SetCacheNodeType sets the CacheNodeType field's value.

func (*DescribeReservedCacheNodesOfferingsInput) SetDuration added in v1.5.0 

func (s *DescribeReservedCacheNodesOfferingsInput) SetDuration(v string) *DescribeReservedCacheNodesOfferingsInput

SetDuration sets the Duration field's value.

func (*DescribeReservedCacheNodesOfferingsInput) SetMarker added in v1.5.0 

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

SetMarker sets the Marker field's value.

func (*DescribeReservedCacheNodesOfferingsInput) SetMaxRecords added in v1.5.0 

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

SetMaxRecords sets the MaxRecords field's value.

func (*DescribeReservedCacheNodesOfferingsInput) SetOfferingType added in v1.5.0 

func (s *DescribeReservedCacheNodesOfferingsInput) SetOfferingType(v string) *DescribeReservedCacheNodesOfferingsInput

SetOfferingType sets the OfferingType field's value.

func (*DescribeReservedCacheNodesOfferingsInput) SetProductDescription added in v1.5.0 

func (s *DescribeReservedCacheNodesOfferingsInput) SetProductDescription(v string) *DescribeReservedCacheNodesOfferingsInput

SetProductDescription sets the ProductDescription field's value.

func (*DescribeReservedCacheNodesOfferingsInput) SetReservedCacheNodesOfferingId added in v1.5.0 

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

SetReservedCacheNodesOfferingId sets the ReservedCacheNodesOfferingId field's value.

func (DescribeReservedCacheNodesOfferingsInput) String added in v0.6.5 

func (s DescribeReservedCacheNodesOfferingsInput) 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 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 added in v0.6.5 

func (s DescribeReservedCacheNodesOfferingsOutput) 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 (*DescribeReservedCacheNodesOfferingsOutput) SetMarker added in v1.5.0 

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

SetMarker sets the Marker field's value.

func (*DescribeReservedCacheNodesOfferingsOutput) SetReservedCacheNodesOfferings added in v1.5.0 

func (s *DescribeReservedCacheNodesOfferingsOutput) SetReservedCacheNodesOfferings(v []*ReservedCacheNodesOffering) *DescribeReservedCacheNodesOfferingsOutput

SetReservedCacheNodesOfferings sets the ReservedCacheNodesOfferings field's value.

func (DescribeReservedCacheNodesOfferingsOutput) String added in v0.6.5 

func (s DescribeReservedCacheNodesOfferingsOutput) 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 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 added in v0.6.5 

func (s DescribeReservedCacheNodesOutput) 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 (*DescribeReservedCacheNodesOutput) SetMarker added in v1.5.0 

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

SetMarker sets the Marker field's value.

func (*DescribeReservedCacheNodesOutput) SetReservedCacheNodes added in v1.5.0 

func (s *DescribeReservedCacheNodesOutput) SetReservedCacheNodes(v []*ReservedCacheNode) *DescribeReservedCacheNodesOutput

SetReservedCacheNodes sets the ReservedCacheNodes field's value.

func (DescribeReservedCacheNodesOutput) String added in v0.6.5 

func (s DescribeReservedCacheNodesOutput) 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 DescribeServerlessCacheSnapshotsInput added in v1.48.6 

type DescribeServerlessCacheSnapshotsInput struct {

	// The maximum number of records to include in the response. If more records
	// exist than the specified max-results value, a market is included in the response
	// so that remaining results can be retrieved. Available for Redis only.The
	// default is 50. The Validation Constraints are a maximum of 50.
	MaxResults *int64 `type:"integer"`

	// An optional marker returned from a prior request to support 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 max-results.
	// Available for Redis only.
	NextToken *string `type:"string"`

	// The identifier of serverless cache. If this parameter is specified, only
	// snapshots associated with that specific serverless cache are described. Available
	// for Redis only.
	ServerlessCacheName *string `type:"string"`

	// The identifier of the serverless cache’s snapshot. If this parameter is
	// specified, only this snapshot is described. Available for Redis only.
	ServerlessCacheSnapshotName *string `type:"string"`

	// The type of snapshot that is being described. Available for Redis only.
	SnapshotType *string `type:"string"`
	// contains filtered or unexported fields
}

func (DescribeServerlessCacheSnapshotsInput) GoString added in v1.48.6 

func (s DescribeServerlessCacheSnapshotsInput) 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 (*DescribeServerlessCacheSnapshotsInput) SetMaxResults added in v1.48.6 

func (s *DescribeServerlessCacheSnapshotsInput) SetMaxResults(v int64) *DescribeServerlessCacheSnapshotsInput

SetMaxResults sets the MaxResults field's value.

func (*DescribeServerlessCacheSnapshotsInput) SetNextToken added in v1.48.6 

func (s *DescribeServerlessCacheSnapshotsInput) SetNextToken(v string) *DescribeServerlessCacheSnapshotsInput

SetNextToken sets the NextToken field's value.

func (*DescribeServerlessCacheSnapshotsInput) SetServerlessCacheName added in v1.48.6 

func (s *DescribeServerlessCacheSnapshotsInput) SetServerlessCacheName(v string) *DescribeServerlessCacheSnapshotsInput

SetServerlessCacheName sets the ServerlessCacheName field's value.

func (*DescribeServerlessCacheSnapshotsInput) SetServerlessCacheSnapshotName added in v1.48.6 

func (s *DescribeServerlessCacheSnapshotsInput) SetServerlessCacheSnapshotName(v string) *DescribeServerlessCacheSnapshotsInput

SetServerlessCacheSnapshotName sets the ServerlessCacheSnapshotName field's value.

func (*DescribeServerlessCacheSnapshotsInput) SetSnapshotType added in v1.48.6 

func (s *DescribeServerlessCacheSnapshotsInput) SetSnapshotType(v string) *DescribeServerlessCacheSnapshotsInput

SetSnapshotType sets the SnapshotType field's value.

func (DescribeServerlessCacheSnapshotsInput) String added in v1.48.6 

func (s DescribeServerlessCacheSnapshotsInput) 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 DescribeServerlessCacheSnapshotsOutput added in v1.48.6 

type DescribeServerlessCacheSnapshotsOutput struct {

	// An optional marker returned from a prior request to support 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 max-results.
	// Available for Redis only.
	NextToken *string `type:"string"`

	// The serverless caches snapshots associated with a given description request.
	// Available for Redis only.
	ServerlessCacheSnapshots []*ServerlessCacheSnapshot `locationNameList:"ServerlessCacheSnapshot" type:"list"`
	// contains filtered or unexported fields
}

func (DescribeServerlessCacheSnapshotsOutput) GoString added in v1.48.6 

func (s DescribeServerlessCacheSnapshotsOutput) 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 (*DescribeServerlessCacheSnapshotsOutput) SetNextToken added in v1.48.6 

func (s *DescribeServerlessCacheSnapshotsOutput) SetNextToken(v string) *DescribeServerlessCacheSnapshotsOutput

SetNextToken sets the NextToken field's value.

func (*DescribeServerlessCacheSnapshotsOutput) SetServerlessCacheSnapshots added in v1.48.6 

func (s *DescribeServerlessCacheSnapshotsOutput) SetServerlessCacheSnapshots(v []*ServerlessCacheSnapshot) *DescribeServerlessCacheSnapshotsOutput

SetServerlessCacheSnapshots sets the ServerlessCacheSnapshots field's value.

func (DescribeServerlessCacheSnapshotsOutput) String added in v1.48.6 

func (s DescribeServerlessCacheSnapshotsOutput) 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 DescribeServerlessCachesInput added in v1.48.6 

type DescribeServerlessCachesInput struct {

	// The maximum number of records in the response. If more records exist than
	// the specified max-records value, the next token is included in the response
	// so that remaining results can be retrieved. The default is 50.
	MaxResults *int64 `type:"integer"`

	// An optional marker returned from a prior request to support 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 MaxResults.
	NextToken *string `type:"string"`

	// The identifier for the serverless cache. If this parameter is specified,
	// only information about that specific serverless cache is returned. Default:
	// NULL
	ServerlessCacheName *string `type:"string"`
	// contains filtered or unexported fields
}

func (DescribeServerlessCachesInput) GoString added in v1.48.6 

func (s DescribeServerlessCachesInput) 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 (*DescribeServerlessCachesInput) SetMaxResults added in v1.48.6 

func (s *DescribeServerlessCachesInput) SetMaxResults(v int64) *DescribeServerlessCachesInput

SetMaxResults sets the MaxResults field's value.

func (*DescribeServerlessCachesInput) SetNextToken added in v1.48.6 

func (s *DescribeServerlessCachesInput) SetNextToken(v string) *DescribeServerlessCachesInput

SetNextToken sets the NextToken field's value.

func (*DescribeServerlessCachesInput) SetServerlessCacheName added in v1.48.6 

func (s *DescribeServerlessCachesInput) SetServerlessCacheName(v string) *DescribeServerlessCachesInput

SetServerlessCacheName sets the ServerlessCacheName field's value.

func (DescribeServerlessCachesInput) String added in v1.48.6 

func (s DescribeServerlessCachesInput) 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 DescribeServerlessCachesOutput added in v1.48.6 

type DescribeServerlessCachesOutput struct {

	// An optional marker returned from a prior request to support 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 MaxResults.
	NextToken *string `type:"string"`

	// The serverless caches associated with a given description request.
	ServerlessCaches []*ServerlessCache `type:"list"`
	// contains filtered or unexported fields
}

func (DescribeServerlessCachesOutput) GoString added in v1.48.6 

func (s DescribeServerlessCachesOutput) 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 (*DescribeServerlessCachesOutput) SetNextToken added in v1.48.6 

func (s *DescribeServerlessCachesOutput) SetNextToken(v string) *DescribeServerlessCachesOutput

SetNextToken sets the NextToken field's value.

func (*DescribeServerlessCachesOutput) SetServerlessCaches added in v1.48.6 

func (s *DescribeServerlessCachesOutput) SetServerlessCaches(v []*ServerlessCache) *DescribeServerlessCachesOutput

SetServerlessCaches sets the ServerlessCaches field's value.

func (DescribeServerlessCachesOutput) String added in v1.48.6 

func (s DescribeServerlessCachesOutput) 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 DescribeServiceUpdatesInput added in v1.19.43 

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 added in v1.19.43 

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 added in v1.19.43 

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

SetMarker sets the Marker field's value.

func (*DescribeServiceUpdatesInput) SetMaxRecords added in v1.19.43 

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

SetMaxRecords sets the MaxRecords field's value.

func (*DescribeServiceUpdatesInput) SetServiceUpdateName added in v1.19.43 

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

SetServiceUpdateName sets the ServiceUpdateName field's value.

func (*DescribeServiceUpdatesInput) SetServiceUpdateStatus added in v1.19.43 

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

SetServiceUpdateStatus sets the ServiceUpdateStatus field's value.

func (DescribeServiceUpdatesInput) String added in v1.19.43 

func (s DescribeServiceUpdatesInput) 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 DescribeServiceUpdatesOutput added in v1.19.43 

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 added in v1.19.43 

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 added in v1.19.43 

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

SetMarker sets the Marker field's value.

func (*DescribeServiceUpdatesOutput) SetServiceUpdates added in v1.19.43 

func (s *DescribeServiceUpdatesOutput) SetServiceUpdates(v []*ServiceUpdate) *DescribeServiceUpdatesOutput

SetServiceUpdates sets the ServiceUpdates field's value.

func (DescribeServiceUpdatesOutput) String added in v1.19.43 

func (s DescribeServiceUpdatesOutput) 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 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 added in v0.6.5 

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 added in v1.5.0 

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

SetCacheClusterId sets the CacheClusterId field's value.

func (*DescribeSnapshotsInput) SetMarker added in v1.5.0 

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

SetMarker sets the Marker field's value.

func (*DescribeSnapshotsInput) SetMaxRecords added in v1.5.0 

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

SetMaxRecords sets the MaxRecords field's value.

func (*DescribeSnapshotsInput) SetReplicationGroupId added in v1.5.0 

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

SetReplicationGroupId sets the ReplicationGroupId field's value.

func (*DescribeSnapshotsInput) SetShowNodeGroupConfig added in v1.5.0 

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

SetShowNodeGroupConfig sets the ShowNodeGroupConfig field's value.

func (*DescribeSnapshotsInput) SetSnapshotName added in v1.5.0 

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

SetSnapshotName sets the SnapshotName field's value.

func (*DescribeSnapshotsInput) SetSnapshotSource added in v1.5.0 

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

SetSnapshotSource sets the SnapshotSource field's value.

func (DescribeSnapshotsInput) String added in v0.6.5 

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 added in v0.6.5 

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 added in v1.5.0 

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

SetMarker sets the Marker field's value.

func (*DescribeSnapshotsOutput) SetSnapshots added in v1.5.0 

func (s *DescribeSnapshotsOutput) SetSnapshots(v []*Snapshot) *DescribeSnapshotsOutput

SetSnapshots sets the Snapshots field's value.

func (DescribeSnapshotsOutput) String added in v0.6.5 

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 added in v1.19.43 

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 added in v1.19.43 

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 added in v1.25.9 

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

SetCacheClusterIds sets the CacheClusterIds field's value.

func (*DescribeUpdateActionsInput) SetEngine added in v1.25.9 

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

SetEngine sets the Engine field's value.

func (*DescribeUpdateActionsInput) SetMarker added in v1.19.43 

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

SetMarker sets the Marker field's value.

func (*DescribeUpdateActionsInput) SetMaxRecords added in v1.19.43 

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

SetMaxRecords sets the MaxRecords field's value.

func (*DescribeUpdateActionsInput) SetReplicationGroupIds added in v1.19.43 

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

SetReplicationGroupIds sets the ReplicationGroupIds field's value.

func (*DescribeUpdateActionsInput) SetServiceUpdateName added in v1.19.43 

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

SetServiceUpdateName sets the ServiceUpdateName field's value.

func (*DescribeUpdateActionsInput) SetServiceUpdateStatus added in v1.19.43 

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

SetServiceUpdateStatus sets the ServiceUpdateStatus field's value.

func (*DescribeUpdateActionsInput) SetServiceUpdateTimeRange added in v1.19.43 

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

SetServiceUpdateTimeRange sets the ServiceUpdateTimeRange field's value.

func (*DescribeUpdateActionsInput) SetShowNodeLevelUpdateStatus added in v1.19.43 

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

SetShowNodeLevelUpdateStatus sets the ShowNodeLevelUpdateStatus field's value.

func (*DescribeUpdateActionsInput) SetUpdateActionStatus added in v1.19.43 

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

SetUpdateActionStatus sets the UpdateActionStatus field's value.

func (DescribeUpdateActionsInput) String added in v1.19.43 

func (s DescribeUpdateActionsInput) 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 DescribeUpdateActionsOutput added in v1.19.43 

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 added in v1.19.43 

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 added in v1.19.43 

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

SetMarker sets the Marker field's value.

func (*DescribeUpdateActionsOutput) SetUpdateActions added in v1.19.43 

func (s *DescribeUpdateActionsOutput) SetUpdateActions(v []*UpdateAction) *DescribeUpdateActionsOutput

SetUpdateActions sets the UpdateActions field's value.

func (DescribeUpdateActionsOutput) String added in v1.19.43 

func (s DescribeUpdateActionsOutput) 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 DescribeUserGroupsInput added in v1.35.5 

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 added in v1.35.5 

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 added in v1.35.5 

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

SetMarker sets the Marker field's value.

func (*DescribeUserGroupsInput) SetMaxRecords added in v1.35.5 

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

SetMaxRecords sets the MaxRecords field's value.

func (*DescribeUserGroupsInput) SetUserGroupId added in v1.35.5 

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

SetUserGroupId sets the UserGroupId field's value.

func (DescribeUserGroupsInput) String added in v1.35.5 

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 added in v1.35.5 

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 added in v1.35.5 

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 added in v1.35.5 

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

SetMarker sets the Marker field's value.

func (*DescribeUserGroupsOutput) SetUserGroups added in v1.35.5 

func (s *DescribeUserGroupsOutput) SetUserGroups(v []*UserGroup) *DescribeUserGroupsOutput

SetUserGroups sets the UserGroups field's value.

func (DescribeUserGroupsOutput) String added in v1.35.5 

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 added in v1.35.5 

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 added in v1.35.5 

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 added in v1.35.5 

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

SetEngine sets the Engine field's value.

func (*DescribeUsersInput) SetFilters added in v1.35.5 

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

SetFilters sets the Filters field's value.

func (*DescribeUsersInput) SetMarker added in v1.35.5 

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

SetMarker sets the Marker field's value.

func (*DescribeUsersInput) SetMaxRecords added in v1.35.5 

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

SetMaxRecords sets the MaxRecords field's value.

func (*DescribeUsersInput) SetUserId added in v1.35.5 

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

SetUserId sets the UserId field's value.

func (DescribeUsersInput) String added in v1.35.5 

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 added in v1.35.5 

func (s *DescribeUsersInput) Validate() error

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

type DescribeUsersOutput added in v1.35.5 

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 added in v1.35.5 

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 added in v1.35.5 

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

SetMarker sets the Marker field's value.

func (*DescribeUsersOutput) SetUsers added in v1.35.5 

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

SetUsers sets the Users field's value.

func (DescribeUsersOutput) String added in v1.35.5 

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 added in v1.38.24 

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 added in v1.38.24 

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 added in v1.38.24 

func (s *DestinationDetails) SetCloudWatchLogsDetails(v *CloudWatchLogsDestinationDetails) *DestinationDetails

SetCloudWatchLogsDetails sets the CloudWatchLogsDetails field's value.

func (*DestinationDetails) SetKinesisFirehoseDetails added in v1.38.24 

func (s *DestinationDetails) SetKinesisFirehoseDetails(v *KinesisFirehoseDestinationDetails) *DestinationDetails

SetKinesisFirehoseDetails sets the KinesisFirehoseDetails field's value.

func (DestinationDetails) String added in v1.38.24 

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 added in v1.29.25 

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 added in v1.29.25 

func (s DisassociateGlobalReplicationGroupInput) 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 (*DisassociateGlobalReplicationGroupInput) SetGlobalReplicationGroupId added in v1.29.25 

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

SetGlobalReplicationGroupId sets the GlobalReplicationGroupId field's value.

func (*DisassociateGlobalReplicationGroupInput) SetReplicationGroupId added in v1.29.25 

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

SetReplicationGroupId sets the ReplicationGroupId field's value.

func (*DisassociateGlobalReplicationGroupInput) SetReplicationGroupRegion added in v1.29.25 

func (s *DisassociateGlobalReplicationGroupInput) SetReplicationGroupRegion(v string) *DisassociateGlobalReplicationGroupInput

SetReplicationGroupRegion sets the ReplicationGroupRegion field's value.

func (DisassociateGlobalReplicationGroupInput) String added in v1.29.25 

func (s DisassociateGlobalReplicationGroupInput) 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 (*DisassociateGlobalReplicationGroupInput) Validate added in v1.29.25 

func (s *DisassociateGlobalReplicationGroupInput) Validate() error

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

type DisassociateGlobalReplicationGroupOutput added in v1.29.25 

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 added in v1.29.25 

func (s DisassociateGlobalReplicationGroupOutput) 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 (*DisassociateGlobalReplicationGroupOutput) SetGlobalReplicationGroup added in v1.29.25 

func (s *DisassociateGlobalReplicationGroupOutput) SetGlobalReplicationGroup(v *GlobalReplicationGroup) *DisassociateGlobalReplicationGroupOutput

SetGlobalReplicationGroup sets the GlobalReplicationGroup field's value.

func (DisassociateGlobalReplicationGroupOutput) String added in v1.29.25 

func (s DisassociateGlobalReplicationGroupOutput) 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 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 added in v0.6.5 

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 added in v1.5.0 

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

SetEC2SecurityGroupName sets the EC2SecurityGroupName field's value.

func (*EC2SecurityGroup) SetEC2SecurityGroupOwnerId added in v1.5.0 

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

SetEC2SecurityGroupOwnerId sets the EC2SecurityGroupOwnerId field's value.

func (*EC2SecurityGroup) SetStatus added in v1.5.0 

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

SetStatus sets the Status field's value.

func (EC2SecurityGroup) String added in v0.6.5 

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 ECPUPerSecond added in v1.48.6 

type ECPUPerSecond struct {

	// The configuration for the maximum number of ECPUs the cache can consume per
	// second.
	Maximum *int64 `type:"integer"`

	// The configuration for the minimum number of ECPUs the cache should be able
	// consume per second.
	Minimum *int64 `type:"integer"`
	// contains filtered or unexported fields
}

The configuration for the number of ElastiCache Processing Units (ECPU) the cache can consume per second.

func (ECPUPerSecond) GoString added in v1.48.6 

func (s ECPUPerSecond) 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 (*ECPUPerSecond) SetMaximum added in v1.48.6 

func (s *ECPUPerSecond) SetMaximum(v int64) *ECPUPerSecond

SetMaximum sets the Maximum field's value.

func (*ECPUPerSecond) SetMinimum added in v1.51.9 

func (s *ECPUPerSecond) SetMinimum(v int64) *ECPUPerSecond

SetMinimum sets the Minimum field's value.

func (ECPUPerSecond) String added in v1.48.6 

func (s ECPUPerSecond) 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

  • ErrCodeServerlessCacheNotFoundFault "ServerlessCacheNotFoundFault" The serverless cache was not found or does not exist.

  • ErrCodeInvalidServerlessCacheStateFault "InvalidServerlessCacheStateFault" The account for these credentials is not currently active.

  • ErrCodeServerlessCacheSnapshotNotFoundFault "ServerlessCacheSnapshotNotFoundFault" This serverless cache snapshot could not be found or does not exist. Available for Redis only.

  • ErrCodeInvalidServerlessCacheSnapshotStateFault "InvalidServerlessCacheSnapshotStateFault" The state of the serverless cache snapshot was not received. Available for Redis only.

  • 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.ErrCodeServerlessCacheNotFoundFault:
				fmt.Println(elasticache.ErrCodeServerlessCacheNotFoundFault, aerr.Error())
			case elasticache.ErrCodeInvalidServerlessCacheStateFault:
				fmt.Println(elasticache.ErrCodeInvalidServerlessCacheStateFault, aerr.Error())
			case elasticache.ErrCodeServerlessCacheSnapshotNotFoundFault:
				fmt.Println(elasticache.ErrCodeServerlessCacheSnapshotNotFoundFault, aerr.Error())
			case elasticache.ErrCodeInvalidServerlessCacheSnapshotStateFault:
				fmt.Println(elasticache.ErrCodeInvalidServerlessCacheSnapshotStateFault, 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 added in v1.8.0 

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 

func (c *ElastiCache) AuthorizeCacheSecurityGroupIngress(input *AuthorizeCacheSecurityGroupIngressInput) (*AuthorizeCacheSecurityGroupIngressOutput, error)

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 added in v1.8.0 

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 added in v1.19.43 

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 added in v1.19.43 

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 added in v1.19.43 

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 added in v1.19.43 

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 added in v1.19.43 

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 added in v1.19.43 

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 added in v1.25.20 

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 added in v1.25.20 

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 added in v1.25.20 

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) CopyServerlessCacheSnapshot added in v1.48.6 

func (c *ElastiCache) CopyServerlessCacheSnapshot(input *CopyServerlessCacheSnapshotInput) (*CopyServerlessCacheSnapshotOutput, error)

CopyServerlessCacheSnapshot API operation for Amazon ElastiCache.

Creates a copy of an existing serverless cache’s snapshot. Available 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 CopyServerlessCacheSnapshot for usage and error information.

Returned Error Codes:

  • ErrCodeServerlessCacheSnapshotAlreadyExistsFault "ServerlessCacheSnapshotAlreadyExistsFault" A serverless cache snapshot with this name already exists. Available for Redis only.

  • ErrCodeServerlessCacheSnapshotNotFoundFault "ServerlessCacheSnapshotNotFoundFault" This serverless cache snapshot could not be found or does not exist. Available for Redis only.

  • ErrCodeServerlessCacheSnapshotQuotaExceededFault "ServerlessCacheSnapshotQuotaExceededFault" The number of serverless cache snapshots exceeds the customer snapshot quota. Available for Redis only.

  • ErrCodeInvalidServerlessCacheSnapshotStateFault "InvalidServerlessCacheSnapshotStateFault" The state of the serverless cache snapshot was not received. Available for Redis only.

  • ErrCodeServiceLinkedRoleNotFoundFault "ServiceLinkedRoleNotFoundFault" The specified service linked role (SLR) was not found.

  • 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/CopyServerlessCacheSnapshot

func (*ElastiCache) CopyServerlessCacheSnapshotRequest added in v1.48.6 

func (c *ElastiCache) CopyServerlessCacheSnapshotRequest(input *CopyServerlessCacheSnapshotInput) (req *request.Request, output *CopyServerlessCacheSnapshotOutput)

CopyServerlessCacheSnapshotRequest generates a "aws/request.Request" representing the client's request for the CopyServerlessCacheSnapshot 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 CopyServerlessCacheSnapshot for more information on using the CopyServerlessCacheSnapshot 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 CopyServerlessCacheSnapshotRequest method.
req, resp := client.CopyServerlessCacheSnapshotRequest(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/CopyServerlessCacheSnapshot

func (*ElastiCache) CopyServerlessCacheSnapshotWithContext added in v1.48.6 

func (c *ElastiCache) CopyServerlessCacheSnapshotWithContext(ctx aws.Context, input *CopyServerlessCacheSnapshotInput, opts ...request.Option) (*CopyServerlessCacheSnapshotOutput, error)

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

See CopyServerlessCacheSnapshot 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 added in v1.8.0 

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 added in v1.8.0 

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 added in v1.8.0 

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 added in v1.8.0 

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 added in v1.8.0 

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 added in v1.29.25 

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 added in v1.29.25 

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 added in v1.29.25 

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 nodes, where one of the nodes 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 added in v1.8.0 

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) CreateServerlessCache added in v1.48.6 

func (c *ElastiCache) CreateServerlessCache(input *CreateServerlessCacheInput) (*CreateServerlessCacheOutput, error)

CreateServerlessCache API operation for Amazon ElastiCache.

Creates a serverless cache.

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 CreateServerlessCache for usage and error information.

Returned Error Codes:

  • ErrCodeServerlessCacheNotFoundFault "ServerlessCacheNotFoundFault" The serverless cache was not found or does not exist.

  • ErrCodeInvalidServerlessCacheStateFault "InvalidServerlessCacheStateFault" The account for these credentials is not currently active.

  • ErrCodeServerlessCacheAlreadyExistsFault "ServerlessCacheAlreadyExistsFault" A serverless cache with this name already exists.

  • ErrCodeServerlessCacheQuotaForCustomerExceededFault "ServerlessCacheQuotaForCustomerExceededFault" The number of serverless caches exceeds the customer quota.

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

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

  • ErrCodeInvalidCredentialsException "InvalidCredentialsException" You must enter valid credentials.

  • ErrCodeInvalidUserGroupStateFault "InvalidUserGroupState" The user group is not in an active state.

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

  • ErrCodeServiceLinkedRoleNotFoundFault "ServiceLinkedRoleNotFoundFault" The specified service linked role (SLR) was not found.

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

func (*ElastiCache) CreateServerlessCacheRequest added in v1.48.6 

func (c *ElastiCache) CreateServerlessCacheRequest(input *CreateServerlessCacheInput) (req *request.Request, output *CreateServerlessCacheOutput)

CreateServerlessCacheRequest generates a "aws/request.Request" representing the client's request for the CreateServerlessCache 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 CreateServerlessCache for more information on using the CreateServerlessCache 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 CreateServerlessCacheRequest method.
req, resp := client.CreateServerlessCacheRequest(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/CreateServerlessCache

func (*ElastiCache) CreateServerlessCacheSnapshot added in v1.48.6 

func (c *ElastiCache) CreateServerlessCacheSnapshot(input *CreateServerlessCacheSnapshotInput) (*CreateServerlessCacheSnapshotOutput, error)

CreateServerlessCacheSnapshot API operation for Amazon ElastiCache.

This API creates a copy of an entire ServerlessCache at a specific moment in time. Available 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 CreateServerlessCacheSnapshot for usage and error information.

Returned Error Codes:

  • ErrCodeServerlessCacheSnapshotAlreadyExistsFault "ServerlessCacheSnapshotAlreadyExistsFault" A serverless cache snapshot with this name already exists. Available for Redis only.

  • ErrCodeServerlessCacheNotFoundFault "ServerlessCacheNotFoundFault" The serverless cache was not found or does not exist.

  • ErrCodeInvalidServerlessCacheStateFault "InvalidServerlessCacheStateFault" The account for these credentials is not currently active.

  • ErrCodeServerlessCacheSnapshotQuotaExceededFault "ServerlessCacheSnapshotQuotaExceededFault" The number of serverless cache snapshots exceeds the customer snapshot quota. Available for Redis only.

  • ErrCodeServiceLinkedRoleNotFoundFault "ServiceLinkedRoleNotFoundFault" The specified service linked role (SLR) was not found.

  • 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/CreateServerlessCacheSnapshot

func (*ElastiCache) CreateServerlessCacheSnapshotRequest added in v1.48.6 

func (c *ElastiCache) CreateServerlessCacheSnapshotRequest(input *CreateServerlessCacheSnapshotInput) (req *request.Request, output *CreateServerlessCacheSnapshotOutput)

CreateServerlessCacheSnapshotRequest generates a "aws/request.Request" representing the client's request for the CreateServerlessCacheSnapshot 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 CreateServerlessCacheSnapshot for more information on using the CreateServerlessCacheSnapshot 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 CreateServerlessCacheSnapshotRequest method.
req, resp := client.CreateServerlessCacheSnapshotRequest(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/CreateServerlessCacheSnapshot

func (*ElastiCache) CreateServerlessCacheSnapshotWithContext added in v1.48.6 

func (c *ElastiCache) CreateServerlessCacheSnapshotWithContext(ctx aws.Context, input *CreateServerlessCacheSnapshotInput, opts ...request.Option) (*CreateServerlessCacheSnapshotOutput, error)

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

See CreateServerlessCacheSnapshot 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) CreateServerlessCacheWithContext added in v1.48.6 

func (c *ElastiCache) CreateServerlessCacheWithContext(ctx aws.Context, input *CreateServerlessCacheInput, opts ...request.Option) (*CreateServerlessCacheOutput, error)

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

See CreateServerlessCache 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 added in v1.8.0 

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 added in v1.35.5 

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 added in v1.35.5 

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 added in v1.35.5 

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 added in v1.35.5 

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 added in v1.35.5 

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 added in v1.35.5 

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 added in v1.29.25 

func (c *ElastiCache) DecreaseNodeGroupsInGlobalReplicationGroup(input *DecreaseNodeGroupsInGlobalReplicationGroupInput) (*DecreaseNodeGroupsInGlobalReplicationGroupOutput, error)

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 added in v1.29.25 

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 added in v1.29.25 

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 added in v1.15.29 

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 added in v1.15.29 

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 added in v1.15.29 

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 added in v1.8.0 

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 added in v1.8.0 

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 added in v1.8.0 

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 added in v1.8.0 

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 added in v1.29.25 

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 added in v1.29.25 

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 added in v1.29.25 

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 added in v1.8.0 

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) DeleteServerlessCache added in v1.48.6 

func (c *ElastiCache) DeleteServerlessCache(input *DeleteServerlessCacheInput) (*DeleteServerlessCacheOutput, error)

DeleteServerlessCache API operation for Amazon ElastiCache.

Deletes a specified existing serverless cache.

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 DeleteServerlessCache for usage and error information.

Returned Error Codes:

  • ErrCodeServerlessCacheNotFoundFault "ServerlessCacheNotFoundFault" The serverless cache was not found or does not exist.

  • ErrCodeInvalidServerlessCacheStateFault "InvalidServerlessCacheStateFault" The account for these credentials is not currently active.

  • ErrCodeServerlessCacheSnapshotAlreadyExistsFault "ServerlessCacheSnapshotAlreadyExistsFault" A serverless cache snapshot with this name already exists. Available for Redis only.

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

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

  • ErrCodeInvalidCredentialsException "InvalidCredentialsException" You must enter valid credentials.

  • ErrCodeServiceLinkedRoleNotFoundFault "ServiceLinkedRoleNotFoundFault" The specified service linked role (SLR) was not found.

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

func (*ElastiCache) DeleteServerlessCacheRequest added in v1.48.6 

func (c *ElastiCache) DeleteServerlessCacheRequest(input *DeleteServerlessCacheInput) (req *request.Request, output *DeleteServerlessCacheOutput)

DeleteServerlessCacheRequest generates a "aws/request.Request" representing the client's request for the DeleteServerlessCache 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 DeleteServerlessCache for more information on using the DeleteServerlessCache 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 DeleteServerlessCacheRequest method.
req, resp := client.DeleteServerlessCacheRequest(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/DeleteServerlessCache

func (*ElastiCache) DeleteServerlessCacheSnapshot added in v1.48.6 

func (c *ElastiCache) DeleteServerlessCacheSnapshot(input *DeleteServerlessCacheSnapshotInput) (*DeleteServerlessCacheSnapshotOutput, error)

DeleteServerlessCacheSnapshot API operation for Amazon ElastiCache.

Deletes an existing serverless cache snapshot. Available 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 DeleteServerlessCacheSnapshot for usage and error information.

Returned Error Codes:

  • ErrCodeServiceLinkedRoleNotFoundFault "ServiceLinkedRoleNotFoundFault" The specified service linked role (SLR) was not found.

  • ErrCodeServerlessCacheSnapshotNotFoundFault "ServerlessCacheSnapshotNotFoundFault" This serverless cache snapshot could not be found or does not exist. Available for Redis only.

  • ErrCodeInvalidServerlessCacheSnapshotStateFault "InvalidServerlessCacheSnapshotStateFault" The state of the serverless cache snapshot was not received. Available for Redis only.

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

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

func (*ElastiCache) DeleteServerlessCacheSnapshotRequest added in v1.48.6 

func (c *ElastiCache) DeleteServerlessCacheSnapshotRequest(input *DeleteServerlessCacheSnapshotInput) (req *request.Request, output *DeleteServerlessCacheSnapshotOutput)

DeleteServerlessCacheSnapshotRequest generates a "aws/request.Request" representing the client's request for the DeleteServerlessCacheSnapshot 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 DeleteServerlessCacheSnapshot for more information on using the DeleteServerlessCacheSnapshot 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 DeleteServerlessCacheSnapshotRequest method.
req, resp := client.DeleteServerlessCacheSnapshotRequest(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/DeleteServerlessCacheSnapshot

func (*ElastiCache) DeleteServerlessCacheSnapshotWithContext added in v1.48.6 

func (c *ElastiCache) DeleteServerlessCacheSnapshotWithContext(ctx aws.Context, input *DeleteServerlessCacheSnapshotInput, opts ...request.Option) (*DeleteServerlessCacheSnapshotOutput, error)

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

See DeleteServerlessCacheSnapshot 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) DeleteServerlessCacheWithContext added in v1.48.6 

func (c *ElastiCache) DeleteServerlessCacheWithContext(ctx aws.Context, input *DeleteServerlessCacheInput, opts ...request.Option) (*DeleteServerlessCacheOutput, error)

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

See DeleteServerlessCache 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 added in v1.8.0 

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 added in v1.35.5 

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 added in v1.35.5 

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 added in v1.35.5 

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 added in v1.35.5 

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 added in v1.35.5 

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 added in v1.35.5 

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 added in v1.8.0 

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 added in v1.8.0 

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 added in v1.8.0 

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 added in v1.8.0 

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 added in v1.8.0 

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 added in v1.8.0 

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 added in v1.8.0 

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 added in v1.8.0 

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 added in v1.8.0 

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 added in v1.8.0 

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 added in v1.8.0 

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 added in v1.8.0 

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 

func (c *ElastiCache) DescribeEngineDefaultParameters(input *DescribeEngineDefaultParametersInput) (*DescribeEngineDefaultParametersOutput, error)

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 added in v1.8.0 

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 added in v1.8.0 

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 added in v1.8.0 

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 added in v1.8.0 

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 added in v1.29.25 

func (c *ElastiCache) DescribeGlobalReplicationGroups(input *DescribeGlobalReplicationGroupsInput) (*DescribeGlobalReplicationGroupsOutput, error)

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 added in v1.29.25 

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 added in v1.29.25 

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 added in v1.29.25 

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 added in v1.29.25 

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 added in v1.8.0 

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 added in v1.8.0 

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 

func (c *ElastiCache) DescribeReservedCacheNodesOfferings(input *DescribeReservedCacheNodesOfferingsInput) (*DescribeReservedCacheNodesOfferingsOutput, error)

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 added in v1.8.0 

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 added in v1.8.0 

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 added in v1.8.0 

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 added in v1.8.0 

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) DescribeServerlessCacheSnapshots added in v1.48.6 

func (c *ElastiCache) DescribeServerlessCacheSnapshots(input *DescribeServerlessCacheSnapshotsInput) (*DescribeServerlessCacheSnapshotsOutput, error)

DescribeServerlessCacheSnapshots API operation for Amazon ElastiCache.

Returns information about serverless cache snapshots. By default, this API lists all of the customer’s serverless cache snapshots. It can also describe a single serverless cache snapshot, or the snapshots associated with a particular serverless cache. Available 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 DescribeServerlessCacheSnapshots for usage and error information.

Returned Error Codes:

  • ErrCodeServerlessCacheNotFoundFault "ServerlessCacheNotFoundFault" The serverless cache was not found or does not exist.

  • ErrCodeServerlessCacheSnapshotNotFoundFault "ServerlessCacheSnapshotNotFoundFault" This serverless cache snapshot could not be found or does not exist. Available for Redis only.

  • 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/DescribeServerlessCacheSnapshots

func (*ElastiCache) DescribeServerlessCacheSnapshotsPages added in v1.48.6 

func (c *ElastiCache) DescribeServerlessCacheSnapshotsPages(input *DescribeServerlessCacheSnapshotsInput, fn func(*DescribeServerlessCacheSnapshotsOutput, bool) bool) error

DescribeServerlessCacheSnapshotsPages iterates over the pages of a DescribeServerlessCacheSnapshots operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See DescribeServerlessCacheSnapshots 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 DescribeServerlessCacheSnapshots operation.
pageNum := 0
err := client.DescribeServerlessCacheSnapshotsPages(params,
    func(page *elasticache.DescribeServerlessCacheSnapshotsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*ElastiCache) DescribeServerlessCacheSnapshotsPagesWithContext added in v1.48.6 

func (c *ElastiCache) DescribeServerlessCacheSnapshotsPagesWithContext(ctx aws.Context, input *DescribeServerlessCacheSnapshotsInput, fn func(*DescribeServerlessCacheSnapshotsOutput, bool) bool, opts ...request.Option) error

DescribeServerlessCacheSnapshotsPagesWithContext same as DescribeServerlessCacheSnapshotsPages 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) DescribeServerlessCacheSnapshotsRequest added in v1.48.6 

func (c *ElastiCache) DescribeServerlessCacheSnapshotsRequest(input *DescribeServerlessCacheSnapshotsInput) (req *request.Request, output *DescribeServerlessCacheSnapshotsOutput)

DescribeServerlessCacheSnapshotsRequest generates a "aws/request.Request" representing the client's request for the DescribeServerlessCacheSnapshots 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 DescribeServerlessCacheSnapshots for more information on using the DescribeServerlessCacheSnapshots 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 DescribeServerlessCacheSnapshotsRequest method.
req, resp := client.DescribeServerlessCacheSnapshotsRequest(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/DescribeServerlessCacheSnapshots

func (*ElastiCache) DescribeServerlessCacheSnapshotsWithContext added in v1.48.6 

func (c *ElastiCache) DescribeServerlessCacheSnapshotsWithContext(ctx aws.Context, input *DescribeServerlessCacheSnapshotsInput, opts ...request.Option) (*DescribeServerlessCacheSnapshotsOutput, error)

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

See DescribeServerlessCacheSnapshots 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) DescribeServerlessCaches added in v1.48.6 

func (c *ElastiCache) DescribeServerlessCaches(input *DescribeServerlessCachesInput) (*DescribeServerlessCachesOutput, error)

DescribeServerlessCaches API operation for Amazon ElastiCache.

Returns information about a specific serverless cache. If no identifier is specified, then the API returns information on all the serverless caches belonging to this Amazon Web Services 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 DescribeServerlessCaches for usage and error information.

Returned Error Codes:

  • ErrCodeServerlessCacheNotFoundFault "ServerlessCacheNotFoundFault" The serverless cache was not found or 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/DescribeServerlessCaches

func (*ElastiCache) DescribeServerlessCachesPages added in v1.48.6 

func (c *ElastiCache) DescribeServerlessCachesPages(input *DescribeServerlessCachesInput, fn func(*DescribeServerlessCachesOutput, bool) bool) error

DescribeServerlessCachesPages iterates over the pages of a DescribeServerlessCaches operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See DescribeServerlessCaches 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 DescribeServerlessCaches operation.
pageNum := 0
err := client.DescribeServerlessCachesPages(params,
    func(page *elasticache.DescribeServerlessCachesOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*ElastiCache) DescribeServerlessCachesPagesWithContext added in v1.48.6 

func (c *ElastiCache) DescribeServerlessCachesPagesWithContext(ctx aws.Context, input *DescribeServerlessCachesInput, fn func(*DescribeServerlessCachesOutput, bool) bool, opts ...request.Option) error

DescribeServerlessCachesPagesWithContext same as DescribeServerlessCachesPages 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) DescribeServerlessCachesRequest added in v1.48.6 

func (c *ElastiCache) DescribeServerlessCachesRequest(input *DescribeServerlessCachesInput) (req *request.Request, output *DescribeServerlessCachesOutput)

DescribeServerlessCachesRequest generates a "aws/request.Request" representing the client's request for the DescribeServerlessCaches 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 DescribeServerlessCaches for more information on using the DescribeServerlessCaches 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 DescribeServerlessCachesRequest method.
req, resp := client.DescribeServerlessCachesRequest(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/DescribeServerlessCaches

func (*ElastiCache) DescribeServerlessCachesWithContext added in v1.48.6 

func (c *ElastiCache) DescribeServerlessCachesWithContext(ctx aws.Context, input *DescribeServerlessCachesInput, opts ...request.Option) (*DescribeServerlessCachesOutput, error)

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

See DescribeServerlessCaches 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 added in v1.19.43 

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 added in v1.19.43 

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 added in v1.19.43 

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 added in v1.19.43 

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 added in v1.19.43 

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 added in v1.8.0 

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 added in v1.8.0 

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 added in v1.19.43 

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 added in v1.19.43 

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 added in v1.19.43 

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 added in v1.19.43 

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 added in v1.19.43 

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 added in v1.35.5 

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 added in v1.35.5 

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 added in v1.35.5 

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 added in v1.35.5 

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 added in v1.35.5 

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 added in v1.35.5 

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 added in v1.35.5 

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 added in v1.35.5 

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 added in v1.35.5 

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 added in v1.35.5 

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 added in v1.29.25 

func (c *ElastiCache) DisassociateGlobalReplicationGroup(input *DisassociateGlobalReplicationGroupInput) (*DisassociateGlobalReplicationGroupOutput, error)

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 added in v1.29.25 

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 added in v1.29.25 

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) ExportServerlessCacheSnapshot added in v1.48.6 

func (c *ElastiCache) ExportServerlessCacheSnapshot(input *ExportServerlessCacheSnapshotInput) (*ExportServerlessCacheSnapshotOutput, error)

ExportServerlessCacheSnapshot API operation for Amazon ElastiCache.

Provides the functionality to export the serverless cache snapshot data to Amazon S3. Available 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 ExportServerlessCacheSnapshot for usage and error information.

Returned Error Codes:

  • ErrCodeServerlessCacheSnapshotNotFoundFault "ServerlessCacheSnapshotNotFoundFault" This serverless cache snapshot could not be found or does not exist. Available for Redis only.

  • ErrCodeInvalidServerlessCacheSnapshotStateFault "InvalidServerlessCacheSnapshotStateFault" The state of the serverless cache snapshot was not received. Available for Redis only.

  • 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/ExportServerlessCacheSnapshot

func (*ElastiCache) ExportServerlessCacheSnapshotRequest added in v1.48.6 

func (c *ElastiCache) ExportServerlessCacheSnapshotRequest(input *ExportServerlessCacheSnapshotInput) (req *request.Request, output *ExportServerlessCacheSnapshotOutput)

ExportServerlessCacheSnapshotRequest generates a "aws/request.Request" representing the client's request for the ExportServerlessCacheSnapshot 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 ExportServerlessCacheSnapshot for more information on using the ExportServerlessCacheSnapshot 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 ExportServerlessCacheSnapshotRequest method.
req, resp := client.ExportServerlessCacheSnapshotRequest(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/ExportServerlessCacheSnapshot

func (*ElastiCache) ExportServerlessCacheSnapshotWithContext added in v1.48.6 

func (c *ElastiCache) ExportServerlessCacheSnapshotWithContext(ctx aws.Context, input *ExportServerlessCacheSnapshotInput, opts ...request.Option) (*ExportServerlessCacheSnapshotOutput, error)

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

See ExportServerlessCacheSnapshot 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 added in v1.29.25 

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 added in v1.29.25 

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 added in v1.29.25 

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 added in v1.29.25 

func (c *ElastiCache) IncreaseNodeGroupsInGlobalReplicationGroup(input *IncreaseNodeGroupsInGlobalReplicationGroupInput) (*IncreaseNodeGroupsInGlobalReplicationGroupOutput, error)

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 added in v1.29.25 

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 added in v1.29.25 

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 added in v1.15.29 

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 added in v1.15.29 

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 added in v1.15.29 

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 added in v1.1.14 

func (c *ElastiCache) ListAllowedNodeTypeModifications(input *ListAllowedNodeTypeModificationsInput) (*ListAllowedNodeTypeModificationsOutput, error)

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 added in v1.1.14 

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 added in v1.8.0 

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

  • ErrCodeServerlessCacheNotFoundFault "ServerlessCacheNotFoundFault" The serverless cache was not found or does not exist.

  • ErrCodeInvalidServerlessCacheStateFault "InvalidServerlessCacheStateFault" The account for these credentials is not currently active.

  • ErrCodeServerlessCacheSnapshotNotFoundFault "ServerlessCacheSnapshotNotFoundFault" This serverless cache snapshot could not be found or does not exist. Available for Redis only.

  • ErrCodeInvalidServerlessCacheSnapshotStateFault "InvalidServerlessCacheSnapshotStateFault" The state of the serverless cache snapshot was not received. Available for Redis only.

  • 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.ErrCodeServerlessCacheNotFoundFault:
				fmt.Println(elasticache.ErrCodeServerlessCacheNotFoundFault, aerr.Error())
			case elasticache.ErrCodeInvalidServerlessCacheStateFault:
				fmt.Println(elasticache.ErrCodeInvalidServerlessCacheStateFault, aerr.Error())
			case elasticache.ErrCodeServerlessCacheSnapshotNotFoundFault:
				fmt.Println(elasticache.ErrCodeServerlessCacheSnapshotNotFoundFault, aerr.Error())
			case elasticache.ErrCodeInvalidServerlessCacheSnapshotStateFault:
				fmt.Println(elasticache.ErrCodeInvalidServerlessCacheSnapshotStateFault, 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 added in v1.8.0 

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 added in v1.8.0 

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 added in v1.8.0 

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 added in v1.8.0 

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 added in v1.29.25 

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 added in v1.29.25 

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 added in v1.29.25 

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 is limited to Redis 7 and newer.

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 added in v1.12.25 

func (c *ElastiCache) ModifyReplicationGroupShardConfiguration(input *ModifyReplicationGroupShardConfigurationInput) (*ModifyReplicationGroupShardConfigurationOutput, error)

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 added in v1.12.25 

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 added in v1.12.25 

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 added in v1.8.0 

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) ModifyServerlessCache added in v1.48.6 

func (c *ElastiCache) ModifyServerlessCache(input *ModifyServerlessCacheInput) (*ModifyServerlessCacheOutput, error)

ModifyServerlessCache API operation for Amazon ElastiCache.

This API modifies the attributes of a serverless cache.

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 ModifyServerlessCache for usage and error information.

Returned Error Codes:

  • ErrCodeServerlessCacheNotFoundFault "ServerlessCacheNotFoundFault" The serverless cache was not found or does not exist.

  • ErrCodeInvalidServerlessCacheStateFault "InvalidServerlessCacheStateFault" The account for these credentials is not currently active.

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

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

  • ErrCodeInvalidCredentialsException "InvalidCredentialsException" You must enter valid credentials.

  • ErrCodeInvalidUserGroupStateFault "InvalidUserGroupState" The user group is not in an active state.

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

  • ErrCodeServiceLinkedRoleNotFoundFault "ServiceLinkedRoleNotFoundFault" The specified service linked role (SLR) was not found.

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

func (*ElastiCache) ModifyServerlessCacheRequest added in v1.48.6 

func (c *ElastiCache) ModifyServerlessCacheRequest(input *ModifyServerlessCacheInput) (req *request.Request, output *ModifyServerlessCacheOutput)

ModifyServerlessCacheRequest generates a "aws/request.Request" representing the client's request for the ModifyServerlessCache 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 ModifyServerlessCache for more information on using the ModifyServerlessCache 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 ModifyServerlessCacheRequest method.
req, resp := client.ModifyServerlessCacheRequest(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/ModifyServerlessCache

func (*ElastiCache) ModifyServerlessCacheWithContext added in v1.48.6 

func (c *ElastiCache) ModifyServerlessCacheWithContext(ctx aws.Context, input *ModifyServerlessCacheInput, opts ...request.Option) (*ModifyServerlessCacheOutput, error)

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

See ModifyServerlessCache 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 added in v1.35.5 

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 added in v1.35.5 

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 added in v1.35.5 

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 added in v1.35.5 

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 added in v1.35.5 

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 added in v1.35.5 

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 

func (c *ElastiCache) PurchaseReservedCacheNodesOffering(input *PurchaseReservedCacheNodesOfferingInput) (*PurchaseReservedCacheNodesOfferingOutput, error)

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 added in v1.8.0 

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 added in v1.29.25 

func (c *ElastiCache) RebalanceSlotsInGlobalReplicationGroup(input *RebalanceSlotsInGlobalReplicationGroupInput) (*RebalanceSlotsInGlobalReplicationGroupOutput, error)

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 added in v1.29.25 

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 added in v1.29.25 

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 added in v1.8.0 

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

  • ErrCodeServerlessCacheNotFoundFault "ServerlessCacheNotFoundFault" The serverless cache was not found or does not exist.

  • ErrCodeInvalidServerlessCacheStateFault "InvalidServerlessCacheStateFault" The account for these credentials is not currently active.

  • ErrCodeServerlessCacheSnapshotNotFoundFault "ServerlessCacheSnapshotNotFoundFault" This serverless cache snapshot could not be found or does not exist. Available for Redis only.

  • ErrCodeInvalidServerlessCacheSnapshotStateFault "InvalidServerlessCacheSnapshotStateFault" The state of the serverless cache snapshot was not received. Available for Redis only.

  • 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.ErrCodeServerlessCacheNotFoundFault:
				fmt.Println(elasticache.ErrCodeServerlessCacheNotFoundFault, aerr.Error())
			case elasticache.ErrCodeInvalidServerlessCacheStateFault:
				fmt.Println(elasticache.ErrCodeInvalidServerlessCacheStateFault, aerr.Error())
			case elasticache.ErrCodeServerlessCacheSnapshotNotFoundFault:
				fmt.Println(elasticache.ErrCodeServerlessCacheSnapshotNotFoundFault, aerr.Error())
			case elasticache.ErrCodeInvalidServerlessCacheSnapshotStateFault:
				fmt.Println(elasticache.ErrCodeInvalidServerlessCacheSnapshotStateFault, 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 added in v1.8.0 

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 added in v1.8.0 

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 

func (c *ElastiCache) RevokeCacheSecurityGroupIngress(input *RevokeCacheSecurityGroupIngressInput) (*RevokeCacheSecurityGroupIngressOutput, error)

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 added in v1.8.0 

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 added in v1.25.20 

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 added in v1.25.20 

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 added in v1.25.20 

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 added in v1.8.9 

func (c *ElastiCache) TestFailover(input *TestFailoverInput) (*TestFailoverOutput, error)

TestFailover API operation for Amazon ElastiCache.

Represents the input of a TestFailover operation which tests 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 15 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 added in v1.8.9 

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 added in v1.8.9 

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) TestMigration added in v1.44.319 

func (c *ElastiCache) TestMigration(input *TestMigrationInput) (*TestMigrationOutput, error)

TestMigration API operation for Amazon ElastiCache.

Async API to test connection between source and target replication 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 TestMigration 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/TestMigration

func (*ElastiCache) TestMigrationRequest added in v1.44.319 

func (c *ElastiCache) TestMigrationRequest(input *TestMigrationInput) (req *request.Request, output *TestMigrationOutput)

TestMigrationRequest generates a "aws/request.Request" representing the client's request for the TestMigration 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 TestMigration for more information on using the TestMigration 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 TestMigrationRequest method.
req, resp := client.TestMigrationRequest(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/TestMigration

func (*ElastiCache) TestMigrationWithContext added in v1.44.319 

func (c *ElastiCache) TestMigrationWithContext(ctx aws.Context, input *TestMigrationInput, opts ...request.Option) (*TestMigrationOutput, error)

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

See TestMigration 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 added in v0.10.3 

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 added in v1.8.0 

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 added in v0.10.3 

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 added in v1.8.0 

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 added in v0.10.3 

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 added in v1.8.0 

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 added in v0.10.3 

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 added in v1.8.0 

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. This value is read-only.

func (Endpoint) GoString added in v0.6.5 

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 added in v1.5.0 

func (s *Endpoint) SetAddress(v string) *Endpoint

SetAddress sets the Address field's value.

func (*Endpoint) SetPort added in v1.5.0 

func (s *Endpoint) SetPort(v int64) *Endpoint

SetPort sets the Port field's value.

func (Endpoint) String added in v0.6.5 

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 added in v0.6.5 

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 added in v1.5.0 

func (s *EngineDefaults) SetCacheNodeTypeSpecificParameters(v []*CacheNodeTypeSpecificParameter) *EngineDefaults

SetCacheNodeTypeSpecificParameters sets the CacheNodeTypeSpecificParameters field's value.

func (*EngineDefaults) SetCacheParameterGroupFamily added in v1.5.0 

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

SetCacheParameterGroupFamily sets the CacheParameterGroupFamily field's value.

func (*EngineDefaults) SetMarker added in v1.5.0 

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

SetMarker sets the Marker field's value.

func (*EngineDefaults) SetParameters added in v1.5.0 

func (s *EngineDefaults) SetParameters(v []*Parameter) *EngineDefaults

SetParameters sets the Parameters field's value.

func (EngineDefaults) String added in v0.6.5 

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 added in v0.6.5 

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 added in v1.5.0 

func (s *Event) SetDate(v time.Time) *Event

SetDate sets the Date field's value.

func (*Event) SetMessage added in v1.5.0 

func (s *Event) SetMessage(v string) *Event

SetMessage sets the Message field's value.

func (*Event) SetSourceIdentifier added in v1.5.0 

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

SetSourceIdentifier sets the SourceIdentifier field's value.

func (*Event) SetSourceType added in v1.5.0 

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

SetSourceType sets the SourceType field's value.

func (Event) String added in v0.6.5 

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 ExportServerlessCacheSnapshotInput added in v1.48.6 

type ExportServerlessCacheSnapshotInput struct {

	// Name of the Amazon S3 bucket to export the snapshot to. The Amazon S3 bucket
	// must also be in same region as the snapshot. Available for Redis only.
	//
	// S3BucketName is a required field
	S3BucketName *string `type:"string" required:"true"`

	// The identifier of the serverless cache snapshot to be exported to S3. Available
	// for Redis only.
	//
	// ServerlessCacheSnapshotName is a required field
	ServerlessCacheSnapshotName *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (ExportServerlessCacheSnapshotInput) GoString added in v1.48.6 

func (s ExportServerlessCacheSnapshotInput) 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 (*ExportServerlessCacheSnapshotInput) SetS3BucketName added in v1.48.6 

func (s *ExportServerlessCacheSnapshotInput) SetS3BucketName(v string) *ExportServerlessCacheSnapshotInput

SetS3BucketName sets the S3BucketName field's value.

func (*ExportServerlessCacheSnapshotInput) SetServerlessCacheSnapshotName added in v1.48.6 

func (s *ExportServerlessCacheSnapshotInput) SetServerlessCacheSnapshotName(v string) *ExportServerlessCacheSnapshotInput

SetServerlessCacheSnapshotName sets the ServerlessCacheSnapshotName field's value.

func (ExportServerlessCacheSnapshotInput) String added in v1.48.6 

func (s ExportServerlessCacheSnapshotInput) 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 (*ExportServerlessCacheSnapshotInput) Validate added in v1.48.6 

func (s *ExportServerlessCacheSnapshotInput) Validate() error

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

type ExportServerlessCacheSnapshotOutput added in v1.48.6 

type ExportServerlessCacheSnapshotOutput struct {

	// The state of a serverless cache at a specific point in time, to the millisecond.
	// Available for Redis only.
	ServerlessCacheSnapshot *ServerlessCacheSnapshot `type:"structure"`
	// contains filtered or unexported fields
}

func (ExportServerlessCacheSnapshotOutput) GoString added in v1.48.6 

func (s ExportServerlessCacheSnapshotOutput) 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 (*ExportServerlessCacheSnapshotOutput) SetServerlessCacheSnapshot added in v1.48.6 

func (s *ExportServerlessCacheSnapshotOutput) SetServerlessCacheSnapshot(v *ServerlessCacheSnapshot) *ExportServerlessCacheSnapshotOutput

SetServerlessCacheSnapshot sets the ServerlessCacheSnapshot field's value.

func (ExportServerlessCacheSnapshotOutput) String added in v1.48.6 

func (s ExportServerlessCacheSnapshotOutput) 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 added in v1.29.25 

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 added in v1.29.25 

func (s FailoverGlobalReplicationGroupInput) 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 (*FailoverGlobalReplicationGroupInput) SetGlobalReplicationGroupId added in v1.29.25 

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

SetGlobalReplicationGroupId sets the GlobalReplicationGroupId field's value.

func (*FailoverGlobalReplicationGroupInput) SetPrimaryRegion added in v1.29.25 

func (s *FailoverGlobalReplicationGroupInput) SetPrimaryRegion(v string) *FailoverGlobalReplicationGroupInput

SetPrimaryRegion sets the PrimaryRegion field's value.

func (*FailoverGlobalReplicationGroupInput) SetPrimaryReplicationGroupId added in v1.29.25 

func (s *FailoverGlobalReplicationGroupInput) SetPrimaryReplicationGroupId(v string) *FailoverGlobalReplicationGroupInput

SetPrimaryReplicationGroupId sets the PrimaryReplicationGroupId field's value.

func (FailoverGlobalReplicationGroupInput) String added in v1.29.25 

func (s FailoverGlobalReplicationGroupInput) 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 (*FailoverGlobalReplicationGroupInput) Validate added in v1.29.25 

func (s *FailoverGlobalReplicationGroupInput) Validate() error

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

type FailoverGlobalReplicationGroupOutput added in v1.29.25 

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 added in v1.29.25 

func (s FailoverGlobalReplicationGroupOutput) 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 (*FailoverGlobalReplicationGroupOutput) SetGlobalReplicationGroup added in v1.29.25 

func (s *FailoverGlobalReplicationGroupOutput) SetGlobalReplicationGroup(v *GlobalReplicationGroup) *FailoverGlobalReplicationGroupOutput

SetGlobalReplicationGroup sets the GlobalReplicationGroup field's value.

func (FailoverGlobalReplicationGroupOutput) String added in v1.29.25 

func (s FailoverGlobalReplicationGroupOutput) 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 Filter added in v1.35.5 

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 added in v1.35.5 

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 added in v1.35.5 

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

SetName sets the Name field's value.

func (*Filter) SetValues added in v1.35.5 

func (s *Filter) SetValues(v []*string) *Filter

SetValues sets the Values field's value.

func (Filter) String added in v1.35.5 

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 added in v1.35.5 

func (s *Filter) Validate() error

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

type GlobalNodeGroup added in v1.29.25 

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 added in v1.29.25 

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 added in v1.29.25 

func (s *GlobalNodeGroup) SetGlobalNodeGroupId(v string) *GlobalNodeGroup

SetGlobalNodeGroupId sets the GlobalNodeGroupId field's value.

func (*GlobalNodeGroup) SetSlots added in v1.29.25 

func (s *GlobalNodeGroup) SetSlots(v string) *GlobalNodeGroup

SetSlots sets the Slots field's value.

func (GlobalNodeGroup) String added in v1.29.25 

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 added in v1.29.25 

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 added in v1.29.25 

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 added in v1.31.5 

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

SetARN sets the ARN field's value.

func (*GlobalReplicationGroup) SetAtRestEncryptionEnabled added in v1.29.25 

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

SetAtRestEncryptionEnabled sets the AtRestEncryptionEnabled field's value.

func (*GlobalReplicationGroup) SetAuthTokenEnabled added in v1.29.25 

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

SetAuthTokenEnabled sets the AuthTokenEnabled field's value.

func (*GlobalReplicationGroup) SetCacheNodeType added in v1.29.25 

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

SetCacheNodeType sets the CacheNodeType field's value.

func (*GlobalReplicationGroup) SetClusterEnabled added in v1.29.25 

func (s *GlobalReplicationGroup) SetClusterEnabled(v bool) *GlobalReplicationGroup

SetClusterEnabled sets the ClusterEnabled field's value.

func (*GlobalReplicationGroup) SetEngine added in v1.29.25 

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

SetEngine sets the Engine field's value.

func (*GlobalReplicationGroup) SetEngineVersion added in v1.29.25 

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

SetEngineVersion sets the EngineVersion field's value.

func (*GlobalReplicationGroup) SetGlobalNodeGroups added in v1.29.25 

func (s *GlobalReplicationGroup) SetGlobalNodeGroups(v []*GlobalNodeGroup) *GlobalReplicationGroup

SetGlobalNodeGroups sets the GlobalNodeGroups field's value.

func (*GlobalReplicationGroup) SetGlobalReplicationGroupDescription added in v1.29.25 

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

SetGlobalReplicationGroupDescription sets the GlobalReplicationGroupDescription field's value.

func (*GlobalReplicationGroup) SetGlobalReplicationGroupId added in v1.29.25 

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

SetGlobalReplicationGroupId sets the GlobalReplicationGroupId field's value.

func (*GlobalReplicationGroup) SetMembers added in v1.29.25 

func (s *GlobalReplicationGroup) SetMembers(v []*GlobalReplicationGroupMember) *GlobalReplicationGroup

SetMembers sets the Members field's value.

func (*GlobalReplicationGroup) SetStatus added in v1.29.25 

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

SetStatus sets the Status field's value.

func (*GlobalReplicationGroup) SetTransitEncryptionEnabled added in v1.29.25 

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

SetTransitEncryptionEnabled sets the TransitEncryptionEnabled field's value.

func (GlobalReplicationGroup) String added in v1.29.25 

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 added in v1.29.25 

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 added in v1.29.25 

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 added in v1.29.25 

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

SetGlobalReplicationGroupId sets the GlobalReplicationGroupId field's value.

func (*GlobalReplicationGroupInfo) SetGlobalReplicationGroupMemberRole added in v1.29.25 

func (s *GlobalReplicationGroupInfo) SetGlobalReplicationGroupMemberRole(v string) *GlobalReplicationGroupInfo

SetGlobalReplicationGroupMemberRole sets the GlobalReplicationGroupMemberRole field's value.

func (GlobalReplicationGroupInfo) String added in v1.29.25 

func (s GlobalReplicationGroupInfo) 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 GlobalReplicationGroupMember added in v1.29.25 

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 added in v1.29.25 

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 added in v1.29.25 

func (s *GlobalReplicationGroupMember) SetAutomaticFailover(v string) *GlobalReplicationGroupMember

SetAutomaticFailover sets the AutomaticFailover field's value.

func (*GlobalReplicationGroupMember) SetReplicationGroupId added in v1.29.25 

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

SetReplicationGroupId sets the ReplicationGroupId field's value.

func (*GlobalReplicationGroupMember) SetReplicationGroupRegion added in v1.29.25 

func (s *GlobalReplicationGroupMember) SetReplicationGroupRegion(v string) *GlobalReplicationGroupMember

SetReplicationGroupRegion sets the ReplicationGroupRegion field's value.

func (*GlobalReplicationGroupMember) SetRole added in v1.29.25 

func (s *GlobalReplicationGroupMember) SetRole(v string) *GlobalReplicationGroupMember

SetRole sets the Role field's value.

func (*GlobalReplicationGroupMember) SetStatus added in v1.29.25 

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

SetStatus sets the Status field's value.

func (GlobalReplicationGroupMember) String added in v1.29.25 

func (s GlobalReplicationGroupMember) 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 IncreaseNodeGroupsInGlobalReplicationGroupInput added in v1.29.25 

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

	// Total number of node groups you want
	//
	// 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 added in v1.29.25 

func (s IncreaseNodeGroupsInGlobalReplicationGroupInput) 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 (*IncreaseNodeGroupsInGlobalReplicationGroupInput) SetApplyImmediately added in v1.29.25 

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

SetApplyImmediately sets the ApplyImmediately field's value.

func (*IncreaseNodeGroupsInGlobalReplicationGroupInput) SetGlobalReplicationGroupId added in v1.29.25 

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

SetGlobalReplicationGroupId sets the GlobalReplicationGroupId field's value.

func (*IncreaseNodeGroupsInGlobalReplicationGroupInput) SetNodeGroupCount added in v1.29.25 

func (s *IncreaseNodeGroupsInGlobalReplicationGroupInput) SetNodeGroupCount(v int64) *IncreaseNodeGroupsInGlobalReplicationGroupInput

SetNodeGroupCount sets the NodeGroupCount field's value.

func (*IncreaseNodeGroupsInGlobalReplicationGroupInput) SetRegionalConfigurations added in v1.29.25 

func (s *IncreaseNodeGroupsInGlobalReplicationGroupInput) SetRegionalConfigurations(v []*RegionalConfiguration) *IncreaseNodeGroupsInGlobalReplicationGroupInput

SetRegionalConfigurations sets the RegionalConfigurations field's value.

func (IncreaseNodeGroupsInGlobalReplicationGroupInput) String added in v1.29.25 

func (s IncreaseNodeGroupsInGlobalReplicationGroupInput) 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 (*IncreaseNodeGroupsInGlobalReplicationGroupInput) Validate added in v1.29.25 

func (s *IncreaseNodeGroupsInGlobalReplicationGroupInput) Validate() error

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

type IncreaseNodeGroupsInGlobalReplicationGroupOutput added in v1.29.25 

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 added in v1.29.25 

func (s IncreaseNodeGroupsInGlobalReplicationGroupOutput) 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 (*IncreaseNodeGroupsInGlobalReplicationGroupOutput) SetGlobalReplicationGroup added in v1.29.25 

func (s *IncreaseNodeGroupsInGlobalReplicationGroupOutput) SetGlobalReplicationGroup(v *GlobalReplicationGroup) *IncreaseNodeGroupsInGlobalReplicationGroupOutput

SetGlobalReplicationGroup sets the GlobalReplicationGroup field's value.

func (IncreaseNodeGroupsInGlobalReplicationGroupOutput) String added in v1.29.25 

func (s IncreaseNodeGroupsInGlobalReplicationGroupOutput) 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 IncreaseReplicaCountInput added in v1.15.29 

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 added in v1.15.29 

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 added in v1.15.29 

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

SetApplyImmediately sets the ApplyImmediately field's value.

func (*IncreaseReplicaCountInput) SetNewReplicaCount added in v1.15.29 

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

SetNewReplicaCount sets the NewReplicaCount field's value.

func (*IncreaseReplicaCountInput) SetReplicaConfiguration added in v1.15.29 

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

SetReplicaConfiguration sets the ReplicaConfiguration field's value.

func (*IncreaseReplicaCountInput) SetReplicationGroupId added in v1.15.29 

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

SetReplicationGroupId sets the ReplicationGroupId field's value.

func (IncreaseReplicaCountInput) String added in v1.15.29 

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 added in v1.15.29 

func (s *IncreaseReplicaCountInput) Validate() error

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

type IncreaseReplicaCountOutput added in v1.15.29 

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 added in v1.15.29 

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 added in v1.15.29 

func (s *IncreaseReplicaCountOutput) SetReplicationGroup(v *ReplicationGroup) *IncreaseReplicaCountOutput

SetReplicationGroup sets the ReplicationGroup field's value.

func (IncreaseReplicaCountOutput) String added in v1.15.29 

func (s IncreaseReplicaCountOutput) 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 KinesisFirehoseDestinationDetails added in v1.38.24 

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 added in v1.38.24 

func (s KinesisFirehoseDestinationDetails) 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 (*KinesisFirehoseDestinationDetails) SetDeliveryStream added in v1.38.24 

func (s *KinesisFirehoseDestinationDetails) SetDeliveryStream(v string) *KinesisFirehoseDestinationDetails

SetDeliveryStream sets the DeliveryStream field's value.

func (KinesisFirehoseDestinationDetails) String added in v1.38.24 

func (s KinesisFirehoseDestinationDetails) 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 ListAllowedNodeTypeModificationsInput added in v1.1.14 

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 added in v1.1.14 

func (s ListAllowedNodeTypeModificationsInput) 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 (*ListAllowedNodeTypeModificationsInput) SetCacheClusterId added in v1.5.0 

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

SetCacheClusterId sets the CacheClusterId field's value.

func (*ListAllowedNodeTypeModificationsInput) SetReplicationGroupId added in v1.5.0 

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

SetReplicationGroupId sets the ReplicationGroupId field's value.

func (ListAllowedNodeTypeModificationsInput) String added in v1.1.14 

func (s ListAllowedNodeTypeModificationsInput) 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 ListAllowedNodeTypeModificationsOutput added in v1.1.14 

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 added in v1.1.14 

func (s ListAllowedNodeTypeModificationsOutput) 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 (*ListAllowedNodeTypeModificationsOutput) SetScaleDownModifications added in v1.23.6 

func (s *ListAllowedNodeTypeModificationsOutput) SetScaleDownModifications(v []*string) *ListAllowedNodeTypeModificationsOutput

SetScaleDownModifications sets the ScaleDownModifications field's value.

func (*ListAllowedNodeTypeModificationsOutput) SetScaleUpModifications added in v1.5.0 

func (s *ListAllowedNodeTypeModificationsOutput) SetScaleUpModifications(v []*string) *ListAllowedNodeTypeModificationsOutput

SetScaleUpModifications sets the ScaleUpModifications field's value.

func (ListAllowedNodeTypeModificationsOutput) String added in v1.1.14 

func (s ListAllowedNodeTypeModificationsOutput) 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 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 added in v0.6.5 

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 added in v1.5.0 

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

SetResourceName sets the ResourceName field's value.

func (ListTagsForResourceInput) String added in v0.6.5 

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 added in v1.1.21 

func (s *ListTagsForResourceInput) Validate() error

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

type LogDeliveryConfiguration added in v1.38.24 

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 added in v1.38.24 

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 added in v1.38.24 

func (s *LogDeliveryConfiguration) SetDestinationDetails(v *DestinationDetails) *LogDeliveryConfiguration

SetDestinationDetails sets the DestinationDetails field's value.

func (*LogDeliveryConfiguration) SetDestinationType added in v1.38.24 

func (s *LogDeliveryConfiguration) SetDestinationType(v string) *LogDeliveryConfiguration

SetDestinationType sets the DestinationType field's value.

func (*LogDeliveryConfiguration) SetLogFormat added in v1.38.24 

func (s *LogDeliveryConfiguration) SetLogFormat(v string) *LogDeliveryConfiguration

SetLogFormat sets the LogFormat field's value.

func (*LogDeliveryConfiguration) SetLogType added in v1.38.24 

func (s *LogDeliveryConfiguration) SetLogType(v string) *LogDeliveryConfiguration

SetLogType sets the LogType field's value.

func (*LogDeliveryConfiguration) SetMessage added in v1.38.24 

func (s *LogDeliveryConfiguration) SetMessage(v string) *LogDeliveryConfiguration

SetMessage sets the Message field's value.

func (*LogDeliveryConfiguration) SetStatus added in v1.38.24 

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

SetStatus sets the Status field's value.

func (LogDeliveryConfiguration) String added in v1.38.24 

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 added in v1.38.24 

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 added in v1.38.24 

func (s LogDeliveryConfigurationRequest) 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 (*LogDeliveryConfigurationRequest) SetDestinationDetails added in v1.38.24 

func (s *LogDeliveryConfigurationRequest) SetDestinationDetails(v *DestinationDetails) *LogDeliveryConfigurationRequest

SetDestinationDetails sets the DestinationDetails field's value.

func (*LogDeliveryConfigurationRequest) SetDestinationType added in v1.38.24 

func (s *LogDeliveryConfigurationRequest) SetDestinationType(v string) *LogDeliveryConfigurationRequest

SetDestinationType sets the DestinationType field's value.

func (*LogDeliveryConfigurationRequest) SetEnabled added in v1.38.24 

func (s *LogDeliveryConfigurationRequest) SetEnabled(v bool) *LogDeliveryConfigurationRequest

SetEnabled sets the Enabled field's value.

func (*LogDeliveryConfigurationRequest) SetLogFormat added in v1.38.24 

func (s *LogDeliveryConfigurationRequest) SetLogFormat(v string) *LogDeliveryConfigurationRequest

SetLogFormat sets the LogFormat field's value.

func (*LogDeliveryConfigurationRequest) SetLogType added in v1.38.24 

func (s *LogDeliveryConfigurationRequest) SetLogType(v string) *LogDeliveryConfigurationRequest

SetLogType sets the LogType field's value.

func (LogDeliveryConfigurationRequest) String added in v1.38.24 

func (s LogDeliveryConfigurationRequest) 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 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 - default, if no update strategy is provided
	//
	//    * SET - allowed only after ROTATE
	//
	//    * DELETE - allowed only when transitioning to RBAC
	//
	// 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 added in v0.6.5 

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 added in v1.5.0 

func (s *ModifyCacheClusterInput) SetAZMode(v string) *ModifyCacheClusterInput

SetAZMode sets the AZMode field's value.

func (*ModifyCacheClusterInput) SetApplyImmediately added in v1.5.0 

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

SetApplyImmediately sets the ApplyImmediately field's value.

func (*ModifyCacheClusterInput) SetAuthToken added in v1.25.23 

func (s *ModifyCacheClusterInput) SetAuthToken(v string) *ModifyCacheClusterInput

SetAuthToken sets the AuthToken field's value.

func (*ModifyCacheClusterInput) SetAuthTokenUpdateStrategy added in v1.25.23 

func (s *ModifyCacheClusterInput) SetAuthTokenUpdateStrategy(v string) *ModifyCacheClusterInput

SetAuthTokenUpdateStrategy sets the AuthTokenUpdateStrategy field's value.

func (*ModifyCacheClusterInput) SetAutoMinorVersionUpgrade added in v1.5.0 

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

SetAutoMinorVersionUpgrade sets the AutoMinorVersionUpgrade field's value.

func (*ModifyCacheClusterInput) SetCacheClusterId added in v1.5.0 

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

SetCacheClusterId sets the CacheClusterId field's value.

func (*ModifyCacheClusterInput) SetCacheNodeIdsToRemove added in v1.5.0 

func (s *ModifyCacheClusterInput) SetCacheNodeIdsToRemove(v []*string) *ModifyCacheClusterInput

SetCacheNodeIdsToRemove sets the CacheNodeIdsToRemove field's value.

func (*ModifyCacheClusterInput) SetCacheNodeType added in v1.5.0 

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

SetCacheNodeType sets the CacheNodeType field's value.

func (*ModifyCacheClusterInput) SetCacheParameterGroupName added in v1.5.0 

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

SetCacheParameterGroupName sets the CacheParameterGroupName field's value.

func (*ModifyCacheClusterInput) SetCacheSecurityGroupNames added in v1.5.0 

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

SetCacheSecurityGroupNames sets the CacheSecurityGroupNames field's value.

func (*ModifyCacheClusterInput) SetEngineVersion added in v1.5.0 

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

SetEngineVersion sets the EngineVersion field's value.

func (*ModifyCacheClusterInput) SetIpDiscovery added in v1.44.132 

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

SetIpDiscovery sets the IpDiscovery field's value.

func (*ModifyCacheClusterInput) SetLogDeliveryConfigurations added in v1.38.24 

func (s *ModifyCacheClusterInput) SetLogDeliveryConfigurations(v []*LogDeliveryConfigurationRequest) *ModifyCacheClusterInput

SetLogDeliveryConfigurations sets the LogDeliveryConfigurations field's value.

func (*ModifyCacheClusterInput) SetNewAvailabilityZones added in v1.5.0 

func (s *ModifyCacheClusterInput) SetNewAvailabilityZones(v []*string) *ModifyCacheClusterInput

SetNewAvailabilityZones sets the NewAvailabilityZones field's value.

func (*ModifyCacheClusterInput) SetNotificationTopicArn added in v1.5.0 

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

SetNotificationTopicArn sets the NotificationTopicArn field's value.

func (*ModifyCacheClusterInput) SetNotificationTopicStatus added in v1.5.0 

func (s *ModifyCacheClusterInput) SetNotificationTopicStatus(v string) *ModifyCacheClusterInput

SetNotificationTopicStatus sets the NotificationTopicStatus field's value.

func (*ModifyCacheClusterInput) SetNumCacheNodes added in v1.5.0 

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

SetNumCacheNodes sets the NumCacheNodes field's value.

func (*ModifyCacheClusterInput) SetPreferredMaintenanceWindow added in v1.5.0 

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

SetPreferredMaintenanceWindow sets the PreferredMaintenanceWindow field's value.

func (*ModifyCacheClusterInput) SetSecurityGroupIds added in v1.5.0 

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

SetSecurityGroupIds sets the SecurityGroupIds field's value.

func (*ModifyCacheClusterInput) SetSnapshotRetentionLimit added in v1.5.0 

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

SetSnapshotRetentionLimit sets the SnapshotRetentionLimit field's value.

func (*ModifyCacheClusterInput) SetSnapshotWindow added in v1.5.0 

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

SetSnapshotWindow sets the SnapshotWindow field's value.

func (ModifyCacheClusterInput) String added in v0.6.5 

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 added in v1.1.21 

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 added in v0.6.5 

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 added in v1.5.0 

func (s *ModifyCacheClusterOutput) SetCacheCluster(v *CacheCluster) *ModifyCacheClusterOutput

SetCacheCluster sets the CacheCluster field's value.

func (ModifyCacheClusterOutput) String added in v0.6.5 

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 added in v0.6.5 

func (s ModifyCacheParameterGroupInput) 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 (*ModifyCacheParameterGroupInput) SetCacheParameterGroupName added in v1.5.0 

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

SetCacheParameterGroupName sets the CacheParameterGroupName field's value.

func (*ModifyCacheParameterGroupInput) SetParameterNameValues added in v1.5.0 

func (s *ModifyCacheParameterGroupInput) SetParameterNameValues(v []*ParameterNameValue) *ModifyCacheParameterGroupInput

SetParameterNameValues sets the ParameterNameValues field's value.

func (ModifyCacheParameterGroupInput) String added in v0.6.5 

func (s ModifyCacheParameterGroupInput) 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 (*ModifyCacheParameterGroupInput) Validate added in v1.1.21 

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 added in v0.6.5 

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 added in v1.5.0 

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

SetCacheSubnetGroupDescription sets the CacheSubnetGroupDescription field's value.

func (*ModifyCacheSubnetGroupInput) SetCacheSubnetGroupName added in v1.5.0 

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

SetCacheSubnetGroupName sets the CacheSubnetGroupName field's value.

func (*ModifyCacheSubnetGroupInput) SetSubnetIds added in v1.5.0 

func (s *ModifyCacheSubnetGroupInput) SetSubnetIds(v []*string) *ModifyCacheSubnetGroupInput

SetSubnetIds sets the SubnetIds field's value.

func (ModifyCacheSubnetGroupInput) String added in v0.6.5 

func (s ModifyCacheSubnetGroupInput) 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 (*ModifyCacheSubnetGroupInput) Validate added in v1.1.21 

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 added in v0.6.5 

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 added in v1.5.0 

func (s *ModifyCacheSubnetGroupOutput) SetCacheSubnetGroup(v *CacheSubnetGroup) *ModifyCacheSubnetGroupOutput

SetCacheSubnetGroup sets the CacheSubnetGroup field's value.

func (ModifyCacheSubnetGroupOutput) String added in v0.6.5 

func (s ModifyCacheSubnetGroupOutput) 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 ModifyGlobalReplicationGroupInput added in v1.29.25 

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 added in v1.29.25 

func (s ModifyGlobalReplicationGroupInput) 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 (*ModifyGlobalReplicationGroupInput) SetApplyImmediately added in v1.29.25 

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

SetApplyImmediately sets the ApplyImmediately field's value.

func (*ModifyGlobalReplicationGroupInput) SetAutomaticFailoverEnabled added in v1.29.25 

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

SetAutomaticFailoverEnabled sets the AutomaticFailoverEnabled field's value.

func (*ModifyGlobalReplicationGroupInput) SetCacheNodeType added in v1.29.25 

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

SetCacheNodeType sets the CacheNodeType field's value.

func (*ModifyGlobalReplicationGroupInput) SetCacheParameterGroupName added in v1.36.33 

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

SetCacheParameterGroupName sets the CacheParameterGroupName field's value.

func (*ModifyGlobalReplicationGroupInput) SetEngineVersion added in v1.29.25 

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

SetEngineVersion sets the EngineVersion field's value.

func (*ModifyGlobalReplicationGroupInput) SetGlobalReplicationGroupDescription added in v1.29.25 

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

SetGlobalReplicationGroupDescription sets the GlobalReplicationGroupDescription field's value.

func (*ModifyGlobalReplicationGroupInput) SetGlobalReplicationGroupId added in v1.29.25 

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

SetGlobalReplicationGroupId sets the GlobalReplicationGroupId field's value.

func (ModifyGlobalReplicationGroupInput) String added in v1.29.25 

func (s ModifyGlobalReplicationGroupInput) 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 (*ModifyGlobalReplicationGroupInput) Validate added in v1.29.25 

func (s *ModifyGlobalReplicationGroupInput) Validate() error

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

type ModifyGlobalReplicationGroupOutput added in v1.29.25 

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 added in v1.29.25 

func (s ModifyGlobalReplicationGroupOutput) 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 (*ModifyGlobalReplicationGroupOutput) SetGlobalReplicationGroup added in v1.29.25 

func (s *ModifyGlobalReplicationGroupOutput) SetGlobalReplicationGroup(v *GlobalReplicationGroup) *ModifyGlobalReplicationGroupOutput

SetGlobalReplicationGroup sets the GlobalReplicationGroup field's value.

func (ModifyGlobalReplicationGroupOutput) String added in v1.29.25 

func (s ModifyGlobalReplicationGroupOutput) 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 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 - default, if no update strategy is provided
	//
	//    * SET - allowed only after ROTATE
	//
	//    * DELETE - allowed only when transitioning to RBAC
	//
	// 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 added in v0.6.5 

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 added in v1.5.0 

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

SetApplyImmediately sets the ApplyImmediately field's value.

func (*ModifyReplicationGroupInput) SetAuthToken added in v1.25.23 

func (s *ModifyReplicationGroupInput) SetAuthToken(v string) *ModifyReplicationGroupInput

SetAuthToken sets the AuthToken field's value.

func (*ModifyReplicationGroupInput) SetAuthTokenUpdateStrategy added in v1.25.23 

func (s *ModifyReplicationGroupInput) SetAuthTokenUpdateStrategy(v string) *ModifyReplicationGroupInput

SetAuthTokenUpdateStrategy sets the AuthTokenUpdateStrategy field's value.

func (*ModifyReplicationGroupInput) SetAutoMinorVersionUpgrade added in v1.5.0 

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

SetAutoMinorVersionUpgrade sets the AutoMinorVersionUpgrade field's value.

func (*ModifyReplicationGroupInput) SetAutomaticFailoverEnabled added in v1.5.0 

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

SetAutomaticFailoverEnabled sets the AutomaticFailoverEnabled field's value.

func (*ModifyReplicationGroupInput) SetCacheNodeType added in v1.5.0 

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

SetCacheNodeType sets the CacheNodeType field's value.

func (*ModifyReplicationGroupInput) SetCacheParameterGroupName added in v1.5.0 

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

SetCacheParameterGroupName sets the CacheParameterGroupName field's value.

func (*ModifyReplicationGroupInput) SetCacheSecurityGroupNames added in v1.5.0 

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

SetCacheSecurityGroupNames sets the CacheSecurityGroupNames field's value.

func (*ModifyReplicationGroupInput) SetClusterMode added in v1.44.262 

func (s *ModifyReplicationGroupInput) SetClusterMode(v string) *ModifyReplicationGroupInput

SetClusterMode sets the ClusterMode field's value.

func (*ModifyReplicationGroupInput) SetEngineVersion added in v1.5.0 

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

SetEngineVersion sets the EngineVersion field's value.

func (*ModifyReplicationGroupInput) SetIpDiscovery added in v1.44.132 

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

SetIpDiscovery sets the IpDiscovery field's value.

func (*ModifyReplicationGroupInput) SetLogDeliveryConfigurations added in v1.38.24 

func (s *ModifyReplicationGroupInput) SetLogDeliveryConfigurations(v []*LogDeliveryConfigurationRequest) *ModifyReplicationGroupInput

SetLogDeliveryConfigurations sets the LogDeliveryConfigurations field's value.

func (*ModifyReplicationGroupInput) SetMultiAZEnabled added in v1.31.10 

func (s *ModifyReplicationGroupInput) SetMultiAZEnabled(v bool) *ModifyReplicationGroupInput

SetMultiAZEnabled sets the MultiAZEnabled field's value.

func (*ModifyReplicationGroupInput) SetNodeGroupId added in v1.8.9 

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

SetNodeGroupId sets the NodeGroupId field's value.

func (*ModifyReplicationGroupInput) SetNotificationTopicArn added in v1.5.0 

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

SetNotificationTopicArn sets the NotificationTopicArn field's value.

func (*ModifyReplicationGroupInput) SetNotificationTopicStatus added in v1.5.0 

func (s *ModifyReplicationGroupInput) SetNotificationTopicStatus(v string) *ModifyReplicationGroupInput

SetNotificationTopicStatus sets the NotificationTopicStatus field's value.

func (*ModifyReplicationGroupInput) SetPreferredMaintenanceWindow added in v1.5.0 

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

SetPreferredMaintenanceWindow sets the PreferredMaintenanceWindow field's value.

func (*ModifyReplicationGroupInput) SetPrimaryClusterId added in v1.5.0 

func (s *ModifyReplicationGroupInput) SetPrimaryClusterId(v string) *ModifyReplicationGroupInput

SetPrimaryClusterId sets the PrimaryClusterId field's value.

func (*ModifyReplicationGroupInput) SetRemoveUserGroups added in v1.35.5 

func (s *ModifyReplicationGroupInput) SetRemoveUserGroups(v bool) *ModifyReplicationGroupInput

SetRemoveUserGroups sets the RemoveUserGroups field's value.

func (*ModifyReplicationGroupInput) SetReplicationGroupDescription added in v1.5.0 

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

SetReplicationGroupDescription sets the ReplicationGroupDescription field's value.

func (*ModifyReplicationGroupInput) SetReplicationGroupId added in v1.5.0 

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

SetReplicationGroupId sets the ReplicationGroupId field's value.

func (*ModifyReplicationGroupInput) SetSecurityGroupIds added in v1.5.0 

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

SetSecurityGroupIds sets the SecurityGroupIds field's value.

func (*ModifyReplicationGroupInput) SetSnapshotRetentionLimit added in v1.5.0 

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

SetSnapshotRetentionLimit sets the SnapshotRetentionLimit field's value.

func (*ModifyReplicationGroupInput) SetSnapshotWindow added in v1.5.0 

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

SetSnapshotWindow sets the SnapshotWindow field's value.

func (*ModifyReplicationGroupInput) SetSnapshottingClusterId added in v1.5.0 

func (s *ModifyReplicationGroupInput) SetSnapshottingClusterId(v string) *ModifyReplicationGroupInput

SetSnapshottingClusterId sets the SnapshottingClusterId field's value.

func (*ModifyReplicationGroupInput) SetTransitEncryptionEnabled added in v1.44.169 

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

SetTransitEncryptionEnabled sets the TransitEncryptionEnabled field's value.

func (*ModifyReplicationGroupInput) SetTransitEncryptionMode added in v1.44.169 

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

SetTransitEncryptionMode sets the TransitEncryptionMode field's value.

func (*ModifyReplicationGroupInput) SetUserGroupIdsToAdd added in v1.35.5 

func (s *ModifyReplicationGroupInput) SetUserGroupIdsToAdd(v []*string) *ModifyReplicationGroupInput

SetUserGroupIdsToAdd sets the UserGroupIdsToAdd field's value.

func (*ModifyReplicationGroupInput) SetUserGroupIdsToRemove added in v1.35.5 

func (s *ModifyReplicationGroupInput) SetUserGroupIdsToRemove(v []*string) *ModifyReplicationGroupInput

SetUserGroupIdsToRemove sets the UserGroupIdsToRemove field's value.

func (ModifyReplicationGroupInput) String added in v0.6.5 

func (s ModifyReplicationGroupInput) 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 (*ModifyReplicationGroupInput) Validate added in v1.1.21 

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 added in v0.6.5 

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 added in v1.5.0 

func (s *ModifyReplicationGroupOutput) SetReplicationGroup(v *ReplicationGroup) *ModifyReplicationGroupOutput

SetReplicationGroup sets the ReplicationGroup field's value.

func (ModifyReplicationGroupOutput) String added in v0.6.5 

func (s ModifyReplicationGroupOutput) 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 ModifyReplicationGroupShardConfigurationInput added in v1.12.25 

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 added in v1.12.25 

func (s ModifyReplicationGroupShardConfigurationInput) 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 (*ModifyReplicationGroupShardConfigurationInput) SetApplyImmediately added in v1.12.25 

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

SetApplyImmediately sets the ApplyImmediately field's value.

func (*ModifyReplicationGroupShardConfigurationInput) SetNodeGroupCount added in v1.12.25 

func (s *ModifyReplicationGroupShardConfigurationInput) SetNodeGroupCount(v int64) *ModifyReplicationGroupShardConfigurationInput

SetNodeGroupCount sets the NodeGroupCount field's value.

func (*ModifyReplicationGroupShardConfigurationInput) SetNodeGroupsToRemove added in v1.12.25 

func (s *ModifyReplicationGroupShardConfigurationInput) SetNodeGroupsToRemove(v []*string) *ModifyReplicationGroupShardConfigurationInput

SetNodeGroupsToRemove sets the NodeGroupsToRemove field's value.

func (*ModifyReplicationGroupShardConfigurationInput) SetNodeGroupsToRetain added in v1.15.29 

func (s *ModifyReplicationGroupShardConfigurationInput) SetNodeGroupsToRetain(v []*string) *ModifyReplicationGroupShardConfigurationInput

SetNodeGroupsToRetain sets the NodeGroupsToRetain field's value.

func (*ModifyReplicationGroupShardConfigurationInput) SetReplicationGroupId added in v1.12.25 

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

SetReplicationGroupId sets the ReplicationGroupId field's value.

func (*ModifyReplicationGroupShardConfigurationInput) SetReshardingConfiguration added in v1.12.25 

func (s *ModifyReplicationGroupShardConfigurationInput) SetReshardingConfiguration(v []*ReshardingConfiguration) *ModifyReplicationGroupShardConfigurationInput

SetReshardingConfiguration sets the ReshardingConfiguration field's value.

func (ModifyReplicationGroupShardConfigurationInput) String added in v1.12.25 

func (s ModifyReplicationGroupShardConfigurationInput) 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 (*ModifyReplicationGroupShardConfigurationInput) Validate added in v1.12.25 

func (s *ModifyReplicationGroupShardConfigurationInput) Validate() error

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

type ModifyReplicationGroupShardConfigurationOutput added in v1.12.25 

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 added in v1.12.25 

func (s ModifyReplicationGroupShardConfigurationOutput) 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 (*ModifyReplicationGroupShardConfigurationOutput) SetReplicationGroup added in v1.12.25 

func (s *ModifyReplicationGroupShardConfigurationOutput) SetReplicationGroup(v *ReplicationGroup) *ModifyReplicationGroupShardConfigurationOutput

SetReplicationGroup sets the ReplicationGroup field's value.

func (ModifyReplicationGroupShardConfigurationOutput) String added in v1.12.25 

func (s ModifyReplicationGroupShardConfigurationOutput) 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 ModifyServerlessCacheInput added in v1.48.6 

type ModifyServerlessCacheInput struct {

	// Modify the cache usage limit for the serverless cache.
	CacheUsageLimits *CacheUsageLimits `type:"structure"`

	// The daily time during which Elasticache begins taking a daily snapshot of
	// the serverless cache. Available for Redis only. The default is NULL, i.e.
	// the existing snapshot time configured for the cluster is not removed.
	DailySnapshotTime *string `type:"string"`

	// User provided description for the serverless cache. Default = NULL, i.e.
	// the existing description is not removed/modified. The description has a maximum
	// length of 255 characters.
	Description *string `type:"string"`

	// The identifier of the UserGroup to be removed from association with the Redis
	// serverless cache. Available for Redis only. Default is NULL.
	RemoveUserGroup *bool `type:"boolean"`

	// The new list of VPC security groups to be associated with the serverless
	// cache. Populating this list means the current VPC security groups will be
	// removed. This security group is used to authorize traffic access for the
	// VPC end-point (private-link). Default = NULL - the existing list of VPC security
	// groups is not removed.
	SecurityGroupIds []*string `locationNameList:"SecurityGroupId" type:"list"`

	// User-provided identifier for the serverless cache to be modified.
	//
	// ServerlessCacheName is a required field
	ServerlessCacheName *string `type:"string" required:"true"`

	// The number of days for which Elasticache retains automatic snapshots before
	// deleting them. Available for Redis only. Default = NULL, i.e. the existing
	// snapshot-retention-limit will not be removed or modified. The maximum value
	// allowed is 35 days.
	SnapshotRetentionLimit *int64 `type:"integer"`

	// The identifier of the UserGroup to be associated with the serverless cache.
	// Available for Redis only. Default is NULL - the existing UserGroup is not
	// removed.
	UserGroupId *string `type:"string"`
	// contains filtered or unexported fields
}

func (ModifyServerlessCacheInput) GoString added in v1.48.6 

func (s ModifyServerlessCacheInput) 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 (*ModifyServerlessCacheInput) SetCacheUsageLimits added in v1.48.6 

func (s *ModifyServerlessCacheInput) SetCacheUsageLimits(v *CacheUsageLimits) *ModifyServerlessCacheInput

SetCacheUsageLimits sets the CacheUsageLimits field's value.

func (*ModifyServerlessCacheInput) SetDailySnapshotTime added in v1.48.6 

func (s *ModifyServerlessCacheInput) SetDailySnapshotTime(v string) *ModifyServerlessCacheInput

SetDailySnapshotTime sets the DailySnapshotTime field's value.

func (*ModifyServerlessCacheInput) SetDescription added in v1.48.6 

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

SetDescription sets the Description field's value.

func (*ModifyServerlessCacheInput) SetRemoveUserGroup added in v1.48.6 

func (s *ModifyServerlessCacheInput) SetRemoveUserGroup(v bool) *ModifyServerlessCacheInput

SetRemoveUserGroup sets the RemoveUserGroup field's value.

func (*ModifyServerlessCacheInput) SetSecurityGroupIds added in v1.48.6 

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

SetSecurityGroupIds sets the SecurityGroupIds field's value.

func (*ModifyServerlessCacheInput) SetServerlessCacheName added in v1.48.6 

func (s *ModifyServerlessCacheInput) SetServerlessCacheName(v string) *ModifyServerlessCacheInput

SetServerlessCacheName sets the ServerlessCacheName field's value.

func (*ModifyServerlessCacheInput) SetSnapshotRetentionLimit added in v1.48.6 

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

SetSnapshotRetentionLimit sets the SnapshotRetentionLimit field's value.

func (*ModifyServerlessCacheInput) SetUserGroupId added in v1.48.6 

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

SetUserGroupId sets the UserGroupId field's value.

func (ModifyServerlessCacheInput) String added in v1.48.6 

func (s ModifyServerlessCacheInput) 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 (*ModifyServerlessCacheInput) Validate added in v1.48.6 

func (s *ModifyServerlessCacheInput) Validate() error

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

type ModifyServerlessCacheOutput added in v1.48.6 

type ModifyServerlessCacheOutput struct {

	// The response for the attempt to modify the serverless cache.
	ServerlessCache *ServerlessCache `type:"structure"`
	// contains filtered or unexported fields
}

func (ModifyServerlessCacheOutput) GoString added in v1.48.6 

func (s ModifyServerlessCacheOutput) 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 (*ModifyServerlessCacheOutput) SetServerlessCache added in v1.48.6 

func (s *ModifyServerlessCacheOutput) SetServerlessCache(v *ServerlessCache) *ModifyServerlessCacheOutput

SetServerlessCache sets the ServerlessCache field's value.

func (ModifyServerlessCacheOutput) String added in v1.48.6 

func (s ModifyServerlessCacheOutput) 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 ModifyUserGroupInput added in v1.35.5 

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 added in v1.35.5 

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 added in v1.35.5 

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

SetUserGroupId sets the UserGroupId field's value.

func (*ModifyUserGroupInput) SetUserIdsToAdd added in v1.35.5 

func (s *ModifyUserGroupInput) SetUserIdsToAdd(v []*string) *ModifyUserGroupInput

SetUserIdsToAdd sets the UserIdsToAdd field's value.

func (*ModifyUserGroupInput) SetUserIdsToRemove added in v1.35.5 

func (s *ModifyUserGroupInput) SetUserIdsToRemove(v []*string) *ModifyUserGroupInput

SetUserIdsToRemove sets the UserIdsToRemove field's value.

func (ModifyUserGroupInput) String added in v1.35.5 

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 added in v1.35.5 

func (s *ModifyUserGroupInput) Validate() error

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

type ModifyUserGroupOutput added in v1.35.5 

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 which serverless caches the specified user group is associated
	// with. Available for Redis only.
	ServerlessCaches []*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 added in v1.35.5 

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 added in v1.35.5 

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

SetARN sets the ARN field's value.

func (*ModifyUserGroupOutput) SetEngine added in v1.35.5 

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

SetEngine sets the Engine field's value.

func (*ModifyUserGroupOutput) SetMinimumEngineVersion added in v1.42.11 

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

SetMinimumEngineVersion sets the MinimumEngineVersion field's value.

func (*ModifyUserGroupOutput) SetPendingChanges added in v1.35.5 

func (s *ModifyUserGroupOutput) SetPendingChanges(v *UserGroupPendingChanges) *ModifyUserGroupOutput

SetPendingChanges sets the PendingChanges field's value.

func (*ModifyUserGroupOutput) SetReplicationGroups added in v1.35.5 

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

SetReplicationGroups sets the ReplicationGroups field's value.

func (*ModifyUserGroupOutput) SetServerlessCaches added in v1.48.6 

func (s *ModifyUserGroupOutput) SetServerlessCaches(v []*string) *ModifyUserGroupOutput

SetServerlessCaches sets the ServerlessCaches field's value.

func (*ModifyUserGroupOutput) SetStatus added in v1.35.5 

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

SetStatus sets the Status field's value.

func (*ModifyUserGroupOutput) SetUserGroupId added in v1.35.5 

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

SetUserGroupId sets the UserGroupId field's value.

func (*ModifyUserGroupOutput) SetUserIds added in v1.35.5 

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

SetUserIds sets the UserIds field's value.

func (ModifyUserGroupOutput) String added in v1.35.5 

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 added in v1.35.5 

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 added in v1.35.5 

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 added in v1.35.5 

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

SetAccessString sets the AccessString field's value.

func (*ModifyUserInput) SetAppendAccessString added in v1.35.5 

func (s *ModifyUserInput) SetAppendAccessString(v string) *ModifyUserInput

SetAppendAccessString sets the AppendAccessString field's value.

func (*ModifyUserInput) SetAuthenticationMode added in v1.44.139 

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

SetAuthenticationMode sets the AuthenticationMode field's value.

func (*ModifyUserInput) SetNoPasswordRequired added in v1.35.5 

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

SetNoPasswordRequired sets the NoPasswordRequired field's value.

func (*ModifyUserInput) SetPasswords added in v1.35.5 

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

SetPasswords sets the Passwords field's value.

func (*ModifyUserInput) SetUserId added in v1.35.5 

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

SetUserId sets the UserId field's value.

func (ModifyUserInput) String added in v1.35.5 

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 added in v1.35.5 

func (s *ModifyUserInput) Validate() error

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

type ModifyUserOutput added in v1.35.5 

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 added in v1.35.5 

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 added in v1.35.5 

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

SetARN sets the ARN field's value.

func (*ModifyUserOutput) SetAccessString added in v1.35.5 

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

SetAccessString sets the AccessString field's value.

func (*ModifyUserOutput) SetAuthentication added in v1.35.5 

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

SetAuthentication sets the Authentication field's value.

func (*ModifyUserOutput) SetEngine added in v1.35.5 

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

SetEngine sets the Engine field's value.

func (*ModifyUserOutput) SetMinimumEngineVersion added in v1.42.11 

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

SetMinimumEngineVersion sets the MinimumEngineVersion field's value.

func (*ModifyUserOutput) SetStatus added in v1.35.5 

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

SetStatus sets the Status field's value.

func (*ModifyUserOutput) SetUserGroupIds added in v1.35.5 

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

SetUserGroupIds sets the UserGroupIds field's value.

func (*ModifyUserOutput) SetUserId added in v1.35.5 

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

SetUserId sets the UserId field's value.

func (*ModifyUserOutput) SetUserName added in v1.35.5 

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

SetUserName sets the UserName field's value.

func (ModifyUserOutput) String added in v1.35.5 

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). This value
	// is read-only.
	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 added in v0.6.5 

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 added in v1.5.0 

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

SetNodeGroupId sets the NodeGroupId field's value.

func (*NodeGroup) SetNodeGroupMembers added in v1.5.0 

func (s *NodeGroup) SetNodeGroupMembers(v []*NodeGroupMember) *NodeGroup

SetNodeGroupMembers sets the NodeGroupMembers field's value.

func (*NodeGroup) SetPrimaryEndpoint added in v1.5.0 

func (s *NodeGroup) SetPrimaryEndpoint(v *Endpoint) *NodeGroup

SetPrimaryEndpoint sets the PrimaryEndpoint field's value.

func (*NodeGroup) SetReaderEndpoint added in v1.20.0 

func (s *NodeGroup) SetReaderEndpoint(v *Endpoint) *NodeGroup

SetReaderEndpoint sets the ReaderEndpoint field's value.

func (*NodeGroup) SetSlots added in v1.5.0 

func (s *NodeGroup) SetSlots(v string) *NodeGroup

SetSlots sets the Slots field's value.

func (*NodeGroup) SetStatus added in v1.5.0 

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

SetStatus sets the Status field's value.

func (NodeGroup) String added in v0.6.5 

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 added in v1.4.16 

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 added in v1.4.16 

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 added in v1.15.29 

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

SetNodeGroupId sets the NodeGroupId field's value.

func (*NodeGroupConfiguration) SetPrimaryAvailabilityZone added in v1.5.0 

func (s *NodeGroupConfiguration) SetPrimaryAvailabilityZone(v string) *NodeGroupConfiguration

SetPrimaryAvailabilityZone sets the PrimaryAvailabilityZone field's value.

func (*NodeGroupConfiguration) SetPrimaryOutpostArn added in v1.35.5 

func (s *NodeGroupConfiguration) SetPrimaryOutpostArn(v string) *NodeGroupConfiguration

SetPrimaryOutpostArn sets the PrimaryOutpostArn field's value.

func (*NodeGroupConfiguration) SetReplicaAvailabilityZones added in v1.5.0 

func (s *NodeGroupConfiguration) SetReplicaAvailabilityZones(v []*string) *NodeGroupConfiguration

SetReplicaAvailabilityZones sets the ReplicaAvailabilityZones field's value.

func (*NodeGroupConfiguration) SetReplicaCount added in v1.5.0 

func (s *NodeGroupConfiguration) SetReplicaCount(v int64) *NodeGroupConfiguration

SetReplicaCount sets the ReplicaCount field's value.

func (*NodeGroupConfiguration) SetReplicaOutpostArns added in v1.35.5 

func (s *NodeGroupConfiguration) SetReplicaOutpostArns(v []*string) *NodeGroupConfiguration

SetReplicaOutpostArns sets the ReplicaOutpostArns field's value.

func (*NodeGroupConfiguration) SetSlots added in v1.5.0 

func (s *NodeGroupConfiguration) SetSlots(v string) *NodeGroupConfiguration

SetSlots sets the Slots field's value.

func (NodeGroupConfiguration) String added in v1.4.16 

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 added in v1.15.29 

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 added in v0.6.5 

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 added in v1.5.0 

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

SetCacheClusterId sets the CacheClusterId field's value.

func (*NodeGroupMember) SetCacheNodeId added in v1.5.0 

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

SetCacheNodeId sets the CacheNodeId field's value.

func (*NodeGroupMember) SetCurrentRole added in v1.5.0 

func (s *NodeGroupMember) SetCurrentRole(v string) *NodeGroupMember

SetCurrentRole sets the CurrentRole field's value.

func (*NodeGroupMember) SetPreferredAvailabilityZone added in v1.5.0 

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

SetPreferredAvailabilityZone sets the PreferredAvailabilityZone field's value.

func (*NodeGroupMember) SetPreferredOutpostArn added in v1.35.5 

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

SetPreferredOutpostArn sets the PreferredOutpostArn field's value.

func (*NodeGroupMember) SetReadEndpoint added in v1.5.0 

func (s *NodeGroupMember) SetReadEndpoint(v *Endpoint) *NodeGroupMember

SetReadEndpoint sets the ReadEndpoint field's value.

func (NodeGroupMember) String added in v0.6.5 

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 added in v1.19.43 

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 added in v1.19.43 

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 added in v1.19.43 

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

SetCacheClusterId sets the CacheClusterId field's value.

func (*NodeGroupMemberUpdateStatus) SetCacheNodeId added in v1.19.43 

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

SetCacheNodeId sets the CacheNodeId field's value.

func (*NodeGroupMemberUpdateStatus) SetNodeDeletionDate added in v1.19.43 

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

SetNodeDeletionDate sets the NodeDeletionDate field's value.

func (*NodeGroupMemberUpdateStatus) SetNodeUpdateEndDate added in v1.19.43 

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

SetNodeUpdateEndDate sets the NodeUpdateEndDate field's value.

func (*NodeGroupMemberUpdateStatus) SetNodeUpdateInitiatedBy added in v1.19.43 

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

SetNodeUpdateInitiatedBy sets the NodeUpdateInitiatedBy field's value.

func (*NodeGroupMemberUpdateStatus) SetNodeUpdateInitiatedDate added in v1.19.43 

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

SetNodeUpdateInitiatedDate sets the NodeUpdateInitiatedDate field's value.

func (*NodeGroupMemberUpdateStatus) SetNodeUpdateStartDate added in v1.19.43 

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

SetNodeUpdateStartDate sets the NodeUpdateStartDate field's value.

func (*NodeGroupMemberUpdateStatus) SetNodeUpdateStatus added in v1.19.43 

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

SetNodeUpdateStatus sets the NodeUpdateStatus field's value.

func (*NodeGroupMemberUpdateStatus) SetNodeUpdateStatusModifiedDate added in v1.19.43 

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

SetNodeUpdateStatusModifiedDate sets the NodeUpdateStatusModifiedDate field's value.

func (NodeGroupMemberUpdateStatus) String added in v1.19.43 

func (s NodeGroupMemberUpdateStatus) 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 NodeGroupUpdateStatus added in v1.19.43 

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 added in v1.19.43 

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 added in v1.19.43 

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

SetNodeGroupId sets the NodeGroupId field's value.

func (*NodeGroupUpdateStatus) SetNodeGroupMemberUpdateStatus added in v1.19.43 

func (s *NodeGroupUpdateStatus) SetNodeGroupMemberUpdateStatus(v []*NodeGroupMemberUpdateStatus) *NodeGroupUpdateStatus

SetNodeGroupMemberUpdateStatus sets the NodeGroupMemberUpdateStatus field's value.

func (NodeGroupUpdateStatus) String added in v1.19.43 

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 added in v0.6.5 

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 added in v1.5.0 

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

SetCacheClusterId sets the CacheClusterId field's value.

func (*NodeSnapshot) SetCacheNodeCreateTime added in v1.5.0 

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

SetCacheNodeCreateTime sets the CacheNodeCreateTime field's value.

func (*NodeSnapshot) SetCacheNodeId added in v1.5.0 

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

SetCacheNodeId sets the CacheNodeId field's value.

func (*NodeSnapshot) SetCacheSize added in v1.5.0 

func (s *NodeSnapshot) SetCacheSize(v string) *NodeSnapshot

SetCacheSize sets the CacheSize field's value.

func (*NodeSnapshot) SetNodeGroupConfiguration added in v1.5.0 

func (s *NodeSnapshot) SetNodeGroupConfiguration(v *NodeGroupConfiguration) *NodeSnapshot

SetNodeGroupConfiguration sets the NodeGroupConfiguration field's value.

func (*NodeSnapshot) SetNodeGroupId added in v1.5.0 

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

SetNodeGroupId sets the NodeGroupId field's value.

func (*NodeSnapshot) SetSnapshotCreateTime added in v1.5.0 

func (s *NodeSnapshot) SetSnapshotCreateTime(v time.Time) *NodeSnapshot

SetSnapshotCreateTime sets the SnapshotCreateTime field's value.

func (NodeSnapshot) String added in v0.6.5 

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 added in v0.6.5 

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 added in v1.5.0 

func (s *NotificationConfiguration) SetTopicArn(v string) *NotificationConfiguration

SetTopicArn sets the TopicArn field's value.

func (*NotificationConfiguration) SetTopicStatus added in v1.5.0 

func (s *NotificationConfiguration) SetTopicStatus(v string) *NotificationConfiguration

SetTopicStatus sets the TopicStatus field's value.

func (NotificationConfiguration) String added in v0.6.5 

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 added in v0.6.5 

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 added in v1.5.0 

func (s *Parameter) SetAllowedValues(v string) *Parameter

SetAllowedValues sets the AllowedValues field's value.

func (*Parameter) SetChangeType added in v1.5.0 

func (s *Parameter) SetChangeType(v string) *Parameter

SetChangeType sets the ChangeType field's value.

func (*Parameter) SetDataType added in v1.5.0 

func (s *Parameter) SetDataType(v string) *Parameter

SetDataType sets the DataType field's value.

func (*Parameter) SetDescription added in v1.5.0 

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

SetDescription sets the Description field's value.

func (*Parameter) SetIsModifiable added in v1.5.0 

func (s *Parameter) SetIsModifiable(v bool) *Parameter

SetIsModifiable sets the IsModifiable field's value.

func (*Parameter) SetMinimumEngineVersion added in v1.5.0 

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

SetMinimumEngineVersion sets the MinimumEngineVersion field's value.

func (*Parameter) SetParameterName added in v1.5.0 

func (s *Parameter) SetParameterName(v string) *Parameter

SetParameterName sets the ParameterName field's value.

func (*Parameter) SetParameterValue added in v1.5.0 

func (s *Parameter) SetParameterValue(v string) *Parameter

SetParameterValue sets the ParameterValue field's value.

func (*Parameter) SetSource added in v1.5.0 

func (s *Parameter) SetSource(v string) *Parameter

SetSource sets the Source field's value.

func (Parameter) String added in v0.6.5 

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 added in v0.6.5 

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 added in v1.5.0 

func (s *ParameterNameValue) SetParameterName(v string) *ParameterNameValue

SetParameterName sets the ParameterName field's value.

func (*ParameterNameValue) SetParameterValue added in v1.5.0 

func (s *ParameterNameValue) SetParameterValue(v string) *ParameterNameValue

SetParameterValue sets the ParameterValue field's value.

func (ParameterNameValue) String added in v0.6.5 

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 added in v1.38.24 

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 added in v1.38.24 

func (s PendingLogDeliveryConfiguration) 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 (*PendingLogDeliveryConfiguration) SetDestinationDetails added in v1.38.24 

func (s *PendingLogDeliveryConfiguration) SetDestinationDetails(v *DestinationDetails) *PendingLogDeliveryConfiguration

SetDestinationDetails sets the DestinationDetails field's value.

func (*PendingLogDeliveryConfiguration) SetDestinationType added in v1.38.24 

func (s *PendingLogDeliveryConfiguration) SetDestinationType(v string) *PendingLogDeliveryConfiguration

SetDestinationType sets the DestinationType field's value.

func (*PendingLogDeliveryConfiguration) SetLogFormat added in v1.38.24 

func (s *PendingLogDeliveryConfiguration) SetLogFormat(v string) *PendingLogDeliveryConfiguration

SetLogFormat sets the LogFormat field's value.

func (*PendingLogDeliveryConfiguration) SetLogType added in v1.38.24 

func (s *PendingLogDeliveryConfiguration) SetLogType(v string) *PendingLogDeliveryConfiguration

SetLogType sets the LogType field's value.

func (PendingLogDeliveryConfiguration) String added in v1.38.24 

func (s PendingLogDeliveryConfiguration) 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 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 added in v0.6.5 

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 added in v1.25.23 

func (s *PendingModifiedValues) SetAuthTokenStatus(v string) *PendingModifiedValues

SetAuthTokenStatus sets the AuthTokenStatus field's value.

func (*PendingModifiedValues) SetCacheNodeIdsToRemove added in v1.5.0 

func (s *PendingModifiedValues) SetCacheNodeIdsToRemove(v []*string) *PendingModifiedValues

SetCacheNodeIdsToRemove sets the CacheNodeIdsToRemove field's value.

func (*PendingModifiedValues) SetCacheNodeType added in v1.5.0 

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

SetCacheNodeType sets the CacheNodeType field's value.

func (*PendingModifiedValues) SetEngineVersion added in v1.5.0 

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

SetEngineVersion sets the EngineVersion field's value.

func (*PendingModifiedValues) SetLogDeliveryConfigurations added in v1.38.24 

func (s *PendingModifiedValues) SetLogDeliveryConfigurations(v []*PendingLogDeliveryConfiguration) *PendingModifiedValues

SetLogDeliveryConfigurations sets the LogDeliveryConfigurations field's value.

func (*PendingModifiedValues) SetNumCacheNodes added in v1.5.0 

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

SetNumCacheNodes sets the NumCacheNodes field's value.

func (*PendingModifiedValues) SetTransitEncryptionEnabled added in v1.44.169 

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

SetTransitEncryptionEnabled sets the TransitEncryptionEnabled field's value.

func (*PendingModifiedValues) SetTransitEncryptionMode added in v1.44.169 

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

SetTransitEncryptionMode sets the TransitEncryptionMode field's value.

func (PendingModifiedValues) String added in v0.6.5 

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 added in v1.19.43 

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 added in v1.19.43 

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 added in v1.25.9 

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

SetCacheClusterId sets the CacheClusterId field's value.

func (*ProcessedUpdateAction) SetReplicationGroupId added in v1.19.43 

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

SetReplicationGroupId sets the ReplicationGroupId field's value.

func (*ProcessedUpdateAction) SetServiceUpdateName added in v1.19.43 

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

SetServiceUpdateName sets the ServiceUpdateName field's value.

func (*ProcessedUpdateAction) SetUpdateActionStatus added in v1.19.43 

func (s *ProcessedUpdateAction) SetUpdateActionStatus(v string) *ProcessedUpdateAction

SetUpdateActionStatus sets the UpdateActionStatus field's value.

func (ProcessedUpdateAction) String added in v1.19.43 

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 added in v0.6.5 

func (s PurchaseReservedCacheNodesOfferingInput) 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 (*PurchaseReservedCacheNodesOfferingInput) SetCacheNodeCount added in v1.5.0 

func (s *PurchaseReservedCacheNodesOfferingInput) SetCacheNodeCount(v int64) *PurchaseReservedCacheNodesOfferingInput

SetCacheNodeCount sets the CacheNodeCount field's value.

func (*PurchaseReservedCacheNodesOfferingInput) SetReservedCacheNodeId added in v1.5.0 

func (s *PurchaseReservedCacheNodesOfferingInput) SetReservedCacheNodeId(v string) *PurchaseReservedCacheNodesOfferingInput

SetReservedCacheNodeId sets the ReservedCacheNodeId field's value.

func (*PurchaseReservedCacheNodesOfferingInput) SetReservedCacheNodesOfferingId added in v1.5.0 

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

SetReservedCacheNodesOfferingId sets the ReservedCacheNodesOfferingId field's value.

func (*PurchaseReservedCacheNodesOfferingInput) SetTags added in v1.38.15 

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

SetTags sets the Tags field's value.

func (PurchaseReservedCacheNodesOfferingInput) String added in v0.6.5 

func (s PurchaseReservedCacheNodesOfferingInput) 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 (*PurchaseReservedCacheNodesOfferingInput) Validate added in v1.1.21 

func (s *PurchaseReservedCacheNodesOfferingInput) Validate() error

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 added in v0.6.5 

func (s PurchaseReservedCacheNodesOfferingOutput) 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 (*PurchaseReservedCacheNodesOfferingOutput) SetReservedCacheNode added in v1.5.0 

func (s *PurchaseReservedCacheNodesOfferingOutput) SetReservedCacheNode(v *ReservedCacheNode) *PurchaseReservedCacheNodesOfferingOutput

SetReservedCacheNode sets the ReservedCacheNode field's value.

func (PurchaseReservedCacheNodesOfferingOutput) String added in v0.6.5 

func (s PurchaseReservedCacheNodesOfferingOutput) 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 RebalanceSlotsInGlobalReplicationGroupInput added in v1.29.25 

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 added in v1.29.25 

func (s RebalanceSlotsInGlobalReplicationGroupInput) 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 (*RebalanceSlotsInGlobalReplicationGroupInput) SetApplyImmediately added in v1.29.25 

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

SetApplyImmediately sets the ApplyImmediately field's value.

func (*RebalanceSlotsInGlobalReplicationGroupInput) SetGlobalReplicationGroupId added in v1.29.25 

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

SetGlobalReplicationGroupId sets the GlobalReplicationGroupId field's value.

func (RebalanceSlotsInGlobalReplicationGroupInput) String added in v1.29.25 

func (s RebalanceSlotsInGlobalReplicationGroupInput) 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 (*RebalanceSlotsInGlobalReplicationGroupInput) Validate added in v1.29.25 

func (s *RebalanceSlotsInGlobalReplicationGroupInput) Validate() error

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

type RebalanceSlotsInGlobalReplicationGroupOutput added in v1.29.25 

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 added in v1.29.25 

func (s RebalanceSlotsInGlobalReplicationGroupOutput) 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 (*RebalanceSlotsInGlobalReplicationGroupOutput) SetGlobalReplicationGroup added in v1.29.25 

func (s *RebalanceSlotsInGlobalReplicationGroupOutput) SetGlobalReplicationGroup(v *GlobalReplicationGroup) *RebalanceSlotsInGlobalReplicationGroupOutput

SetGlobalReplicationGroup sets the GlobalReplicationGroup field's value.

func (RebalanceSlotsInGlobalReplicationGroupOutput) String added in v1.29.25 

func (s RebalanceSlotsInGlobalReplicationGroupOutput) 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 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 added in v0.6.5 

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 added in v1.5.0 

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

SetCacheClusterId sets the CacheClusterId field's value.

func (*RebootCacheClusterInput) SetCacheNodeIdsToReboot added in v1.5.0 

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

SetCacheNodeIdsToReboot sets the CacheNodeIdsToReboot field's value.

func (RebootCacheClusterInput) String added in v0.6.5 

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 added in v1.1.21 

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 added in v0.6.5 

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 added in v1.5.0 

func (s *RebootCacheClusterOutput) SetCacheCluster(v *CacheCluster) *RebootCacheClusterOutput

SetCacheCluster sets the CacheCluster field's value.

func (RebootCacheClusterOutput) String added in v0.6.5 

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 added in v0.6.5 

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 added in v1.5.0 

func (s *RecurringCharge) SetRecurringChargeAmount(v float64) *RecurringCharge

SetRecurringChargeAmount sets the RecurringChargeAmount field's value.

func (*RecurringCharge) SetRecurringChargeFrequency added in v1.5.0 

func (s *RecurringCharge) SetRecurringChargeFrequency(v string) *RecurringCharge

SetRecurringChargeFrequency sets the RecurringChargeFrequency field's value.

func (RecurringCharge) String added in v0.6.5 

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 added in v1.29.25 

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 added in v1.29.25 

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 added in v1.29.25 

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

SetReplicationGroupId sets the ReplicationGroupId field's value.

func (*RegionalConfiguration) SetReplicationGroupRegion added in v1.29.25 

func (s *RegionalConfiguration) SetReplicationGroupRegion(v string) *RegionalConfiguration

SetReplicationGroupRegion sets the ReplicationGroupRegion field's value.

func (*RegionalConfiguration) SetReshardingConfiguration added in v1.29.25 

func (s *RegionalConfiguration) SetReshardingConfiguration(v []*ReshardingConfiguration) *RegionalConfiguration

SetReshardingConfiguration sets the ReshardingConfiguration field's value.

func (RegionalConfiguration) String added in v1.29.25 

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 added in v1.29.25 

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 added in v0.6.5 

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 added in v1.5.0 

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

SetResourceName sets the ResourceName field's value.

func (*RemoveTagsFromResourceInput) SetTagKeys added in v1.5.0 

func (s *RemoveTagsFromResourceInput) SetTagKeys(v []*string) *RemoveTagsFromResourceInput

SetTagKeys sets the TagKeys field's value.

func (RemoveTagsFromResourceInput) String added in v0.6.5 

func (s RemoveTagsFromResourceInput) 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 (*RemoveTagsFromResourceInput) Validate added in v1.1.21 

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 added in v0.6.5 

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 added in v1.31.5 

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

SetARN sets the ARN field's value.

func (*ReplicationGroup) SetAtRestEncryptionEnabled added in v1.12.17 

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

SetAtRestEncryptionEnabled sets the AtRestEncryptionEnabled field's value.

func (*ReplicationGroup) SetAuthTokenEnabled added in v1.12.17 

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

SetAuthTokenEnabled sets the AuthTokenEnabled field's value.

func (*ReplicationGroup) SetAuthTokenLastModifiedDate added in v1.25.23 

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

SetAuthTokenLastModifiedDate sets the AuthTokenLastModifiedDate field's value.

func (*ReplicationGroup) SetAutoMinorVersionUpgrade added in v1.44.57 

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

SetAutoMinorVersionUpgrade sets the AutoMinorVersionUpgrade field's value.

func (*ReplicationGroup) SetAutomaticFailover added in v1.5.0 

func (s *ReplicationGroup) SetAutomaticFailover(v string) *ReplicationGroup

SetAutomaticFailover sets the AutomaticFailover field's value.

func (*ReplicationGroup) SetCacheNodeType added in v1.8.9 

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

SetCacheNodeType sets the CacheNodeType field's value.

func (*ReplicationGroup) SetClusterEnabled added in v1.8.9 

func (s *ReplicationGroup) SetClusterEnabled(v bool) *ReplicationGroup

SetClusterEnabled sets the ClusterEnabled field's value.

func (*ReplicationGroup) SetClusterMode added in v1.44.262 

func (s *ReplicationGroup) SetClusterMode(v string) *ReplicationGroup

SetClusterMode sets the ClusterMode field's value.

func (*ReplicationGroup) SetConfigurationEndpoint added in v1.5.0 

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

SetConfigurationEndpoint sets the ConfigurationEndpoint field's value.

func (*ReplicationGroup) SetDataTiering added in v1.42.11 

func (s *ReplicationGroup) SetDataTiering(v string) *ReplicationGroup

SetDataTiering sets the DataTiering field's value.

func (*ReplicationGroup) SetDescription added in v1.5.0 

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

SetDescription sets the Description field's value.

func (*ReplicationGroup) SetGlobalReplicationGroupInfo added in v1.29.25 

func (s *ReplicationGroup) SetGlobalReplicationGroupInfo(v *GlobalReplicationGroupInfo) *ReplicationGroup

SetGlobalReplicationGroupInfo sets the GlobalReplicationGroupInfo field's value.

func (*ReplicationGroup) SetIpDiscovery added in v1.44.132 

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

SetIpDiscovery sets the IpDiscovery field's value.

func (*ReplicationGroup) SetKmsKeyId added in v1.23.12 

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

SetKmsKeyId sets the KmsKeyId field's value.

func (*ReplicationGroup) SetLogDeliveryConfigurations added in v1.38.24 

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

SetLogDeliveryConfigurations sets the LogDeliveryConfigurations field's value.

func (*ReplicationGroup) SetMemberClusters added in v1.5.0 

func (s *ReplicationGroup) SetMemberClusters(v []*string) *ReplicationGroup

SetMemberClusters sets the MemberClusters field's value.

func (*ReplicationGroup) SetMemberClustersOutpostArns added in v1.35.5 

func (s *ReplicationGroup) SetMemberClustersOutpostArns(v []*string) *ReplicationGroup

SetMemberClustersOutpostArns sets the MemberClustersOutpostArns field's value.

func (*ReplicationGroup) SetMultiAZ added in v1.31.10 

func (s *ReplicationGroup) SetMultiAZ(v string) *ReplicationGroup

SetMultiAZ sets the MultiAZ field's value.

func (*ReplicationGroup) SetNetworkType added in v1.44.132 

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

SetNetworkType sets the NetworkType field's value.

func (*ReplicationGroup) SetNodeGroups added in v1.5.0 

func (s *ReplicationGroup) SetNodeGroups(v []*NodeGroup) *ReplicationGroup

SetNodeGroups sets the NodeGroups field's value.

func (*ReplicationGroup) SetPendingModifiedValues added in v1.5.0 

func (s *ReplicationGroup) SetPendingModifiedValues(v *ReplicationGroupPendingModifiedValues) *ReplicationGroup

SetPendingModifiedValues sets the PendingModifiedValues field's value.

func (*ReplicationGroup) SetReplicationGroupCreateTime added in v1.40.22 

func (s *ReplicationGroup) SetReplicationGroupCreateTime(v time.Time) *ReplicationGroup

SetReplicationGroupCreateTime sets the ReplicationGroupCreateTime field's value.

func (*ReplicationGroup) SetReplicationGroupId added in v1.5.0 

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

SetReplicationGroupId sets the ReplicationGroupId field's value.

func (*ReplicationGroup) SetSnapshotRetentionLimit added in v1.5.0 

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

SetSnapshotRetentionLimit sets the SnapshotRetentionLimit field's value.

func (*ReplicationGroup) SetSnapshotWindow added in v1.5.0 

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

SetSnapshotWindow sets the SnapshotWindow field's value.

func (*ReplicationGroup) SetSnapshottingClusterId added in v1.5.0 

func (s *ReplicationGroup) SetSnapshottingClusterId(v string) *ReplicationGroup

SetSnapshottingClusterId sets the SnapshottingClusterId field's value.

func (*ReplicationGroup) SetStatus added in v1.5.0 

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

SetStatus sets the Status field's value.

func (*ReplicationGroup) SetTransitEncryptionEnabled added in v1.12.17 

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

SetTransitEncryptionEnabled sets the TransitEncryptionEnabled field's value.

func (*ReplicationGroup) SetTransitEncryptionMode added in v1.44.169 

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

SetTransitEncryptionMode sets the TransitEncryptionMode field's value.

func (*ReplicationGroup) SetUserGroupIds added in v1.35.5 

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

SetUserGroupIds sets the UserGroupIds field's value.

func (ReplicationGroup) String added in v0.6.5 

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 added in v0.6.5 

func (s ReplicationGroupPendingModifiedValues) 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 (*ReplicationGroupPendingModifiedValues) SetAuthTokenStatus added in v1.25.23 

func (s *ReplicationGroupPendingModifiedValues) SetAuthTokenStatus(v string) *ReplicationGroupPendingModifiedValues

SetAuthTokenStatus sets the AuthTokenStatus field's value.

func (*ReplicationGroupPendingModifiedValues) SetAutomaticFailoverStatus added in v1.5.0 

func (s *ReplicationGroupPendingModifiedValues) SetAutomaticFailoverStatus(v string) *ReplicationGroupPendingModifiedValues

SetAutomaticFailoverStatus sets the AutomaticFailoverStatus field's value.

func (*ReplicationGroupPendingModifiedValues) SetClusterMode added in v1.44.262 

func (s *ReplicationGroupPendingModifiedValues) SetClusterMode(v string) *ReplicationGroupPendingModifiedValues

SetClusterMode sets the ClusterMode field's value.

func (*ReplicationGroupPendingModifiedValues) SetLogDeliveryConfigurations added in v1.38.24 

func (s *ReplicationGroupPendingModifiedValues) SetLogDeliveryConfigurations(v []*PendingLogDeliveryConfiguration) *ReplicationGroupPendingModifiedValues

SetLogDeliveryConfigurations sets the LogDeliveryConfigurations field's value.

func (*ReplicationGroupPendingModifiedValues) SetPrimaryClusterId added in v1.5.0 

func (s *ReplicationGroupPendingModifiedValues) SetPrimaryClusterId(v string) *ReplicationGroupPendingModifiedValues

SetPrimaryClusterId sets the PrimaryClusterId field's value.

func (*ReplicationGroupPendingModifiedValues) SetResharding added in v1.12.25 

func (s *ReplicationGroupPendingModifiedValues) SetResharding(v *ReshardingStatus) *ReplicationGroupPendingModifiedValues

SetResharding sets the Resharding field's value.

func (*ReplicationGroupPendingModifiedValues) SetTransitEncryptionEnabled added in v1.44.169 

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

SetTransitEncryptionEnabled sets the TransitEncryptionEnabled field's value.

func (*ReplicationGroupPendingModifiedValues) SetTransitEncryptionMode added in v1.44.169 

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

SetTransitEncryptionMode sets the TransitEncryptionMode field's value.

func (*ReplicationGroupPendingModifiedValues) SetUserGroups added in v1.35.5 

func (s *ReplicationGroupPendingModifiedValues) SetUserGroups(v *UserGroupsUpdateStatus) *ReplicationGroupPendingModifiedValues

SetUserGroups sets the UserGroups field's value.

func (ReplicationGroupPendingModifiedValues) String added in v0.6.5 

func (s ReplicationGroupPendingModifiedValues) 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 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: M7g node types: cache.m7g.large,
	//    cache.m7g.xlarge, cache.m7g.2xlarge, cache.m7g.4xlarge, cache.m7g.8xlarge,
	//    cache.m7g.12xlarge, cache.m7g.16xlarge For region availability, see Supported
	//    Node Types (https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/CacheNodes.SupportedTypes.html#CacheNodes.SupportedTypesByRegion)
	//    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 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: R7g node types: cache.r7g.large,
	//    cache.r7g.xlarge, cache.r7g.2xlarge, cache.r7g.4xlarge, cache.r7g.8xlarge,
	//    cache.r7g.12xlarge, cache.r7g.16xlarge For region availability, see Supported
	//    Node Types (https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/CacheNodes.SupportedTypes.html#CacheNodes.SupportedTypesByRegion)
	//    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 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 added in v0.6.5 

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 added in v1.5.0 

func (s *ReservedCacheNode) SetCacheNodeCount(v int64) *ReservedCacheNode

SetCacheNodeCount sets the CacheNodeCount field's value.

func (*ReservedCacheNode) SetCacheNodeType added in v1.5.0 

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

SetCacheNodeType sets the CacheNodeType field's value.

func (*ReservedCacheNode) SetDuration added in v1.5.0 

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

SetDuration sets the Duration field's value.

func (*ReservedCacheNode) SetFixedPrice added in v1.5.0 

func (s *ReservedCacheNode) SetFixedPrice(v float64) *ReservedCacheNode

SetFixedPrice sets the FixedPrice field's value.

func (*ReservedCacheNode) SetOfferingType added in v1.5.0 

func (s *ReservedCacheNode) SetOfferingType(v string) *ReservedCacheNode

SetOfferingType sets the OfferingType field's value.

func (*ReservedCacheNode) SetProductDescription added in v1.5.0 

func (s *ReservedCacheNode) SetProductDescription(v string) *ReservedCacheNode

SetProductDescription sets the ProductDescription field's value.

func (*ReservedCacheNode) SetRecurringCharges added in v1.5.0 

func (s *ReservedCacheNode) SetRecurringCharges(v []*RecurringCharge) *ReservedCacheNode

SetRecurringCharges sets the RecurringCharges field's value.

func (*ReservedCacheNode) SetReservationARN added in v1.15.29 

func (s *ReservedCacheNode) SetReservationARN(v string) *ReservedCacheNode

SetReservationARN sets the ReservationARN field's value.

func (*ReservedCacheNode) SetReservedCacheNodeId added in v1.5.0 

func (s *ReservedCacheNode) SetReservedCacheNodeId(v string) *ReservedCacheNode

SetReservedCacheNodeId sets the ReservedCacheNodeId field's value.

func (*ReservedCacheNode) SetReservedCacheNodesOfferingId added in v1.5.0 

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

SetReservedCacheNodesOfferingId sets the ReservedCacheNodesOfferingId field's value.

func (*ReservedCacheNode) SetStartTime added in v1.5.0 

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

SetStartTime sets the StartTime field's value.

func (*ReservedCacheNode) SetState added in v1.5.0 

func (s *ReservedCacheNode) SetState(v string) *ReservedCacheNode

SetState sets the State field's value.

func (*ReservedCacheNode) SetUsagePrice added in v1.5.0 

func (s *ReservedCacheNode) SetUsagePrice(v float64) *ReservedCacheNode

SetUsagePrice sets the UsagePrice field's value.

func (ReservedCacheNode) String added in v0.6.5 

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: M7g node types: cache.m7g.large,
	//    cache.m7g.xlarge, cache.m7g.2xlarge, cache.m7g.4xlarge, cache.m7g.8xlarge,
	//    cache.m7g.12xlarge, cache.m7g.16xlarge For region availability, see Supported
	//    Node Types (https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/CacheNodes.SupportedTypes.html#CacheNodes.SupportedTypesByRegion)
	//    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 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: R7g node types: cache.r7g.large,
	//    cache.r7g.xlarge, cache.r7g.2xlarge, cache.r7g.4xlarge, cache.r7g.8xlarge,
	//    cache.r7g.12xlarge, cache.r7g.16xlarge For region availability, see Supported
	//    Node Types (https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/CacheNodes.SupportedTypes.html#CacheNodes.SupportedTypesByRegion)
	//    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 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 added in v0.6.5 

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 added in v1.5.0 

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

SetCacheNodeType sets the CacheNodeType field's value.

func (*ReservedCacheNodesOffering) SetDuration added in v1.5.0 

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

SetDuration sets the Duration field's value.

func (*ReservedCacheNodesOffering) SetFixedPrice added in v1.5.0 

func (s *ReservedCacheNodesOffering) SetFixedPrice(v float64) *ReservedCacheNodesOffering

SetFixedPrice sets the FixedPrice field's value.

func (*ReservedCacheNodesOffering) SetOfferingType added in v1.5.0 

func (s *ReservedCacheNodesOffering) SetOfferingType(v string) *ReservedCacheNodesOffering

SetOfferingType sets the OfferingType field's value.

func (*ReservedCacheNodesOffering) SetProductDescription added in v1.5.0 

func (s *ReservedCacheNodesOffering) SetProductDescription(v string) *ReservedCacheNodesOffering

SetProductDescription sets the ProductDescription field's value.

func (*ReservedCacheNodesOffering) SetRecurringCharges added in v1.5.0 

func (s *ReservedCacheNodesOffering) SetRecurringCharges(v []*RecurringCharge) *ReservedCacheNodesOffering

SetRecurringCharges sets the RecurringCharges field's value.

func (*ReservedCacheNodesOffering) SetReservedCacheNodesOfferingId added in v1.5.0 

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

SetReservedCacheNodesOfferingId sets the ReservedCacheNodesOfferingId field's value.

func (*ReservedCacheNodesOffering) SetUsagePrice added in v1.5.0 

func (s *ReservedCacheNodesOffering) SetUsagePrice(v float64) *ReservedCacheNodesOffering

SetUsagePrice sets the UsagePrice field's value.

func (ReservedCacheNodesOffering) String added in v0.6.5 

func (s ReservedCacheNodesOffering) 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 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 added in v0.6.5 

func (s ResetCacheParameterGroupInput) 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 (*ResetCacheParameterGroupInput) SetCacheParameterGroupName added in v1.5.0 

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

SetCacheParameterGroupName sets the CacheParameterGroupName field's value.

func (*ResetCacheParameterGroupInput) SetParameterNameValues added in v1.5.0 

func (s *ResetCacheParameterGroupInput) SetParameterNameValues(v []*ParameterNameValue) *ResetCacheParameterGroupInput

SetParameterNameValues sets the ParameterNameValues field's value.

func (*ResetCacheParameterGroupInput) SetResetAllParameters added in v1.5.0 

func (s *ResetCacheParameterGroupInput) SetResetAllParameters(v bool) *ResetCacheParameterGroupInput

SetResetAllParameters sets the ResetAllParameters field's value.

func (ResetCacheParameterGroupInput) String added in v0.6.5 

func (s ResetCacheParameterGroupInput) 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 (*ResetCacheParameterGroupInput) Validate added in v1.1.21 

func (s *ResetCacheParameterGroupInput) Validate() error

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

type ReshardingConfiguration added in v1.12.25 

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 added in v1.12.25 

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 added in v1.15.29 

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

SetNodeGroupId sets the NodeGroupId field's value.

func (*ReshardingConfiguration) SetPreferredAvailabilityZones added in v1.12.25 

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

SetPreferredAvailabilityZones sets the PreferredAvailabilityZones field's value.

func (ReshardingConfiguration) String added in v1.12.25 

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 added in v1.15.29 

func (s *ReshardingConfiguration) Validate() error

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

type ReshardingStatus added in v1.12.25 

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 added in v1.12.25 

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 added in v1.12.25 

func (s *ReshardingStatus) SetSlotMigration(v *SlotMigration) *ReshardingStatus

SetSlotMigration sets the SlotMigration field's value.

func (ReshardingStatus) String added in v1.12.25 

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 added in v0.6.5 

func (s RevokeCacheSecurityGroupIngressInput) 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 (*RevokeCacheSecurityGroupIngressInput) SetCacheSecurityGroupName added in v1.5.0 

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

SetCacheSecurityGroupName sets the CacheSecurityGroupName field's value.

func (*RevokeCacheSecurityGroupIngressInput) SetEC2SecurityGroupName added in v1.5.0 

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

SetEC2SecurityGroupName sets the EC2SecurityGroupName field's value.

func (*RevokeCacheSecurityGroupIngressInput) SetEC2SecurityGroupOwnerId added in v1.5.0 

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

SetEC2SecurityGroupOwnerId sets the EC2SecurityGroupOwnerId field's value.

func (RevokeCacheSecurityGroupIngressInput) String added in v0.6.5 

func (s RevokeCacheSecurityGroupIngressInput) 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 (*RevokeCacheSecurityGroupIngressInput) Validate added in v1.1.21 

func (s *RevokeCacheSecurityGroupIngressInput) Validate() error

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 added in v0.6.5 

func (s RevokeCacheSecurityGroupIngressOutput) 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 (*RevokeCacheSecurityGroupIngressOutput) SetCacheSecurityGroup added in v1.5.0 

func (s *RevokeCacheSecurityGroupIngressOutput) SetCacheSecurityGroup(v *CacheSecurityGroup) *RevokeCacheSecurityGroupIngressOutput

SetCacheSecurityGroup sets the CacheSecurityGroup field's value.

func (RevokeCacheSecurityGroupIngressOutput) String added in v0.6.5 

func (s RevokeCacheSecurityGroupIngressOutput) 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 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 added in v0.6.5 

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 added in v1.5.0 

func (s *SecurityGroupMembership) SetSecurityGroupId(v string) *SecurityGroupMembership

SetSecurityGroupId sets the SecurityGroupId field's value.

func (*SecurityGroupMembership) SetStatus added in v1.5.0 

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

SetStatus sets the Status field's value.

func (SecurityGroupMembership) String added in v0.6.5 

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 ServerlessCache added in v1.48.6 

type ServerlessCache struct {

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

	// The cache usage limit for the serverless cache.
	CacheUsageLimits *CacheUsageLimits `type:"structure"`

	// When the serverless cache was created.
	CreateTime *time.Time `type:"timestamp"`

	// The daily time that a cache snapshot will be created. Default is NULL, i.e.
	// snapshots will not be created at a specific time on a daily basis. Available
	// for Redis only.
	DailySnapshotTime *string `type:"string"`

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

	// Represents the information required for client programs to connect to a cache
	// node. This value is read-only.
	Endpoint *Endpoint `type:"structure"`

	// The engine the serverless cache is compatible with.
	Engine *string `type:"string"`

	// The name and version number of the engine the serverless cache is compatible
	// with.
	FullEngineVersion *string `type:"string"`

	// The ID of the Amazon Web Services Key Management Service (KMS) key that is
	// used to encrypt data at rest in the serverless cache.
	KmsKeyId *string `type:"string"`

	// The version number of the engine the serverless cache is compatible with.
	MajorEngineVersion *string `type:"string"`

	// Represents the information required for client programs to connect to a cache
	// node. This value is read-only.
	ReaderEndpoint *Endpoint `type:"structure"`

	// The IDs of the EC2 security groups associated with the serverless cache.
	SecurityGroupIds []*string `locationNameList:"SecurityGroupId" type:"list"`

	// The unique identifier of the serverless cache.
	ServerlessCacheName *string `type:"string"`

	// The current setting for the number of serverless cache snapshots the system
	// will retain. Available for Redis only.
	SnapshotRetentionLimit *int64 `type:"integer"`

	// The current status of the serverless cache. The allowed values are CREATING,
	// AVAILABLE, DELETING, CREATE-FAILED and MODIFYING.
	Status *string `type:"string"`

	// If no subnet IDs are given and your VPC is in us-west-1, then ElastiCache
	// will select 2 default subnets across AZs in your VPC. For all other Regions,
	// if no subnet IDs are given then ElastiCache will select 3 default subnets
	// across AZs in your default VPC.
	SubnetIds []*string `locationNameList:"SubnetId" type:"list"`

	// The identifier of the user group associated with the serverless cache. Available
	// for Redis only. Default is NULL.
	UserGroupId *string `type:"string"`
	// contains filtered or unexported fields
}

The resource representing a serverless cache.

func (ServerlessCache) GoString added in v1.48.6 

func (s ServerlessCache) 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 (*ServerlessCache) SetARN added in v1.48.6 

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

SetARN sets the ARN field's value.

func (*ServerlessCache) SetCacheUsageLimits added in v1.48.6 

func (s *ServerlessCache) SetCacheUsageLimits(v *CacheUsageLimits) *ServerlessCache

SetCacheUsageLimits sets the CacheUsageLimits field's value.

func (*ServerlessCache) SetCreateTime added in v1.48.6 

func (s *ServerlessCache) SetCreateTime(v time.Time) *ServerlessCache

SetCreateTime sets the CreateTime field's value.

func (*ServerlessCache) SetDailySnapshotTime added in v1.48.6 

func (s *ServerlessCache) SetDailySnapshotTime(v string) *ServerlessCache

SetDailySnapshotTime sets the DailySnapshotTime field's value.

func (*ServerlessCache) SetDescription added in v1.48.6 

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

SetDescription sets the Description field's value.

func (*ServerlessCache) SetEndpoint added in v1.48.6 

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

SetEndpoint sets the Endpoint field's value.

func (*ServerlessCache) SetEngine added in v1.48.6 

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

SetEngine sets the Engine field's value.

func (*ServerlessCache) SetFullEngineVersion added in v1.48.6 

func (s *ServerlessCache) SetFullEngineVersion(v string) *ServerlessCache

SetFullEngineVersion sets the FullEngineVersion field's value.

func (*ServerlessCache) SetKmsKeyId added in v1.48.6 

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

SetKmsKeyId sets the KmsKeyId field's value.

func (*ServerlessCache) SetMajorEngineVersion added in v1.48.6 

func (s *ServerlessCache) SetMajorEngineVersion(v string) *ServerlessCache

SetMajorEngineVersion sets the MajorEngineVersion field's value.

func (*ServerlessCache) SetReaderEndpoint added in v1.48.6 

func (s *ServerlessCache) SetReaderEndpoint(v *Endpoint) *ServerlessCache

SetReaderEndpoint sets the ReaderEndpoint field's value.

func (*ServerlessCache) SetSecurityGroupIds added in v1.48.6 

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

SetSecurityGroupIds sets the SecurityGroupIds field's value.

func (*ServerlessCache) SetServerlessCacheName added in v1.48.6 

func (s *ServerlessCache) SetServerlessCacheName(v string) *ServerlessCache

SetServerlessCacheName sets the ServerlessCacheName field's value.

func (*ServerlessCache) SetSnapshotRetentionLimit added in v1.48.6 

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

SetSnapshotRetentionLimit sets the SnapshotRetentionLimit field's value.

func (*ServerlessCache) SetStatus added in v1.48.6 

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

SetStatus sets the Status field's value.

func (*ServerlessCache) SetSubnetIds added in v1.48.6 

func (s *ServerlessCache) SetSubnetIds(v []*string) *ServerlessCache

SetSubnetIds sets the SubnetIds field's value.

func (*ServerlessCache) SetUserGroupId added in v1.48.6 

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

SetUserGroupId sets the UserGroupId field's value.

func (ServerlessCache) String added in v1.48.6 

func (s ServerlessCache) 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 ServerlessCacheConfiguration added in v1.48.6 

type ServerlessCacheConfiguration struct {

	// The engine that the serverless cache is configured with.
	Engine *string `type:"string"`

	// The engine version number that the serverless cache is configured with.
	MajorEngineVersion *string `type:"string"`

	// The identifier of a serverless cache.
	ServerlessCacheName *string `type:"string"`
	// contains filtered or unexported fields
}

The configuration settings for a specific serverless cache.

func (ServerlessCacheConfiguration) GoString added in v1.48.6 

func (s ServerlessCacheConfiguration) 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 (*ServerlessCacheConfiguration) SetEngine added in v1.48.6 

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

SetEngine sets the Engine field's value.

func (*ServerlessCacheConfiguration) SetMajorEngineVersion added in v1.48.6 

func (s *ServerlessCacheConfiguration) SetMajorEngineVersion(v string) *ServerlessCacheConfiguration

SetMajorEngineVersion sets the MajorEngineVersion field's value.

func (*ServerlessCacheConfiguration) SetServerlessCacheName added in v1.48.6 

func (s *ServerlessCacheConfiguration) SetServerlessCacheName(v string) *ServerlessCacheConfiguration

SetServerlessCacheName sets the ServerlessCacheName field's value.

func (ServerlessCacheConfiguration) String added in v1.48.6 

func (s ServerlessCacheConfiguration) 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 ServerlessCacheSnapshot added in v1.48.6 

type ServerlessCacheSnapshot struct {

	// The Amazon Resource Name (ARN) of a serverless cache snapshot. Available
	// for Redis only.
	ARN *string `type:"string"`

	// The total size of a serverless cache snapshot, in bytes. Available for Redis
	// only.
	BytesUsedForCache *string `type:"string"`

	// The date and time that the source serverless cache's metadata and cache data
	// set was obtained for the snapshot. Available for Redis only.
	CreateTime *time.Time `type:"timestamp"`

	// The time that the serverless cache snapshot will expire. Available for Redis
	// only.
	ExpiryTime *time.Time `type:"timestamp"`

	// The ID of the Amazon Web Services Key Management Service (KMS) key of a serverless
	// cache snapshot. Available for Redis only.
	KmsKeyId *string `type:"string"`

	// The configuration of the serverless cache, at the time the snapshot was taken.
	// Available for Redis only.
	ServerlessCacheConfiguration *ServerlessCacheConfiguration `type:"structure"`

	// The identifier of a serverless cache snapshot. Available for Redis only.
	ServerlessCacheSnapshotName *string `type:"string"`

	// The type of snapshot of serverless cache. Available for Redis only.
	SnapshotType *string `type:"string"`

	// The current status of the serverless cache. Available for Redis only.
	Status *string `type:"string"`
	// contains filtered or unexported fields
}

The resource representing a serverless cache snapshot. Available for Redis only.

func (ServerlessCacheSnapshot) GoString added in v1.48.6 

func (s ServerlessCacheSnapshot) 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 (*ServerlessCacheSnapshot) SetARN added in v1.48.6 

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

SetARN sets the ARN field's value.

func (*ServerlessCacheSnapshot) SetBytesUsedForCache added in v1.48.6 

func (s *ServerlessCacheSnapshot) SetBytesUsedForCache(v string) *ServerlessCacheSnapshot

SetBytesUsedForCache sets the BytesUsedForCache field's value.

func (*ServerlessCacheSnapshot) SetCreateTime added in v1.48.6 

func (s *ServerlessCacheSnapshot) SetCreateTime(v time.Time) *ServerlessCacheSnapshot

SetCreateTime sets the CreateTime field's value.

func (*ServerlessCacheSnapshot) SetExpiryTime added in v1.48.6 

func (s *ServerlessCacheSnapshot) SetExpiryTime(v time.Time) *ServerlessCacheSnapshot

SetExpiryTime sets the ExpiryTime field's value.

func (*ServerlessCacheSnapshot) SetKmsKeyId added in v1.48.6 

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

SetKmsKeyId sets the KmsKeyId field's value.

func (*ServerlessCacheSnapshot) SetServerlessCacheConfiguration added in v1.48.6 

func (s *ServerlessCacheSnapshot) SetServerlessCacheConfiguration(v *ServerlessCacheConfiguration) *ServerlessCacheSnapshot

SetServerlessCacheConfiguration sets the ServerlessCacheConfiguration field's value.

func (*ServerlessCacheSnapshot) SetServerlessCacheSnapshotName added in v1.48.6 

func (s *ServerlessCacheSnapshot) SetServerlessCacheSnapshotName(v string) *ServerlessCacheSnapshot

SetServerlessCacheSnapshotName sets the ServerlessCacheSnapshotName field's value.

func (*ServerlessCacheSnapshot) SetSnapshotType added in v1.48.6 

func (s *ServerlessCacheSnapshot) SetSnapshotType(v string) *ServerlessCacheSnapshot

SetSnapshotType sets the SnapshotType field's value.

func (*ServerlessCacheSnapshot) SetStatus added in v1.48.6 

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

SetStatus sets the Status field's value.

func (ServerlessCacheSnapshot) String added in v1.48.6 

func (s ServerlessCacheSnapshot) 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 added in v1.19.43 

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 added in v1.19.43 

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 added in v1.19.43 

func (s *ServiceUpdate) SetAutoUpdateAfterRecommendedApplyByDate(v bool) *ServiceUpdate

SetAutoUpdateAfterRecommendedApplyByDate sets the AutoUpdateAfterRecommendedApplyByDate field's value.

func (*ServiceUpdate) SetEngine added in v1.19.43 

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

SetEngine sets the Engine field's value.

func (*ServiceUpdate) SetEngineVersion added in v1.19.43 

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

SetEngineVersion sets the EngineVersion field's value.

func (*ServiceUpdate) SetEstimatedUpdateTime added in v1.19.43 

func (s *ServiceUpdate) SetEstimatedUpdateTime(v string) *ServiceUpdate

SetEstimatedUpdateTime sets the EstimatedUpdateTime field's value.

func (*ServiceUpdate) SetServiceUpdateDescription added in v1.19.43 

func (s *ServiceUpdate) SetServiceUpdateDescription(v string) *ServiceUpdate

SetServiceUpdateDescription sets the ServiceUpdateDescription field's value.

func (*ServiceUpdate) SetServiceUpdateEndDate added in v1.19.43 

func (s *ServiceUpdate) SetServiceUpdateEndDate(v time.Time) *ServiceUpdate

SetServiceUpdateEndDate sets the ServiceUpdateEndDate field's value.

func (*ServiceUpdate) SetServiceUpdateName added in v1.19.43 

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

SetServiceUpdateName sets the ServiceUpdateName field's value.

func (*ServiceUpdate) SetServiceUpdateRecommendedApplyByDate added in v1.19.43 

func (s *ServiceUpdate) SetServiceUpdateRecommendedApplyByDate(v time.Time) *ServiceUpdate

SetServiceUpdateRecommendedApplyByDate sets the ServiceUpdateRecommendedApplyByDate field's value.

func (*ServiceUpdate) SetServiceUpdateReleaseDate added in v1.19.43 

func (s *ServiceUpdate) SetServiceUpdateReleaseDate(v time.Time) *ServiceUpdate

SetServiceUpdateReleaseDate sets the ServiceUpdateReleaseDate field's value.

func (*ServiceUpdate) SetServiceUpdateSeverity added in v1.19.43 

func (s *ServiceUpdate) SetServiceUpdateSeverity(v string) *ServiceUpdate

SetServiceUpdateSeverity sets the ServiceUpdateSeverity field's value.

func (*ServiceUpdate) SetServiceUpdateStatus added in v1.19.43 

func (s *ServiceUpdate) SetServiceUpdateStatus(v string) *ServiceUpdate

SetServiceUpdateStatus sets the ServiceUpdateStatus field's value.

func (*ServiceUpdate) SetServiceUpdateType added in v1.19.43 

func (s *ServiceUpdate) SetServiceUpdateType(v string) *ServiceUpdate

SetServiceUpdateType sets the ServiceUpdateType field's value.

func (ServiceUpdate) String added in v1.19.43 

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 added in v1.12.25 

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 added in v1.12.25 

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 added in v1.12.25 

func (s *SlotMigration) SetProgressPercentage(v float64) *SlotMigration

SetProgressPercentage sets the ProgressPercentage field's value.

func (SlotMigration) String added in v1.12.25 

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: M7g node types: cache.m7g.large,
	//    cache.m7g.xlarge, cache.m7g.2xlarge, cache.m7g.4xlarge, cache.m7g.8xlarge,
	//    cache.m7g.12xlarge, cache.m7g.16xlarge For region availability, see Supported
	//    Node Types (https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/CacheNodes.SupportedTypes.html#CacheNodes.SupportedTypesByRegion)
	//    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 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: R7g node types: cache.r7g.large,
	//    cache.r7g.xlarge, cache.r7g.2xlarge, cache.r7g.4xlarge, cache.r7g.8xlarge,
	//    cache.r7g.12xlarge, cache.r7g.16xlarge For region availability, see Supported
	//    Node Types (https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/CacheNodes.SupportedTypes.html#CacheNodes.SupportedTypesByRegion)
	//    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 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 added in v0.6.5 

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 added in v1.31.5 

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

SetARN sets the ARN field's value.

func (*Snapshot) SetAutoMinorVersionUpgrade added in v1.5.0 

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

SetAutoMinorVersionUpgrade sets the AutoMinorVersionUpgrade field's value.

func (*Snapshot) SetAutomaticFailover added in v1.5.0 

func (s *Snapshot) SetAutomaticFailover(v string) *Snapshot

SetAutomaticFailover sets the AutomaticFailover field's value.

func (*Snapshot) SetCacheClusterCreateTime added in v1.5.0 

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

SetCacheClusterCreateTime sets the CacheClusterCreateTime field's value.

func (*Snapshot) SetCacheClusterId added in v1.5.0 

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

SetCacheClusterId sets the CacheClusterId field's value.

func (*Snapshot) SetCacheNodeType added in v1.5.0 

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

SetCacheNodeType sets the CacheNodeType field's value.

func (*Snapshot) SetCacheParameterGroupName added in v1.5.0 

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

SetCacheParameterGroupName sets the CacheParameterGroupName field's value.

func (*Snapshot) SetCacheSubnetGroupName added in v1.5.0 

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

SetCacheSubnetGroupName sets the CacheSubnetGroupName field's value.

func (*Snapshot) SetDataTiering added in v1.42.11 

func (s *Snapshot) SetDataTiering(v string) *Snapshot

SetDataTiering sets the DataTiering field's value.

func (*Snapshot) SetEngine added in v1.5.0 

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

SetEngine sets the Engine field's value.

func (*Snapshot) SetEngineVersion added in v1.5.0 

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

SetEngineVersion sets the EngineVersion field's value.

func (*Snapshot) SetKmsKeyId added in v1.23.12 

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

SetKmsKeyId sets the KmsKeyId field's value.

func (*Snapshot) SetNodeSnapshots added in v1.5.0 

func (s *Snapshot) SetNodeSnapshots(v []*NodeSnapshot) *Snapshot

SetNodeSnapshots sets the NodeSnapshots field's value.

func (*Snapshot) SetNumCacheNodes added in v1.5.0 

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

SetNumCacheNodes sets the NumCacheNodes field's value.

func (*Snapshot) SetNumNodeGroups added in v1.5.0 

func (s *Snapshot) SetNumNodeGroups(v int64) *Snapshot

SetNumNodeGroups sets the NumNodeGroups field's value.

func (*Snapshot) SetPort added in v1.5.0 

func (s *Snapshot) SetPort(v int64) *Snapshot

SetPort sets the Port field's value.

func (*Snapshot) SetPreferredAvailabilityZone added in v1.5.0 

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

SetPreferredAvailabilityZone sets the PreferredAvailabilityZone field's value.

func (*Snapshot) SetPreferredMaintenanceWindow added in v1.5.0 

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

SetPreferredMaintenanceWindow sets the PreferredMaintenanceWindow field's value.

func (*Snapshot) SetPreferredOutpostArn added in v1.35.5 

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

SetPreferredOutpostArn sets the PreferredOutpostArn field's value.

func (*Snapshot) SetReplicationGroupDescription added in v1.5.0 

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

SetReplicationGroupDescription sets the ReplicationGroupDescription field's value.

func (*Snapshot) SetReplicationGroupId added in v1.5.0 

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

SetReplicationGroupId sets the ReplicationGroupId field's value.

func (*Snapshot) SetSnapshotName added in v1.5.0 

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

SetSnapshotName sets the SnapshotName field's value.

func (*Snapshot) SetSnapshotRetentionLimit added in v1.5.0 

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

SetSnapshotRetentionLimit sets the SnapshotRetentionLimit field's value.

func (*Snapshot) SetSnapshotSource added in v1.5.0 

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

SetSnapshotSource sets the SnapshotSource field's value.

func (*Snapshot) SetSnapshotStatus added in v1.5.0 

func (s *Snapshot) SetSnapshotStatus(v string) *Snapshot

SetSnapshotStatus sets the SnapshotStatus field's value.

func (*Snapshot) SetSnapshotWindow added in v1.5.0 

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

SetSnapshotWindow sets the SnapshotWindow field's value.

func (*Snapshot) SetTopicArn added in v1.5.0 

func (s *Snapshot) SetTopicArn(v string) *Snapshot

SetTopicArn sets the TopicArn field's value.

func (*Snapshot) SetVpcId added in v1.5.0 

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

SetVpcId sets the VpcId field's value.

func (Snapshot) String added in v0.6.5 

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 added in v1.25.20 

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 added in v1.25.20 

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 added in v1.25.20 

func (s *StartMigrationInput) SetCustomerNodeEndpointList(v []*CustomerNodeEndpoint) *StartMigrationInput

SetCustomerNodeEndpointList sets the CustomerNodeEndpointList field's value.

func (*StartMigrationInput) SetReplicationGroupId added in v1.25.20 

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

SetReplicationGroupId sets the ReplicationGroupId field's value.

func (StartMigrationInput) String added in v1.25.20 

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 added in v1.25.20 

func (s *StartMigrationInput) Validate() error

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

type StartMigrationOutput added in v1.25.20 

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 added in v1.25.20 

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 added in v1.25.20 

func (s *StartMigrationOutput) SetReplicationGroup(v *ReplicationGroup) *StartMigrationOutput

SetReplicationGroup sets the ReplicationGroup field's value.

func (StartMigrationOutput) String added in v1.25.20 

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 added in v0.6.5 

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 added in v1.5.0 

func (s *Subnet) SetSubnetAvailabilityZone(v *AvailabilityZone) *Subnet

SetSubnetAvailabilityZone sets the SubnetAvailabilityZone field's value.

func (*Subnet) SetSubnetIdentifier added in v1.5.0 

func (s *Subnet) SetSubnetIdentifier(v string) *Subnet

SetSubnetIdentifier sets the SubnetIdentifier field's value.

func (*Subnet) SetSubnetOutpost added in v1.35.5 

func (s *Subnet) SetSubnetOutpost(v *SubnetOutpost) *Subnet

SetSubnetOutpost sets the SubnetOutpost field's value.

func (*Subnet) SetSupportedNetworkTypes added in v1.44.132 

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

SetSupportedNetworkTypes sets the SupportedNetworkTypes field's value.

func (Subnet) String added in v0.6.5 

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 added in v1.35.5 

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 added in v1.35.5 

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 added in v1.35.5 

func (s *SubnetOutpost) SetSubnetOutpostArn(v string) *SubnetOutpost

SetSubnetOutpostArn sets the SubnetOutpostArn field's value.

func (SubnetOutpost) String added in v1.35.5 

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 added in v0.6.5 

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 added in v1.5.0 

func (s *Tag) SetKey(v string) *Tag

SetKey sets the Key field's value.

func (*Tag) SetValue added in v1.5.0 

func (s *Tag) SetValue(v string) *Tag

SetValue sets the Value field's value.

func (Tag) String added in v0.6.5 

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 added in v0.6.5 

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 added in v1.5.0 

func (s *TagListMessage) SetTagList(v []*Tag) *TagListMessage

SetTagList sets the TagList field's value.

func (TagListMessage) String added in v0.6.5 

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 added in v1.8.9 

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 15 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 added in v1.8.9 

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 added in v1.8.9 

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

SetNodeGroupId sets the NodeGroupId field's value.

func (*TestFailoverInput) SetReplicationGroupId added in v1.8.9 

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

SetReplicationGroupId sets the ReplicationGroupId field's value.

func (TestFailoverInput) String added in v1.8.9 

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 added in v1.8.9 

func (s *TestFailoverInput) Validate() error

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

type TestFailoverOutput added in v1.8.9 

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 added in v1.8.9 

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 added in v1.8.9 

func (s *TestFailoverOutput) SetReplicationGroup(v *ReplicationGroup) *TestFailoverOutput

SetReplicationGroup sets the ReplicationGroup field's value.

func (TestFailoverOutput) String added in v1.8.9 

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 TestMigrationInput added in v1.44.319 

type TestMigrationInput struct {

	// List of endpoints from which data should be migrated. 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 is to be migrated.
	//
	// ReplicationGroupId is a required field
	ReplicationGroupId *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (TestMigrationInput) GoString added in v1.44.319 

func (s TestMigrationInput) 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 (*TestMigrationInput) SetCustomerNodeEndpointList added in v1.44.319 

func (s *TestMigrationInput) SetCustomerNodeEndpointList(v []*CustomerNodeEndpoint) *TestMigrationInput

SetCustomerNodeEndpointList sets the CustomerNodeEndpointList field's value.

func (*TestMigrationInput) SetReplicationGroupId added in v1.44.319 

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

SetReplicationGroupId sets the ReplicationGroupId field's value.

func (TestMigrationInput) String added in v1.44.319 

func (s TestMigrationInput) 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 (*TestMigrationInput) Validate added in v1.44.319 

func (s *TestMigrationInput) Validate() error

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

type TestMigrationOutput added in v1.44.319 

type TestMigrationOutput struct {

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

func (TestMigrationOutput) GoString added in v1.44.319 

func (s TestMigrationOutput) 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 (*TestMigrationOutput) SetReplicationGroup added in v1.44.319 

func (s *TestMigrationOutput) SetReplicationGroup(v *ReplicationGroup) *TestMigrationOutput

SetReplicationGroup sets the ReplicationGroup field's value.

func (TestMigrationOutput) String added in v1.44.319 

func (s TestMigrationOutput) 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 added in v1.19.43 

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 added in v1.19.43 

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 added in v1.19.43 

func (s *TimeRangeFilter) SetEndTime(v time.Time) *TimeRangeFilter

SetEndTime sets the EndTime field's value.

func (*TimeRangeFilter) SetStartTime added in v1.19.43 

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

SetStartTime sets the StartTime field's value.

func (TimeRangeFilter) String added in v1.19.43 

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 added in v1.19.43 

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 added in v1.19.43 

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 added in v1.25.9 

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

SetCacheClusterId sets the CacheClusterId field's value.

func (*UnprocessedUpdateAction) SetErrorMessage added in v1.19.43 

func (s *UnprocessedUpdateAction) SetErrorMessage(v string) *UnprocessedUpdateAction

SetErrorMessage sets the ErrorMessage field's value.

func (*UnprocessedUpdateAction) SetErrorType added in v1.19.43 

func (s *UnprocessedUpdateAction) SetErrorType(v string) *UnprocessedUpdateAction

SetErrorType sets the ErrorType field's value.

func (*UnprocessedUpdateAction) SetReplicationGroupId added in v1.19.43 

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

SetReplicationGroupId sets the ReplicationGroupId field's value.

func (*UnprocessedUpdateAction) SetServiceUpdateName added in v1.19.43 

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

SetServiceUpdateName sets the ServiceUpdateName field's value.

func (UnprocessedUpdateAction) String added in v1.19.43 

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 added in v1.19.43 

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 added in v1.19.43 

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 added in v1.25.9 

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

SetCacheClusterId sets the CacheClusterId field's value.

func (*UpdateAction) SetCacheNodeUpdateStatus added in v1.25.9 

func (s *UpdateAction) SetCacheNodeUpdateStatus(v []*CacheNodeUpdateStatus) *UpdateAction

SetCacheNodeUpdateStatus sets the CacheNodeUpdateStatus field's value.

func (*UpdateAction) SetEngine added in v1.25.9 

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

SetEngine sets the Engine field's value.

func (*UpdateAction) SetEstimatedUpdateTime added in v1.19.43 

func (s *UpdateAction) SetEstimatedUpdateTime(v string) *UpdateAction

SetEstimatedUpdateTime sets the EstimatedUpdateTime field's value.

func (*UpdateAction) SetNodeGroupUpdateStatus added in v1.19.43 

func (s *UpdateAction) SetNodeGroupUpdateStatus(v []*NodeGroupUpdateStatus) *UpdateAction

SetNodeGroupUpdateStatus sets the NodeGroupUpdateStatus field's value.

func (*UpdateAction) SetNodesUpdated added in v1.19.43 

func (s *UpdateAction) SetNodesUpdated(v string) *UpdateAction

SetNodesUpdated sets the NodesUpdated field's value.

func (*UpdateAction) SetReplicationGroupId added in v1.19.43 

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

SetReplicationGroupId sets the ReplicationGroupId field's value.

func (*UpdateAction) SetServiceUpdateName added in v1.19.43 

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

SetServiceUpdateName sets the ServiceUpdateName field's value.

func (*UpdateAction) SetServiceUpdateRecommendedApplyByDate added in v1.19.43 

func (s *UpdateAction) SetServiceUpdateRecommendedApplyByDate(v time.Time) *UpdateAction

SetServiceUpdateRecommendedApplyByDate sets the ServiceUpdateRecommendedApplyByDate field's value.

func (*UpdateAction) SetServiceUpdateReleaseDate added in v1.19.43 

func (s *UpdateAction) SetServiceUpdateReleaseDate(v time.Time) *UpdateAction

SetServiceUpdateReleaseDate sets the ServiceUpdateReleaseDate field's value.

func (*UpdateAction) SetServiceUpdateSeverity added in v1.19.43 

func (s *UpdateAction) SetServiceUpdateSeverity(v string) *UpdateAction

SetServiceUpdateSeverity sets the ServiceUpdateSeverity field's value.

func (*UpdateAction) SetServiceUpdateStatus added in v1.19.43 

func (s *UpdateAction) SetServiceUpdateStatus(v string) *UpdateAction

SetServiceUpdateStatus sets the ServiceUpdateStatus field's value.

func (*UpdateAction) SetServiceUpdateType added in v1.19.43 

func (s *UpdateAction) SetServiceUpdateType(v string) *UpdateAction

SetServiceUpdateType sets the ServiceUpdateType field's value.

func (*UpdateAction) SetSlaMet added in v1.19.43 

func (s *UpdateAction) SetSlaMet(v string) *UpdateAction

SetSlaMet sets the SlaMet field's value.

func (*UpdateAction) SetUpdateActionAvailableDate added in v1.19.43 

func (s *UpdateAction) SetUpdateActionAvailableDate(v time.Time) *UpdateAction

SetUpdateActionAvailableDate sets the UpdateActionAvailableDate field's value.

func (*UpdateAction) SetUpdateActionStatus added in v1.19.43 

func (s *UpdateAction) SetUpdateActionStatus(v string) *UpdateAction

SetUpdateActionStatus sets the UpdateActionStatus field's value.

func (*UpdateAction) SetUpdateActionStatusModifiedDate added in v1.19.43 

func (s *UpdateAction) SetUpdateActionStatusModifiedDate(v time.Time) *UpdateAction

SetUpdateActionStatusModifiedDate sets the UpdateActionStatusModifiedDate field's value.

func (UpdateAction) String added in v1.19.43 

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 added in v1.35.5 

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 added in v1.35.5 

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 added in v1.35.5 

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

SetARN sets the ARN field's value.

func (*User) SetAccessString added in v1.35.5 

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

SetAccessString sets the AccessString field's value.

func (*User) SetAuthentication added in v1.35.5 

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

SetAuthentication sets the Authentication field's value.

func (*User) SetEngine added in v1.35.5 

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

SetEngine sets the Engine field's value.

func (*User) SetMinimumEngineVersion added in v1.42.11 

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

SetMinimumEngineVersion sets the MinimumEngineVersion field's value.

func (*User) SetStatus added in v1.35.5 

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

SetStatus sets the Status field's value.

func (*User) SetUserGroupIds added in v1.35.5 

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

SetUserGroupIds sets the UserGroupIds field's value.

func (*User) SetUserId added in v1.35.5 

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

SetUserId sets the UserId field's value.

func (*User) SetUserName added in v1.35.5 

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

SetUserName sets the UserName field's value.

func (User) String added in v1.35.5 

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 added in v1.35.5 

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 which serverless caches the specified user group is associated
	// with. Available for Redis only.
	ServerlessCaches []*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 added in v1.35.5 

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 added in v1.35.5 

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

SetARN sets the ARN field's value.

func (*UserGroup) SetEngine added in v1.35.5 

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

SetEngine sets the Engine field's value.

func (*UserGroup) SetMinimumEngineVersion added in v1.42.11 

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

SetMinimumEngineVersion sets the MinimumEngineVersion field's value.

func (*UserGroup) SetPendingChanges added in v1.35.5 

func (s *UserGroup) SetPendingChanges(v *UserGroupPendingChanges) *UserGroup

SetPendingChanges sets the PendingChanges field's value.

func (*UserGroup) SetReplicationGroups added in v1.35.5 

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

SetReplicationGroups sets the ReplicationGroups field's value.

func (*UserGroup) SetServerlessCaches added in v1.48.6 

func (s *UserGroup) SetServerlessCaches(v []*string) *UserGroup

SetServerlessCaches sets the ServerlessCaches field's value.

func (*UserGroup) SetStatus added in v1.35.5 

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

SetStatus sets the Status field's value.

func (*UserGroup) SetUserGroupId added in v1.35.5 

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

SetUserGroupId sets the UserGroupId field's value.

func (*UserGroup) SetUserIds added in v1.35.5 

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

SetUserIds sets the UserIds field's value.

func (UserGroup) String added in v1.35.5 

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 added in v1.35.5 

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 added in v1.35.5 

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 added in v1.35.5 

func (s *UserGroupPendingChanges) SetUserIdsToAdd(v []*string) *UserGroupPendingChanges

SetUserIdsToAdd sets the UserIdsToAdd field's value.

func (*UserGroupPendingChanges) SetUserIdsToRemove added in v1.35.5 

func (s *UserGroupPendingChanges) SetUserIdsToRemove(v []*string) *UserGroupPendingChanges

SetUserIdsToRemove sets the UserIdsToRemove field's value.

func (UserGroupPendingChanges) String added in v1.35.5 

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 added in v1.35.5 

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 added in v1.35.5 

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 added in v1.35.5 

func (s *UserGroupsUpdateStatus) SetUserGroupIdsToAdd(v []*string) *UserGroupsUpdateStatus

SetUserGroupIdsToAdd sets the UserGroupIdsToAdd field's value.

func (*UserGroupsUpdateStatus) SetUserGroupIdsToRemove added in v1.35.5 

func (s *UserGroupsUpdateStatus) SetUserGroupIdsToRemove(v []*string) *UserGroupsUpdateStatus

SetUserGroupIdsToRemove sets the UserGroupIdsToRemove field's value.

func (UserGroupsUpdateStatus) String added in v1.35.5 

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

Source Files

View all Source files

Directories

Path Synopsis
Package elasticacheiface provides an interface to enable mocking the Amazon ElastiCache service client for testing your code.
 Package elasticacheiface provides an interface to enable mocking the Amazon ElastiCache service client for testing your code.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.