types

package
v1.3.0 Latest Latest
Warning

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

 Go to latest Published: Apr 8, 2021 License: Apache-2.0 Imports: 3 Imported by: 21

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type APICallRateForCustomerExceededFault 

type APICallRateForCustomerExceededFault struct {
	Message *string
}

The customer has exceeded the allowed rate of API calls.

func (*APICallRateForCustomerExceededFault) Error 

func (e *APICallRateForCustomerExceededFault) Error() string

func (*APICallRateForCustomerExceededFault) ErrorCode 

func (e *APICallRateForCustomerExceededFault) ErrorCode() string

func (*APICallRateForCustomerExceededFault) ErrorFault 

func (e *APICallRateForCustomerExceededFault) ErrorFault() smithy.ErrorFault

func (*APICallRateForCustomerExceededFault) ErrorMessage 

func (e *APICallRateForCustomerExceededFault) ErrorMessage() string

type AZMode 

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

Enum values for AZMode

func (AZMode) Values added in v0.29.0 

func (AZMode) Values() []AZMode

Values returns all known values for AZMode. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type AuthTokenUpdateStatus 

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

Enum values for AuthTokenUpdateStatus

func (AuthTokenUpdateStatus) Values added in v0.29.0 

func (AuthTokenUpdateStatus) Values() []AuthTokenUpdateStatus

Values returns all known values for AuthTokenUpdateStatus. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type AuthTokenUpdateStrategyType 

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

Enum values for AuthTokenUpdateStrategyType

func (AuthTokenUpdateStrategyType) Values added in v0.29.0 

func (AuthTokenUpdateStrategyType) Values() []AuthTokenUpdateStrategyType

Values returns all known values for AuthTokenUpdateStrategyType. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type Authentication added in v0.29.0 

type Authentication struct {

	// The number of passwords belonging to the user. The maximum is two.
	PasswordCount *int32

	// Indicates whether the user requires a password to authenticate.
	Type AuthenticationType
}

Indicates whether the user requires a password to authenticate.

type AuthenticationType added in v0.29.0 

type AuthenticationType string
const (
	AuthenticationTypePassword   AuthenticationType = "password"
	AuthenticationTypeNoPassword AuthenticationType = "no-password"
)

Enum values for AuthenticationType

func (AuthenticationType) Values added in v0.29.0 

func (AuthenticationType) Values() []AuthenticationType

Values returns all known values for AuthenticationType. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type AuthorizationAlreadyExistsFault 

type AuthorizationAlreadyExistsFault struct {
	Message *string
}

The specified Amazon EC2 security group is already authorized for the specified cache security group.

func (*AuthorizationAlreadyExistsFault) Error 

func (e *AuthorizationAlreadyExistsFault) Error() string

func (*AuthorizationAlreadyExistsFault) ErrorCode 

func (e *AuthorizationAlreadyExistsFault) ErrorCode() string

func (*AuthorizationAlreadyExistsFault) ErrorFault 

func (e *AuthorizationAlreadyExistsFault) ErrorFault() smithy.ErrorFault

func (*AuthorizationAlreadyExistsFault) ErrorMessage 

func (e *AuthorizationAlreadyExistsFault) ErrorMessage() string

type AuthorizationNotFoundFault 

type AuthorizationNotFoundFault struct {
	Message *string
}

The specified Amazon EC2 security group is not authorized for the specified cache security group.

func (*AuthorizationNotFoundFault) Error 

func (e *AuthorizationNotFoundFault) Error() string

func (*AuthorizationNotFoundFault) ErrorCode 

func (e *AuthorizationNotFoundFault) ErrorCode() string

func (*AuthorizationNotFoundFault) ErrorFault 

func (e *AuthorizationNotFoundFault) ErrorFault() smithy.ErrorFault

func (*AuthorizationNotFoundFault) ErrorMessage 

func (e *AuthorizationNotFoundFault) ErrorMessage() string

type AutomaticFailoverStatus 

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

Enum values for AutomaticFailoverStatus

func (AutomaticFailoverStatus) Values added in v0.29.0 

func (AutomaticFailoverStatus) Values() []AutomaticFailoverStatus

Values returns all known values for AutomaticFailoverStatus. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type AvailabilityZone 

type AvailabilityZone struct {

	// The name of the Availability Zone.
	Name *string
}

Describes an Availability Zone in which the cluster is launched.

type CacheCluster 

type CacheCluster struct {

	// The ARN (Amazon Resource Name) of the cache cluster.
	ARN *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

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

	// The date the auth token was last modified
	AuthTokenLastModifiedDate *time.Time

	// This parameter is currently disabled.
	AutoMinorVersionUpgrade bool

	// The date and time when the cluster was created.
	CacheClusterCreateTime *time.Time

	// The user-supplied identifier of the cluster. This identifier is a unique key
	// that identifies a cluster.
	CacheClusterId *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

	// The name of the compute and memory capacity node type for the cluster. The
	// following node types are supported by ElastiCache. Generally speaking, the
	// current generation types provide more memory and computational power at lower
	// cost when compared to their equivalent previous generation counterparts.
	//
	// *
	// General purpose:
	//
	// * Current generation: M6g node types (available only for Redis
	// engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward).
	// cache.m6g.large, cache.m6g.xlarge, cache.m6g.2xlarge, cache.m6g.4xlarge,
	// cache.m6g.8xlarge, cache.m6g.12xlarge, cache.m6g.16xlarge For region
	// availability, see Supported Node Types
	// (https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/CacheNodes.SupportedTypes.html#CacheNodes.SupportedTypesByRegion)
	// M5 node types: cache.m5.large, cache.m5.xlarge, cache.m5.2xlarge,
	// cache.m5.4xlarge, cache.m5.12xlarge, cache.m5.24xlarge M4 node types:
	// cache.m4.large, cache.m4.xlarge, cache.m4.2xlarge, cache.m4.4xlarge,
	// cache.m4.10xlarge T3 node types: cache.t3.micro, cache.t3.small, cache.t3.medium
	// T2 node types: cache.t2.micro, cache.t2.small, cache.t2.medium
	//
	// * Previous
	// generation: (not recommended) T1 node types: cache.t1.micro M1 node types:
	// cache.m1.small, cache.m1.medium, cache.m1.large, cache.m1.xlarge M3 node types:
	// cache.m3.medium, cache.m3.large, cache.m3.xlarge, cache.m3.2xlarge
	//
	// * Compute
	// optimized:
	//
	// * Previous generation: (not recommended) C1 node types:
	// cache.c1.xlarge
	//
	// * Memory optimized:
	//
	// * Current generation: R6g node types
	// (available only for Redis engine version 5.0.6 onward and for Memcached engine
	// version 1.5.16 onward). cache.r6g.large, cache.r6g.xlarge, cache.r6g.2xlarge,
	// cache.r6g.4xlarge, cache.r6g.8xlarge, cache.r6g.12xlarge, cache.r6g.16xlarge For
	// region availability, see Supported Node Types
	// (https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/CacheNodes.SupportedTypes.html#CacheNodes.SupportedTypesByRegion)
	// R5 node types: cache.r5.large, cache.r5.xlarge, cache.r5.2xlarge,
	// cache.r5.4xlarge, cache.r5.12xlarge, cache.r5.24xlarge R4 node types:
	// cache.r4.large, cache.r4.xlarge, cache.r4.2xlarge, cache.r4.4xlarge,
	// cache.r4.8xlarge, cache.r4.16xlarge
	//
	// * Previous generation: (not recommended) 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

	// A list of cache nodes that are members of the cluster.
	CacheNodes []CacheNode

	// Status of the cache parameter group.
	CacheParameterGroup *CacheParameterGroupStatus

	// A list of cache security group elements, composed of name and status
	// sub-elements.
	CacheSecurityGroups []CacheSecurityGroupMembership

	// The name of the cache subnet group associated with the cluster.
	CacheSubnetGroupName *string

	// The URL of the web page where you can download the latest ElastiCache client
	// library.
	ClientDownloadLandingPage *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

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

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

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

	// The number of cache nodes in the cluster. For clusters running Redis, this value
	// must be 1. For clusters running Memcached, this value must be between 1 and 20.
	NumCacheNodes *int32

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

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

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

	// The outpost ARN in which the cache cluster is created.
	PreferredOutpostArn *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

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

	// 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 *int32

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

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

Contains all of the attributes of a specific cluster.

type CacheClusterAlreadyExistsFault 

type CacheClusterAlreadyExistsFault struct {
	Message *string
}

You already have a cluster with the given identifier.

func (*CacheClusterAlreadyExistsFault) Error 

func (e *CacheClusterAlreadyExistsFault) Error() string

func (*CacheClusterAlreadyExistsFault) ErrorCode 

func (e *CacheClusterAlreadyExistsFault) ErrorCode() string

func (*CacheClusterAlreadyExistsFault) ErrorFault 

func (e *CacheClusterAlreadyExistsFault) ErrorFault() smithy.ErrorFault

func (*CacheClusterAlreadyExistsFault) ErrorMessage 

func (e *CacheClusterAlreadyExistsFault) ErrorMessage() string

type CacheClusterNotFoundFault 

type CacheClusterNotFoundFault struct {
	Message *string
}

The requested cluster ID does not refer to an existing cluster.

func (*CacheClusterNotFoundFault) Error 

func (e *CacheClusterNotFoundFault) Error() string

func (*CacheClusterNotFoundFault) ErrorCode 

func (e *CacheClusterNotFoundFault) ErrorCode() string

func (*CacheClusterNotFoundFault) ErrorFault 

func (e *CacheClusterNotFoundFault) ErrorFault() smithy.ErrorFault

func (*CacheClusterNotFoundFault) ErrorMessage 

func (e *CacheClusterNotFoundFault) ErrorMessage() string

type CacheEngineVersion 

type CacheEngineVersion struct {

	// The description of the cache engine.
	CacheEngineDescription *string

	// The description of the cache engine version.
	CacheEngineVersionDescription *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 |
	CacheParameterGroupFamily *string

	// The name of the cache engine.
	Engine *string

	// The version number of the cache engine.
	EngineVersion *string
}

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

type CacheNode 

type CacheNode struct {

	// The date and time when the cache node was created.
	CacheNodeCreateTime *time.Time

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

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

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

	// The customer outpost ARN of the cache node.
	CustomerOutpostArn *string

	// The hostname for connecting to this cache node.
	Endpoint *Endpoint

	// The status of the parameter group applied to this cache node.
	ParameterGroupStatus *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
}

Represents an individual cache node within a cluster. Each cache node runs its own instance of the cluster's protocol-compliant caching software - either Memcached or Redis. The following node types are supported by ElastiCache. Generally speaking, the current generation types provide more memory and computational power at lower cost when compared to their equivalent previous generation counterparts.

* General purpose:

* Current generation: M6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward). cache.m6g.large, cache.m6g.xlarge, cache.m6g.2xlarge, cache.m6g.4xlarge, cache.m6g.8xlarge, cache.m6g.12xlarge, cache.m6g.16xlarge For region availability, see Supported Node Types (https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/CacheNodes.SupportedTypes.html#CacheNodes.SupportedTypesByRegion) M5 node types: cache.m5.large, cache.m5.xlarge, cache.m5.2xlarge, cache.m5.4xlarge, cache.m5.12xlarge, cache.m5.24xlarge M4 node types: cache.m4.large, cache.m4.xlarge, cache.m4.2xlarge, cache.m4.4xlarge, cache.m4.10xlarge T3 node types: cache.t3.micro, cache.t3.small, cache.t3.medium T2 node types: cache.t2.micro, cache.t2.small, cache.t2.medium

* Previous generation: (not recommended) T1 node types: cache.t1.micro M1 node types: cache.m1.small, cache.m1.medium, cache.m1.large, cache.m1.xlarge M3 node types: cache.m3.medium, cache.m3.large, cache.m3.xlarge, cache.m3.2xlarge

* Compute optimized:

* Previous generation: (not recommended) C1 node types: cache.c1.xlarge

* Memory optimized:

* Current generation: R6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward). cache.r6g.large, cache.r6g.xlarge, cache.r6g.2xlarge, cache.r6g.4xlarge, cache.r6g.8xlarge, cache.r6g.12xlarge, cache.r6g.16xlarge For region availability, see Supported Node Types (https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/CacheNodes.SupportedTypes.html#CacheNodes.SupportedTypesByRegion) R5 node types: cache.r5.large, cache.r5.xlarge, cache.r5.2xlarge, cache.r5.4xlarge, cache.r5.12xlarge, cache.r5.24xlarge R4 node types: cache.r4.large, cache.r4.xlarge, cache.r4.2xlarge, cache.r4.4xlarge, cache.r4.8xlarge, cache.r4.16xlarge

* Previous generation: (not recommended) 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.

type CacheNodeTypeSpecificParameter 

type CacheNodeTypeSpecificParameter struct {

	// The valid range of values for the parameter.
	AllowedValues *string

	// A list of cache node types and their corresponding values for this parameter.
	CacheNodeTypeSpecificValues []CacheNodeTypeSpecificValue

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

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

	// A description of the parameter.
	Description *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

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

	// The name of the parameter.
	ParameterName *string

	// The source of the parameter value.
	Source *string
}

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.

type CacheNodeTypeSpecificValue 

type CacheNodeTypeSpecificValue struct {

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

	// The value for the cache node type.
	Value *string
}

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

type CacheNodeUpdateStatus 

type CacheNodeUpdateStatus struct {

	// The node ID of the cache cluster
	CacheNodeId *string

	// The deletion date of the node
	NodeDeletionDate *time.Time

	// The end date of the update for a node
	NodeUpdateEndDate *time.Time

	// Reflects whether the update was initiated by the customer or automatically
	// applied
	NodeUpdateInitiatedBy NodeUpdateInitiatedBy

	// The date when the update is triggered
	NodeUpdateInitiatedDate *time.Time

	// The start date of the update for a node
	NodeUpdateStartDate *time.Time

	// The update status of the node
	NodeUpdateStatus NodeUpdateStatus

	// The date when the NodeUpdateStatus was last modified>
	NodeUpdateStatusModifiedDate *time.Time
}

The status of the service update on the cache node

type CacheParameterGroup 

type CacheParameterGroup struct {

	// The ARN (Amazon Resource Name) of the cache parameter group.
	ARN *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 |
	CacheParameterGroupFamily *string

	// The name of the cache parameter group.
	CacheParameterGroupName *string

	// The description for this cache parameter group.
	Description *string

	// Indicates whether the parameter group is associated with a Global datastore
	IsGlobal bool
}

Represents the output of a CreateCacheParameterGroup operation.

type CacheParameterGroupAlreadyExistsFault 

type CacheParameterGroupAlreadyExistsFault struct {
	Message *string
}

A cache parameter group with the requested name already exists.

func (*CacheParameterGroupAlreadyExistsFault) Error 

func (e *CacheParameterGroupAlreadyExistsFault) Error() string

func (*CacheParameterGroupAlreadyExistsFault) ErrorCode 

func (e *CacheParameterGroupAlreadyExistsFault) ErrorCode() string

func (*CacheParameterGroupAlreadyExistsFault) ErrorFault 

func (e *CacheParameterGroupAlreadyExistsFault) ErrorFault() smithy.ErrorFault

func (*CacheParameterGroupAlreadyExistsFault) ErrorMessage 

func (e *CacheParameterGroupAlreadyExistsFault) ErrorMessage() string

type CacheParameterGroupNotFoundFault 

type CacheParameterGroupNotFoundFault struct {
	Message *string
}

The requested cache parameter group name does not refer to an existing cache parameter group.

func (*CacheParameterGroupNotFoundFault) Error 

func (e *CacheParameterGroupNotFoundFault) Error() string

func (*CacheParameterGroupNotFoundFault) ErrorCode 

func (e *CacheParameterGroupNotFoundFault) ErrorCode() string

func (*CacheParameterGroupNotFoundFault) ErrorFault 

func (e *CacheParameterGroupNotFoundFault) ErrorFault() smithy.ErrorFault

func (*CacheParameterGroupNotFoundFault) ErrorMessage 

func (e *CacheParameterGroupNotFoundFault) ErrorMessage() string

type CacheParameterGroupQuotaExceededFault 

type CacheParameterGroupQuotaExceededFault struct {
	Message *string
}

The request cannot be processed because it would exceed the maximum number of cache security groups.

func (*CacheParameterGroupQuotaExceededFault) Error 

func (e *CacheParameterGroupQuotaExceededFault) Error() string

func (*CacheParameterGroupQuotaExceededFault) ErrorCode 

func (e *CacheParameterGroupQuotaExceededFault) ErrorCode() string

func (*CacheParameterGroupQuotaExceededFault) ErrorFault 

func (e *CacheParameterGroupQuotaExceededFault) ErrorFault() smithy.ErrorFault

func (*CacheParameterGroupQuotaExceededFault) ErrorMessage 

func (e *CacheParameterGroupQuotaExceededFault) ErrorMessage() string

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

	// The name of the cache parameter group.
	CacheParameterGroupName *string

	// The status of parameter updates.
	ParameterApplyStatus *string
}

Status of the cache parameter group.

type CacheSecurityGroup 

type CacheSecurityGroup struct {

	// The ARN of the cache security group,
	ARN *string

	// The name of the cache security group.
	CacheSecurityGroupName *string

	// The description of the cache security group.
	Description *string

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

	// The AWS account ID of the cache security group owner.
	OwnerId *string
}

Represents the output of one of the following operations:

* AuthorizeCacheSecurityGroupIngress

* CreateCacheSecurityGroup

* RevokeCacheSecurityGroupIngress

type CacheSecurityGroupAlreadyExistsFault 

type CacheSecurityGroupAlreadyExistsFault struct {
	Message *string
}

A cache security group with the specified name already exists.

func (*CacheSecurityGroupAlreadyExistsFault) Error 

func (e *CacheSecurityGroupAlreadyExistsFault) Error() string

func (*CacheSecurityGroupAlreadyExistsFault) ErrorCode 

func (e *CacheSecurityGroupAlreadyExistsFault) ErrorCode() string

func (*CacheSecurityGroupAlreadyExistsFault) ErrorFault 

func (e *CacheSecurityGroupAlreadyExistsFault) ErrorFault() smithy.ErrorFault

func (*CacheSecurityGroupAlreadyExistsFault) ErrorMessage 

func (e *CacheSecurityGroupAlreadyExistsFault) ErrorMessage() string

type CacheSecurityGroupMembership 

type CacheSecurityGroupMembership struct {

	// The name of the cache security group.
	CacheSecurityGroupName *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
}

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

type CacheSecurityGroupNotFoundFault 

type CacheSecurityGroupNotFoundFault struct {
	Message *string
}

The requested cache security group name does not refer to an existing cache security group.

func (*CacheSecurityGroupNotFoundFault) Error 

func (e *CacheSecurityGroupNotFoundFault) Error() string

func (*CacheSecurityGroupNotFoundFault) ErrorCode 

func (e *CacheSecurityGroupNotFoundFault) ErrorCode() string

func (*CacheSecurityGroupNotFoundFault) ErrorFault 

func (e *CacheSecurityGroupNotFoundFault) ErrorFault() smithy.ErrorFault

func (*CacheSecurityGroupNotFoundFault) ErrorMessage 

func (e *CacheSecurityGroupNotFoundFault) ErrorMessage() string

type CacheSecurityGroupQuotaExceededFault 

type CacheSecurityGroupQuotaExceededFault struct {
	Message *string
}

The request cannot be processed because it would exceed the allowed number of cache security groups.

func (*CacheSecurityGroupQuotaExceededFault) Error 

func (e *CacheSecurityGroupQuotaExceededFault) Error() string

func (*CacheSecurityGroupQuotaExceededFault) ErrorCode 

func (e *CacheSecurityGroupQuotaExceededFault) ErrorCode() string

func (*CacheSecurityGroupQuotaExceededFault) ErrorFault 

func (e *CacheSecurityGroupQuotaExceededFault) ErrorFault() smithy.ErrorFault

func (*CacheSecurityGroupQuotaExceededFault) ErrorMessage 

func (e *CacheSecurityGroupQuotaExceededFault) ErrorMessage() string

type CacheSubnetGroup 

type CacheSubnetGroup struct {

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

	// The description of the cache subnet group.
	CacheSubnetGroupDescription *string

	// The name of the cache subnet group.
	CacheSubnetGroupName *string

	// A list of subnets associated with the cache subnet group.
	Subnets []Subnet

	// The Amazon Virtual Private Cloud identifier (VPC ID) of the cache subnet group.
	VpcId *string
}

Represents the output of one of the following operations:

* CreateCacheSubnetGroup

* ModifyCacheSubnetGroup

type CacheSubnetGroupAlreadyExistsFault 

type CacheSubnetGroupAlreadyExistsFault struct {
	Message *string
}

The requested cache subnet group name is already in use by an existing cache subnet group.

func (*CacheSubnetGroupAlreadyExistsFault) Error 

func (e *CacheSubnetGroupAlreadyExistsFault) Error() string

func (*CacheSubnetGroupAlreadyExistsFault) ErrorCode 

func (e *CacheSubnetGroupAlreadyExistsFault) ErrorCode() string

func (*CacheSubnetGroupAlreadyExistsFault) ErrorFault 

func (e *CacheSubnetGroupAlreadyExistsFault) ErrorFault() smithy.ErrorFault

func (*CacheSubnetGroupAlreadyExistsFault) ErrorMessage 

func (e *CacheSubnetGroupAlreadyExistsFault) ErrorMessage() string

type CacheSubnetGroupInUse 

type CacheSubnetGroupInUse struct {
	Message *string
}

The requested cache subnet group is currently in use.

func (*CacheSubnetGroupInUse) Error 

func (e *CacheSubnetGroupInUse) Error() string

func (*CacheSubnetGroupInUse) ErrorCode 

func (e *CacheSubnetGroupInUse) ErrorCode() string

func (*CacheSubnetGroupInUse) ErrorFault 

func (e *CacheSubnetGroupInUse) ErrorFault() smithy.ErrorFault

func (*CacheSubnetGroupInUse) ErrorMessage 

func (e *CacheSubnetGroupInUse) ErrorMessage() string

type CacheSubnetGroupNotFoundFault 

type CacheSubnetGroupNotFoundFault struct {
	Message *string
}

The requested cache subnet group name does not refer to an existing cache subnet group.

func (*CacheSubnetGroupNotFoundFault) Error 

func (e *CacheSubnetGroupNotFoundFault) Error() string

func (*CacheSubnetGroupNotFoundFault) ErrorCode 

func (e *CacheSubnetGroupNotFoundFault) ErrorCode() string

func (*CacheSubnetGroupNotFoundFault) ErrorFault 

func (e *CacheSubnetGroupNotFoundFault) ErrorFault() smithy.ErrorFault

func (*CacheSubnetGroupNotFoundFault) ErrorMessage 

func (e *CacheSubnetGroupNotFoundFault) ErrorMessage() string

type CacheSubnetGroupQuotaExceededFault 

type CacheSubnetGroupQuotaExceededFault struct {
	Message *string
}

The request cannot be processed because it would exceed the allowed number of cache subnet groups.

func (*CacheSubnetGroupQuotaExceededFault) Error 

func (e *CacheSubnetGroupQuotaExceededFault) Error() string

func (*CacheSubnetGroupQuotaExceededFault) ErrorCode 

func (e *CacheSubnetGroupQuotaExceededFault) ErrorCode() string

func (*CacheSubnetGroupQuotaExceededFault) ErrorFault 

func (e *CacheSubnetGroupQuotaExceededFault) ErrorFault() smithy.ErrorFault

func (*CacheSubnetGroupQuotaExceededFault) ErrorMessage 

func (e *CacheSubnetGroupQuotaExceededFault) ErrorMessage() string

type CacheSubnetQuotaExceededFault 

type CacheSubnetQuotaExceededFault struct {
	Message *string
}

The request cannot be processed because it would exceed the allowed number of subnets in a cache subnet group.

func (*CacheSubnetQuotaExceededFault) Error 

func (e *CacheSubnetQuotaExceededFault) Error() string

func (*CacheSubnetQuotaExceededFault) ErrorCode 

func (e *CacheSubnetQuotaExceededFault) ErrorCode() string

func (*CacheSubnetQuotaExceededFault) ErrorFault 

func (e *CacheSubnetQuotaExceededFault) ErrorFault() smithy.ErrorFault

func (*CacheSubnetQuotaExceededFault) ErrorMessage 

func (e *CacheSubnetQuotaExceededFault) ErrorMessage() string

type ChangeType 

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

Enum values for ChangeType

func (ChangeType) Values added in v0.29.0 

func (ChangeType) Values() []ChangeType

Values returns all known values for ChangeType. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type ClusterQuotaForCustomerExceededFault 

type ClusterQuotaForCustomerExceededFault struct {
	Message *string
}

The request cannot be processed because it would exceed the allowed number of clusters per customer.

func (*ClusterQuotaForCustomerExceededFault) Error 

func (e *ClusterQuotaForCustomerExceededFault) Error() string

func (*ClusterQuotaForCustomerExceededFault) ErrorCode 

func (e *ClusterQuotaForCustomerExceededFault) ErrorCode() string

func (*ClusterQuotaForCustomerExceededFault) ErrorFault 

func (e *ClusterQuotaForCustomerExceededFault) ErrorFault() smithy.ErrorFault

func (*ClusterQuotaForCustomerExceededFault) ErrorMessage 

func (e *ClusterQuotaForCustomerExceededFault) ErrorMessage() string

type ConfigureShard 

type ConfigureShard struct {

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

	// 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).
	//
	// This member is required.
	NodeGroupId *string

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

	// The outpost ARNs in which the cache cluster is created.
	PreferredOutpostArns []string
}

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

type CustomerNodeEndpoint 

type CustomerNodeEndpoint struct {

	// The address of the node endpoint
	Address *string

	// The port of the node endpoint
	Port *int32
}

The endpoint from which data should be migrated.

type DefaultUserAssociatedToUserGroupFault added in v0.29.0 

type DefaultUserAssociatedToUserGroupFault struct {
	Message *string
}

func (*DefaultUserAssociatedToUserGroupFault) Error added in v0.29.0 

func (e *DefaultUserAssociatedToUserGroupFault) Error() string

func (*DefaultUserAssociatedToUserGroupFault) ErrorCode added in v0.29.0 

func (e *DefaultUserAssociatedToUserGroupFault) ErrorCode() string

func (*DefaultUserAssociatedToUserGroupFault) ErrorFault added in v0.29.0 

func (e *DefaultUserAssociatedToUserGroupFault) ErrorFault() smithy.ErrorFault

func (*DefaultUserAssociatedToUserGroupFault) ErrorMessage added in v0.29.0 

func (e *DefaultUserAssociatedToUserGroupFault) ErrorMessage() string

type DefaultUserRequired added in v0.29.0 

type DefaultUserRequired struct {
	Message *string
}

You must add default user to a user group.

func (*DefaultUserRequired) Error added in v0.29.0 

func (e *DefaultUserRequired) Error() string

func (*DefaultUserRequired) ErrorCode added in v0.29.0 

func (e *DefaultUserRequired) ErrorCode() string

func (*DefaultUserRequired) ErrorFault added in v0.29.0 

func (e *DefaultUserRequired) ErrorFault() smithy.ErrorFault

func (*DefaultUserRequired) ErrorMessage added in v0.29.0 

func (e *DefaultUserRequired) ErrorMessage() string

type DuplicateUserNameFault added in v0.29.0 

type DuplicateUserNameFault struct {
	Message *string
}

A user with this username already exists.

func (*DuplicateUserNameFault) Error added in v0.29.0 

func (e *DuplicateUserNameFault) Error() string

func (*DuplicateUserNameFault) ErrorCode added in v0.29.0 

func (e *DuplicateUserNameFault) ErrorCode() string

func (*DuplicateUserNameFault) ErrorFault added in v0.29.0 

func (e *DuplicateUserNameFault) ErrorFault() smithy.ErrorFault

func (*DuplicateUserNameFault) ErrorMessage added in v0.29.0 

func (e *DuplicateUserNameFault) ErrorMessage() string

type EC2SecurityGroup 

type EC2SecurityGroup struct {

	// The name of the Amazon EC2 security group.
	EC2SecurityGroupName *string

	// The AWS account ID of the Amazon EC2 security group owner.
	EC2SecurityGroupOwnerId *string

	// The status of the Amazon EC2 security group.
	Status *string
}

Provides ownership and status information for an Amazon EC2 security group.

type Endpoint 

type Endpoint struct {

	// The DNS hostname of the cache node.
	Address *string

	// The port number that the cache engine is listening on.
	Port int32
}

Represents the information required for client programs to connect to a cache node.

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

	// 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.x |
	CacheParameterGroupFamily *string

	// Provides an identifier to allow retrieval of paginated results.
	Marker *string

	// Contains a list of engine default parameters.
	Parameters []Parameter
}

Represents the output of a DescribeEngineDefaultParameters operation.

type Event 

type Event struct {

	// The date and time when the event occurred.
	Date *time.Time

	// The text of the event.
	Message *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

	// Specifies the origin of this event - a cluster, a parameter group, a security
	// group, etc.
	SourceType SourceType
}

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.

type Filter added in v0.29.0 

type Filter struct {

	// The property being filtered. For example, UserId.
	//
	// This member is required.
	Name *string

	// The property values to filter on. For example, "user-123".
	//
	// This member is required.
	Values []string
}

Used to streamline results of a search based on the property being filtered.

type GlobalNodeGroup 

type GlobalNodeGroup struct {

	// The name of the global node group
	GlobalNodeGroupId *string

	// The keyspace for this node group
	Slots *string
}

Indicates the slot configuration and global identifier for a slice group.

type GlobalReplicationGroup 

type GlobalReplicationGroup struct {

	// The ARN (Amazon Resource Name) of the global replication group.
	ARN *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

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

	// The cache node type of the Global datastore
	CacheNodeType *string

	// A flag that indicates whether the Global datastore is cluster enabled.
	ClusterEnabled *bool

	// The Elasticache engine. For Redis only.
	Engine *string

	// The Elasticache Redis engine version.
	EngineVersion *string

	// Indicates the slot configuration and global identifier for each slice group.
	GlobalNodeGroups []GlobalNodeGroup

	// The optional description of the Global datastore
	GlobalReplicationGroupDescription *string

	// The name of the Global datastore
	GlobalReplicationGroupId *string

	// The replication groups that comprise the Global datastore.
	Members []GlobalReplicationGroupMember

	// The status of the Global datastore
	Status *string

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

Consists of a primary cluster that accepts writes and an associated secondary cluster that resides in a different AWS region. The secondary cluster accepts only reads. The primary cluster automatically replicates updates to the secondary cluster.

* The GlobalReplicationGroupIdSuffix represents the name of the Global datastore, which is what you use to associate a secondary cluster.

type GlobalReplicationGroupAlreadyExistsFault 

type GlobalReplicationGroupAlreadyExistsFault struct {
	Message *string
}

The Global datastore name already exists.

func (*GlobalReplicationGroupAlreadyExistsFault) Error 

func (e *GlobalReplicationGroupAlreadyExistsFault) Error() string

func (*GlobalReplicationGroupAlreadyExistsFault) ErrorCode 

func (e *GlobalReplicationGroupAlreadyExistsFault) ErrorCode() string

func (*GlobalReplicationGroupAlreadyExistsFault) ErrorFault 

func (e *GlobalReplicationGroupAlreadyExistsFault) ErrorFault() smithy.ErrorFault

func (*GlobalReplicationGroupAlreadyExistsFault) ErrorMessage 

func (e *GlobalReplicationGroupAlreadyExistsFault) ErrorMessage() string

type GlobalReplicationGroupInfo 

type GlobalReplicationGroupInfo struct {

	// The name of the Global datastore
	GlobalReplicationGroupId *string

	// The role of the replication group in a Global datastore. Can be primary or
	// secondary.
	GlobalReplicationGroupMemberRole *string
}

The name of the Global datastore and role of this replication group in the Global datastore.

type GlobalReplicationGroupMember 

type GlobalReplicationGroupMember struct {

	// Indicates whether automatic failover is enabled for the replication group.
	AutomaticFailover AutomaticFailoverStatus

	// The replication group id of the Global datastore member.
	ReplicationGroupId *string

	// The AWS region of the Global datastore member.
	ReplicationGroupRegion *string

	// Indicates the role of the replication group, primary or secondary.
	Role *string

	// The status of the membership of the replication group.
	Status *string
}

A member of a Global datastore. It contains the Replication Group Id, the AWS region and the role of the replication group.

type GlobalReplicationGroupNotFoundFault 

type GlobalReplicationGroupNotFoundFault struct {
	Message *string
}

The Global datastore does not exist

func (*GlobalReplicationGroupNotFoundFault) Error 

func (e *GlobalReplicationGroupNotFoundFault) Error() string

func (*GlobalReplicationGroupNotFoundFault) ErrorCode 

func (e *GlobalReplicationGroupNotFoundFault) ErrorCode() string

func (*GlobalReplicationGroupNotFoundFault) ErrorFault 

func (e *GlobalReplicationGroupNotFoundFault) ErrorFault() smithy.ErrorFault

func (*GlobalReplicationGroupNotFoundFault) ErrorMessage 

func (e *GlobalReplicationGroupNotFoundFault) ErrorMessage() string

type InsufficientCacheClusterCapacityFault 

type InsufficientCacheClusterCapacityFault struct {
	Message *string
}

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.

func (*InsufficientCacheClusterCapacityFault) Error 

func (e *InsufficientCacheClusterCapacityFault) Error() string

func (*InsufficientCacheClusterCapacityFault) ErrorCode 

func (e *InsufficientCacheClusterCapacityFault) ErrorCode() string

func (*InsufficientCacheClusterCapacityFault) ErrorFault 

func (e *InsufficientCacheClusterCapacityFault) ErrorFault() smithy.ErrorFault

func (*InsufficientCacheClusterCapacityFault) ErrorMessage 

func (e *InsufficientCacheClusterCapacityFault) ErrorMessage() string

type InvalidARNFault 

type InvalidARNFault struct {
	Message *string
}

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

func (*InvalidARNFault) Error 

func (e *InvalidARNFault) Error() string

func (*InvalidARNFault) ErrorCode 

func (e *InvalidARNFault) ErrorCode() string

func (*InvalidARNFault) ErrorFault 

func (e *InvalidARNFault) ErrorFault() smithy.ErrorFault

func (*InvalidARNFault) ErrorMessage 

func (e *InvalidARNFault) ErrorMessage() string

type InvalidCacheClusterStateFault 

type InvalidCacheClusterStateFault struct {
	Message *string
}

The requested cluster is not in the available state.

func (*InvalidCacheClusterStateFault) Error 

func (e *InvalidCacheClusterStateFault) Error() string

func (*InvalidCacheClusterStateFault) ErrorCode 

func (e *InvalidCacheClusterStateFault) ErrorCode() string

func (*InvalidCacheClusterStateFault) ErrorFault 

func (e *InvalidCacheClusterStateFault) ErrorFault() smithy.ErrorFault

func (*InvalidCacheClusterStateFault) ErrorMessage 

func (e *InvalidCacheClusterStateFault) ErrorMessage() string

type InvalidCacheParameterGroupStateFault 

type InvalidCacheParameterGroupStateFault struct {
	Message *string
}

The current state of the cache parameter group does not allow the requested operation to occur.

func (*InvalidCacheParameterGroupStateFault) Error 

func (e *InvalidCacheParameterGroupStateFault) Error() string

func (*InvalidCacheParameterGroupStateFault) ErrorCode 

func (e *InvalidCacheParameterGroupStateFault) ErrorCode() string

func (*InvalidCacheParameterGroupStateFault) ErrorFault 

func (e *InvalidCacheParameterGroupStateFault) ErrorFault() smithy.ErrorFault

func (*InvalidCacheParameterGroupStateFault) ErrorMessage 

func (e *InvalidCacheParameterGroupStateFault) ErrorMessage() string

type InvalidCacheSecurityGroupStateFault 

type InvalidCacheSecurityGroupStateFault struct {
	Message *string
}

The current state of the cache security group does not allow deletion.

func (*InvalidCacheSecurityGroupStateFault) Error 

func (e *InvalidCacheSecurityGroupStateFault) Error() string

func (*InvalidCacheSecurityGroupStateFault) ErrorCode 

func (e *InvalidCacheSecurityGroupStateFault) ErrorCode() string

func (*InvalidCacheSecurityGroupStateFault) ErrorFault 

func (e *InvalidCacheSecurityGroupStateFault) ErrorFault() smithy.ErrorFault

func (*InvalidCacheSecurityGroupStateFault) ErrorMessage 

func (e *InvalidCacheSecurityGroupStateFault) ErrorMessage() string

type InvalidGlobalReplicationGroupStateFault 

type InvalidGlobalReplicationGroupStateFault struct {
	Message *string
}

The Global datastore is not available or in primary-only state.

func (*InvalidGlobalReplicationGroupStateFault) Error 

func (e *InvalidGlobalReplicationGroupStateFault) Error() string

func (*InvalidGlobalReplicationGroupStateFault) ErrorCode 

func (e *InvalidGlobalReplicationGroupStateFault) ErrorCode() string

func (*InvalidGlobalReplicationGroupStateFault) ErrorFault 

func (e *InvalidGlobalReplicationGroupStateFault) ErrorFault() smithy.ErrorFault

func (*InvalidGlobalReplicationGroupStateFault) ErrorMessage 

func (e *InvalidGlobalReplicationGroupStateFault) ErrorMessage() string

type InvalidKMSKeyFault 

type InvalidKMSKeyFault struct {
	Message *string
}

The KMS key supplied is not valid.

func (*InvalidKMSKeyFault) Error 

func (e *InvalidKMSKeyFault) Error() string

func (*InvalidKMSKeyFault) ErrorCode 

func (e *InvalidKMSKeyFault) ErrorCode() string

func (*InvalidKMSKeyFault) ErrorFault 

func (e *InvalidKMSKeyFault) ErrorFault() smithy.ErrorFault

func (*InvalidKMSKeyFault) ErrorMessage 

func (e *InvalidKMSKeyFault) ErrorMessage() string

type InvalidParameterCombinationException 

type InvalidParameterCombinationException struct {
	Message *string
}

Two or more incompatible parameters were specified.

func (*InvalidParameterCombinationException) Error 

func (e *InvalidParameterCombinationException) Error() string

func (*InvalidParameterCombinationException) ErrorCode 

func (e *InvalidParameterCombinationException) ErrorCode() string

func (*InvalidParameterCombinationException) ErrorFault 

func (e *InvalidParameterCombinationException) ErrorFault() smithy.ErrorFault

func (*InvalidParameterCombinationException) ErrorMessage 

func (e *InvalidParameterCombinationException) ErrorMessage() string

type InvalidParameterValueException 

type InvalidParameterValueException struct {
	Message *string
}

The value for a parameter is invalid.

func (*InvalidParameterValueException) Error 

func (e *InvalidParameterValueException) Error() string

func (*InvalidParameterValueException) ErrorCode 

func (e *InvalidParameterValueException) ErrorCode() string

func (*InvalidParameterValueException) ErrorFault 

func (e *InvalidParameterValueException) ErrorFault() smithy.ErrorFault

func (*InvalidParameterValueException) ErrorMessage 

func (e *InvalidParameterValueException) ErrorMessage() string

type InvalidReplicationGroupStateFault 

type InvalidReplicationGroupStateFault struct {
	Message *string
}

The requested replication group is not in the available state.

func (*InvalidReplicationGroupStateFault) Error 

func (e *InvalidReplicationGroupStateFault) Error() string

func (*InvalidReplicationGroupStateFault) ErrorCode 

func (e *InvalidReplicationGroupStateFault) ErrorCode() string

func (*InvalidReplicationGroupStateFault) ErrorFault 

func (e *InvalidReplicationGroupStateFault) ErrorFault() smithy.ErrorFault

func (*InvalidReplicationGroupStateFault) ErrorMessage 

func (e *InvalidReplicationGroupStateFault) ErrorMessage() string

type InvalidSnapshotStateFault 

type InvalidSnapshotStateFault struct {
	Message *string
}

The current state of the snapshot does not allow the requested operation to occur.

func (*InvalidSnapshotStateFault) Error 

func (e *InvalidSnapshotStateFault) Error() string

func (*InvalidSnapshotStateFault) ErrorCode 

func (e *InvalidSnapshotStateFault) ErrorCode() string

func (*InvalidSnapshotStateFault) ErrorFault 

func (e *InvalidSnapshotStateFault) ErrorFault() smithy.ErrorFault

func (*InvalidSnapshotStateFault) ErrorMessage 

func (e *InvalidSnapshotStateFault) ErrorMessage() string

type InvalidSubnet 

type InvalidSubnet struct {
	Message *string
}

An invalid subnet identifier was specified.

func (*InvalidSubnet) Error 

func (e *InvalidSubnet) Error() string

func (*InvalidSubnet) ErrorCode 

func (e *InvalidSubnet) ErrorCode() string

func (*InvalidSubnet) ErrorFault 

func (e *InvalidSubnet) ErrorFault() smithy.ErrorFault

func (*InvalidSubnet) ErrorMessage 

func (e *InvalidSubnet) ErrorMessage() string

type InvalidUserGroupStateFault added in v0.29.0 

type InvalidUserGroupStateFault struct {
	Message *string
}

The user group is not in an active state.

func (*InvalidUserGroupStateFault) Error added in v0.29.0 

func (e *InvalidUserGroupStateFault) Error() string

func (*InvalidUserGroupStateFault) ErrorCode added in v0.29.0 

func (e *InvalidUserGroupStateFault) ErrorCode() string

func (*InvalidUserGroupStateFault) ErrorFault added in v0.29.0 

func (e *InvalidUserGroupStateFault) ErrorFault() smithy.ErrorFault

func (*InvalidUserGroupStateFault) ErrorMessage added in v0.29.0 

func (e *InvalidUserGroupStateFault) ErrorMessage() string

type InvalidUserStateFault added in v0.29.0 

type InvalidUserStateFault struct {
	Message *string
}

The user is not in active state.

func (*InvalidUserStateFault) Error added in v0.29.0 

func (e *InvalidUserStateFault) Error() string

func (*InvalidUserStateFault) ErrorCode added in v0.29.0 

func (e *InvalidUserStateFault) ErrorCode() string

func (*InvalidUserStateFault) ErrorFault added in v0.29.0 

func (e *InvalidUserStateFault) ErrorFault() smithy.ErrorFault

func (*InvalidUserStateFault) ErrorMessage added in v0.29.0 

func (e *InvalidUserStateFault) ErrorMessage() string

type InvalidVPCNetworkStateFault 

type InvalidVPCNetworkStateFault struct {
	Message *string
}

The VPC network is in an invalid state.

func (*InvalidVPCNetworkStateFault) Error 

func (e *InvalidVPCNetworkStateFault) Error() string

func (*InvalidVPCNetworkStateFault) ErrorCode 

func (e *InvalidVPCNetworkStateFault) ErrorCode() string

func (*InvalidVPCNetworkStateFault) ErrorFault 

func (e *InvalidVPCNetworkStateFault) ErrorFault() smithy.ErrorFault

func (*InvalidVPCNetworkStateFault) ErrorMessage 

func (e *InvalidVPCNetworkStateFault) ErrorMessage() string

type MultiAZStatus 

type MultiAZStatus string
const (
	MultiAZStatusEnabled  MultiAZStatus = "enabled"
	MultiAZStatusDisabled MultiAZStatus = "disabled"
)

Enum values for MultiAZStatus

func (MultiAZStatus) Values added in v0.29.0 

func (MultiAZStatus) Values() []MultiAZStatus

Values returns all known values for MultiAZStatus. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type NoOperationFault 

type NoOperationFault struct {
	Message *string
}

The operation was not performed because no changes were required.

func (*NoOperationFault) Error 

func (e *NoOperationFault) Error() string

func (*NoOperationFault) ErrorCode 

func (e *NoOperationFault) ErrorCode() string

func (*NoOperationFault) ErrorFault 

func (e *NoOperationFault) ErrorFault() smithy.ErrorFault

func (*NoOperationFault) ErrorMessage 

func (e *NoOperationFault) ErrorMessage() string

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

	// A list containing information about individual nodes within the node group
	// (shard).
	NodeGroupMembers []NodeGroupMember

	// The endpoint of the primary node in this node group (shard).
	PrimaryEndpoint *Endpoint

	// The endpoint of the replica nodes in this node group (shard).
	ReaderEndpoint *Endpoint

	// The keyspace for this node group (shard).
	Slots *string

	// The current state of this replication group - creating, available, modifying,
	// deleting.
	Status *string
}

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.

type NodeGroupConfiguration 

type NodeGroupConfiguration struct {

	// Either the ElastiCache for Redis supplied 4-digit id or a user supplied id for
	// the node group these configuration values apply to.
	NodeGroupId *string

	// The Availability Zone where the primary node of this node group (shard) is
	// launched.
	PrimaryAvailabilityZone *string

	// The outpost ARN of the primary node.
	PrimaryOutpostArn *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

	// The number of read replica nodes in this node group (shard).
	ReplicaCount *int32

	// The outpost ARN of the node replicas.
	ReplicaOutpostArns []string

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

Node group (shard) configuration options. Each node group (shard) configuration has the following: Slots, PrimaryAvailabilityZone, ReplicaAvailabilityZones, ReplicaCount.

type NodeGroupMember 

type NodeGroupMember struct {

	// The ID of the cluster to which the node belongs.
	CacheClusterId *string

	// The ID of the node within its cluster. A node ID is a numeric identifier (0001,
	// 0002, etc.).
	CacheNodeId *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

	// The name of the Availability Zone in which the node is located.
	PreferredAvailabilityZone *string

	// The outpost ARN of the node group member.
	PreferredOutpostArn *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
}

Represents a single node within a node group (shard).

type NodeGroupMemberUpdateStatus 

type NodeGroupMemberUpdateStatus struct {

	// The cache cluster ID
	CacheClusterId *string

	// The node ID of the cache cluster
	CacheNodeId *string

	// The deletion date of the node
	NodeDeletionDate *time.Time

	// The end date of the update for a node
	NodeUpdateEndDate *time.Time

	// Reflects whether the update was initiated by the customer or automatically
	// applied
	NodeUpdateInitiatedBy NodeUpdateInitiatedBy

	// The date when the update is triggered
	NodeUpdateInitiatedDate *time.Time

	// The start date of the update for a node
	NodeUpdateStartDate *time.Time

	// The update status of the node
	NodeUpdateStatus NodeUpdateStatus

	// The date when the NodeUpdateStatus was last modified
	NodeUpdateStatusModifiedDate *time.Time
}

The status of the service update on the node group member

type NodeGroupNotFoundFault 

type NodeGroupNotFoundFault struct {
	Message *string
}

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.

func (*NodeGroupNotFoundFault) Error 

func (e *NodeGroupNotFoundFault) Error() string

func (*NodeGroupNotFoundFault) ErrorCode 

func (e *NodeGroupNotFoundFault) ErrorCode() string

func (*NodeGroupNotFoundFault) ErrorFault 

func (e *NodeGroupNotFoundFault) ErrorFault() smithy.ErrorFault

func (*NodeGroupNotFoundFault) ErrorMessage 

func (e *NodeGroupNotFoundFault) ErrorMessage() string

type NodeGroupUpdateStatus 

type NodeGroupUpdateStatus struct {

	// The ID of the node group
	NodeGroupId *string

	// The status of the service update on the node group member
	NodeGroupMemberUpdateStatus []NodeGroupMemberUpdateStatus
}

The status of the service update on the node group

type NodeGroupsPerReplicationGroupQuotaExceededFault 

type NodeGroupsPerReplicationGroupQuotaExceededFault struct {
	Message *string
}

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

func (*NodeGroupsPerReplicationGroupQuotaExceededFault) Error 

func (e *NodeGroupsPerReplicationGroupQuotaExceededFault) Error() string

func (*NodeGroupsPerReplicationGroupQuotaExceededFault) ErrorCode 

func (e *NodeGroupsPerReplicationGroupQuotaExceededFault) ErrorCode() string

func (*NodeGroupsPerReplicationGroupQuotaExceededFault) ErrorFault 

func (e *NodeGroupsPerReplicationGroupQuotaExceededFault) ErrorFault() smithy.ErrorFault

func (*NodeGroupsPerReplicationGroupQuotaExceededFault) ErrorMessage 

func (e *NodeGroupsPerReplicationGroupQuotaExceededFault) ErrorMessage() string

type NodeQuotaForClusterExceededFault 

type NodeQuotaForClusterExceededFault struct {
	Message *string
}

The request cannot be processed because it would exceed the allowed number of cache nodes in a single cluster.

func (*NodeQuotaForClusterExceededFault) Error 

func (e *NodeQuotaForClusterExceededFault) Error() string

func (*NodeQuotaForClusterExceededFault) ErrorCode 

func (e *NodeQuotaForClusterExceededFault) ErrorCode() string

func (*NodeQuotaForClusterExceededFault) ErrorFault 

func (e *NodeQuotaForClusterExceededFault) ErrorFault() smithy.ErrorFault

func (*NodeQuotaForClusterExceededFault) ErrorMessage 

func (e *NodeQuotaForClusterExceededFault) ErrorMessage() string

type NodeQuotaForCustomerExceededFault 

type NodeQuotaForCustomerExceededFault struct {
	Message *string
}

The request cannot be processed because it would exceed the allowed number of cache nodes per customer.

func (*NodeQuotaForCustomerExceededFault) Error 

func (e *NodeQuotaForCustomerExceededFault) Error() string

func (*NodeQuotaForCustomerExceededFault) ErrorCode 

func (e *NodeQuotaForCustomerExceededFault) ErrorCode() string

func (*NodeQuotaForCustomerExceededFault) ErrorFault 

func (e *NodeQuotaForCustomerExceededFault) ErrorFault() smithy.ErrorFault

func (*NodeQuotaForCustomerExceededFault) ErrorMessage 

func (e *NodeQuotaForCustomerExceededFault) ErrorMessage() string

type NodeSnapshot 

type NodeSnapshot struct {

	// A unique identifier for the source cluster.
	CacheClusterId *string

	// The date and time when the cache node was created in the source cluster.
	CacheNodeCreateTime *time.Time

	// The cache node identifier for the node in the source cluster.
	CacheNodeId *string

	// The size of the cache on the source cache node.
	CacheSize *string

	// The configuration for the source node group (shard).
	NodeGroupConfiguration *NodeGroupConfiguration

	// A unique identifier for the source node group (shard).
	NodeGroupId *string

	// The date and time when the source node's metadata and cache data set was
	// obtained for the snapshot.
	SnapshotCreateTime *time.Time
}

Represents an individual cache node in a snapshot of a cluster.

type NodeUpdateInitiatedBy 

type NodeUpdateInitiatedBy string
const (
	NodeUpdateInitiatedBySystem   NodeUpdateInitiatedBy = "system"
	NodeUpdateInitiatedByCustomer NodeUpdateInitiatedBy = "customer"
)

Enum values for NodeUpdateInitiatedBy

func (NodeUpdateInitiatedBy) Values added in v0.29.0 

func (NodeUpdateInitiatedBy) Values() []NodeUpdateInitiatedBy

Values returns all known values for NodeUpdateInitiatedBy. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type NodeUpdateStatus 

type NodeUpdateStatus string
const (
	NodeUpdateStatusNotApplied     NodeUpdateStatus = "not-applied"
	NodeUpdateStatusWaitingToStart NodeUpdateStatus = "waiting-to-start"
	NodeUpdateStatusInProgress     NodeUpdateStatus = "in-progress"
	NodeUpdateStatusStopping       NodeUpdateStatus = "stopping"
	NodeUpdateStatusStopped        NodeUpdateStatus = "stopped"
	NodeUpdateStatusComplete       NodeUpdateStatus = "complete"
)

Enum values for NodeUpdateStatus

func (NodeUpdateStatus) Values added in v0.29.0 

func (NodeUpdateStatus) Values() []NodeUpdateStatus

Values returns all known values for NodeUpdateStatus. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type NotificationConfiguration 

type NotificationConfiguration struct {

	// The Amazon Resource Name (ARN) that identifies the topic.
	TopicArn *string

	// The current state of the topic.
	TopicStatus *string
}

Describes a notification topic and its status. Notification topics are used for publishing ElastiCache events to subscribers using Amazon Simple Notification Service (SNS).

type OutpostMode added in v0.29.0 

type OutpostMode string
const (
	OutpostModeSingleOutpost OutpostMode = "single-outpost"
	OutpostModeCrossOutpost  OutpostMode = "cross-outpost"
)

Enum values for OutpostMode

func (OutpostMode) Values added in v0.29.0 

func (OutpostMode) Values() []OutpostMode

Values returns all known values for OutpostMode. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type Parameter 

type Parameter struct {

	// The valid range of values for the parameter.
	AllowedValues *string

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

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

	// A description of the parameter.
	Description *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

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

	// The name of the parameter.
	ParameterName *string

	// The value of the parameter.
	ParameterValue *string

	// The source of the parameter.
	Source *string
}

Describes an individual setting that controls some aspect of ElastiCache behavior.

type ParameterNameValue 

type ParameterNameValue struct {

	// The name of the parameter.
	ParameterName *string

	// The value of the parameter.
	ParameterValue *string
}

Describes a name-value pair that is used to update the value of a parameter.

type PendingAutomaticFailoverStatus 

type PendingAutomaticFailoverStatus string
const (
	PendingAutomaticFailoverStatusEnabled  PendingAutomaticFailoverStatus = "enabled"
	PendingAutomaticFailoverStatusDisabled PendingAutomaticFailoverStatus = "disabled"
)

Enum values for PendingAutomaticFailoverStatus

func (PendingAutomaticFailoverStatus) Values added in v0.29.0 

func (PendingAutomaticFailoverStatus) Values() []PendingAutomaticFailoverStatus

Values returns all known values for PendingAutomaticFailoverStatus. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type PendingModifiedValues 

type PendingModifiedValues struct {

	// The auth token status
	AuthTokenStatus 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

	// The cache node type that this cluster or replication group is scaled to.
	CacheNodeType *string

	// The new cache engine version that the cluster runs.
	EngineVersion *string

	// The new number of cache nodes for the cluster. For clusters running Redis, this
	// value must be 1. For clusters running Memcached, this value must be between 1
	// and 20.
	NumCacheNodes *int32
}

A group of settings that are applied to the cluster in the future, or that are currently being applied.

type ProcessedUpdateAction 

type ProcessedUpdateAction struct {

	// The ID of the cache cluster
	CacheClusterId *string

	// The ID of the replication group
	ReplicationGroupId *string

	// The unique ID of the service update
	ServiceUpdateName *string

	// The status of the update action on the Redis cluster
	UpdateActionStatus UpdateActionStatus
}

Update action that has been processed for the corresponding apply/stop request

type RecurringCharge 

type RecurringCharge struct {

	// The monetary amount of the recurring charge.
	RecurringChargeAmount float64

	// The frequency of the recurring charge.
	RecurringChargeFrequency *string
}

Contains the specific price and frequency of a recurring charges for a reserved cache node, or for a reserved cache node offering.

type RegionalConfiguration 

type RegionalConfiguration struct {

	// The name of the secondary cluster
	//
	// This member is required.
	ReplicationGroupId *string

	// The AWS region where the cluster is stored
	//
	// This member is required.
	ReplicationGroupRegion *string

	// A list of PreferredAvailabilityZones objects that specifies the configuration of
	// a node group in the resharded cluster.
	//
	// This member is required.
	ReshardingConfiguration []ReshardingConfiguration
}

A list of the replication groups

type ReplicationGroup 

type ReplicationGroup struct {

	// The ARN (Amazon Resource Name) of the replication group.
	ARN *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

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

	// The date the auth token was last modified
	AuthTokenLastModifiedDate *time.Time

	// Indicates the status of automatic failover for this Redis replication group.
	AutomaticFailover AutomaticFailoverStatus

	// The name of the compute and memory capacity node type for each node in the
	// replication group.
	CacheNodeType *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

	// The configuration endpoint for this replication group. Use the configuration
	// endpoint to connect to this replication group.
	ConfigurationEndpoint *Endpoint

	// The user supplied description of the replication group.
	Description *string

	// The name of the Global datastore and role of this replication group in the
	// Global datastore.
	GlobalReplicationGroupInfo *GlobalReplicationGroupInfo

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

	// The names of all the cache clusters that are part of this replication group.
	MemberClusters []string

	// The outpost ARNs of the replication group's member clusters.
	MemberClustersOutpostArns []string

	// A flag indicating if you have Multi-AZ enabled to enhance fault tolerance. For
	// more information, see Minimizing Downtime: Multi-AZ
	// (http://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/AutoFailover.html)
	MultiAZ MultiAZStatus

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

	// A group of settings to be applied to the replication group, either immediately
	// or during the next maintenance window.
	PendingModifiedValues *ReplicationGroupPendingModifiedValues

	// The identifier for the replication group.
	ReplicationGroupId *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 *int32

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

	// The cluster ID that is used as the daily snapshot source for the replication
	// group.
	SnapshottingClusterId *string

	// The current state of this replication group - creating, available, modifying,
	// deleting, create-failed, snapshotting.
	Status *string

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

	// The list of user group IDs that have access to the replication group.
	UserGroupIds []string
}

Contains all of the attributes of a specific Redis replication group.

type ReplicationGroupAlreadyExistsFault 

type ReplicationGroupAlreadyExistsFault struct {
	Message *string
}

The specified replication group already exists.

func (*ReplicationGroupAlreadyExistsFault) Error 

func (e *ReplicationGroupAlreadyExistsFault) Error() string

func (*ReplicationGroupAlreadyExistsFault) ErrorCode 

func (e *ReplicationGroupAlreadyExistsFault) ErrorCode() string

func (*ReplicationGroupAlreadyExistsFault) ErrorFault 

func (e *ReplicationGroupAlreadyExistsFault) ErrorFault() smithy.ErrorFault

func (*ReplicationGroupAlreadyExistsFault) ErrorMessage 

func (e *ReplicationGroupAlreadyExistsFault) ErrorMessage() string

type ReplicationGroupAlreadyUnderMigrationFault 

type ReplicationGroupAlreadyUnderMigrationFault struct {
	Message *string
}

The targeted replication group is not available.

func (*ReplicationGroupAlreadyUnderMigrationFault) Error 

func (e *ReplicationGroupAlreadyUnderMigrationFault) Error() string

func (*ReplicationGroupAlreadyUnderMigrationFault) ErrorCode 

func (e *ReplicationGroupAlreadyUnderMigrationFault) ErrorCode() string

func (*ReplicationGroupAlreadyUnderMigrationFault) ErrorFault 

func (e *ReplicationGroupAlreadyUnderMigrationFault) ErrorFault() smithy.ErrorFault

func (*ReplicationGroupAlreadyUnderMigrationFault) ErrorMessage 

func (e *ReplicationGroupAlreadyUnderMigrationFault) ErrorMessage() string

type ReplicationGroupNotFoundFault 

type ReplicationGroupNotFoundFault struct {
	Message *string
}

The specified replication group does not exist.

func (*ReplicationGroupNotFoundFault) Error 

func (e *ReplicationGroupNotFoundFault) Error() string

func (*ReplicationGroupNotFoundFault) ErrorCode 

func (e *ReplicationGroupNotFoundFault) ErrorCode() string

func (*ReplicationGroupNotFoundFault) ErrorFault 

func (e *ReplicationGroupNotFoundFault) ErrorFault() smithy.ErrorFault

func (*ReplicationGroupNotFoundFault) ErrorMessage 

func (e *ReplicationGroupNotFoundFault) ErrorMessage() string

type ReplicationGroupNotUnderMigrationFault 

type ReplicationGroupNotUnderMigrationFault struct {
	Message *string
}

The designated replication group is not available for data migration.

func (*ReplicationGroupNotUnderMigrationFault) Error 

func (e *ReplicationGroupNotUnderMigrationFault) Error() string

func (*ReplicationGroupNotUnderMigrationFault) ErrorCode 

func (e *ReplicationGroupNotUnderMigrationFault) ErrorCode() string

func (*ReplicationGroupNotUnderMigrationFault) ErrorFault 

func (e *ReplicationGroupNotUnderMigrationFault) ErrorFault() smithy.ErrorFault

func (*ReplicationGroupNotUnderMigrationFault) ErrorMessage 

func (e *ReplicationGroupNotUnderMigrationFault) ErrorMessage() string

type ReplicationGroupPendingModifiedValues 

type ReplicationGroupPendingModifiedValues struct {

	// The auth token status
	AuthTokenStatus AuthTokenUpdateStatus

	// Indicates the status of automatic failover for this Redis replication group.
	AutomaticFailoverStatus PendingAutomaticFailoverStatus

	// The primary cluster ID that is applied immediately (if --apply-immediately was
	// specified), or during the next maintenance window.
	PrimaryClusterId *string

	// The status of an online resharding operation.
	Resharding *ReshardingStatus

	// The user groups being modified.
	UserGroups *UserGroupsUpdateStatus
}

The settings to be applied to the Redis replication group, either immediately or during the next maintenance window.

type ReservedCacheNode 

type ReservedCacheNode struct {

	// The number of cache nodes that have been reserved.
	CacheNodeCount int32

	// The cache node type for the reserved cache nodes. The following node types are
	// supported by ElastiCache. Generally speaking, the current generation types
	// provide more memory and computational power at lower cost when compared to their
	// equivalent previous generation counterparts.
	//
	// * General purpose:
	//
	// * Current
	// generation: M6g node types (available only for Redis engine version 5.0.6 onward
	// and for Memcached engine version 1.5.16 onward). cache.m6g.large,
	// cache.m6g.xlarge, cache.m6g.2xlarge, cache.m6g.4xlarge, cache.m6g.8xlarge,
	// cache.m6g.12xlarge, cache.m6g.16xlarge For region availability, see Supported
	// Node Types
	// (https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/CacheNodes.SupportedTypes.html#CacheNodes.SupportedTypesByRegion)
	// M5 node types: cache.m5.large, cache.m5.xlarge, cache.m5.2xlarge,
	// cache.m5.4xlarge, cache.m5.12xlarge, cache.m5.24xlarge M4 node types:
	// cache.m4.large, cache.m4.xlarge, cache.m4.2xlarge, cache.m4.4xlarge,
	// cache.m4.10xlarge T3 node types: cache.t3.micro, cache.t3.small, cache.t3.medium
	// T2 node types: cache.t2.micro, cache.t2.small, cache.t2.medium
	//
	// * Previous
	// generation: (not recommended) T1 node types: cache.t1.micro M1 node types:
	// cache.m1.small, cache.m1.medium, cache.m1.large, cache.m1.xlarge M3 node types:
	// cache.m3.medium, cache.m3.large, cache.m3.xlarge, cache.m3.2xlarge
	//
	// * Compute
	// optimized:
	//
	// * Previous generation: (not recommended) C1 node types:
	// cache.c1.xlarge
	//
	// * Memory optimized:
	//
	// * Current generation: R6g node types
	// (available only for Redis engine version 5.0.6 onward and for Memcached engine
	// version 1.5.16 onward). cache.r6g.large, cache.r6g.xlarge, cache.r6g.2xlarge,
	// cache.r6g.4xlarge, cache.r6g.8xlarge, cache.r6g.12xlarge, cache.r6g.16xlarge For
	// region availability, see Supported Node Types
	// (https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/CacheNodes.SupportedTypes.html#CacheNodes.SupportedTypesByRegion)
	// R5 node types: cache.r5.large, cache.r5.xlarge, cache.r5.2xlarge,
	// cache.r5.4xlarge, cache.r5.12xlarge, cache.r5.24xlarge R4 node types:
	// cache.r4.large, cache.r4.xlarge, cache.r4.2xlarge, cache.r4.4xlarge,
	// cache.r4.8xlarge, cache.r4.16xlarge
	//
	// * Previous generation: (not recommended) 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

	// The duration of the reservation in seconds.
	Duration int32

	// The fixed price charged for this reserved cache node.
	FixedPrice float64

	// The offering type of this reserved cache node.
	OfferingType *string

	// The description of the reserved cache node.
	ProductDescription *string

	// The recurring price charged to run this reserved cache node.
	RecurringCharges []RecurringCharge

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

	// The unique identifier for the reservation.
	ReservedCacheNodeId *string

	// The offering identifier.
	ReservedCacheNodesOfferingId *string

	// The time the reservation started.
	StartTime *time.Time

	// The state of the reserved cache node.
	State *string

	// The hourly price charged for this reserved cache node.
	UsagePrice float64
}

Represents the output of a PurchaseReservedCacheNodesOffering operation.

type ReservedCacheNodeAlreadyExistsFault 

type ReservedCacheNodeAlreadyExistsFault struct {
	Message *string
}

You already have a reservation with the given identifier.

func (*ReservedCacheNodeAlreadyExistsFault) Error 

func (e *ReservedCacheNodeAlreadyExistsFault) Error() string

func (*ReservedCacheNodeAlreadyExistsFault) ErrorCode 

func (e *ReservedCacheNodeAlreadyExistsFault) ErrorCode() string

func (*ReservedCacheNodeAlreadyExistsFault) ErrorFault 

func (e *ReservedCacheNodeAlreadyExistsFault) ErrorFault() smithy.ErrorFault

func (*ReservedCacheNodeAlreadyExistsFault) ErrorMessage 

func (e *ReservedCacheNodeAlreadyExistsFault) ErrorMessage() string

type ReservedCacheNodeNotFoundFault 

type ReservedCacheNodeNotFoundFault struct {
	Message *string
}

The requested reserved cache node was not found.

func (*ReservedCacheNodeNotFoundFault) Error 

func (e *ReservedCacheNodeNotFoundFault) Error() string

func (*ReservedCacheNodeNotFoundFault) ErrorCode 

func (e *ReservedCacheNodeNotFoundFault) ErrorCode() string

func (*ReservedCacheNodeNotFoundFault) ErrorFault 

func (e *ReservedCacheNodeNotFoundFault) ErrorFault() smithy.ErrorFault

func (*ReservedCacheNodeNotFoundFault) ErrorMessage 

func (e *ReservedCacheNodeNotFoundFault) ErrorMessage() string

type ReservedCacheNodeQuotaExceededFault 

type ReservedCacheNodeQuotaExceededFault struct {
	Message *string
}

The request cannot be processed because it would exceed the user's cache node quota.

func (*ReservedCacheNodeQuotaExceededFault) Error 

func (e *ReservedCacheNodeQuotaExceededFault) Error() string

func (*ReservedCacheNodeQuotaExceededFault) ErrorCode 

func (e *ReservedCacheNodeQuotaExceededFault) ErrorCode() string

func (*ReservedCacheNodeQuotaExceededFault) ErrorFault 

func (e *ReservedCacheNodeQuotaExceededFault) ErrorFault() smithy.ErrorFault

func (*ReservedCacheNodeQuotaExceededFault) ErrorMessage 

func (e *ReservedCacheNodeQuotaExceededFault) ErrorMessage() string

type ReservedCacheNodesOffering 

type ReservedCacheNodesOffering struct {

	// The cache node type for the reserved cache node. The following node types are
	// supported by ElastiCache. Generally speaking, the current generation types
	// provide more memory and computational power at lower cost when compared to their
	// equivalent previous generation counterparts.
	//
	// * General purpose:
	//
	// * Current
	// generation: M6g node types (available only for Redis engine version 5.0.6 onward
	// and for Memcached engine version 1.5.16 onward). cache.m6g.large,
	// cache.m6g.xlarge, cache.m6g.2xlarge, cache.m6g.4xlarge, cache.m6g.8xlarge,
	// cache.m6g.12xlarge, cache.m6g.16xlarge For region availability, see Supported
	// Node Types
	// (https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/CacheNodes.SupportedTypes.html#CacheNodes.SupportedTypesByRegion)
	// M5 node types: cache.m5.large, cache.m5.xlarge, cache.m5.2xlarge,
	// cache.m5.4xlarge, cache.m5.12xlarge, cache.m5.24xlarge M4 node types:
	// cache.m4.large, cache.m4.xlarge, cache.m4.2xlarge, cache.m4.4xlarge,
	// cache.m4.10xlarge T3 node types: cache.t3.micro, cache.t3.small, cache.t3.medium
	// T2 node types: cache.t2.micro, cache.t2.small, cache.t2.medium
	//
	// * Previous
	// generation: (not recommended) T1 node types: cache.t1.micro M1 node types:
	// cache.m1.small, cache.m1.medium, cache.m1.large, cache.m1.xlarge M3 node types:
	// cache.m3.medium, cache.m3.large, cache.m3.xlarge, cache.m3.2xlarge
	//
	// * Compute
	// optimized:
	//
	// * Previous generation: (not recommended) C1 node types:
	// cache.c1.xlarge
	//
	// * Memory optimized:
	//
	// * Current generation: R6g node types
	// (available only for Redis engine version 5.0.6 onward and for Memcached engine
	// version 1.5.16 onward). cache.r6g.large, cache.r6g.xlarge, cache.r6g.2xlarge,
	// cache.r6g.4xlarge, cache.r6g.8xlarge, cache.r6g.12xlarge, cache.r6g.16xlarge For
	// region availability, see Supported Node Types
	// (https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/CacheNodes.SupportedTypes.html#CacheNodes.SupportedTypesByRegion)
	// R5 node types: cache.r5.large, cache.r5.xlarge, cache.r5.2xlarge,
	// cache.r5.4xlarge, cache.r5.12xlarge, cache.r5.24xlarge R4 node types:
	// cache.r4.large, cache.r4.xlarge, cache.r4.2xlarge, cache.r4.4xlarge,
	// cache.r4.8xlarge, cache.r4.16xlarge
	//
	// * Previous generation: (not recommended) 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

	// The duration of the offering. in seconds.
	Duration int32

	// The fixed price charged for this offering.
	FixedPrice float64

	// The offering type.
	OfferingType *string

	// The cache engine used by the offering.
	ProductDescription *string

	// The recurring price charged to run this reserved cache node.
	RecurringCharges []RecurringCharge

	// A unique identifier for the reserved cache node offering.
	ReservedCacheNodesOfferingId *string

	// The hourly price charged for this offering.
	UsagePrice float64
}

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

type ReservedCacheNodesOfferingNotFoundFault 

type ReservedCacheNodesOfferingNotFoundFault struct {
	Message *string
}

The requested cache node offering does not exist.

func (*ReservedCacheNodesOfferingNotFoundFault) Error 

func (e *ReservedCacheNodesOfferingNotFoundFault) Error() string

func (*ReservedCacheNodesOfferingNotFoundFault) ErrorCode 

func (e *ReservedCacheNodesOfferingNotFoundFault) ErrorCode() string

func (*ReservedCacheNodesOfferingNotFoundFault) ErrorFault 

func (e *ReservedCacheNodesOfferingNotFoundFault) ErrorFault() smithy.ErrorFault

func (*ReservedCacheNodesOfferingNotFoundFault) ErrorMessage 

func (e *ReservedCacheNodesOfferingNotFoundFault) ErrorMessage() string

type ReshardingConfiguration 

type ReshardingConfiguration struct {

	// Either the ElastiCache for Redis supplied 4-digit id or a user supplied id for
	// the node group these configuration values apply to.
	NodeGroupId *string

	// A list of preferred availability zones for the nodes in this cluster.
	PreferredAvailabilityZones []string
}

A list of PreferredAvailabilityZones objects that specifies the configuration of a node group in the resharded cluster.

type ReshardingStatus 

type ReshardingStatus struct {

	// Represents the progress of an online resharding operation.
	SlotMigration *SlotMigration
}

The status of an online resharding operation.

type SecurityGroupMembership 

type SecurityGroupMembership struct {

	// The identifier of the cache security group.
	SecurityGroupId *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
}

Represents a single cache security group and its status.

type ServiceLinkedRoleNotFoundFault 

type ServiceLinkedRoleNotFoundFault struct {
	Message *string
}

The specified service linked role (SLR) was not found.

func (*ServiceLinkedRoleNotFoundFault) Error 

func (e *ServiceLinkedRoleNotFoundFault) Error() string

func (*ServiceLinkedRoleNotFoundFault) ErrorCode 

func (e *ServiceLinkedRoleNotFoundFault) ErrorCode() string

func (*ServiceLinkedRoleNotFoundFault) ErrorFault 

func (e *ServiceLinkedRoleNotFoundFault) ErrorFault() smithy.ErrorFault

func (*ServiceLinkedRoleNotFoundFault) ErrorMessage 

func (e *ServiceLinkedRoleNotFoundFault) ErrorMessage() string

type ServiceUpdate 

type ServiceUpdate struct {

	// Indicates whether the service update will be automatically applied once the
	// recommended apply-by date has expired.
	AutoUpdateAfterRecommendedApplyByDate *bool

	// The Elasticache engine to which the update applies. Either Redis or Memcached
	Engine *string

	// The Elasticache engine version to which the update applies. Either Redis or
	// Memcached engine version
	EngineVersion *string

	// The estimated length of time the service update will take
	EstimatedUpdateTime *string

	// Provides details of the service update
	ServiceUpdateDescription *string

	// The date after which the service update is no longer available
	ServiceUpdateEndDate *time.Time

	// The unique ID of the service update
	ServiceUpdateName *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

	// The date when the service update is initially available
	ServiceUpdateReleaseDate *time.Time

	// The severity of the service update
	ServiceUpdateSeverity ServiceUpdateSeverity

	// The status of the service update
	ServiceUpdateStatus ServiceUpdateStatus

	// Reflects the nature of the service update
	ServiceUpdateType ServiceUpdateType
}

An update that you can apply to your Redis clusters.

type ServiceUpdateNotFoundFault 

type ServiceUpdateNotFoundFault struct {
	Message *string
}

The service update doesn't exist

func (*ServiceUpdateNotFoundFault) Error 

func (e *ServiceUpdateNotFoundFault) Error() string

func (*ServiceUpdateNotFoundFault) ErrorCode 

func (e *ServiceUpdateNotFoundFault) ErrorCode() string

func (*ServiceUpdateNotFoundFault) ErrorFault 

func (e *ServiceUpdateNotFoundFault) ErrorFault() smithy.ErrorFault

func (*ServiceUpdateNotFoundFault) ErrorMessage 

func (e *ServiceUpdateNotFoundFault) ErrorMessage() string

type ServiceUpdateSeverity 

type ServiceUpdateSeverity string
const (
	ServiceUpdateSeverityCritical  ServiceUpdateSeverity = "critical"
	ServiceUpdateSeverityImportant ServiceUpdateSeverity = "important"
	ServiceUpdateSeverityMedium    ServiceUpdateSeverity = "medium"
	ServiceUpdateSeverityLow       ServiceUpdateSeverity = "low"
)

Enum values for ServiceUpdateSeverity

func (ServiceUpdateSeverity) Values added in v0.29.0 

func (ServiceUpdateSeverity) Values() []ServiceUpdateSeverity

Values returns all known values for ServiceUpdateSeverity. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type ServiceUpdateStatus 

type ServiceUpdateStatus string
const (
	ServiceUpdateStatusAvailable ServiceUpdateStatus = "available"
	ServiceUpdateStatusCancelled ServiceUpdateStatus = "cancelled"
	ServiceUpdateStatusExpired   ServiceUpdateStatus = "expired"
)

Enum values for ServiceUpdateStatus

func (ServiceUpdateStatus) Values added in v0.29.0 

func (ServiceUpdateStatus) Values() []ServiceUpdateStatus

Values returns all known values for ServiceUpdateStatus. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type ServiceUpdateType 

type ServiceUpdateType string
const (
	ServiceUpdateTypeSecurityUpdate ServiceUpdateType = "security-update"
)

Enum values for ServiceUpdateType

func (ServiceUpdateType) Values added in v0.29.0 

func (ServiceUpdateType) Values() []ServiceUpdateType

Values returns all known values for ServiceUpdateType. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type SlaMet 

type SlaMet string
const (
	SlaMetYes SlaMet = "yes"
	SlaMetNo  SlaMet = "no"
	SlaMetNa  SlaMet = "n/a"
)

Enum values for SlaMet

func (SlaMet) Values added in v0.29.0 

func (SlaMet) Values() []SlaMet

Values returns all known values for SlaMet. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type SlotMigration 

type SlotMigration struct {

	// The percentage of the slot migration that is complete.
	ProgressPercentage float64
}

Represents the progress of an online resharding operation.

type Snapshot 

type Snapshot struct {

	// The ARN (Amazon Resource Name) of the snapshot.
	ARN *string

	// This parameter is currently disabled.
	AutoMinorVersionUpgrade bool

	// Indicates the status of automatic failover for the source Redis replication
	// group.
	AutomaticFailover AutomaticFailoverStatus

	// The date and time when the source cluster was created.
	CacheClusterCreateTime *time.Time

	// The user-supplied identifier of the source cluster.
	CacheClusterId *string

	// The name of the compute and memory capacity node type for the source cluster.
	// The following node types are supported by ElastiCache. Generally speaking, the
	// current generation types provide more memory and computational power at lower
	// cost when compared to their equivalent previous generation counterparts.
	//
	// *
	// General purpose:
	//
	// * Current generation: M6g node types (available only for Redis
	// engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward).
	// cache.m6g.large, cache.m6g.xlarge, cache.m6g.2xlarge, cache.m6g.4xlarge,
	// cache.m6g.8xlarge, cache.m6g.12xlarge, cache.m6g.16xlarge For region
	// availability, see Supported Node Types
	// (https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/CacheNodes.SupportedTypes.html#CacheNodes.SupportedTypesByRegion)
	// M5 node types: cache.m5.large, cache.m5.xlarge, cache.m5.2xlarge,
	// cache.m5.4xlarge, cache.m5.12xlarge, cache.m5.24xlarge M4 node types:
	// cache.m4.large, cache.m4.xlarge, cache.m4.2xlarge, cache.m4.4xlarge,
	// cache.m4.10xlarge T3 node types: cache.t3.micro, cache.t3.small, cache.t3.medium
	// T2 node types: cache.t2.micro, cache.t2.small, cache.t2.medium
	//
	// * Previous
	// generation: (not recommended) T1 node types: cache.t1.micro M1 node types:
	// cache.m1.small, cache.m1.medium, cache.m1.large, cache.m1.xlarge M3 node types:
	// cache.m3.medium, cache.m3.large, cache.m3.xlarge, cache.m3.2xlarge
	//
	// * Compute
	// optimized:
	//
	// * Previous generation: (not recommended) C1 node types:
	// cache.c1.xlarge
	//
	// * Memory optimized:
	//
	// * Current generation: R6g node types
	// (available only for Redis engine version 5.0.6 onward and for Memcached engine
	// version 1.5.16 onward). cache.r6g.large, cache.r6g.xlarge, cache.r6g.2xlarge,
	// cache.r6g.4xlarge, cache.r6g.8xlarge, cache.r6g.12xlarge, cache.r6g.16xlarge For
	// region availability, see Supported Node Types
	// (https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/CacheNodes.SupportedTypes.html#CacheNodes.SupportedTypesByRegion)
	// R5 node types: cache.r5.large, cache.r5.xlarge, cache.r5.2xlarge,
	// cache.r5.4xlarge, cache.r5.12xlarge, cache.r5.24xlarge R4 node types:
	// cache.r4.large, cache.r4.xlarge, cache.r4.2xlarge, cache.r4.4xlarge,
	// cache.r4.8xlarge, cache.r4.16xlarge
	//
	// * Previous generation: (not recommended) 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

	// The cache parameter group that is associated with the source cluster.
	CacheParameterGroupName *string

	// The name of the cache subnet group associated with the source cluster.
	CacheSubnetGroupName *string

	// The name of the cache engine (memcached or redis) used by the source cluster.
	Engine *string

	// The version of the cache engine version that is used by the source cluster.
	EngineVersion *string

	// The ID of the KMS key used to encrypt the snapshot.
	KmsKeyId *string

	// A list of the cache nodes in the source cluster.
	NodeSnapshots []NodeSnapshot

	// The number of cache nodes in the source cluster. For clusters running Redis,
	// this value must be 1. For clusters running Memcached, this value must be between
	// 1 and 20.
	NumCacheNodes *int32

	// 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 *int32

	// The port number used by each cache nodes in the source cluster.
	Port *int32

	// The name of the Availability Zone in which the source cluster is located.
	PreferredAvailabilityZone *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

	// The ARN (Amazon Resource Name) of the preferred outpost.
	PreferredOutpostArn *string

	// A description of the source replication group.
	ReplicationGroupDescription *string

	// The unique identifier of the source replication group.
	ReplicationGroupId *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

	// 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 *int32

	// Indicates whether the snapshot is from an automatic backup (automated) or was
	// created manually (manual).
	SnapshotSource *string

	// The status of the snapshot. Valid values: creating | available | restoring |
	// copying | deleting.
	SnapshotStatus *string

	// The daily time range during which ElastiCache takes daily snapshots of the
	// source cluster.
	SnapshotWindow *string

	// The Amazon Resource Name (ARN) for the topic used by the source cluster for
	// publishing notifications.
	TopicArn *string

	// The Amazon Virtual Private Cloud identifier (VPC ID) of the cache subnet group
	// for the source cluster.
	VpcId *string
}

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

type SnapshotAlreadyExistsFault 

type SnapshotAlreadyExistsFault struct {
	Message *string
}

You already have a snapshot with the given name.

func (*SnapshotAlreadyExistsFault) Error 

func (e *SnapshotAlreadyExistsFault) Error() string

func (*SnapshotAlreadyExistsFault) ErrorCode 

func (e *SnapshotAlreadyExistsFault) ErrorCode() string

func (*SnapshotAlreadyExistsFault) ErrorFault 

func (e *SnapshotAlreadyExistsFault) ErrorFault() smithy.ErrorFault

func (*SnapshotAlreadyExistsFault) ErrorMessage 

func (e *SnapshotAlreadyExistsFault) ErrorMessage() string

type SnapshotFeatureNotSupportedFault 

type SnapshotFeatureNotSupportedFault struct {
	Message *string
}

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.

func (*SnapshotFeatureNotSupportedFault) Error 

func (e *SnapshotFeatureNotSupportedFault) Error() string

func (*SnapshotFeatureNotSupportedFault) ErrorCode 

func (e *SnapshotFeatureNotSupportedFault) ErrorCode() string

func (*SnapshotFeatureNotSupportedFault) ErrorFault 

func (e *SnapshotFeatureNotSupportedFault) ErrorFault() smithy.ErrorFault

func (*SnapshotFeatureNotSupportedFault) ErrorMessage 

func (e *SnapshotFeatureNotSupportedFault) ErrorMessage() string

type SnapshotNotFoundFault 

type SnapshotNotFoundFault struct {
	Message *string
}

The requested snapshot name does not refer to an existing snapshot.

func (*SnapshotNotFoundFault) Error 

func (e *SnapshotNotFoundFault) Error() string

func (*SnapshotNotFoundFault) ErrorCode 

func (e *SnapshotNotFoundFault) ErrorCode() string

func (*SnapshotNotFoundFault) ErrorFault 

func (e *SnapshotNotFoundFault) ErrorFault() smithy.ErrorFault

func (*SnapshotNotFoundFault) ErrorMessage 

func (e *SnapshotNotFoundFault) ErrorMessage() string

type SnapshotQuotaExceededFault 

type SnapshotQuotaExceededFault struct {
	Message *string
}

The request cannot be processed because it would exceed the maximum number of snapshots.

func (*SnapshotQuotaExceededFault) Error 

func (e *SnapshotQuotaExceededFault) Error() string

func (*SnapshotQuotaExceededFault) ErrorCode 

func (e *SnapshotQuotaExceededFault) ErrorCode() string

func (*SnapshotQuotaExceededFault) ErrorFault 

func (e *SnapshotQuotaExceededFault) ErrorFault() smithy.ErrorFault

func (*SnapshotQuotaExceededFault) ErrorMessage 

func (e *SnapshotQuotaExceededFault) ErrorMessage() string

type SourceType 

type SourceType string
const (
	SourceTypeCacheCluster        SourceType = "cache-cluster"
	SourceTypeCacheParameterGroup SourceType = "cache-parameter-group"
	SourceTypeCacheSecurityGroup  SourceType = "cache-security-group"
	SourceTypeCacheSubnetGroup    SourceType = "cache-subnet-group"
	SourceTypeReplicationGroup    SourceType = "replication-group"
	SourceTypeUser                SourceType = "user"
	SourceTypeUserGroup           SourceType = "user-group"
)

Enum values for SourceType

func (SourceType) Values added in v0.29.0 

func (SourceType) Values() []SourceType

Values returns all known values for SourceType. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type Subnet 

type Subnet struct {

	// The Availability Zone associated with the subnet.
	SubnetAvailabilityZone *AvailabilityZone

	// The unique identifier for the subnet.
	SubnetIdentifier *string

	// The outpost ARN of the subnet.
	SubnetOutpost *SubnetOutpost
}

Represents the subnet associated with a cluster. This parameter refers to subnets defined in Amazon Virtual Private Cloud (Amazon VPC) and used with ElastiCache.

type SubnetInUse 

type SubnetInUse struct {
	Message *string
}

The requested subnet is being used by another cache subnet group.

func (*SubnetInUse) Error 

func (e *SubnetInUse) Error() string

func (*SubnetInUse) ErrorCode 

func (e *SubnetInUse) ErrorCode() string

func (*SubnetInUse) ErrorFault 

func (e *SubnetInUse) ErrorFault() smithy.ErrorFault

func (*SubnetInUse) ErrorMessage 

func (e *SubnetInUse) ErrorMessage() string

type SubnetNotAllowedFault added in v0.29.0 

type SubnetNotAllowedFault struct {
	Message *string
}

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.

func (*SubnetNotAllowedFault) Error added in v0.29.0 

func (e *SubnetNotAllowedFault) Error() string

func (*SubnetNotAllowedFault) ErrorCode added in v0.29.0 

func (e *SubnetNotAllowedFault) ErrorCode() string

func (*SubnetNotAllowedFault) ErrorFault added in v0.29.0 

func (e *SubnetNotAllowedFault) ErrorFault() smithy.ErrorFault

func (*SubnetNotAllowedFault) ErrorMessage added in v0.29.0 

func (e *SubnetNotAllowedFault) ErrorMessage() string

type SubnetOutpost added in v0.29.0 

type SubnetOutpost struct {

	// The outpost ARN of the subnet.
	SubnetOutpostArn *string
}

The ID of the outpost subnet.

type Tag 

type Tag struct {

	// The key for the tag. May not be null.
	Key *string

	// The tag's value. May be null.
	Value *string
}

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.

type TagNotFoundFault 

type TagNotFoundFault struct {
	Message *string
}

The requested tag was not found on this resource.

func (*TagNotFoundFault) Error 

func (e *TagNotFoundFault) Error() string

func (*TagNotFoundFault) ErrorCode 

func (e *TagNotFoundFault) ErrorCode() string

func (*TagNotFoundFault) ErrorFault 

func (e *TagNotFoundFault) ErrorFault() smithy.ErrorFault

func (*TagNotFoundFault) ErrorMessage 

func (e *TagNotFoundFault) ErrorMessage() string

type TagQuotaPerResourceExceeded 

type TagQuotaPerResourceExceeded struct {
	Message *string
}

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.

func (*TagQuotaPerResourceExceeded) Error 

func (e *TagQuotaPerResourceExceeded) Error() string

func (*TagQuotaPerResourceExceeded) ErrorCode 

func (e *TagQuotaPerResourceExceeded) ErrorCode() string

func (*TagQuotaPerResourceExceeded) ErrorFault 

func (e *TagQuotaPerResourceExceeded) ErrorFault() smithy.ErrorFault

func (*TagQuotaPerResourceExceeded) ErrorMessage 

func (e *TagQuotaPerResourceExceeded) ErrorMessage() string

type TestFailoverNotAvailableFault 

type TestFailoverNotAvailableFault struct {
	Message *string
}

The TestFailover action is not available.

func (*TestFailoverNotAvailableFault) Error 

func (e *TestFailoverNotAvailableFault) Error() string

func (*TestFailoverNotAvailableFault) ErrorCode 

func (e *TestFailoverNotAvailableFault) ErrorCode() string

func (*TestFailoverNotAvailableFault) ErrorFault 

func (e *TestFailoverNotAvailableFault) ErrorFault() smithy.ErrorFault

func (*TestFailoverNotAvailableFault) ErrorMessage 

func (e *TestFailoverNotAvailableFault) ErrorMessage() string

type TimeRangeFilter 

type TimeRangeFilter struct {

	// The end time of the time range filter
	EndTime *time.Time

	// The start time of the time range filter
	StartTime *time.Time
}

Filters update actions from the service updates that are in available status during the time range.

type UnprocessedUpdateAction 

type UnprocessedUpdateAction struct {

	// The ID of the cache cluster
	CacheClusterId *string

	// The error message that describes the reason the request was not processed
	ErrorMessage *string

	// The error type for requests that are not processed
	ErrorType *string

	// The replication group ID
	ReplicationGroupId *string

	// The unique ID of the service update
	ServiceUpdateName *string
}

Update action that has failed to be processed for the corresponding apply/stop request

type UpdateAction 

type UpdateAction struct {

	// The ID of the cache cluster
	CacheClusterId *string

	// The status of the service update on the cache node
	CacheNodeUpdateStatus []CacheNodeUpdateStatus

	// The Elasticache engine to which the update applies. Either Redis or Memcached
	Engine *string

	// The estimated length of time for the update to complete
	EstimatedUpdateTime *string

	// The status of the service update on the node group
	NodeGroupUpdateStatus []NodeGroupUpdateStatus

	// The progress of the service update on the replication group
	NodesUpdated *string

	// The ID of the replication group
	ReplicationGroupId *string

	// The unique ID of the service update
	ServiceUpdateName *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

	// The date the update is first available
	ServiceUpdateReleaseDate *time.Time

	// The severity of the service update
	ServiceUpdateSeverity ServiceUpdateSeverity

	// The status of the service update
	ServiceUpdateStatus ServiceUpdateStatus

	// Reflects the nature of the service update
	ServiceUpdateType 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 SlaMet

	// The date that the service update is available to a replication group
	UpdateActionAvailableDate *time.Time

	// The status of the update action
	UpdateActionStatus UpdateActionStatus

	// The date when the UpdateActionStatus was last modified
	UpdateActionStatusModifiedDate *time.Time
}

The status of the service update for a specific replication group

type UpdateActionStatus 

type UpdateActionStatus string
const (
	UpdateActionStatusNotApplied     UpdateActionStatus = "not-applied"
	UpdateActionStatusWaitingToStart UpdateActionStatus = "waiting-to-start"
	UpdateActionStatusInProgress     UpdateActionStatus = "in-progress"
	UpdateActionStatusStopping       UpdateActionStatus = "stopping"
	UpdateActionStatusStopped        UpdateActionStatus = "stopped"
	UpdateActionStatusComplete       UpdateActionStatus = "complete"
	UpdateActionStatusScheduling     UpdateActionStatus = "scheduling"
	UpdateActionStatusScheduled      UpdateActionStatus = "scheduled"
	UpdateActionStatusNotApplicable  UpdateActionStatus = "not-applicable"
)

Enum values for UpdateActionStatus

func (UpdateActionStatus) Values added in v0.29.0 

func (UpdateActionStatus) Values() []UpdateActionStatus

Values returns all known values for UpdateActionStatus. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type User added in v0.29.0 

type User struct {

	// The Amazon Resource Name (ARN) of the user.
	ARN *string

	// Access permissions string used for this user.
	AccessString *string

	// Denotes whether the user requires a password to authenticate.
	Authentication *Authentication

	// The current supported value is Redis.
	Engine *string

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

	// Returns a list of the user group IDs the user belongs to.
	UserGroupIds []string

	// The ID of the user.
	UserId *string

	// The username of the user.
	UserName *string
}

type UserAlreadyExistsFault added in v0.29.0 

type UserAlreadyExistsFault struct {
	Message *string
}

A user with this ID already exists.

func (*UserAlreadyExistsFault) Error added in v0.29.0 

func (e *UserAlreadyExistsFault) Error() string

func (*UserAlreadyExistsFault) ErrorCode added in v0.29.0 

func (e *UserAlreadyExistsFault) ErrorCode() string

func (*UserAlreadyExistsFault) ErrorFault added in v0.29.0 

func (e *UserAlreadyExistsFault) ErrorFault() smithy.ErrorFault

func (*UserAlreadyExistsFault) ErrorMessage added in v0.29.0 

func (e *UserAlreadyExistsFault) ErrorMessage() string

type UserGroup added in v0.29.0 

type UserGroup struct {

	// The Amazon Resource Name (ARN) of the user group.
	ARN *string

	// The current supported value is Redis.
	Engine *string

	// A list of updates being applied to the user groups.
	PendingChanges *UserGroupPendingChanges

	// A list of replication groups that the user group can access.
	ReplicationGroups []string

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

	// The ID of the user group.
	UserGroupId *string

	// The list of user IDs that belong to the user group.
	UserIds []string
}

type UserGroupAlreadyExistsFault added in v0.29.0 

type UserGroupAlreadyExistsFault struct {
	Message *string
}

The user group with this ID already exists.

func (*UserGroupAlreadyExistsFault) Error added in v0.29.0 

func (e *UserGroupAlreadyExistsFault) Error() string

func (*UserGroupAlreadyExistsFault) ErrorCode added in v0.29.0 

func (e *UserGroupAlreadyExistsFault) ErrorCode() string

func (*UserGroupAlreadyExistsFault) ErrorFault added in v0.29.0 

func (e *UserGroupAlreadyExistsFault) ErrorFault() smithy.ErrorFault

func (*UserGroupAlreadyExistsFault) ErrorMessage added in v0.29.0 

func (e *UserGroupAlreadyExistsFault) ErrorMessage() string

type UserGroupNotFoundFault added in v0.29.0 

type UserGroupNotFoundFault struct {
	Message *string
}

The user group was not found or does not exist

func (*UserGroupNotFoundFault) Error added in v0.29.0 

func (e *UserGroupNotFoundFault) Error() string

func (*UserGroupNotFoundFault) ErrorCode added in v0.29.0 

func (e *UserGroupNotFoundFault) ErrorCode() string

func (*UserGroupNotFoundFault) ErrorFault added in v0.29.0 

func (e *UserGroupNotFoundFault) ErrorFault() smithy.ErrorFault

func (*UserGroupNotFoundFault) ErrorMessage added in v0.29.0 

func (e *UserGroupNotFoundFault) ErrorMessage() string

type UserGroupPendingChanges added in v0.29.0 

type UserGroupPendingChanges struct {

	// The list of user IDs to add.
	UserIdsToAdd []string

	// The list of user IDs to remove.
	UserIdsToRemove []string
}

Returns the updates being applied to the user group.

type UserGroupQuotaExceededFault added in v0.29.0 

type UserGroupQuotaExceededFault struct {
	Message *string
}

The number of users exceeds the user group limit.

func (*UserGroupQuotaExceededFault) Error added in v0.29.0 

func (e *UserGroupQuotaExceededFault) Error() string

func (*UserGroupQuotaExceededFault) ErrorCode added in v0.29.0 

func (e *UserGroupQuotaExceededFault) ErrorCode() string

func (*UserGroupQuotaExceededFault) ErrorFault added in v0.29.0 

func (e *UserGroupQuotaExceededFault) ErrorFault() smithy.ErrorFault

func (*UserGroupQuotaExceededFault) ErrorMessage added in v0.29.0 

func (e *UserGroupQuotaExceededFault) ErrorMessage() string

type UserGroupsUpdateStatus added in v0.29.0 

type UserGroupsUpdateStatus struct {

	// The list of user group IDs to add.
	UserGroupIdsToAdd []string

	// The list of user group IDs to remove.
	UserGroupIdsToRemove []string
}

The status of the user group update.

type UserNotFoundFault added in v0.29.0 

type UserNotFoundFault struct {
	Message *string
}

The user does not exist or could not be found.

func (*UserNotFoundFault) Error added in v0.29.0 

func (e *UserNotFoundFault) Error() string

func (*UserNotFoundFault) ErrorCode added in v0.29.0 

func (e *UserNotFoundFault) ErrorCode() string

func (*UserNotFoundFault) ErrorFault added in v0.29.0 

func (e *UserNotFoundFault) ErrorFault() smithy.ErrorFault

func (*UserNotFoundFault) ErrorMessage added in v0.29.0 

func (e *UserNotFoundFault) ErrorMessage() string

type UserQuotaExceededFault added in v0.29.0 

type UserQuotaExceededFault struct {
	Message *string
}

The quota of users has been exceeded.

func (*UserQuotaExceededFault) Error added in v0.29.0 

func (e *UserQuotaExceededFault) Error() string

func (*UserQuotaExceededFault) ErrorCode added in v0.29.0 

func (e *UserQuotaExceededFault) ErrorCode() string

func (*UserQuotaExceededFault) ErrorFault added in v0.29.0 

func (e *UserQuotaExceededFault) ErrorFault() smithy.ErrorFault

func (*UserQuotaExceededFault) ErrorMessage added in v0.29.0 

func (e *UserQuotaExceededFault) ErrorMessage() string

Source Files

View all Source files

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.