Documentation ¶
Overview ¶
Package memorydb provides the API client, operations, and parameter types for Amazon MemoryDB.
Amazon MemoryDB for Redis is a fully managed, Redis-compatible, in-memory database that delivers ultra-fast performance and Multi-AZ durability for modern applications built using microservices architectures. MemoryDB stores the entire database in-memory, enabling low latency and high throughput data access. It is compatible with Redis, a popular open source data store, enabling you to leverage Redis’ flexible and friendly data structures, APIs, and commands.
Index ¶
- Constants
- func NewDefaultEndpointResolver() *internalendpoints.Resolver
- func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options)
- func WithEndpointResolver(v EndpointResolver) func(*Options)
- type BatchUpdateClusterInput
- type BatchUpdateClusterOutput
- type Client
- func (c *Client) BatchUpdateCluster(ctx context.Context, params *BatchUpdateClusterInput, optFns ...func(*Options)) (*BatchUpdateClusterOutput, error)
- func (c *Client) CopySnapshot(ctx context.Context, params *CopySnapshotInput, optFns ...func(*Options)) (*CopySnapshotOutput, error)
- func (c *Client) CreateACL(ctx context.Context, params *CreateACLInput, optFns ...func(*Options)) (*CreateACLOutput, error)
- func (c *Client) CreateCluster(ctx context.Context, params *CreateClusterInput, optFns ...func(*Options)) (*CreateClusterOutput, error)
- func (c *Client) CreateParameterGroup(ctx context.Context, params *CreateParameterGroupInput, ...) (*CreateParameterGroupOutput, error)
- func (c *Client) CreateSnapshot(ctx context.Context, params *CreateSnapshotInput, optFns ...func(*Options)) (*CreateSnapshotOutput, error)
- func (c *Client) CreateSubnetGroup(ctx context.Context, params *CreateSubnetGroupInput, optFns ...func(*Options)) (*CreateSubnetGroupOutput, error)
- func (c *Client) CreateUser(ctx context.Context, params *CreateUserInput, optFns ...func(*Options)) (*CreateUserOutput, error)
- func (c *Client) DeleteACL(ctx context.Context, params *DeleteACLInput, optFns ...func(*Options)) (*DeleteACLOutput, error)
- func (c *Client) DeleteCluster(ctx context.Context, params *DeleteClusterInput, optFns ...func(*Options)) (*DeleteClusterOutput, error)
- func (c *Client) DeleteParameterGroup(ctx context.Context, params *DeleteParameterGroupInput, ...) (*DeleteParameterGroupOutput, error)
- func (c *Client) DeleteSnapshot(ctx context.Context, params *DeleteSnapshotInput, optFns ...func(*Options)) (*DeleteSnapshotOutput, error)
- func (c *Client) DeleteSubnetGroup(ctx context.Context, params *DeleteSubnetGroupInput, optFns ...func(*Options)) (*DeleteSubnetGroupOutput, error)
- func (c *Client) DeleteUser(ctx context.Context, params *DeleteUserInput, optFns ...func(*Options)) (*DeleteUserOutput, error)
- func (c *Client) DescribeACLs(ctx context.Context, params *DescribeACLsInput, optFns ...func(*Options)) (*DescribeACLsOutput, error)
- func (c *Client) DescribeClusters(ctx context.Context, params *DescribeClustersInput, optFns ...func(*Options)) (*DescribeClustersOutput, error)
- func (c *Client) DescribeEngineVersions(ctx context.Context, params *DescribeEngineVersionsInput, ...) (*DescribeEngineVersionsOutput, error)
- func (c *Client) DescribeEvents(ctx context.Context, params *DescribeEventsInput, optFns ...func(*Options)) (*DescribeEventsOutput, error)
- func (c *Client) DescribeParameterGroups(ctx context.Context, params *DescribeParameterGroupsInput, ...) (*DescribeParameterGroupsOutput, error)
- func (c *Client) DescribeParameters(ctx context.Context, params *DescribeParametersInput, optFns ...func(*Options)) (*DescribeParametersOutput, error)
- func (c *Client) DescribeServiceUpdates(ctx context.Context, params *DescribeServiceUpdatesInput, ...) (*DescribeServiceUpdatesOutput, error)
- func (c *Client) DescribeSnapshots(ctx context.Context, params *DescribeSnapshotsInput, optFns ...func(*Options)) (*DescribeSnapshotsOutput, error)
- func (c *Client) DescribeSubnetGroups(ctx context.Context, params *DescribeSubnetGroupsInput, ...) (*DescribeSubnetGroupsOutput, error)
- func (c *Client) DescribeUsers(ctx context.Context, params *DescribeUsersInput, optFns ...func(*Options)) (*DescribeUsersOutput, error)
- func (c *Client) FailoverShard(ctx context.Context, params *FailoverShardInput, optFns ...func(*Options)) (*FailoverShardOutput, error)
- func (c *Client) ListAllowedNodeTypeUpdates(ctx context.Context, params *ListAllowedNodeTypeUpdatesInput, ...) (*ListAllowedNodeTypeUpdatesOutput, error)
- func (c *Client) ListTags(ctx context.Context, params *ListTagsInput, optFns ...func(*Options)) (*ListTagsOutput, error)
- func (c *Client) ResetParameterGroup(ctx context.Context, params *ResetParameterGroupInput, ...) (*ResetParameterGroupOutput, error)
- func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optFns ...func(*Options)) (*TagResourceOutput, error)
- func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, optFns ...func(*Options)) (*UntagResourceOutput, error)
- func (c *Client) UpdateACL(ctx context.Context, params *UpdateACLInput, optFns ...func(*Options)) (*UpdateACLOutput, error)
- func (c *Client) UpdateCluster(ctx context.Context, params *UpdateClusterInput, optFns ...func(*Options)) (*UpdateClusterOutput, error)
- func (c *Client) UpdateParameterGroup(ctx context.Context, params *UpdateParameterGroupInput, ...) (*UpdateParameterGroupOutput, error)
- func (c *Client) UpdateSubnetGroup(ctx context.Context, params *UpdateSubnetGroupInput, optFns ...func(*Options)) (*UpdateSubnetGroupOutput, error)
- func (c *Client) UpdateUser(ctx context.Context, params *UpdateUserInput, optFns ...func(*Options)) (*UpdateUserOutput, error)
- type CopySnapshotInput
- type CopySnapshotOutput
- type CreateACLInput
- type CreateACLOutput
- type CreateClusterInput
- type CreateClusterOutput
- type CreateParameterGroupInput
- type CreateParameterGroupOutput
- type CreateSnapshotInput
- type CreateSnapshotOutput
- type CreateSubnetGroupInput
- type CreateSubnetGroupOutput
- type CreateUserInput
- type CreateUserOutput
- type DeleteACLInput
- type DeleteACLOutput
- type DeleteClusterInput
- type DeleteClusterOutput
- type DeleteParameterGroupInput
- type DeleteParameterGroupOutput
- type DeleteSnapshotInput
- type DeleteSnapshotOutput
- type DeleteSubnetGroupInput
- type DeleteSubnetGroupOutput
- type DeleteUserInput
- type DeleteUserOutput
- type DescribeACLsInput
- type DescribeACLsOutput
- type DescribeClustersInput
- type DescribeClustersOutput
- type DescribeEngineVersionsInput
- type DescribeEngineVersionsOutput
- type DescribeEventsInput
- type DescribeEventsOutput
- type DescribeParameterGroupsInput
- type DescribeParameterGroupsOutput
- type DescribeParametersInput
- type DescribeParametersOutput
- type DescribeServiceUpdatesInput
- type DescribeServiceUpdatesOutput
- type DescribeSnapshotsInput
- type DescribeSnapshotsOutput
- type DescribeSubnetGroupsInput
- type DescribeSubnetGroupsOutput
- type DescribeUsersInput
- type DescribeUsersOutput
- type EndpointResolver
- type EndpointResolverFunc
- type EndpointResolverOptions
- type FailoverShardInput
- type FailoverShardOutput
- type HTTPClient
- type HTTPSignerV4
- type ListAllowedNodeTypeUpdatesInput
- type ListAllowedNodeTypeUpdatesOutput
- type ListTagsInput
- type ListTagsOutput
- type Options
- type ResetParameterGroupInput
- type ResetParameterGroupOutput
- type ResolveEndpoint
- type TagResourceInput
- type TagResourceOutput
- type UntagResourceInput
- type UntagResourceOutput
- type UpdateACLInput
- type UpdateACLOutput
- type UpdateClusterInput
- type UpdateClusterOutput
- type UpdateParameterGroupInput
- type UpdateParameterGroupOutput
- type UpdateSubnetGroupInput
- type UpdateSubnetGroupOutput
- type UpdateUserInput
- type UpdateUserOutput
Constants ¶
const ServiceAPIVersion = "2021-01-01"
const ServiceID = "MemoryDB"
Variables ¶
This section is empty.
Functions ¶
func NewDefaultEndpointResolver ¶
func NewDefaultEndpointResolver() *internalendpoints.Resolver
NewDefaultEndpointResolver constructs a new service endpoint resolver
func WithAPIOptions ¶
func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options)
WithAPIOptions returns a functional option for setting the Client's APIOptions option.
func WithEndpointResolver ¶
func WithEndpointResolver(v EndpointResolver) func(*Options)
WithEndpointResolver returns a functional option for setting the Client's EndpointResolver option.
Types ¶
type BatchUpdateClusterInput ¶
type BatchUpdateClusterInput struct { // The cluster names to apply the updates. // // This member is required. ClusterNames []string // The unique ID of the service update ServiceUpdate *types.ServiceUpdateRequest // contains filtered or unexported fields }
type BatchUpdateClusterOutput ¶
type BatchUpdateClusterOutput struct { // The list of clusters that have been updated. ProcessedClusters []types.Cluster // The list of clusters where updates have not been applied. UnprocessedClusters []types.UnprocessedCluster // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type Client ¶
type Client struct {
// contains filtered or unexported fields
}
Client provides the API client to make operations call for Amazon MemoryDB.
func New ¶
New returns an initialized Client based on the functional options. Provide additional functional options to further configure the behavior of the client, such as changing the client's endpoint or adding custom middleware behavior.
func NewFromConfig ¶
NewFromConfig returns a new client from the provided config.
func (*Client) BatchUpdateCluster ¶
func (c *Client) BatchUpdateCluster(ctx context.Context, params *BatchUpdateClusterInput, optFns ...func(*Options)) (*BatchUpdateClusterOutput, error)
Apply the service update to a list of clusters supplied. For more information on service updates and applying them, see Applying the service updates (https://docs.aws.amazon.com/AmazonMemoryDB/latest/devguide/managing-updates.html#applying-updates).
func (*Client) CopySnapshot ¶
func (c *Client) CopySnapshot(ctx context.Context, params *CopySnapshotInput, optFns ...func(*Options)) (*CopySnapshotOutput, error)
Makes a copy of an existing snapshot.
func (*Client) CreateACL ¶
func (c *Client) CreateACL(ctx context.Context, params *CreateACLInput, optFns ...func(*Options)) (*CreateACLOutput, error)
Creates an Access Control List. For more information, see Authenticating users with Access Contol Lists (ACLs) (https://docs.aws.amazon.com/AmazonMemoryDB/latest/devguide/Clusters.ACLs.html).
func (*Client) CreateCluster ¶
func (c *Client) CreateCluster(ctx context.Context, params *CreateClusterInput, optFns ...func(*Options)) (*CreateClusterOutput, error)
Creates a cluster. All nodes in the cluster run the same protocol-compliant engine software.
func (*Client) CreateParameterGroup ¶
func (c *Client) CreateParameterGroup(ctx context.Context, params *CreateParameterGroupInput, optFns ...func(*Options)) (*CreateParameterGroupOutput, error)
Creates a new MemoryDB parameter group. A parameter group is a collection of parameters and their values that are applied to all of the nodes in any cluster. For more information, see Configuring engine parameters using parameter groups (https://docs.aws.amazon.com/AmazonMemoryDB/latest/devguide/ParameterGroups.html).
func (*Client) CreateSnapshot ¶
func (c *Client) CreateSnapshot(ctx context.Context, params *CreateSnapshotInput, optFns ...func(*Options)) (*CreateSnapshotOutput, error)
Creates a copy of an entire cluster at a specific moment in time.
func (*Client) CreateSubnetGroup ¶
func (c *Client) CreateSubnetGroup(ctx context.Context, params *CreateSubnetGroupInput, optFns ...func(*Options)) (*CreateSubnetGroupOutput, error)
Creates a subnet group. 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. When you create a cluster in an Amazon VPC, you must specify a subnet group. MemoryDB uses that subnet group to choose a subnet and IP addresses within that subnet to associate with your nodes. For more information, see Subnets and subnet groups (https://docs.aws.amazon.com/AmazonMemoryDB/latest/devguide/SubnetGroups.html).
func (*Client) CreateUser ¶
func (c *Client) CreateUser(ctx context.Context, params *CreateUserInput, optFns ...func(*Options)) (*CreateUserOutput, error)
Creates a MemoryDB user. For more information, see Authenticating users with Access Contol Lists (ACLs) (https://docs.aws.amazon.com/AmazonMemoryDB/latest/devguide/Clusters.ACLs.html).
func (*Client) DeleteACL ¶
func (c *Client) DeleteACL(ctx context.Context, params *DeleteACLInput, optFns ...func(*Options)) (*DeleteACLOutput, error)
Deletes an Access Control List. The ACL must first be disassociated from the cluster before it can be deleted. For more information, see Authenticating users with Access Contol Lists (ACLs) (https://docs.aws.amazon.com/AmazonMemoryDB/latest/devguide/Clusters.ACLs.html).
func (*Client) DeleteCluster ¶
func (c *Client) DeleteCluster(ctx context.Context, params *DeleteClusterInput, optFns ...func(*Options)) (*DeleteClusterOutput, error)
Deletes a cluster. It also deletes all associated nodes and node endpoints
func (*Client) DeleteParameterGroup ¶
func (c *Client) DeleteParameterGroup(ctx context.Context, params *DeleteParameterGroupInput, optFns ...func(*Options)) (*DeleteParameterGroupOutput, error)
Deletes the specified parameter group. You cannot delete a parameter group if it is associated with any clusters. You cannot delete the default parameter groups in your account.
func (*Client) DeleteSnapshot ¶
func (c *Client) DeleteSnapshot(ctx context.Context, params *DeleteSnapshotInput, optFns ...func(*Options)) (*DeleteSnapshotOutput, error)
Deletes an existing snapshot. When you receive a successful response from this operation, MemoryDB immediately begins deleting the snapshot; you cannot cancel or revert this operation.
func (*Client) DeleteSubnetGroup ¶
func (c *Client) DeleteSubnetGroup(ctx context.Context, params *DeleteSubnetGroupInput, optFns ...func(*Options)) (*DeleteSubnetGroupOutput, error)
Deletes a subnet group. You cannot delete a default subnet group or one that is associated with any clusters.
func (*Client) DeleteUser ¶
func (c *Client) DeleteUser(ctx context.Context, params *DeleteUserInput, optFns ...func(*Options)) (*DeleteUserOutput, error)
Deletes a user. The user will be removed from all ACLs and in turn removed from all clusters.
func (*Client) DescribeACLs ¶
func (c *Client) DescribeACLs(ctx context.Context, params *DescribeACLsInput, optFns ...func(*Options)) (*DescribeACLsOutput, error)
Returns a list of ACLs
func (*Client) DescribeClusters ¶
func (c *Client) DescribeClusters(ctx context.Context, params *DescribeClustersInput, optFns ...func(*Options)) (*DescribeClustersOutput, error)
Returns information about all provisioned clusters if no cluster identifier is specified, or about a specific cluster if a cluster name is supplied.
func (*Client) DescribeEngineVersions ¶
func (c *Client) DescribeEngineVersions(ctx context.Context, params *DescribeEngineVersionsInput, optFns ...func(*Options)) (*DescribeEngineVersionsOutput, error)
Returns a list of the available Redis engine versions.
func (*Client) DescribeEvents ¶
func (c *Client) DescribeEvents(ctx context.Context, params *DescribeEventsInput, optFns ...func(*Options)) (*DescribeEventsOutput, error)
Returns events related to clusters, security groups, and parameter groups. You can obtain events specific to a particular cluster, security group, or parameter group by providing the name as a parameter. By default, only the events occurring within the last hour are returned; however, you can retrieve up to 14 days' worth of events if necessary.
func (*Client) DescribeParameterGroups ¶
func (c *Client) DescribeParameterGroups(ctx context.Context, params *DescribeParameterGroupsInput, optFns ...func(*Options)) (*DescribeParameterGroupsOutput, error)
Returns a list of parameter group descriptions. If a parameter group name is specified, the list contains only the descriptions for that group.
func (*Client) DescribeParameters ¶
func (c *Client) DescribeParameters(ctx context.Context, params *DescribeParametersInput, optFns ...func(*Options)) (*DescribeParametersOutput, error)
Returns the detailed parameter list for a particular parameter group.
func (*Client) DescribeServiceUpdates ¶
func (c *Client) DescribeServiceUpdates(ctx context.Context, params *DescribeServiceUpdatesInput, optFns ...func(*Options)) (*DescribeServiceUpdatesOutput, error)
Returns details of the service updates
func (*Client) DescribeSnapshots ¶
func (c *Client) DescribeSnapshots(ctx context.Context, params *DescribeSnapshotsInput, optFns ...func(*Options)) (*DescribeSnapshotsOutput, error)
Returns information about cluster snapshots. By default, DescribeSnapshots lists all of your snapshots; it can optionally describe a single snapshot, or just the snapshots associated with a particular cluster.
func (*Client) DescribeSubnetGroups ¶
func (c *Client) DescribeSubnetGroups(ctx context.Context, params *DescribeSubnetGroupsInput, optFns ...func(*Options)) (*DescribeSubnetGroupsOutput, error)
Returns a list of subnet group descriptions. If a subnet group name is specified, the list contains only the description of that group.
func (*Client) DescribeUsers ¶
func (c *Client) DescribeUsers(ctx context.Context, params *DescribeUsersInput, optFns ...func(*Options)) (*DescribeUsersOutput, error)
Returns a list of users.
func (*Client) FailoverShard ¶
func (c *Client) FailoverShard(ctx context.Context, params *FailoverShardInput, optFns ...func(*Options)) (*FailoverShardOutput, error)
Used to failover a shard
func (*Client) ListAllowedNodeTypeUpdates ¶
func (c *Client) ListAllowedNodeTypeUpdates(ctx context.Context, params *ListAllowedNodeTypeUpdatesInput, optFns ...func(*Options)) (*ListAllowedNodeTypeUpdatesOutput, error)
Lists all available node types that you can scale to from your cluster's current node type. When you use the UpdateCluster operation to scale your cluster, the value of the NodeType parameter must be one of the node types returned by this operation.
func (*Client) ListTags ¶
func (c *Client) ListTags(ctx context.Context, params *ListTagsInput, optFns ...func(*Options)) (*ListTagsOutput, error)
Lists all tags currently on a named resource. A tag is a key-value pair where the key and value are case-sensitive. You can use tags to categorize and track your MemoryDB resources. For more information, see Tagging your MemoryDB resources (https://docs.aws.amazon.com/AmazonMemoryDB/latest/devguide/Tagging-Resources.html)
func (*Client) ResetParameterGroup ¶
func (c *Client) ResetParameterGroup(ctx context.Context, params *ResetParameterGroupInput, optFns ...func(*Options)) (*ResetParameterGroupOutput, error)
Modifies the parameters of a parameter group to the engine or system default value. You can reset specific parameters by submitting a list of parameter names. To reset the entire parameter group, specify the AllParameters and ParameterGroupName parameters.
func (*Client) TagResource ¶
func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optFns ...func(*Options)) (*TagResourceOutput, error)
A tag is a key-value pair where the key and value are case-sensitive. You can use tags to categorize and track all your MemoryDB resources. When you add or remove tags on clusters, those actions will be replicated to all nodes in the cluster. For more information, see Resource-level permissions (https://docs.aws.amazon.com/AmazonMemoryDB/latest/devguide/IAM.ResourceLevelPermissions.html). For example, you can use cost-allocation tags to your MemoryDB resources, Amazon generates a cost allocation report as a comma-separated value (CSV) file with your usage and costs aggregated by your tags. You can apply tags that represent business categories (such as cost centers, application names, or owners) to organize your costs across multiple services. For more information, see Using Cost Allocation Tags (https://docs.aws.amazon.com/AmazonMemoryDB/latest/devguide/Tagging.html).
func (*Client) UntagResource ¶
func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, optFns ...func(*Options)) (*UntagResourceOutput, error)
Use this operation to remove tags on a resource
func (*Client) UpdateACL ¶
func (c *Client) UpdateACL(ctx context.Context, params *UpdateACLInput, optFns ...func(*Options)) (*UpdateACLOutput, error)
Changes the list of users that belong to the Access Control List.
func (*Client) UpdateCluster ¶
func (c *Client) UpdateCluster(ctx context.Context, params *UpdateClusterInput, optFns ...func(*Options)) (*UpdateClusterOutput, error)
Modifies the settings for a cluster. You can use this operation to change one or more cluster configuration settings by specifying the settings and the new values.
func (*Client) UpdateParameterGroup ¶
func (c *Client) UpdateParameterGroup(ctx context.Context, params *UpdateParameterGroupInput, optFns ...func(*Options)) (*UpdateParameterGroupOutput, error)
Updates the parameters of a parameter group. You can modify up to 20 parameters in a single request by submitting a list parameter name and value pairs.
func (*Client) UpdateSubnetGroup ¶
func (c *Client) UpdateSubnetGroup(ctx context.Context, params *UpdateSubnetGroupInput, optFns ...func(*Options)) (*UpdateSubnetGroupOutput, error)
Updates a subnet group. For more information, see Updating a subnet group (https://docs.aws.amazon.com/AmazonMemoryDB/latest/devguide/SubnetGroups.Modifying.html)
func (*Client) UpdateUser ¶
func (c *Client) UpdateUser(ctx context.Context, params *UpdateUserInput, optFns ...func(*Options)) (*UpdateUserOutput, error)
Changes user password(s) and/or access string.
type CopySnapshotInput ¶
type CopySnapshotInput struct { // The name of an existing snapshot from which to make a copy. // // This member is required. SourceSnapshotName *string // A name for the snapshot copy. MemoryDB does not permit overwriting a snapshot, // therefore this name must be unique within its context - MemoryDB or an Amazon S3 // bucket if exporting. // // This member is required. TargetSnapshotName *string // The ID of the KMS key used to encrypt the target snapshot. KmsKeyId *string // A list of tags to be added to this resource. A tag is a key-value pair. A tag // key must be accompanied by a tag value, although null is accepted. Tags []types.Tag // The Amazon S3 bucket to which the snapshot is exported. This parameter is used // only when exporting a snapshot for external access. When using this parameter to // export a snapshot, be sure MemoryDB has the needed permissions to this S3 // bucket. For more information, see Step 2: Grant MemoryDB Access to Your Amazon // S3 Bucket // (https://docs.aws.amazon.com/AmazonMemoryDB/latest/devguide/snapshots-exporting.html). TargetBucket *string // contains filtered or unexported fields }
type CopySnapshotOutput ¶
type CopySnapshotOutput struct { // Represents a copy of an entire cluster as of the time when the snapshot was // taken. Snapshot *types.Snapshot // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type CreateACLInput ¶
type CreateACLInput struct { // The name of the Access Control List. // // This member is required. ACLName *string // A list of tags to be added to this resource. A tag is a key-value pair. A tag // key must be accompanied by a tag value, although null is accepted. Tags []types.Tag // The list of users that belong to the Access Control List. UserNames []string // contains filtered or unexported fields }
type CreateACLOutput ¶
type CreateACLOutput struct { // The newly-created Access Control List. ACL *types.ACL // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type CreateClusterInput ¶
type CreateClusterInput struct { // The name of the Access Control List to associate with the cluster. // // This member is required. ACLName *string // The name of the cluster. This value must be unique as it also serves as the // cluster identifier. // // This member is required. ClusterName *string // The compute and memory capacity of the nodes in the cluster. // // This member is required. NodeType *string // When set to true, the cluster will automatically receive minor engine version // upgrades after launch. AutoMinorVersionUpgrade *bool // An optional description of the cluster. Description *string // The version number of the Redis engine to be used for the cluster. EngineVersion *string // 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 number of replicas to apply to each shard. The limit is 5. NumReplicasPerShard *int32 // The number of shards the cluster will contain. Clusters can have up to 500 // shards, with your data partitioned across the shards. For example, you can // choose to configure a 500 node cluster that ranges between 83 shards (one // primary and 5 replicas per shard) and 500 shards (single primary and no // replicas). Make sure there are enough available IP addresses to accommodate the // increase. Common pitfalls include the subnets in the subnet group have too small // a CIDR range or the subnets are shared and heavily used by other clusters. NumShards *int32 // The name of the parameter group associated with the cluster. ParameterGroupName *string // The port number on which each of the nodes accepts connections. Port *int32 // A list of security group names to associate with this cluster. SecurityGroupIds []string // A list of Amazon Resource Names (ARN) that uniquely identify the RDB snapshot // files stored in Amazon S3. The snapshot files are used to populate the new // cluster. The Amazon S3 object name in the ARN cannot contain any commas. SnapshotArns []string // The name of a snapshot from which to restore data into the new cluster. The // snapshot status changes to restoring while the new cluster is being created. SnapshotName *string // 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 Amazon Simple Notification Service (SNS) // topic to which notifications are sent. SnsTopicArn *string // The name of the subnet group to be used for the cluster. SubnetGroupName *string // A flag to enable in-transit encryption on the cluster. TLSEnabled *bool // A list of tags to be added to this resource. Tags are comma-separated key,value // pairs (e.g. Key=myKey, Value=myKeyValue. You can include multiple tags as shown // following: Key=myKey, Value=myKeyValue Key=mySecondKey, Value=mySecondKeyValue. Tags []types.Tag // contains filtered or unexported fields }
type CreateClusterOutput ¶
type CreateClusterOutput struct { // The newly-created cluster. Cluster *types.Cluster // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type CreateParameterGroupInput ¶
type CreateParameterGroupInput struct { // The name of the parameter group family that the parameter group can be used // with. // // This member is required. Family *string // The name of the parameter group. // // This member is required. ParameterGroupName *string // An optional description of the parameter group. Description *string // A list of tags to be added to this resource. A tag is a key-value pair. A tag // key must be accompanied by a tag value, although null is accepted. Tags []types.Tag // contains filtered or unexported fields }
type CreateParameterGroupOutput ¶
type CreateParameterGroupOutput struct { // The newly-created parameter group. ParameterGroup *types.ParameterGroup // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type CreateSnapshotInput ¶
type CreateSnapshotInput struct { // The snapshot is created from this cluster. // // This member is required. ClusterName *string // A name for the snapshot being created. // // This member is required. SnapshotName *string // The ID of the KMS key used to encrypt the snapshot. KmsKeyId *string // A list of tags to be added to this resource. A tag is a key-value pair. A tag // key must be accompanied by a tag value, although null is accepted. Tags []types.Tag // contains filtered or unexported fields }
type CreateSnapshotOutput ¶
type CreateSnapshotOutput struct { // The newly-created snapshot. Snapshot *types.Snapshot // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type CreateSubnetGroupInput ¶
type CreateSubnetGroupInput struct { // The name of the subnet group. // // This member is required. SubnetGroupName *string // A list of VPC subnet IDs for the subnet group. // // This member is required. SubnetIds []string // A description for the subnet group. Description *string // A list of tags to be added to this resource. A tag is a key-value pair. A tag // key must be accompanied by a tag value, although null is accepted. Tags []types.Tag // contains filtered or unexported fields }
type CreateSubnetGroupOutput ¶
type CreateSubnetGroupOutput struct { // The newly-created subnet group SubnetGroup *types.SubnetGroup // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type CreateUserInput ¶
type CreateUserInput struct { // Access permissions string used for this user. // // This member is required. AccessString *string // Denotes the user's authentication properties, such as whether it requires a // password to authenticate. // // This member is required. AuthenticationMode *types.AuthenticationMode // The name of the user. This value must be unique as it also serves as the user // identifier. // // This member is required. UserName *string // A list of tags to be added to this resource. A tag is a key-value pair. A tag // key must be accompanied by a tag value, although null is accepted. Tags []types.Tag // contains filtered or unexported fields }
type CreateUserOutput ¶
type CreateUserOutput struct { // The newly-created user. User *types.User // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DeleteACLInput ¶
type DeleteACLInput struct { // The name of the Access Control List to delete // // This member is required. ACLName *string // contains filtered or unexported fields }
type DeleteACLOutput ¶
type DeleteACLOutput struct { // The Access Control List object that has been deleted. ACL *types.ACL // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DeleteClusterInput ¶
type DeleteClusterInput struct { // The name of the cluster to be deleted // // This member is required. ClusterName *string // The user-supplied name of a final cluster snapshot. This is the unique name that // identifies the snapshot. MemoryDB creates the snapshot, and then deletes the // cluster immediately afterward. FinalSnapshotName *string // contains filtered or unexported fields }
type DeleteClusterOutput ¶
type DeleteClusterOutput struct { // The cluster object that has been deleted Cluster *types.Cluster // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DeleteParameterGroupInput ¶
type DeleteParameterGroupInput struct { // The name of the parameter group to delete. // // This member is required. ParameterGroupName *string // contains filtered or unexported fields }
type DeleteParameterGroupOutput ¶
type DeleteParameterGroupOutput struct { // The parameter group that has been deleted. ParameterGroup *types.ParameterGroup // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DeleteSnapshotInput ¶
type DeleteSnapshotInput struct { // The name of the snapshot to delete // // This member is required. SnapshotName *string // contains filtered or unexported fields }
type DeleteSnapshotOutput ¶
type DeleteSnapshotOutput struct { // The snapshot object that has been deleted. Snapshot *types.Snapshot // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DeleteSubnetGroupInput ¶
type DeleteSubnetGroupInput struct { // The name of the subnet group to delete // // This member is required. SubnetGroupName *string // contains filtered or unexported fields }
type DeleteSubnetGroupOutput ¶
type DeleteSubnetGroupOutput struct { // The subnet group object that has been deleted. SubnetGroup *types.SubnetGroup // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DeleteUserInput ¶
type DeleteUserInput struct { // The name of the user to delete // // This member is required. UserName *string // contains filtered or unexported fields }
type DeleteUserOutput ¶
type DeleteUserOutput struct { // The user object that has been deleted. User *types.User // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DescribeACLsInput ¶
type DescribeACLsInput struct { // The name of the ACL ACLName *string // The maximum number of records to include in the response. If more records exist // than the specified MaxResults value, a token is included in the response so that // the remaining results can be retrieved. MaxResults *int32 // An optional argument to pass in case the total number of records exceeds the // value of MaxResults. If nextToken is returned, there are more results available. // The value of nextToken is a unique pagination token for each page. Make the call // again using the returned token to retrieve the next page. Keep all other // arguments unchanged. NextToken *string // contains filtered or unexported fields }
type DescribeACLsOutput ¶
type DescribeACLsOutput struct { // The list of ACLs ACLs []types.ACL // If nextToken is returned, there are more results available. The value of // nextToken is a unique pagination token for each page. Make the call again using // the returned token to retrieve the next page. Keep all other arguments // unchanged. NextToken *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DescribeClustersInput ¶
type DescribeClustersInput struct { // The name of the cluster ClusterName *string // The maximum number of records to include in the response. If more records exist // than the specified MaxResults value, a token is included in the response so that // the remaining results can be retrieved. MaxResults *int32 // An optional argument to pass in case the total number of records exceeds the // value of MaxResults. If nextToken is returned, there are more results available. // The value of nextToken is a unique pagination token for each page. Make the call // again using the returned token to retrieve the next page. Keep all other // arguments unchanged. NextToken *string // An optional flag that can be included in the request to retrieve information // about the individual shard(s). ShowShardDetails *bool // contains filtered or unexported fields }
type DescribeClustersOutput ¶
type DescribeClustersOutput struct { // A list of clusters Clusters []types.Cluster // An optional argument to pass in case the total number of records exceeds the // value of MaxResults. If nextToken is returned, there are more results available. // The value of nextToken is a unique pagination token for each page. Make the call // again using the returned token to retrieve the next page. Keep all other // arguments unchanged. NextToken *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DescribeEngineVersionsInput ¶
type DescribeEngineVersionsInput struct { // If true, specifies that only the default version of the specified engine or // engine and major version combination is to be returned. DefaultOnly bool // The Redis engine version EngineVersion *string // The maximum number of records to include in the response. If more records exist // than the specified MaxResults value, a token is included in the response so that // the remaining results can be retrieved. MaxResults *int32 // An optional argument to pass in case the total number of records exceeds the // value of MaxResults. If nextToken is returned, there are more results available. // The value of nextToken is a unique pagination token for each page. Make the call // again using the returned token to retrieve the next page. Keep all other // arguments unchanged. NextToken *string // The name of a specific parameter group family to return details for. ParameterGroupFamily *string // contains filtered or unexported fields }
type DescribeEngineVersionsOutput ¶
type DescribeEngineVersionsOutput struct { // A list of engine version details. Each element in the list contains detailed // information about one engine version. EngineVersions []types.EngineVersionInfo // An optional argument to pass in case the total number of records exceeds the // value of MaxResults. If nextToken is returned, there are more results available. // The value of nextToken is a unique pagination token for each page. Make the call // again using the returned token to retrieve the next page. Keep all other // arguments unchanged. NextToken *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DescribeEventsInput ¶
type DescribeEventsInput struct { // The number of minutes worth of events to retrieve. Duration *int32 // The end of the time interval for which to retrieve events, specified in ISO 8601 // format. Example: 2017-03-30T07:03:49.555Z EndTime *time.Time // The maximum number of records to include in the response. If more records exist // than the specified MaxResults value, a token is included in the response so that // the remaining results can be retrieved. MaxResults *int32 // An optional argument to pass in case the total number of records exceeds the // value of MaxResults. If nextToken is returned, there are more results available. // The value of nextToken is a unique pagination token for each page. Make the call // again using the returned token to retrieve the next page. Keep all other // arguments unchanged. NextToken *string // The identifier of the event source for which events are returned. If not // specified, all sources are included in the response. SourceName *string // The event source to retrieve events for. If no value is specified, all events // are returned. SourceType types.SourceType // The beginning of the time interval to retrieve events for, specified in ISO 8601 // format. Example: 2017-03-30T07:03:49.555Z StartTime *time.Time // contains filtered or unexported fields }
type DescribeEventsOutput ¶
type DescribeEventsOutput struct { // A list of events. Each element in the list contains detailed information about // one event. Events []types.Event // An optional argument to pass in case the total number of records exceeds the // value of MaxResults. If nextToken is returned, there are more results available. // The value of nextToken is a unique pagination token for each page. Make the call // again using the returned token to retrieve the next page. Keep all other // arguments unchanged. NextToken *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DescribeParameterGroupsInput ¶
type DescribeParameterGroupsInput struct { // The maximum number of records to include in the response. If more records exist // than the specified MaxResults value, a token is included in the response so that // the remaining results can be retrieved. MaxResults *int32 // An optional argument to pass in case the total number of records exceeds the // value of MaxResults. If nextToken is returned, there are more results available. // The value of nextToken is a unique pagination token for each page. Make the call // again using the returned token to retrieve the next page. Keep all other // arguments unchanged. NextToken *string // The name of a specific parameter group to return details for. ParameterGroupName *string // contains filtered or unexported fields }
type DescribeParameterGroupsOutput ¶
type DescribeParameterGroupsOutput struct { // An optional argument to pass in case the total number of records exceeds the // value of MaxResults. If nextToken is returned, there are more results available. // The value of nextToken is a unique pagination token for each page. Make the call // again using the returned token to retrieve the next page. Keep all other // arguments unchanged. NextToken *string // A list of parameter groups. Each element in the list contains detailed // information about one parameter group. ParameterGroups []types.ParameterGroup // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DescribeParametersInput ¶
type DescribeParametersInput struct { // he name of a specific parameter group to return details for. // // This member is required. ParameterGroupName *string // The maximum number of records to include in the response. If more records exist // than the specified MaxResults value, a token is included in the response so that // the remaining results can be retrieved. MaxResults *int32 // An optional argument to pass in case the total number of records exceeds the // value of MaxResults. If nextToken is returned, there are more results available. // The value of nextToken is a unique pagination token for each page. Make the call // again using the returned token to retrieve the next page. Keep all other // arguments unchanged. NextToken *string // contains filtered or unexported fields }
type DescribeParametersOutput ¶
type DescribeParametersOutput struct { // An optional argument to pass in case the total number of records exceeds the // value of MaxResults. If nextToken is returned, there are more results available. // The value of nextToken is a unique pagination token for each page. Make the call // again using the returned token to retrieve the next page. Keep all other // arguments unchanged. NextToken *string // A list of parameters specific to a particular parameter group. Each element in // the list contains detailed information about one parameter. Parameters []types.Parameter // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DescribeServiceUpdatesInput ¶
type DescribeServiceUpdatesInput struct { // The list of cluster names to identify service updates to apply ClusterNames []string // The maximum number of records to include in the response. If more records exist // than the specified MaxResults value, a token is included in the response so that // the remaining results can be retrieved. MaxResults *int32 // An optional argument to pass in case the total number of records exceeds the // value of MaxResults. If nextToken is returned, there are more results available. // The value of nextToken is a unique pagination token for each page. Make the call // again using the returned token to retrieve the next page. Keep all other // arguments unchanged. NextToken *string // The unique ID of the service update to describe. ServiceUpdateName *string // The status(es) of the service updates to filter on Status []types.ServiceUpdateStatus // contains filtered or unexported fields }
type DescribeServiceUpdatesOutput ¶
type DescribeServiceUpdatesOutput struct { // An optional argument to pass in case the total number of records exceeds the // value of MaxResults. If nextToken is returned, there are more results available. // The value of nextToken is a unique pagination token for each page. Make the call // again using the returned token to retrieve the next page. Keep all other // arguments unchanged. NextToken *string // A list of service updates ServiceUpdates []types.ServiceUpdate // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DescribeSnapshotsInput ¶
type DescribeSnapshotsInput struct { // A user-supplied cluster identifier. If this parameter is specified, only // snapshots associated with that specific cluster are described. ClusterName *string // The maximum number of records to include in the response. If more records exist // than the specified MaxResults value, a token is included in the response so that // the remaining results can be retrieved. MaxResults *int32 // An optional argument to pass in case the total number of records exceeds the // value of MaxResults. If nextToken is returned, there are more results available. // The value of nextToken is a unique pagination token for each page. Make the call // again using the returned token to retrieve the next page. Keep all other // arguments unchanged. NextToken *string // A Boolean value which if true, the shard configuration is included in the // snapshot description. ShowDetail *bool // A user-supplied name of the snapshot. If this parameter is specified, only this // named snapshot is described. SnapshotName *string // If set to system, the output shows snapshots that were automatically created by // MemoryDB. If set to user the output shows snapshots that were manually created. // If omitted, the output shows both automatically and manually created snapshots. Source *string // contains filtered or unexported fields }
type DescribeSnapshotsOutput ¶
type DescribeSnapshotsOutput struct { // An optional argument to pass in case the total number of records exceeds the // value of MaxResults. If nextToken is returned, there are more results available. // The value of nextToken is a unique pagination token for each page. Make the call // again using the returned token to retrieve the next page. Keep all other // arguments unchanged. NextToken *string // A list of snapshots. Each item in the list contains detailed information about // one snapshot. Snapshots []types.Snapshot // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DescribeSubnetGroupsInput ¶
type DescribeSubnetGroupsInput struct { // The maximum number of records to include in the response. If more records exist // than the specified MaxResults value, a token is included in the response so that // the remaining results can be retrieved. MaxResults *int32 // An optional argument to pass in case the total number of records exceeds the // value of MaxResults. If nextToken is returned, there are more results available. // The value of nextToken is a unique pagination token for each page. Make the call // again using the returned token to retrieve the next page. Keep all other // arguments unchanged. NextToken *string // The name of the subnet group to return details for. SubnetGroupName *string // contains filtered or unexported fields }
type DescribeSubnetGroupsOutput ¶
type DescribeSubnetGroupsOutput struct { // An optional argument to pass in case the total number of records exceeds the // value of MaxResults. If nextToken is returned, there are more results available. // The value of nextToken is a unique pagination token for each page. Make the call // again using the returned token to retrieve the next page. Keep all other // arguments unchanged. NextToken *string // A list of subnet groups. Each element in the list contains detailed information // about one group. SubnetGroups []types.SubnetGroup // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DescribeUsersInput ¶
type DescribeUsersInput struct { // Filter to determine the list of users to return. Filters []types.Filter // The maximum number of records to include in the response. If more records exist // than the specified MaxResults value, a token is included in the response so that // the remaining results can be retrieved. MaxResults *int32 // An optional argument to pass in case the total number of records exceeds the // value of MaxResults. If nextToken is returned, there are more results available. // The value of nextToken is a unique pagination token for each page. Make the call // again using the returned token to retrieve the next page. Keep all other // arguments unchanged. NextToken *string // The name of the user UserName *string // contains filtered or unexported fields }
type DescribeUsersOutput ¶
type DescribeUsersOutput struct { // An optional argument to pass in case the total number of records exceeds the // value of MaxResults. If nextToken is returned, there are more results available. // The value of nextToken is a unique pagination token for each page. Make the call // again using the returned token to retrieve the next page. Keep all other // arguments unchanged. NextToken *string // A list of users. Users []types.User // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type EndpointResolver ¶
type EndpointResolver interface {
ResolveEndpoint(region string, options EndpointResolverOptions) (aws.Endpoint, error)
}
EndpointResolver interface for resolving service endpoints.
func EndpointResolverFromURL ¶
func EndpointResolverFromURL(url string, optFns ...func(*aws.Endpoint)) EndpointResolver
EndpointResolverFromURL returns an EndpointResolver configured using the provided endpoint url. By default, the resolved endpoint resolver uses the client region as signing region, and the endpoint source is set to EndpointSourceCustom.You can provide functional options to configure endpoint values for the resolved endpoint.
type EndpointResolverFunc ¶
type EndpointResolverFunc func(region string, options EndpointResolverOptions) (aws.Endpoint, error)
EndpointResolverFunc is a helper utility that wraps a function so it satisfies the EndpointResolver interface. This is useful when you want to add additional endpoint resolving logic, or stub out specific endpoints with custom values.
func (EndpointResolverFunc) ResolveEndpoint ¶
func (fn EndpointResolverFunc) ResolveEndpoint(region string, options EndpointResolverOptions) (endpoint aws.Endpoint, err error)
type EndpointResolverOptions ¶
type EndpointResolverOptions = internalendpoints.Options
EndpointResolverOptions is the service endpoint resolver options
type FailoverShardInput ¶
type FailoverShardOutput ¶
type FailoverShardOutput struct { // The cluster being failed over Cluster *types.Cluster // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type HTTPSignerV4 ¶
type ListAllowedNodeTypeUpdatesInput ¶
type ListAllowedNodeTypeUpdatesInput struct { // The name of the cluster you want to scale. MemoryDB uses the cluster name to // identify the current node type being used by this cluster, and from that to // create a list of node types you can scale up to. // // This member is required. ClusterName *string // contains filtered or unexported fields }
type ListAllowedNodeTypeUpdatesOutput ¶
type ListAllowedNodeTypeUpdatesOutput struct { // A list node types which you can use to scale down your cluster. ScaleDownNodeTypes []string // A list node types which you can use to scale up your cluster. ScaleUpNodeTypes []string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type ListTagsInput ¶
type ListTagsInput struct { // The Amazon Resource Name (ARN) of the resource for which you want the list of // tags // // This member is required. ResourceArn *string // contains filtered or unexported fields }
type ListTagsOutput ¶
type ListTagsOutput struct { // A list of tags as key-value pairs. TagList []types.Tag // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type Options ¶
type Options struct { // Set of options to modify how an operation is invoked. These apply to all // operations invoked for this client. Use functional options on operation call to // modify this list for per operation behavior. APIOptions []func(*middleware.Stack) error // Configures the events that will be sent to the configured logger. ClientLogMode aws.ClientLogMode // The credentials object to use when signing requests. Credentials aws.CredentialsProvider // The endpoint options to be used when attempting to resolve an endpoint. EndpointOptions EndpointResolverOptions // The service endpoint resolver. EndpointResolver EndpointResolver // Signature Version 4 (SigV4) Signer HTTPSignerV4 HTTPSignerV4 // The logger writer interface to write logging messages to. Logger logging.Logger // The region to send requests to. (Required) Region string // Retryer guides how HTTP requests should be retried in case of recoverable // failures. When nil the API client will use a default retryer. Retryer aws.Retryer // The HTTP client to invoke API calls with. Defaults to client's default HTTP // implementation if nil. HTTPClient HTTPClient }
type ResetParameterGroupInput ¶
type ResetParameterGroupInput struct { // The name of the parameter group to reset. // // This member is required. ParameterGroupName *string // If true, all parameters in the parameter group are reset to their default // values. If false, only the parameters listed by ParameterNames are reset to // their default values. AllParameters bool // An array of parameter names to reset to their default values. If AllParameters // is true, do not use ParameterNames. If AllParameters is false, you must specify // the name of at least one parameter to reset. ParameterNames []string // contains filtered or unexported fields }
type ResetParameterGroupOutput ¶
type ResetParameterGroupOutput struct { // The parameter group being reset. ParameterGroup *types.ParameterGroup // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type ResolveEndpoint ¶
type ResolveEndpoint struct { Resolver EndpointResolver Options EndpointResolverOptions }
func (*ResolveEndpoint) HandleSerialize ¶
func (m *ResolveEndpoint) HandleSerialize(ctx context.Context, in middleware.SerializeInput, next middleware.SerializeHandler) ( out middleware.SerializeOutput, metadata middleware.Metadata, err error, )
func (*ResolveEndpoint) ID ¶
func (*ResolveEndpoint) ID() string
type TagResourceInput ¶
type TagResourceInput struct { // The Amazon Resource Name (ARN) of the resource to which the tags are to be added // // This member is required. ResourceArn *string // A list of tags to be added to this resource. A tag is a key-value pair. A tag // key must be accompanied by a tag value, although null is accepted. // // This member is required. Tags []types.Tag // contains filtered or unexported fields }
type TagResourceOutput ¶
type TagResourceOutput struct { // A list of tags as key-value pairs. TagList []types.Tag // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type UntagResourceInput ¶
type UntagResourceInput struct { // The Amazon Resource Name (ARN) of the resource to which the tags are to be // removed // // This member is required. ResourceArn *string // The list of keys of the tags that are to be removed // // This member is required. TagKeys []string // contains filtered or unexported fields }
type UntagResourceOutput ¶
type UntagResourceOutput struct { // The list of tags removed TagList []types.Tag // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type UpdateACLInput ¶
type UpdateACLInput struct { // The name of the Access Control List // // This member is required. ACLName *string // The list of users to add to the Access Control List UserNamesToAdd []string // The list of users to remove from the Access Control List UserNamesToRemove []string // contains filtered or unexported fields }
type UpdateACLOutput ¶
type UpdateACLOutput struct { // The updated Access Control List ACL *types.ACL // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type UpdateClusterInput ¶
type UpdateClusterInput struct { // The name of the cluster to update // // This member is required. ClusterName *string // The Access Control List that is associated with the cluster ACLName *string // The description of the cluster to update Description *string // The upgraded version of the engine to be run on the nodes. You can upgrade to a // newer engine version, but you cannot downgrade to an earlier engine version. If // you want to use an earlier engine version, you must delete the existing cluster // and create it anew with the earlier engine version. EngineVersion *string // The maintenance window to update MaintenanceWindow *string // A valid node type that you want to scale this cluster up or down to. NodeType *string // The name of the parameter group to update ParameterGroupName *string // The number of replicas that will reside in each shard ReplicaConfiguration *types.ReplicaConfigurationRequest // The SecurityGroupIds to update SecurityGroupIds []string // The number of shards in the cluster ShardConfiguration *types.ShardConfigurationRequest // The number of days for which MemoryDB 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. SnapshotRetentionLimit *int32 // The daily time range (in UTC) during which MemoryDB begins taking a daily // snapshot of your cluster. SnapshotWindow *string // The SNS topic ARN to update SnsTopicArn *string // The status of the Amazon SNS notification topic. Notifications are sent only if // the status is active. SnsTopicStatus *string // contains filtered or unexported fields }
type UpdateClusterOutput ¶
type UpdateClusterOutput struct { // The updated cluster Cluster *types.Cluster // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type UpdateParameterGroupInput ¶
type UpdateParameterGroupInput struct { // The name of the parameter group to update. // // This member is required. ParameterGroupName *string // An array of parameter names and values for the parameter update. You must supply // at least one parameter name and value; subsequent arguments are optional. A // maximum of 20 parameters may be updated per request. // // This member is required. ParameterNameValues []types.ParameterNameValue // contains filtered or unexported fields }
type UpdateParameterGroupOutput ¶
type UpdateParameterGroupOutput struct { // The updated parameter group ParameterGroup *types.ParameterGroup // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type UpdateSubnetGroupInput ¶
type UpdateSubnetGroupOutput ¶
type UpdateSubnetGroupOutput struct { // The updated subnet group SubnetGroup *types.SubnetGroup // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type UpdateUserInput ¶
type UpdateUserInput struct { // The name of the user // // This member is required. UserName *string // Access permissions string used for this user. AccessString *string // Denotes the user's authentication properties, such as whether it requires a // password to authenticate. AuthenticationMode *types.AuthenticationMode // contains filtered or unexported fields }
type UpdateUserOutput ¶
type UpdateUserOutput struct { // The updated user User *types.User // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
Source Files ¶
- api_client.go
- api_op_BatchUpdateCluster.go
- api_op_CopySnapshot.go
- api_op_CreateACL.go
- api_op_CreateCluster.go
- api_op_CreateParameterGroup.go
- api_op_CreateSnapshot.go
- api_op_CreateSubnetGroup.go
- api_op_CreateUser.go
- api_op_DeleteACL.go
- api_op_DeleteCluster.go
- api_op_DeleteParameterGroup.go
- api_op_DeleteSnapshot.go
- api_op_DeleteSubnetGroup.go
- api_op_DeleteUser.go
- api_op_DescribeACLs.go
- api_op_DescribeClusters.go
- api_op_DescribeEngineVersions.go
- api_op_DescribeEvents.go
- api_op_DescribeParameterGroups.go
- api_op_DescribeParameters.go
- api_op_DescribeServiceUpdates.go
- api_op_DescribeSnapshots.go
- api_op_DescribeSubnetGroups.go
- api_op_DescribeUsers.go
- api_op_FailoverShard.go
- api_op_ListAllowedNodeTypeUpdates.go
- api_op_ListTags.go
- api_op_ResetParameterGroup.go
- api_op_TagResource.go
- api_op_UntagResource.go
- api_op_UpdateACL.go
- api_op_UpdateCluster.go
- api_op_UpdateParameterGroup.go
- api_op_UpdateSubnetGroup.go
- api_op_UpdateUser.go
- deserializers.go
- doc.go
- endpoints.go
- go_module_metadata.go
- serializers.go
- validators.go