Documentation
¶
Index ¶
- type ACL
- type ACLAlreadyExistsFault
- type ACLNotFoundFault
- type ACLPendingChanges
- type ACLQuotaExceededFault
- type ACLsUpdateStatus
- type APICallRateForCustomerExceededFault
- type AZStatus
- type Authentication
- type AuthenticationMode
- type AuthenticationType
- type AvailabilityZone
- type Cluster
- type ClusterAlreadyExistsFault
- type ClusterConfiguration
- type ClusterNotFoundFault
- type ClusterPendingUpdates
- type ClusterQuotaForCustomerExceededFault
- type DataTieringStatus
- type DefaultUserRequired
- type DuplicateUserNameFault
- type Endpoint
- type EngineVersionInfo
- type Event
- type Filter
- type InputAuthenticationType
- type InsufficientClusterCapacityFault
- type InvalidACLStateFault
- type InvalidARNFault
- type InvalidClusterStateFault
- type InvalidCredentialsException
- type InvalidKMSKeyFault
- type InvalidMultiRegionClusterStateFault
- type InvalidNodeStateFault
- type InvalidParameterCombinationException
- type InvalidParameterGroupStateFault
- type InvalidParameterValueException
- type InvalidSnapshotStateFault
- type InvalidSubnet
- type InvalidUserStateFault
- type InvalidVPCNetworkStateFault
- type IpDiscovery
- type MultiRegionCluster
- type MultiRegionClusterAlreadyExistsFault
- type MultiRegionClusterNotFoundFault
- type MultiRegionParameter
- type MultiRegionParameterGroup
- type MultiRegionParameterGroupNotFoundFault
- type NetworkType
- type NoOperationFault
- type Node
- type NodeQuotaForClusterExceededFault
- type NodeQuotaForCustomerExceededFault
- type Parameter
- type ParameterGroup
- type ParameterGroupAlreadyExistsFault
- type ParameterGroupNotFoundFault
- type ParameterGroupQuotaExceededFault
- type ParameterNameValue
- type PendingModifiedServiceUpdate
- type RecurringCharge
- type RegionalCluster
- type ReplicaConfigurationRequest
- type ReservedNode
- type ReservedNodeAlreadyExistsFault
- type ReservedNodeNotFoundFault
- type ReservedNodeQuotaExceededFault
- type ReservedNodesOffering
- type ReservedNodesOfferingNotFoundFault
- type ReshardingStatus
- type SecurityGroupMembership
- type ServiceLinkedRoleNotFoundFault
- type ServiceUpdate
- type ServiceUpdateNotFoundFault
- type ServiceUpdateRequest
- type ServiceUpdateStatus
- type ServiceUpdateType
- type Shard
- type ShardConfiguration
- type ShardConfigurationRequest
- type ShardDetail
- type ShardNotFoundFault
- type ShardsPerClusterQuotaExceededFault
- type SlotMigration
- type Snapshot
- type SnapshotAlreadyExistsFault
- type SnapshotNotFoundFault
- type SnapshotQuotaExceededFault
- type SourceType
- type Subnet
- type SubnetGroup
- type SubnetGroupAlreadyExistsFault
- type SubnetGroupInUseFault
- type SubnetGroupNotFoundFault
- type SubnetGroupQuotaExceededFault
- type SubnetInUse
- type SubnetNotAllowedFault
- type SubnetQuotaExceededFault
- type Tag
- type TagNotFoundFault
- type TagQuotaPerResourceExceeded
- type TestFailoverNotAvailableFault
- type UnprocessedCluster
- type UpdateStrategy
- type User
- type UserAlreadyExistsFault
- type UserNotFoundFault
- type UserQuotaExceededFault
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type ACL ¶
type ACL struct {
// The Amazon Resource Name (ARN) of the ACL
ARN *string
// A list of clusters associated with the ACL.
Clusters []string
// The minimum engine version supported for the ACL
MinimumEngineVersion *string
// The name of the Access Control List
Name *string
// A list of updates being applied to the ACL.
PendingChanges *ACLPendingChanges
// Indicates ACL status. Can be "creating", "active", "modifying", "deleting".
Status *string
// The list of user names that belong to the ACL.
UserNames []string
// contains filtered or unexported fields
}
An Access Control List. You can authenticate users with Access Contol Lists.
ACLs enable you to control cluster access by grouping users. These Access control lists are designed as a way to organize access to clusters.
type ACLAlreadyExistsFault ¶
type ACLAlreadyExistsFault struct {
Message *string
ErrorCodeOverride *string
// contains filtered or unexported fields
}
An ACL with the specified name already exists.
func (*ACLAlreadyExistsFault) Error ¶
func (e *ACLAlreadyExistsFault) Error() string
func (*ACLAlreadyExistsFault) ErrorCode ¶
func (e *ACLAlreadyExistsFault) ErrorCode() string
func (*ACLAlreadyExistsFault) ErrorFault ¶
func (e *ACLAlreadyExistsFault) ErrorFault() smithy.ErrorFault
func (*ACLAlreadyExistsFault) ErrorMessage ¶
func (e *ACLAlreadyExistsFault) ErrorMessage() string
type ACLNotFoundFault ¶
type ACLNotFoundFault struct {
Message *string
ErrorCodeOverride *string
// contains filtered or unexported fields
}
The specified ACL does not exist.
func (*ACLNotFoundFault) Error ¶
func (e *ACLNotFoundFault) Error() string
func (*ACLNotFoundFault) ErrorCode ¶
func (e *ACLNotFoundFault) ErrorCode() string
func (*ACLNotFoundFault) ErrorFault ¶
func (e *ACLNotFoundFault) ErrorFault() smithy.ErrorFault
func (*ACLNotFoundFault) ErrorMessage ¶
func (e *ACLNotFoundFault) ErrorMessage() string
type ACLPendingChanges ¶
type ACLPendingChanges struct {
// A list of users being added to the ACL
UserNamesToAdd []string
// A list of user names being removed from the ACL
UserNamesToRemove []string
// contains filtered or unexported fields
}
Returns the updates being applied to the ACL.
type ACLQuotaExceededFault ¶
type ACLQuotaExceededFault struct {
Message *string
ErrorCodeOverride *string
// contains filtered or unexported fields
}
The request cannot be processed because it would exceed the maximum number of ACLs allowed.
func (*ACLQuotaExceededFault) Error ¶
func (e *ACLQuotaExceededFault) Error() string
func (*ACLQuotaExceededFault) ErrorCode ¶
func (e *ACLQuotaExceededFault) ErrorCode() string
func (*ACLQuotaExceededFault) ErrorFault ¶
func (e *ACLQuotaExceededFault) ErrorFault() smithy.ErrorFault
func (*ACLQuotaExceededFault) ErrorMessage ¶
func (e *ACLQuotaExceededFault) ErrorMessage() string
type ACLsUpdateStatus ¶
type ACLsUpdateStatus struct {
// A list of ACLs pending to be applied.
ACLToApply *string
// contains filtered or unexported fields
}
The status of the ACL update
type APICallRateForCustomerExceededFault ¶
type APICallRateForCustomerExceededFault struct {
Message *string
ErrorCodeOverride *string
// contains filtered or unexported fields
}
The customer has exceeded the maximum number of API requests allowed per time period.
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 Authentication ¶
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
// contains filtered or unexported fields
}
Denotes the user's authentication properties, such as whether it requires a password to authenticate. Used in output responses.
type AuthenticationMode ¶
type AuthenticationMode struct {
// The password(s) used for authentication
Passwords []string
// Indicates whether the user requires a password to authenticate. All
// newly-created users require a password.
Type InputAuthenticationType
// contains filtered or unexported fields
}
Denotes the user's authentication properties, such as whether it requires a password to authenticate. Used in output responses.
type AuthenticationType ¶
type AuthenticationType string
const ( AuthenticationTypePassword AuthenticationType = "password" AuthenticationTypeNoPassword AuthenticationType = "no-password" AuthenticationTypeIam AuthenticationType = "iam" )
Enum values for AuthenticationType
func (AuthenticationType) Values ¶
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 AvailabilityZone ¶
type AvailabilityZone struct {
// The name of the Availability Zone.
Name *string
// contains filtered or unexported fields
}
Indicates if the cluster has a Multi-AZ configuration (multiaz) or not (singleaz).
type Cluster ¶
type Cluster struct {
// The name of the Access Control List associated with this cluster.
ACLName *string
// The Amazon Resource Name (ARN) of the cluster.
ARN *string
// When set to true, the cluster will automatically receive minor engine version
// upgrades after launch.
AutoMinorVersionUpgrade *bool
// Indicates if the cluster has a Multi-AZ configuration (multiaz) or not
// (singleaz).
AvailabilityMode AZStatus
// The cluster's configuration endpoint
ClusterEndpoint *Endpoint
// Enables data tiering. Data tiering is only supported for clusters using the
// r6gd node type. This parameter must be set when using r6gd nodes. For more
// information, see [Data tiering].
//
// [Data tiering]: https://docs.aws.amazon.com/memorydb/latest/devguide/data-tiering.html
DataTiering DataTieringStatus
// A description of the cluster
Description *string
// The name of the engine used by the cluster.
Engine *string
// The Redis OSS engine patch version used by the cluster
EnginePatchVersion *string
// The Redis OSS engine version used by the cluster
EngineVersion *string
// The mechanism that the cluster uses to discover IP addresses. Returns 'ipv4'
// when DNS endpoints resolve to IPv4 addresses, or 'ipv6' when DNS endpoints
// resolve to IPv6 addresses.
IpDiscovery IpDiscovery
// The ID of the KMS key used to encrypt the cluster
KmsKeyId *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.
MaintenanceWindow *string
// The name of the multi-Region cluster that this cluster belongs to.
MultiRegionClusterName *string
// The user-supplied name of the cluster. This identifier is a unique key that
// identifies a cluster.
Name *string
// The IP address type for the cluster. Returns 'ipv4' for IPv4 only, 'ipv6' for
// IPv6 only, or 'dual-stack' if the cluster supports both IPv4 and IPv6
// addressing.
NetworkType NetworkType
// The cluster's node type
NodeType *string
// The number of shards in the cluster
NumberOfShards *int32
// The name of the parameter group used by the cluster
ParameterGroupName *string
// The status of the parameter group used by the cluster, for example 'active' or
// 'applying'.
ParameterGroupStatus *string
// A group of settings that are currently being applied.
PendingUpdates *ClusterPendingUpdates
// A list of security groups used by the cluster
SecurityGroups []SecurityGroupMembership
// A list of shards that are members of the cluster.
Shards []Shard
// The number of days for which MemoryDB retains automatic snapshots before
// deleting them. For example, if you set SnapshotRetentionLimit to 5, a snapshot
// that was taken today is retained for 5 days before being deleted.
SnapshotRetentionLimit *int32
// The daily time range (in UTC) during which MemoryDB begins taking a daily
// snapshot of your shard.
//
// Example: 05:00-09:00
//
// If you do not specify this parameter, MemoryDB automatically chooses an
// appropriate time range.
SnapshotWindow *string
// The Amazon Resource Name (ARN) of the SNS notification topic
SnsTopicArn *string
// The SNS topic must be in Active status to receive notifications
SnsTopicStatus *string
// The status of the cluster. For example, Available, Updating, Creating.
Status *string
// The name of the subnet group used by the cluster
SubnetGroupName *string
// A flag to indicate if In-transit encryption is enabled
TLSEnabled *bool
// contains filtered or unexported fields
}
Contains all of the attributes of a specific cluster.
type ClusterAlreadyExistsFault ¶
type ClusterAlreadyExistsFault struct {
Message *string
ErrorCodeOverride *string
// contains filtered or unexported fields
}
A cluster with the specified name already exists.
func (*ClusterAlreadyExistsFault) Error ¶
func (e *ClusterAlreadyExistsFault) Error() string
func (*ClusterAlreadyExistsFault) ErrorCode ¶
func (e *ClusterAlreadyExistsFault) ErrorCode() string
func (*ClusterAlreadyExistsFault) ErrorFault ¶
func (e *ClusterAlreadyExistsFault) ErrorFault() smithy.ErrorFault
func (*ClusterAlreadyExistsFault) ErrorMessage ¶
func (e *ClusterAlreadyExistsFault) ErrorMessage() string
type ClusterConfiguration ¶
type ClusterConfiguration struct {
// The description of the cluster configuration
Description *string
// The name of the engine used by the cluster configuration.
Engine *string
// The Redis OSS engine version used by the cluster
EngineVersion *string
// The specified maintenance window for the cluster
MaintenanceWindow *string
// The name for the multi-Region cluster associated with the cluster configuration.
MultiRegionClusterName *string
// The name of the multi-Region parameter group associated with the cluster
// configuration.
MultiRegionParameterGroupName *string
// The name of the cluster
Name *string
// The node type used for the cluster
NodeType *string
// The number of shards in the cluster
NumShards *int32
// The name of parameter group used by the cluster
ParameterGroupName *string
// The port used by the cluster
Port *int32
// The list of shards in the cluster
Shards []ShardDetail
// The snapshot retention limit set by the cluster
SnapshotRetentionLimit *int32
// The snapshot window set by the cluster
SnapshotWindow *string
// The name of the subnet group used by the cluster
SubnetGroupName *string
// The Amazon Resource Name (ARN) of the SNS notification topic for the cluster
TopicArn *string
// The ID of the VPC the cluster belongs to
VpcId *string
// contains filtered or unexported fields
}
A list of cluster configuration options.
type ClusterNotFoundFault ¶
type ClusterNotFoundFault struct {
Message *string
ErrorCodeOverride *string
// contains filtered or unexported fields
}
The specified cluster does not exist.
func (*ClusterNotFoundFault) Error ¶
func (e *ClusterNotFoundFault) Error() string
func (*ClusterNotFoundFault) ErrorCode ¶
func (e *ClusterNotFoundFault) ErrorCode() string
func (*ClusterNotFoundFault) ErrorFault ¶
func (e *ClusterNotFoundFault) ErrorFault() smithy.ErrorFault
func (*ClusterNotFoundFault) ErrorMessage ¶
func (e *ClusterNotFoundFault) ErrorMessage() string
type ClusterPendingUpdates ¶
type ClusterPendingUpdates struct {
// A list of ACLs associated with the cluster that are being updated
ACLs *ACLsUpdateStatus
// The status of an online resharding operation.
Resharding *ReshardingStatus
// A list of service updates being applied to the cluster
ServiceUpdates []PendingModifiedServiceUpdate
// contains filtered or unexported fields
}
A list of updates being applied to the cluster
type ClusterQuotaForCustomerExceededFault ¶
type ClusterQuotaForCustomerExceededFault struct {
Message *string
ErrorCodeOverride *string
// contains filtered or unexported fields
}
The request cannot be processed because it would exceed the maximum number of clusters allowed for this 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 DataTieringStatus ¶ added in v1.10.0
type DataTieringStatus string
const ( DataTieringStatusTrue DataTieringStatus = "true" DataTieringStatusFalse DataTieringStatus = "false" )
Enum values for DataTieringStatus
func (DataTieringStatus) Values ¶ added in v1.10.0
func (DataTieringStatus) Values() []DataTieringStatus
Values returns all known values for DataTieringStatus. 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 DefaultUserRequired ¶
type DefaultUserRequired struct {
Message *string
ErrorCodeOverride *string
// contains filtered or unexported fields
}
A default user is required and must be specified.
func (*DefaultUserRequired) Error ¶
func (e *DefaultUserRequired) Error() string
func (*DefaultUserRequired) ErrorCode ¶
func (e *DefaultUserRequired) ErrorCode() string
func (*DefaultUserRequired) ErrorFault ¶
func (e *DefaultUserRequired) ErrorFault() smithy.ErrorFault
func (*DefaultUserRequired) ErrorMessage ¶
func (e *DefaultUserRequired) ErrorMessage() string
type DuplicateUserNameFault ¶
type DuplicateUserNameFault struct {
Message *string
ErrorCodeOverride *string
// contains filtered or unexported fields
}
A user with the specified name already exists.
func (*DuplicateUserNameFault) Error ¶
func (e *DuplicateUserNameFault) Error() string
func (*DuplicateUserNameFault) ErrorCode ¶
func (e *DuplicateUserNameFault) ErrorCode() string
func (*DuplicateUserNameFault) ErrorFault ¶
func (e *DuplicateUserNameFault) ErrorFault() smithy.ErrorFault
func (*DuplicateUserNameFault) ErrorMessage ¶
func (e *DuplicateUserNameFault) ErrorMessage() string
type Endpoint ¶
type Endpoint struct {
// The DNS hostname of the node.
Address *string
// The port number that the engine is listening on.
Port int32
// contains filtered or unexported fields
}
Represents the information required for client programs to connect to the cluster and its nodes.
type EngineVersionInfo ¶
type EngineVersionInfo struct {
// The name of the engine for which version information is provided.
Engine *string
// The patched engine version
EnginePatchVersion *string
// The engine version
EngineVersion *string
// Specifies the name of the parameter group family to which the engine default
// parameters apply.
ParameterGroupFamily *string
// contains filtered or unexported fields
}
Provides details of the Redis OSS engine version
type Event ¶
type Event struct {
// The date and time when the event occurred.
Date *time.Time
// The text of the event.
Message *string
// The name 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.
SourceName *string
// Specifies the origin of this event - a cluster, a parameter group, a security
// group, etc.
SourceType SourceType
// contains filtered or unexported fields
}
Represents a single occurrence of something interesting within the system. Some examples of events are creating a cluster or adding or removing a node.
type Filter ¶
type Filter struct {
// The property being filtered. For example, UserName.
//
// This member is required.
Name *string
// The property values to filter on. For example, "user-123".
//
// This member is required.
Values []string
// contains filtered or unexported fields
}
Used to streamline results of a search based on the property being filtered.
type InputAuthenticationType ¶
type InputAuthenticationType string
const ( InputAuthenticationTypePassword InputAuthenticationType = "password" InputAuthenticationTypeIam InputAuthenticationType = "iam" )
Enum values for InputAuthenticationType
func (InputAuthenticationType) Values ¶
func (InputAuthenticationType) Values() []InputAuthenticationType
Values returns all known values for InputAuthenticationType. 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 InsufficientClusterCapacityFault ¶
type InsufficientClusterCapacityFault struct {
Message *string
ErrorCodeOverride *string
// contains filtered or unexported fields
}
The cluster does not have sufficient capacity to perform the requested operation.
func (*InsufficientClusterCapacityFault) Error ¶
func (e *InsufficientClusterCapacityFault) Error() string
func (*InsufficientClusterCapacityFault) ErrorCode ¶
func (e *InsufficientClusterCapacityFault) ErrorCode() string
func (*InsufficientClusterCapacityFault) ErrorFault ¶
func (e *InsufficientClusterCapacityFault) ErrorFault() smithy.ErrorFault
func (*InsufficientClusterCapacityFault) ErrorMessage ¶
func (e *InsufficientClusterCapacityFault) ErrorMessage() string
type InvalidACLStateFault ¶
type InvalidACLStateFault struct {
Message *string
ErrorCodeOverride *string
// contains filtered or unexported fields
}
The ACL is not in a valid state for the requested operation.
func (*InvalidACLStateFault) Error ¶
func (e *InvalidACLStateFault) Error() string
func (*InvalidACLStateFault) ErrorCode ¶
func (e *InvalidACLStateFault) ErrorCode() string
func (*InvalidACLStateFault) ErrorFault ¶
func (e *InvalidACLStateFault) ErrorFault() smithy.ErrorFault
func (*InvalidACLStateFault) ErrorMessage ¶
func (e *InvalidACLStateFault) ErrorMessage() string
type InvalidARNFault ¶
type InvalidARNFault struct {
Message *string
ErrorCodeOverride *string
// contains filtered or unexported fields
}
The specified Amazon Resource Name (ARN) is not valid.
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 InvalidClusterStateFault ¶
type InvalidClusterStateFault struct {
Message *string
ErrorCodeOverride *string
// contains filtered or unexported fields
}
The cluster is not in a valid state for the requested operation.
func (*InvalidClusterStateFault) Error ¶
func (e *InvalidClusterStateFault) Error() string
func (*InvalidClusterStateFault) ErrorCode ¶
func (e *InvalidClusterStateFault) ErrorCode() string
func (*InvalidClusterStateFault) ErrorFault ¶
func (e *InvalidClusterStateFault) ErrorFault() smithy.ErrorFault
func (*InvalidClusterStateFault) ErrorMessage ¶
func (e *InvalidClusterStateFault) ErrorMessage() string
type InvalidCredentialsException ¶
type InvalidCredentialsException struct {
Message *string
ErrorCodeOverride *string
// contains filtered or unexported fields
}
The provided credentials are not valid.
func (*InvalidCredentialsException) Error ¶
func (e *InvalidCredentialsException) Error() string
func (*InvalidCredentialsException) ErrorCode ¶
func (e *InvalidCredentialsException) ErrorCode() string
func (*InvalidCredentialsException) ErrorFault ¶
func (e *InvalidCredentialsException) ErrorFault() smithy.ErrorFault
func (*InvalidCredentialsException) ErrorMessage ¶
func (e *InvalidCredentialsException) ErrorMessage() string
type InvalidKMSKeyFault ¶
type InvalidKMSKeyFault struct {
Message *string
ErrorCodeOverride *string
// contains filtered or unexported fields
}
The specified KMS key is not valid or accessible.
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 InvalidMultiRegionClusterStateFault ¶ added in v1.25.0
type InvalidMultiRegionClusterStateFault struct {
Message *string
ErrorCodeOverride *string
// contains filtered or unexported fields
}
The requested operation cannot be performed on the multi-Region cluster in its current state.
func (*InvalidMultiRegionClusterStateFault) Error ¶ added in v1.25.0
func (e *InvalidMultiRegionClusterStateFault) Error() string
func (*InvalidMultiRegionClusterStateFault) ErrorCode ¶ added in v1.25.0
func (e *InvalidMultiRegionClusterStateFault) ErrorCode() string
func (*InvalidMultiRegionClusterStateFault) ErrorFault ¶ added in v1.25.0
func (e *InvalidMultiRegionClusterStateFault) ErrorFault() smithy.ErrorFault
func (*InvalidMultiRegionClusterStateFault) ErrorMessage ¶ added in v1.25.0
func (e *InvalidMultiRegionClusterStateFault) ErrorMessage() string
type InvalidNodeStateFault ¶
type InvalidNodeStateFault struct {
Message *string
ErrorCodeOverride *string
// contains filtered or unexported fields
}
The node is not in a valid state for the requested operation.
func (*InvalidNodeStateFault) Error ¶
func (e *InvalidNodeStateFault) Error() string
func (*InvalidNodeStateFault) ErrorCode ¶
func (e *InvalidNodeStateFault) ErrorCode() string
func (*InvalidNodeStateFault) ErrorFault ¶
func (e *InvalidNodeStateFault) ErrorFault() smithy.ErrorFault
func (*InvalidNodeStateFault) ErrorMessage ¶
func (e *InvalidNodeStateFault) ErrorMessage() string
type InvalidParameterCombinationException ¶
type InvalidParameterCombinationException struct {
Message *string
ErrorCodeOverride *string
// contains filtered or unexported fields
}
The specified parameter combination is not valid.
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 InvalidParameterGroupStateFault ¶
type InvalidParameterGroupStateFault struct {
Message *string
ErrorCodeOverride *string
// contains filtered or unexported fields
}
The parameter group is not in a valid state for the requested operation.
func (*InvalidParameterGroupStateFault) Error ¶
func (e *InvalidParameterGroupStateFault) Error() string
func (*InvalidParameterGroupStateFault) ErrorCode ¶
func (e *InvalidParameterGroupStateFault) ErrorCode() string
func (*InvalidParameterGroupStateFault) ErrorFault ¶
func (e *InvalidParameterGroupStateFault) ErrorFault() smithy.ErrorFault
func (*InvalidParameterGroupStateFault) ErrorMessage ¶
func (e *InvalidParameterGroupStateFault) ErrorMessage() string
type InvalidParameterValueException ¶
type InvalidParameterValueException struct {
Message *string
ErrorCodeOverride *string
// contains filtered or unexported fields
}
The specified parameter value is not valid.
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 InvalidSnapshotStateFault ¶
type InvalidSnapshotStateFault struct {
Message *string
ErrorCodeOverride *string
// contains filtered or unexported fields
}
The snapshot is not in a valid state for the requested operation.
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
ErrorCodeOverride *string
// contains filtered or unexported fields
}
The specified subnet is not valid.
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 InvalidUserStateFault ¶
type InvalidUserStateFault struct {
Message *string
ErrorCodeOverride *string
// contains filtered or unexported fields
}
The user is not in a valid state for the requested operation.
func (*InvalidUserStateFault) Error ¶
func (e *InvalidUserStateFault) Error() string
func (*InvalidUserStateFault) ErrorCode ¶
func (e *InvalidUserStateFault) ErrorCode() string
func (*InvalidUserStateFault) ErrorFault ¶
func (e *InvalidUserStateFault) ErrorFault() smithy.ErrorFault
func (*InvalidUserStateFault) ErrorMessage ¶
func (e *InvalidUserStateFault) ErrorMessage() string
type InvalidVPCNetworkStateFault ¶
type InvalidVPCNetworkStateFault struct {
Message *string
ErrorCodeOverride *string
// contains filtered or unexported fields
}
The VPC network is not in a valid state for the requested operation.
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 IpDiscovery ¶ added in v1.27.0
type IpDiscovery string
const ( IpDiscoveryIpv4 IpDiscovery = "ipv4" IpDiscoveryIpv6 IpDiscovery = "ipv6" )
Enum values for IpDiscovery
func (IpDiscovery) Values ¶ added in v1.27.0
func (IpDiscovery) Values() []IpDiscovery
Values returns all known values for IpDiscovery. 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 MultiRegionCluster ¶ added in v1.25.0
type MultiRegionCluster struct {
// The Amazon Resource Name (ARN) of the multi-Region cluster.
ARN *string
// The clusters in this multi-Region cluster.
Clusters []RegionalCluster
// The description of the multi-Region cluster.
Description *string
// The name of the engine used by the multi-Region cluster.
Engine *string
// The version of the engine used by the multi-Region cluster.
EngineVersion *string
// The name of the multi-Region cluster.
MultiRegionClusterName *string
// The name of the multi-Region parameter group associated with the cluster.
MultiRegionParameterGroupName *string
// The node type used by the multi-Region cluster.
NodeType *string
// The number of shards in the multi-Region cluster.
NumberOfShards *int32
// The current status of the multi-Region cluster.
Status *string
// Indiciates if the multi-Region cluster is TLS enabled.
TLSEnabled *bool
// contains filtered or unexported fields
}
Represents a multi-Region cluster.
type MultiRegionClusterAlreadyExistsFault ¶ added in v1.25.0
type MultiRegionClusterAlreadyExistsFault struct {
Message *string
ErrorCodeOverride *string
// contains filtered or unexported fields
}
A multi-Region cluster with the specified name already exists.
func (*MultiRegionClusterAlreadyExistsFault) Error ¶ added in v1.25.0
func (e *MultiRegionClusterAlreadyExistsFault) Error() string
func (*MultiRegionClusterAlreadyExistsFault) ErrorCode ¶ added in v1.25.0
func (e *MultiRegionClusterAlreadyExistsFault) ErrorCode() string
func (*MultiRegionClusterAlreadyExistsFault) ErrorFault ¶ added in v1.25.0
func (e *MultiRegionClusterAlreadyExistsFault) ErrorFault() smithy.ErrorFault
func (*MultiRegionClusterAlreadyExistsFault) ErrorMessage ¶ added in v1.25.0
func (e *MultiRegionClusterAlreadyExistsFault) ErrorMessage() string
type MultiRegionClusterNotFoundFault ¶ added in v1.25.0
type MultiRegionClusterNotFoundFault struct {
Message *string
ErrorCodeOverride *string
// contains filtered or unexported fields
}
The specified multi-Region cluster does not exist.
func (*MultiRegionClusterNotFoundFault) Error ¶ added in v1.25.0
func (e *MultiRegionClusterNotFoundFault) Error() string
func (*MultiRegionClusterNotFoundFault) ErrorCode ¶ added in v1.25.0
func (e *MultiRegionClusterNotFoundFault) ErrorCode() string
func (*MultiRegionClusterNotFoundFault) ErrorFault ¶ added in v1.25.0
func (e *MultiRegionClusterNotFoundFault) ErrorFault() smithy.ErrorFault
func (*MultiRegionClusterNotFoundFault) ErrorMessage ¶ added in v1.25.0
func (e *MultiRegionClusterNotFoundFault) ErrorMessage() string
type MultiRegionParameter ¶ added in v1.32.0
type MultiRegionParameter struct {
// The valid range of values for the parameter.
AllowedValues *string
// The valid data type for the parameter.
DataType *string
// A description of the parameter.
Description *string
// The earliest engine version to which the parameter can apply.
MinimumEngineVersion *string
// The name of the parameter.
Name *string
// Indicates the source of the parameter value. Valid values: user | system |
// engine-default
Source *string
// The value of the parameter.
Value *string
// contains filtered or unexported fields
}
Describes an individual setting that controls some aspect of MemoryDB behavior across multiple regions.
type MultiRegionParameterGroup ¶ added in v1.32.0
type MultiRegionParameterGroup struct {
// The Amazon Resource Name (ARN) of the multi-region parameter group.
ARN *string
// A description of the multi-region parameter group.
Description *string
// The name of the parameter group family that this multi-region parameter group
// is compatible with.
Family *string
// The name of the multi-region parameter group.
Name *string
// contains filtered or unexported fields
}
Represents the output of a CreateMultiRegionParameterGroup operation. A multi-region parameter group represents a collection of parameters that can be applied to clusters across multiple regions.
type MultiRegionParameterGroupNotFoundFault ¶ added in v1.25.0
type MultiRegionParameterGroupNotFoundFault struct {
Message *string
ErrorCodeOverride *string
// contains filtered or unexported fields
}
The specified multi-Region parameter group does not exist.
func (*MultiRegionParameterGroupNotFoundFault) Error ¶ added in v1.25.0
func (e *MultiRegionParameterGroupNotFoundFault) Error() string
func (*MultiRegionParameterGroupNotFoundFault) ErrorCode ¶ added in v1.25.0
func (e *MultiRegionParameterGroupNotFoundFault) ErrorCode() string
func (*MultiRegionParameterGroupNotFoundFault) ErrorFault ¶ added in v1.25.0
func (e *MultiRegionParameterGroupNotFoundFault) ErrorFault() smithy.ErrorFault
func (*MultiRegionParameterGroupNotFoundFault) ErrorMessage ¶ added in v1.25.0
func (e *MultiRegionParameterGroupNotFoundFault) ErrorMessage() string
type NetworkType ¶ added in v1.27.0
type NetworkType string
const ( NetworkTypeIpv4 NetworkType = "ipv4" NetworkTypeIpv6 NetworkType = "ipv6" NetworkTypeDualStack NetworkType = "dual_stack" )
Enum values for NetworkType
func (NetworkType) Values ¶ added in v1.27.0
func (NetworkType) Values() []NetworkType
Values returns all known values for NetworkType. 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
ErrorCodeOverride *string
// contains filtered or unexported fields
}
The requested operation would result in no changes.
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 Node ¶
type Node struct {
// The Availability Zone in which the node resides
AvailabilityZone *string
// The date and time when the node was created.
CreateTime *time.Time
// The hostname for connecting to this node.
Endpoint *Endpoint
// The node identifier. A node name is a numeric identifier (0001, 0002, etc.).
// The combination of cluster name, shard name and node name uniquely identifies
// every node used in a customer's Amazon account.
Name *string
// The status of the service update on the node
Status *string
// contains filtered or unexported fields
}
Represents an individual node within a cluster. Each node runs its own instance of the cluster's protocol-compliant caching software.
type NodeQuotaForClusterExceededFault ¶
type NodeQuotaForClusterExceededFault struct {
Message *string
ErrorCodeOverride *string
// contains filtered or unexported fields
}
The request cannot be processed because it would exceed the maximum number of nodes allowed for this 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
ErrorCodeOverride *string
// contains filtered or unexported fields
}
The request cannot be processed because it would exceed the maximum number of nodes allowed for this 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 Parameter ¶
type Parameter struct {
// The valid range of values for the parameter.
AllowedValues *string
// The parameter's data type
DataType *string
// A description of the parameter
Description *string
// The earliest engine version to which the parameter can apply.
MinimumEngineVersion *string
// The name of the parameter
Name *string
// The value of the parameter
Value *string
// contains filtered or unexported fields
}
Describes an individual setting that controls some aspect of MemoryDB behavior.
type ParameterGroup ¶
type ParameterGroup struct {
// The Amazon Resource Name (ARN) of the parameter group
ARN *string
// A description of the parameter group
Description *string
// The name of the parameter group family that this parameter group is compatible
// with.
Family *string
// The name of the parameter group
Name *string
// contains filtered or unexported fields
}
Represents the output of a CreateParameterGroup operation. A parameter group represents a combination of specific values for the parameters that are passed to the engine software during startup.
type ParameterGroupAlreadyExistsFault ¶
type ParameterGroupAlreadyExistsFault struct {
Message *string
ErrorCodeOverride *string
// contains filtered or unexported fields
}
A parameter group with the specified name already exists.
func (*ParameterGroupAlreadyExistsFault) Error ¶
func (e *ParameterGroupAlreadyExistsFault) Error() string
func (*ParameterGroupAlreadyExistsFault) ErrorCode ¶
func (e *ParameterGroupAlreadyExistsFault) ErrorCode() string
func (*ParameterGroupAlreadyExistsFault) ErrorFault ¶
func (e *ParameterGroupAlreadyExistsFault) ErrorFault() smithy.ErrorFault
func (*ParameterGroupAlreadyExistsFault) ErrorMessage ¶
func (e *ParameterGroupAlreadyExistsFault) ErrorMessage() string
type ParameterGroupNotFoundFault ¶
type ParameterGroupNotFoundFault struct {
Message *string
ErrorCodeOverride *string
// contains filtered or unexported fields
}
The specified parameter group does not exist.
func (*ParameterGroupNotFoundFault) Error ¶
func (e *ParameterGroupNotFoundFault) Error() string
func (*ParameterGroupNotFoundFault) ErrorCode ¶
func (e *ParameterGroupNotFoundFault) ErrorCode() string
func (*ParameterGroupNotFoundFault) ErrorFault ¶
func (e *ParameterGroupNotFoundFault) ErrorFault() smithy.ErrorFault
func (*ParameterGroupNotFoundFault) ErrorMessage ¶
func (e *ParameterGroupNotFoundFault) ErrorMessage() string
type ParameterGroupQuotaExceededFault ¶
type ParameterGroupQuotaExceededFault struct {
Message *string
ErrorCodeOverride *string
// contains filtered or unexported fields
}
The request cannot be processed because it would exceed the maximum number of parameter groups allowed.
func (*ParameterGroupQuotaExceededFault) Error ¶
func (e *ParameterGroupQuotaExceededFault) Error() string
func (*ParameterGroupQuotaExceededFault) ErrorCode ¶
func (e *ParameterGroupQuotaExceededFault) ErrorCode() string
func (*ParameterGroupQuotaExceededFault) ErrorFault ¶
func (e *ParameterGroupQuotaExceededFault) ErrorFault() smithy.ErrorFault
func (*ParameterGroupQuotaExceededFault) ErrorMessage ¶
func (e *ParameterGroupQuotaExceededFault) ErrorMessage() string
type ParameterNameValue ¶
type ParameterNameValue struct {
// The name of the parameter
ParameterName *string
// The value of the parameter
ParameterValue *string
// contains filtered or unexported fields
}
Describes a name-value pair that is used to update the value of a parameter.
type PendingModifiedServiceUpdate ¶
type PendingModifiedServiceUpdate struct {
// The unique ID of the service update
ServiceUpdateName *string
// The status of the service update
Status ServiceUpdateStatus
// contains filtered or unexported fields
}
Update action that has yet to be processed for the corresponding apply/stop request
type RecurringCharge ¶ added in v1.11.0
type RecurringCharge struct {
// The amount of the recurring charge to run this reserved node.
RecurringChargeAmount float64
// The frequency of the recurring price charged to run this reserved node.
RecurringChargeFrequency *string
// contains filtered or unexported fields
}
The recurring charge to run this reserved node.
type RegionalCluster ¶ added in v1.25.0
type RegionalCluster struct {
// The Amazon Resource Name (ARN) the Regional cluster
ARN *string
// The name of the Regional cluster
ClusterName *string
// The Region the current Regional cluster is assigned to.
Region *string
// The status of the Regional cluster.
Status *string
// contains filtered or unexported fields
}
Represents a Regional cluster
type ReplicaConfigurationRequest ¶
type ReplicaConfigurationRequest struct {
// The number of replicas to scale up or down to
ReplicaCount int32
// contains filtered or unexported fields
}
A request to configure the number of replicas in a shard
type ReservedNode ¶ added in v1.11.0
type ReservedNode struct {
// The Amazon Resource Name (ARN) of the reserved node.
ARN *string
// The duration of the reservation in seconds.
Duration int32
// The fixed price charged for this reserved node.
FixedPrice float64
// The number of nodes that have been reserved.
NodeCount int32
// The node type for the reserved nodes.
NodeType *string
// The offering type of this reserved node.
OfferingType *string
// The recurring price charged to run this reserved node.
RecurringCharges []RecurringCharge
// A customer-specified identifier to track this reservation.
ReservationId *string
// The ID of the reserved node offering to purchase.
ReservedNodesOfferingId *string
// The time the reservation started.
StartTime *time.Time
// The state of the reserved node.
State *string
// contains filtered or unexported fields
}
Represents the output of a PurchaseReservedNodesOffering operation.
type ReservedNodeAlreadyExistsFault ¶ added in v1.11.0
type ReservedNodeAlreadyExistsFault struct {
Message *string
ErrorCodeOverride *string
// contains filtered or unexported fields
}
You already have a reservation with the given identifier.
func (*ReservedNodeAlreadyExistsFault) Error ¶ added in v1.11.0
func (e *ReservedNodeAlreadyExistsFault) Error() string
func (*ReservedNodeAlreadyExistsFault) ErrorCode ¶ added in v1.11.0
func (e *ReservedNodeAlreadyExistsFault) ErrorCode() string
func (*ReservedNodeAlreadyExistsFault) ErrorFault ¶ added in v1.11.0
func (e *ReservedNodeAlreadyExistsFault) ErrorFault() smithy.ErrorFault
func (*ReservedNodeAlreadyExistsFault) ErrorMessage ¶ added in v1.11.0
func (e *ReservedNodeAlreadyExistsFault) ErrorMessage() string
type ReservedNodeNotFoundFault ¶ added in v1.11.0
type ReservedNodeNotFoundFault struct {
Message *string
ErrorCodeOverride *string
// contains filtered or unexported fields
}
The requested node does not exist.
func (*ReservedNodeNotFoundFault) Error ¶ added in v1.11.0
func (e *ReservedNodeNotFoundFault) Error() string
func (*ReservedNodeNotFoundFault) ErrorCode ¶ added in v1.11.0
func (e *ReservedNodeNotFoundFault) ErrorCode() string
func (*ReservedNodeNotFoundFault) ErrorFault ¶ added in v1.11.0
func (e *ReservedNodeNotFoundFault) ErrorFault() smithy.ErrorFault
func (*ReservedNodeNotFoundFault) ErrorMessage ¶ added in v1.11.0
func (e *ReservedNodeNotFoundFault) ErrorMessage() string
type ReservedNodeQuotaExceededFault ¶ added in v1.11.0
type ReservedNodeQuotaExceededFault struct {
Message *string
ErrorCodeOverride *string
// contains filtered or unexported fields
}
The request cannot be processed because it would exceed the user's node quota.
func (*ReservedNodeQuotaExceededFault) Error ¶ added in v1.11.0
func (e *ReservedNodeQuotaExceededFault) Error() string
func (*ReservedNodeQuotaExceededFault) ErrorCode ¶ added in v1.11.0
func (e *ReservedNodeQuotaExceededFault) ErrorCode() string
func (*ReservedNodeQuotaExceededFault) ErrorFault ¶ added in v1.11.0
func (e *ReservedNodeQuotaExceededFault) ErrorFault() smithy.ErrorFault
func (*ReservedNodeQuotaExceededFault) ErrorMessage ¶ added in v1.11.0
func (e *ReservedNodeQuotaExceededFault) ErrorMessage() string
type ReservedNodesOffering ¶ added in v1.11.0
type ReservedNodesOffering struct {
// The duration of the reservation in seconds.
Duration int32
// The fixed price charged for this reserved node.
FixedPrice float64
// The node type for the reserved nodes. For more information, see [Supported node types].
//
// [Supported node types]: https://docs.aws.amazon.com/memorydb/latest/devguide/nodes.reserved.html#reserved-nodes-supported
NodeType *string
// The offering type of this reserved node.
OfferingType *string
// The recurring price charged to run this reserved node.
RecurringCharges []RecurringCharge
// The offering identifier.
ReservedNodesOfferingId *string
// contains filtered or unexported fields
}
The offering type of this node.
type ReservedNodesOfferingNotFoundFault ¶ added in v1.11.0
type ReservedNodesOfferingNotFoundFault struct {
Message *string
ErrorCodeOverride *string
// contains filtered or unexported fields
}
The requested node offering does not exist.
func (*ReservedNodesOfferingNotFoundFault) Error ¶ added in v1.11.0
func (e *ReservedNodesOfferingNotFoundFault) Error() string
func (*ReservedNodesOfferingNotFoundFault) ErrorCode ¶ added in v1.11.0
func (e *ReservedNodesOfferingNotFoundFault) ErrorCode() string
func (*ReservedNodesOfferingNotFoundFault) ErrorFault ¶ added in v1.11.0
func (e *ReservedNodesOfferingNotFoundFault) ErrorFault() smithy.ErrorFault
func (*ReservedNodesOfferingNotFoundFault) ErrorMessage ¶ added in v1.11.0
func (e *ReservedNodesOfferingNotFoundFault) ErrorMessage() string
type ReshardingStatus ¶
type ReshardingStatus struct {
// The status of the online resharding slot migration
SlotMigration *SlotMigration
// contains filtered or unexported fields
}
The status of the online resharding
type SecurityGroupMembership ¶
type SecurityGroupMembership struct {
// The identifier of the security group.
SecurityGroupId *string
// The status of the security group membership. The status changes whenever a
// security group is modified, or when the security groups assigned to a cluster
// are modified.
Status *string
// contains filtered or unexported fields
}
Represents a single security group and its status.
type ServiceLinkedRoleNotFoundFault ¶
type ServiceLinkedRoleNotFoundFault struct {
Message *string
ErrorCodeOverride *string
// contains filtered or unexported fields
}
The required service-linked role 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 {
// The date at which the service update will be automatically applied
AutoUpdateStartDate *time.Time
// The name of the cluster to which the service update applies
ClusterName *string
// Provides details of the service update
Description *string
// The name of the engine for which a service update is available.
Engine *string
// A list of nodes updated by the service update
NodesUpdated *string
// The date when the service update is initially available
ReleaseDate *time.Time
// The unique ID of the service update
ServiceUpdateName *string
// The status of the service update
Status ServiceUpdateStatus
// Reflects the nature of the service update
Type ServiceUpdateType
// contains filtered or unexported fields
}
An update that you can apply to your MemoryDB clusters.
type ServiceUpdateNotFoundFault ¶
type ServiceUpdateNotFoundFault struct {
Message *string
ErrorCodeOverride *string
// contains filtered or unexported fields
}
The specified service update does not 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 ServiceUpdateRequest ¶
type ServiceUpdateRequest struct {
// The unique ID of the service update
ServiceUpdateNameToApply *string
// contains filtered or unexported fields
}
A request to apply a service update
type ServiceUpdateStatus ¶
type ServiceUpdateStatus string
const ( ServiceUpdateStatusNotApplied ServiceUpdateStatus = "available" ServiceUpdateStatusInProgress ServiceUpdateStatus = "in-progress" ServiceUpdateStatusComplete ServiceUpdateStatus = "complete" ServiceUpdateStatusScheduled ServiceUpdateStatus = "scheduled" )
Enum values for ServiceUpdateStatus
func (ServiceUpdateStatus) Values ¶
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 ¶
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 Shard ¶
type Shard struct {
// The name of the shard
Name *string
// A list containing information about individual nodes within the shard
Nodes []Node
// The number of nodes in the shard
NumberOfNodes *int32
// The keyspace for this shard.
Slots *string
// The current state of this replication group - creating, available, modifying,
// deleting.
Status *string
// contains filtered or unexported fields
}
Represents a collection of nodes in a cluster. One node in the node group is the read/write primary node. All the other nodes are read-only Replica nodes.
type ShardConfiguration ¶
type ShardConfiguration struct {
// The number of read replica nodes in this shard.
ReplicaCount *int32
// 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.
Slots *string
// contains filtered or unexported fields
}
Shard configuration options. Each shard configuration has the following: Slots and ReplicaCount.
type ShardConfigurationRequest ¶
type ShardConfigurationRequest struct {
// The number of shards in the cluster
ShardCount int32
// contains filtered or unexported fields
}
A request to configure the sharding properties of a cluster
type ShardDetail ¶
type ShardDetail struct {
// The configuration details of the shard
Configuration *ShardConfiguration
// The name of the shard
Name *string
// The size of the shard's snapshot
Size *string
// The date and time that the shard's snapshot was created
SnapshotCreationTime *time.Time
// contains filtered or unexported fields
}
Provides details of a shard in a snapshot
type ShardNotFoundFault ¶
type ShardNotFoundFault struct {
Message *string
ErrorCodeOverride *string
// contains filtered or unexported fields
}
The specified shard does not exist.
func (*ShardNotFoundFault) Error ¶
func (e *ShardNotFoundFault) Error() string
func (*ShardNotFoundFault) ErrorCode ¶
func (e *ShardNotFoundFault) ErrorCode() string
func (*ShardNotFoundFault) ErrorFault ¶
func (e *ShardNotFoundFault) ErrorFault() smithy.ErrorFault
func (*ShardNotFoundFault) ErrorMessage ¶
func (e *ShardNotFoundFault) ErrorMessage() string
type ShardsPerClusterQuotaExceededFault ¶
type ShardsPerClusterQuotaExceededFault struct {
Message *string
ErrorCodeOverride *string
// contains filtered or unexported fields
}
The request cannot be processed because it would exceed the maximum number of shards allowed per cluster.
func (*ShardsPerClusterQuotaExceededFault) Error ¶
func (e *ShardsPerClusterQuotaExceededFault) Error() string
func (*ShardsPerClusterQuotaExceededFault) ErrorCode ¶
func (e *ShardsPerClusterQuotaExceededFault) ErrorCode() string
func (*ShardsPerClusterQuotaExceededFault) ErrorFault ¶
func (e *ShardsPerClusterQuotaExceededFault) ErrorFault() smithy.ErrorFault
func (*ShardsPerClusterQuotaExceededFault) ErrorMessage ¶
func (e *ShardsPerClusterQuotaExceededFault) ErrorMessage() string
type SlotMigration ¶
type SlotMigration struct {
// The percentage of the slot migration that is complete.
ProgressPercentage float64
// contains filtered or unexported fields
}
Represents the progress of an online resharding operation.
type Snapshot ¶
type Snapshot struct {
// The ARN (Amazon Resource Name) of the snapshot.
ARN *string
// The configuration of the cluster from which the snapshot was taken
ClusterConfiguration *ClusterConfiguration
// Enables data tiering. Data tiering is only supported for clusters using the
// r6gd node type. This parameter must be set when using r6gd nodes. For more
// information, see [Data tiering].
//
// [Data tiering]: https://docs.aws.amazon.com/memorydb/latest/devguide/data-tiering.html
DataTiering DataTieringStatus
// The ID of the KMS key used to encrypt the snapshot.
KmsKeyId *string
// The name of the snapshot
Name *string
// Indicates whether the snapshot is from an automatic backup (automated) or was
// created manually (manual).
Source *string
// The status of the snapshot. Valid values: creating | available | restoring |
// copying | deleting.
Status *string
// contains filtered or unexported fields
}
Represents a copy of an entire cluster as of the time when the snapshot was taken.
type SnapshotAlreadyExistsFault ¶
type SnapshotAlreadyExistsFault struct {
Message *string
ErrorCodeOverride *string
// contains filtered or unexported fields
}
A snapshot with the specified name already exists.
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 SnapshotNotFoundFault ¶
type SnapshotNotFoundFault struct {
Message *string
ErrorCodeOverride *string
// contains filtered or unexported fields
}
The specified snapshot does not exist.
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
ErrorCodeOverride *string
// contains filtered or unexported fields
}
The request cannot be processed because it would exceed the maximum number of snapshots allowed.
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 ( SourceTypeNode SourceType = "node" SourceTypeParameterGroup SourceType = "parameter-group" SourceTypeSubnetGroup SourceType = "subnet-group" SourceTypeCluster SourceType = "cluster" SourceTypeUser SourceType = "user" SourceTypeAcl SourceType = "acl" )
Enum values for SourceType
func (SourceType) Values ¶
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 where the subnet resides
AvailabilityZone *AvailabilityZone
// The unique identifier for the subnet.
Identifier *string
// The network types supported by this subnet. Returns an array of strings that
// can include 'ipv4', 'ipv6', or both, indicating whether the subnet supports IPv4
// only, IPv6 only, or dual-stack deployments.
SupportedNetworkTypes []NetworkType
// contains filtered or unexported fields
}
Represents the subnet associated with a cluster. This parameter refers to subnets defined in Amazon Virtual Private Cloud (Amazon VPC) and used with MemoryDB.
type SubnetGroup ¶
type SubnetGroup struct {
// The ARN (Amazon Resource Name) of the subnet group.
ARN *string
// A description of the subnet group
Description *string
// The name of the subnet group
Name *string
// A list of subnets associated with the subnet group.
Subnets []Subnet
// The network types supported by this subnet group. Returns an array of strings
// that can include 'ipv4', 'ipv6', or both, indicating the IP address types that
// can be used for clusters deployed in this subnet group.
SupportedNetworkTypes []NetworkType
// The Amazon Virtual Private Cloud identifier (VPC ID) of the subnet group.
VpcId *string
// contains filtered or unexported fields
}
Represents the output of one of the following operations:
CreateSubnetGroup
UpdateSubnetGroup
A subnet group is a collection of subnets (typically private) that you can designate for your clusters running in an Amazon Virtual Private Cloud (VPC) environment.
type SubnetGroupAlreadyExistsFault ¶
type SubnetGroupAlreadyExistsFault struct {
Message *string
ErrorCodeOverride *string
// contains filtered or unexported fields
}
A subnet group with the specified name already exists.
func (*SubnetGroupAlreadyExistsFault) Error ¶
func (e *SubnetGroupAlreadyExistsFault) Error() string
func (*SubnetGroupAlreadyExistsFault) ErrorCode ¶
func (e *SubnetGroupAlreadyExistsFault) ErrorCode() string
func (*SubnetGroupAlreadyExistsFault) ErrorFault ¶
func (e *SubnetGroupAlreadyExistsFault) ErrorFault() smithy.ErrorFault
func (*SubnetGroupAlreadyExistsFault) ErrorMessage ¶
func (e *SubnetGroupAlreadyExistsFault) ErrorMessage() string
type SubnetGroupInUseFault ¶
type SubnetGroupInUseFault struct {
Message *string
ErrorCodeOverride *string
// contains filtered or unexported fields
}
The subnet group is currently in use and cannot be deleted.
func (*SubnetGroupInUseFault) Error ¶
func (e *SubnetGroupInUseFault) Error() string
func (*SubnetGroupInUseFault) ErrorCode ¶
func (e *SubnetGroupInUseFault) ErrorCode() string
func (*SubnetGroupInUseFault) ErrorFault ¶
func (e *SubnetGroupInUseFault) ErrorFault() smithy.ErrorFault
func (*SubnetGroupInUseFault) ErrorMessage ¶
func (e *SubnetGroupInUseFault) ErrorMessage() string
type SubnetGroupNotFoundFault ¶
type SubnetGroupNotFoundFault struct {
Message *string
ErrorCodeOverride *string
// contains filtered or unexported fields
}
The specified subnet group does not exist.
func (*SubnetGroupNotFoundFault) Error ¶
func (e *SubnetGroupNotFoundFault) Error() string
func (*SubnetGroupNotFoundFault) ErrorCode ¶
func (e *SubnetGroupNotFoundFault) ErrorCode() string
func (*SubnetGroupNotFoundFault) ErrorFault ¶
func (e *SubnetGroupNotFoundFault) ErrorFault() smithy.ErrorFault
func (*SubnetGroupNotFoundFault) ErrorMessage ¶
func (e *SubnetGroupNotFoundFault) ErrorMessage() string
type SubnetGroupQuotaExceededFault ¶
type SubnetGroupQuotaExceededFault struct {
Message *string
ErrorCodeOverride *string
// contains filtered or unexported fields
}
The request cannot be processed because it would exceed the maximum number of subnet groups allowed.
func (*SubnetGroupQuotaExceededFault) Error ¶
func (e *SubnetGroupQuotaExceededFault) Error() string
func (*SubnetGroupQuotaExceededFault) ErrorCode ¶
func (e *SubnetGroupQuotaExceededFault) ErrorCode() string
func (*SubnetGroupQuotaExceededFault) ErrorFault ¶
func (e *SubnetGroupQuotaExceededFault) ErrorFault() smithy.ErrorFault
func (*SubnetGroupQuotaExceededFault) ErrorMessage ¶
func (e *SubnetGroupQuotaExceededFault) ErrorMessage() string
type SubnetInUse ¶
type SubnetInUse struct {
Message *string
ErrorCodeOverride *string
// contains filtered or unexported fields
}
The subnet is currently in use and cannot be deleted.
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 ¶
type SubnetNotAllowedFault struct {
Message *string
ErrorCodeOverride *string
// contains filtered or unexported fields
}
The specified subnet is not allowed for this operation.
func (*SubnetNotAllowedFault) Error ¶
func (e *SubnetNotAllowedFault) Error() string
func (*SubnetNotAllowedFault) ErrorCode ¶
func (e *SubnetNotAllowedFault) ErrorCode() string
func (*SubnetNotAllowedFault) ErrorFault ¶
func (e *SubnetNotAllowedFault) ErrorFault() smithy.ErrorFault
func (*SubnetNotAllowedFault) ErrorMessage ¶
func (e *SubnetNotAllowedFault) ErrorMessage() string
type SubnetQuotaExceededFault ¶
type SubnetQuotaExceededFault struct {
Message *string
ErrorCodeOverride *string
// contains filtered or unexported fields
}
The request cannot be processed because it would exceed the maximum number of subnets allowed.
func (*SubnetQuotaExceededFault) Error ¶
func (e *SubnetQuotaExceededFault) Error() string
func (*SubnetQuotaExceededFault) ErrorCode ¶
func (e *SubnetQuotaExceededFault) ErrorCode() string
func (*SubnetQuotaExceededFault) ErrorFault ¶
func (e *SubnetQuotaExceededFault) ErrorFault() smithy.ErrorFault
func (*SubnetQuotaExceededFault) ErrorMessage ¶
func (e *SubnetQuotaExceededFault) ErrorMessage() string
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
// contains filtered or unexported fields
}
A tag that can be added to an MemoryDB resource. Tags are composed of a Key/Value pair. You can use tags to categorize and track all your MemoryDB resources. When you add or remove tags on clusters, those actions will be replicated to all nodes in the cluster. A tag with a null Value is permitted. For more information, see Tagging your MemoryDB resources
type TagNotFoundFault ¶
type TagNotFoundFault struct {
Message *string
ErrorCodeOverride *string
// contains filtered or unexported fields
}
The specified tag does not exist.
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
ErrorCodeOverride *string
// contains filtered or unexported fields
}
The request cannot be processed because it would exceed the maximum number of tags allowed per resource.
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
ErrorCodeOverride *string
// contains filtered or unexported fields
}
Test failover is not available for this cluster configuration.
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 UnprocessedCluster ¶
type UnprocessedCluster struct {
// The name of the cluster
ClusterName *string
// The error message associated with the update failure
ErrorMessage *string
// The error type associated with the update failure
ErrorType *string
// contains filtered or unexported fields
}
A cluster whose updates have failed
type UpdateStrategy ¶ added in v1.25.0
type UpdateStrategy string
const ( UpdateStrategyCoordinated UpdateStrategy = "coordinated" UpdateStrategyUncoordinated UpdateStrategy = "uncoordinated" )
Enum values for UpdateStrategy
func (UpdateStrategy) Values ¶ added in v1.25.0
func (UpdateStrategy) Values() []UpdateStrategy
Values returns all known values for UpdateStrategy. 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 ¶
type User struct {
// The names of the Access Control Lists to which the user belongs
ACLNames []string
// 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 minimum engine version supported for the user
MinimumEngineVersion *string
// The name of the user
Name *string
// Indicates the user status. Can be "active", "modifying" or "deleting".
Status *string
// contains filtered or unexported fields
}
You create users and assign them specific permissions by using an access string. You assign the users to Access Control Lists aligned with a specific role (administrators, human resources) that are then deployed to one or more MemoryDB clusters.
type UserAlreadyExistsFault ¶
type UserAlreadyExistsFault struct {
Message *string
ErrorCodeOverride *string
// contains filtered or unexported fields
}
A user with the specified name already exists.
func (*UserAlreadyExistsFault) Error ¶
func (e *UserAlreadyExistsFault) Error() string
func (*UserAlreadyExistsFault) ErrorCode ¶
func (e *UserAlreadyExistsFault) ErrorCode() string
func (*UserAlreadyExistsFault) ErrorFault ¶
func (e *UserAlreadyExistsFault) ErrorFault() smithy.ErrorFault
func (*UserAlreadyExistsFault) ErrorMessage ¶
func (e *UserAlreadyExistsFault) ErrorMessage() string
type UserNotFoundFault ¶
type UserNotFoundFault struct {
Message *string
ErrorCodeOverride *string
// contains filtered or unexported fields
}
The specified user does not exist.
func (*UserNotFoundFault) Error ¶
func (e *UserNotFoundFault) Error() string
func (*UserNotFoundFault) ErrorCode ¶
func (e *UserNotFoundFault) ErrorCode() string
func (*UserNotFoundFault) ErrorFault ¶
func (e *UserNotFoundFault) ErrorFault() smithy.ErrorFault
func (*UserNotFoundFault) ErrorMessage ¶
func (e *UserNotFoundFault) ErrorMessage() string
type UserQuotaExceededFault ¶
type UserQuotaExceededFault struct {
Message *string
ErrorCodeOverride *string
// contains filtered or unexported fields
}
The request cannot be processed because it would exceed the maximum number of users allowed.
func (*UserQuotaExceededFault) Error ¶
func (e *UserQuotaExceededFault) Error() string
func (*UserQuotaExceededFault) ErrorCode ¶
func (e *UserQuotaExceededFault) ErrorCode() string
func (*UserQuotaExceededFault) ErrorFault ¶
func (e *UserQuotaExceededFault) ErrorFault() smithy.ErrorFault
func (*UserQuotaExceededFault) ErrorMessage ¶
func (e *UserQuotaExceededFault) ErrorMessage() string