dax

package
v0.24.0 Latest Latest
Warning

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

 Go to latest Published: Jul 22, 2020 License: Apache-2.0 Imports: 7 Imported by: 49

Documentation

Overview

Package dax provides the client and types for making API requests to Amazon DAX.

DAX is a managed caching service engineered for Amazon DynamoDB. DAX dramatically speeds up database reads by caching frequently-accessed data from DynamoDB, so applications can access that data with sub-millisecond latency. You can create a DAX cluster easily, using the AWS Management Console. With a few simple modifications to your code, your application can begin taking advantage of the DAX cluster and realize significant improvements in read performance.

See https://docs.aws.amazon.com/goto/WebAPI/dax-2017-04-19 for more information on this service.

See dax package documentation for more information. https://docs.aws.amazon.com/sdk-for-go/api/service/dax/

Using the Client

To use Amazon DAX with the SDK use the New function to create a new service client. With that client you can make API requests to the service. These clients are safe to use concurrently.

See the SDK's documentation for more information on how to use the SDK. https://docs.aws.amazon.com/sdk-for-go/api/

See aws.Config documentation for more information on configuring SDK clients. https://docs.aws.amazon.com/sdk-for-go/api/aws/#Config

See the Amazon DAX client for more information on creating client for this service. https://docs.aws.amazon.com/sdk-for-go/api/service/dax/#New

Index

Constants

View Source 
const (
	ServiceName = "Amazon DAX" // Service's name
	ServiceID   = "DAX"        // Service's identifier
	EndpointsID = "dax"        // Service's Endpoint identifier
)
View Source 
const (

	// ErrCodeClusterAlreadyExistsFault for service response error code
	// "ClusterAlreadyExistsFault".
	//
	// You already have a DAX cluster with the given identifier.
	ErrCodeClusterAlreadyExistsFault = "ClusterAlreadyExistsFault"

	// ErrCodeClusterNotFoundFault for service response error code
	// "ClusterNotFoundFault".
	//
	// The requested cluster ID does not refer to an existing DAX cluster.
	ErrCodeClusterNotFoundFault = "ClusterNotFoundFault"

	// ErrCodeClusterQuotaForCustomerExceededFault for service response error code
	// "ClusterQuotaForCustomerExceededFault".
	//
	// You have attempted to exceed the maximum number of DAX clusters for your
	// AWS account.
	ErrCodeClusterQuotaForCustomerExceededFault = "ClusterQuotaForCustomerExceededFault"

	// ErrCodeInsufficientClusterCapacityFault for service response error code
	// "InsufficientClusterCapacityFault".
	//
	// There are not enough system resources to create the cluster you requested
	// (or to resize an already-existing cluster).
	ErrCodeInsufficientClusterCapacityFault = "InsufficientClusterCapacityFault"

	// ErrCodeInvalidARNFault for service response error code
	// "InvalidARNFault".
	//
	// The Amazon Resource Name (ARN) supplied in the request is not valid.
	ErrCodeInvalidARNFault = "InvalidARNFault"

	// ErrCodeInvalidClusterStateFault for service response error code
	// "InvalidClusterStateFault".
	//
	// The requested DAX cluster is not in the available state.
	ErrCodeInvalidClusterStateFault = "InvalidClusterStateFault"

	// ErrCodeInvalidParameterCombinationException for service response error code
	// "InvalidParameterCombinationException".
	//
	// Two or more incompatible parameters were specified.
	ErrCodeInvalidParameterCombinationException = "InvalidParameterCombinationException"

	// ErrCodeInvalidParameterGroupStateFault for service response error code
	// "InvalidParameterGroupStateFault".
	//
	// One or more parameters in a parameter group are in an invalid state.
	ErrCodeInvalidParameterGroupStateFault = "InvalidParameterGroupStateFault"

	// ErrCodeInvalidParameterValueException for service response error code
	// "InvalidParameterValueException".
	//
	// The value for a parameter is invalid.
	ErrCodeInvalidParameterValueException = "InvalidParameterValueException"

	// ErrCodeInvalidSubnet for service response error code
	// "InvalidSubnet".
	//
	// An invalid subnet identifier was specified.
	ErrCodeInvalidSubnet = "InvalidSubnet"

	// ErrCodeInvalidVPCNetworkStateFault for service response error code
	// "InvalidVPCNetworkStateFault".
	//
	// The VPC network is in an invalid state.
	ErrCodeInvalidVPCNetworkStateFault = "InvalidVPCNetworkStateFault"

	// ErrCodeNodeNotFoundFault for service response error code
	// "NodeNotFoundFault".
	//
	// None of the nodes in the cluster have the given node ID.
	ErrCodeNodeNotFoundFault = "NodeNotFoundFault"

	// ErrCodeNodeQuotaForClusterExceededFault for service response error code
	// "NodeQuotaForClusterExceededFault".
	//
	// You have attempted to exceed the maximum number of nodes for a DAX cluster.
	ErrCodeNodeQuotaForClusterExceededFault = "NodeQuotaForClusterExceededFault"

	// ErrCodeNodeQuotaForCustomerExceededFault for service response error code
	// "NodeQuotaForCustomerExceededFault".
	//
	// You have attempted to exceed the maximum number of nodes for your AWS account.
	ErrCodeNodeQuotaForCustomerExceededFault = "NodeQuotaForCustomerExceededFault"

	// ErrCodeParameterGroupAlreadyExistsFault for service response error code
	// "ParameterGroupAlreadyExistsFault".
	//
	// The specified parameter group already exists.
	ErrCodeParameterGroupAlreadyExistsFault = "ParameterGroupAlreadyExistsFault"

	// ErrCodeParameterGroupNotFoundFault for service response error code
	// "ParameterGroupNotFoundFault".
	//
	// The specified parameter group does not exist.
	ErrCodeParameterGroupNotFoundFault = "ParameterGroupNotFoundFault"

	// ErrCodeParameterGroupQuotaExceededFault for service response error code
	// "ParameterGroupQuotaExceededFault".
	//
	// You have attempted to exceed the maximum number of parameter groups.
	ErrCodeParameterGroupQuotaExceededFault = "ParameterGroupQuotaExceededFault"

	// ErrCodeServiceLinkedRoleNotFoundFault for service response error code
	// "ServiceLinkedRoleNotFoundFault".
	//
	// The specified service linked role (SLR) was not found.
	ErrCodeServiceLinkedRoleNotFoundFault = "ServiceLinkedRoleNotFoundFault"

	// ErrCodeSubnetGroupAlreadyExistsFault for service response error code
	// "SubnetGroupAlreadyExistsFault".
	//
	// The specified subnet group already exists.
	ErrCodeSubnetGroupAlreadyExistsFault = "SubnetGroupAlreadyExistsFault"

	// ErrCodeSubnetGroupInUseFault for service response error code
	// "SubnetGroupInUseFault".
	//
	// The specified subnet group is currently in use.
	ErrCodeSubnetGroupInUseFault = "SubnetGroupInUseFault"

	// ErrCodeSubnetGroupNotFoundFault for service response error code
	// "SubnetGroupNotFoundFault".
	//
	// The requested subnet group name does not refer to an existing subnet group.
	ErrCodeSubnetGroupNotFoundFault = "SubnetGroupNotFoundFault"

	// ErrCodeSubnetGroupQuotaExceededFault for service response error code
	// "SubnetGroupQuotaExceededFault".
	//
	// The request cannot be processed because it would exceed the allowed number
	// of subnets in a subnet group.
	ErrCodeSubnetGroupQuotaExceededFault = "SubnetGroupQuotaExceededFault"

	// ErrCodeSubnetInUse for service response error code
	// "SubnetInUse".
	//
	// The requested subnet is being used by another subnet group.
	ErrCodeSubnetInUse = "SubnetInUse"

	// ErrCodeSubnetQuotaExceededFault for service response error code
	// "SubnetQuotaExceededFault".
	//
	// The request cannot be processed because it would exceed the allowed number
	// of subnets in a subnet group.
	ErrCodeSubnetQuotaExceededFault = "SubnetQuotaExceededFault"

	// ErrCodeTagNotFoundFault for service response error code
	// "TagNotFoundFault".
	//
	// The tag does not exist.
	ErrCodeTagNotFoundFault = "TagNotFoundFault"

	// ErrCodeTagQuotaPerResourceExceeded for service response error code
	// "TagQuotaPerResourceExceeded".
	//
	// You have exceeded the maximum number of tags for this DAX cluster.
	ErrCodeTagQuotaPerResourceExceeded = "TagQuotaPerResourceExceeded"
)

Variables

This section is empty.

Functions

This section is empty.

Types

type ChangeType 

type ChangeType string
const (
	ChangeTypeImmediate      ChangeType = "IMMEDIATE"
	ChangeTypeRequiresReboot ChangeType = "REQUIRES_REBOOT"
)

Enum values for ChangeType

func (ChangeType) MarshalValue added in v0.3.0 

func (enum ChangeType) MarshalValue() (string, error)

func (ChangeType) MarshalValueBuf added in v0.3.0 

func (enum ChangeType) MarshalValueBuf(b []byte) ([]byte, error)

type Client added in v0.9.0 

type Client struct {
	*aws.Client
}

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

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

func New 

func New(config aws.Config) *Client

New creates a new instance of the client from the provided Config.

Example: 

// Create a client from just a config.
svc := dax.New(myConfig)

func (*Client) CreateClusterRequest added in v0.9.0 

func (c *Client) CreateClusterRequest(input *CreateClusterInput) CreateClusterRequest

CreateClusterRequest returns a request value for making API operation for Amazon DynamoDB Accelerator (DAX).

Creates a DAX cluster. All nodes in the cluster run the same DAX caching software. 

// Example sending a request using CreateClusterRequest.
req := client.CreateClusterRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/dax-2017-04-19/CreateCluster

func (*Client) CreateParameterGroupRequest added in v0.9.0 

func (c *Client) CreateParameterGroupRequest(input *CreateParameterGroupInput) CreateParameterGroupRequest

CreateParameterGroupRequest returns a request value for making API operation for Amazon DynamoDB Accelerator (DAX).

Creates a new parameter group. A parameter group is a collection of parameters that you apply to all of the nodes in a DAX cluster. 

// Example sending a request using CreateParameterGroupRequest.
req := client.CreateParameterGroupRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/dax-2017-04-19/CreateParameterGroup

func (*Client) CreateSubnetGroupRequest added in v0.9.0 

func (c *Client) CreateSubnetGroupRequest(input *CreateSubnetGroupInput) CreateSubnetGroupRequest

CreateSubnetGroupRequest returns a request value for making API operation for Amazon DynamoDB Accelerator (DAX).

Creates a new subnet group. 

// Example sending a request using CreateSubnetGroupRequest.
req := client.CreateSubnetGroupRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/dax-2017-04-19/CreateSubnetGroup

func (*Client) DecreaseReplicationFactorRequest added in v0.9.0 

func (c *Client) DecreaseReplicationFactorRequest(input *DecreaseReplicationFactorInput) DecreaseReplicationFactorRequest

DecreaseReplicationFactorRequest returns a request value for making API operation for Amazon DynamoDB Accelerator (DAX).

Removes one or more nodes from a DAX cluster.

You cannot use DecreaseReplicationFactor to remove the last node in a DAX cluster. If you need to do this, use DeleteCluster instead. 

// Example sending a request using DecreaseReplicationFactorRequest.
req := client.DecreaseReplicationFactorRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/dax-2017-04-19/DecreaseReplicationFactor

func (*Client) DeleteClusterRequest added in v0.9.0 

func (c *Client) DeleteClusterRequest(input *DeleteClusterInput) DeleteClusterRequest

DeleteClusterRequest returns a request value for making API operation for Amazon DynamoDB Accelerator (DAX).

Deletes a previously provisioned DAX cluster. DeleteCluster deletes all associated nodes, node endpoints and the DAX cluster itself. When you receive a successful response from this action, DAX immediately begins deleting the cluster; you cannot cancel or revert this action. 

// Example sending a request using DeleteClusterRequest.
req := client.DeleteClusterRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/dax-2017-04-19/DeleteCluster

func (*Client) DeleteParameterGroupRequest added in v0.9.0 

func (c *Client) DeleteParameterGroupRequest(input *DeleteParameterGroupInput) DeleteParameterGroupRequest

DeleteParameterGroupRequest returns a request value for making API operation for Amazon DynamoDB Accelerator (DAX).

Deletes the specified parameter group. You cannot delete a parameter group if it is associated with any DAX clusters. 

// Example sending a request using DeleteParameterGroupRequest.
req := client.DeleteParameterGroupRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/dax-2017-04-19/DeleteParameterGroup

func (*Client) DeleteSubnetGroupRequest added in v0.9.0 

func (c *Client) DeleteSubnetGroupRequest(input *DeleteSubnetGroupInput) DeleteSubnetGroupRequest

DeleteSubnetGroupRequest returns a request value for making API operation for Amazon DynamoDB Accelerator (DAX).

Deletes a subnet group.

You cannot delete a subnet group if it is associated with any DAX clusters. 

// Example sending a request using DeleteSubnetGroupRequest.
req := client.DeleteSubnetGroupRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/dax-2017-04-19/DeleteSubnetGroup

func (*Client) DescribeClustersRequest added in v0.9.0 

func (c *Client) DescribeClustersRequest(input *DescribeClustersInput) DescribeClustersRequest

DescribeClustersRequest returns a request value for making API operation for Amazon DynamoDB Accelerator (DAX).

Returns information about all provisioned DAX clusters if no cluster identifier is specified, or about a specific DAX cluster if a cluster identifier is supplied.

If the cluster is in the CREATING state, only cluster level information will be displayed until all of the nodes are successfully provisioned.

If the cluster is in the DELETING state, only cluster level information will be displayed.

If nodes are currently being added to the DAX cluster, node endpoint information and creation time for the additional nodes will not be displayed until they are completely provisioned. When the DAX cluster state is available, the cluster is ready for use.

If nodes are currently being removed from the DAX cluster, no endpoint information for the removed nodes is displayed. 

// Example sending a request using DescribeClustersRequest.
req := client.DescribeClustersRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/dax-2017-04-19/DescribeClusters

func (*Client) DescribeDefaultParametersRequest added in v0.9.0 

func (c *Client) DescribeDefaultParametersRequest(input *DescribeDefaultParametersInput) DescribeDefaultParametersRequest

DescribeDefaultParametersRequest returns a request value for making API operation for Amazon DynamoDB Accelerator (DAX).

Returns the default system parameter information for the DAX caching software. 

// Example sending a request using DescribeDefaultParametersRequest.
req := client.DescribeDefaultParametersRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/dax-2017-04-19/DescribeDefaultParameters

func (*Client) DescribeEventsRequest added in v0.9.0 

func (c *Client) DescribeEventsRequest(input *DescribeEventsInput) DescribeEventsRequest

DescribeEventsRequest returns a request value for making API operation for Amazon DynamoDB Accelerator (DAX).

Returns events related to DAX clusters and parameter groups. You can obtain events specific to a particular DAX cluster or parameter group by providing the name as a parameter.

By default, only the events occurring within the last 24 hours are returned; however, you can retrieve up to 14 days' worth of events if necessary. 

// Example sending a request using DescribeEventsRequest.
req := client.DescribeEventsRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/dax-2017-04-19/DescribeEvents

func (*Client) DescribeParameterGroupsRequest added in v0.9.0 

func (c *Client) DescribeParameterGroupsRequest(input *DescribeParameterGroupsInput) DescribeParameterGroupsRequest

DescribeParameterGroupsRequest returns a request value for making API operation for Amazon DynamoDB Accelerator (DAX).

Returns a list of parameter group descriptions. If a parameter group name is specified, the list will contain only the descriptions for that group. 

// Example sending a request using DescribeParameterGroupsRequest.
req := client.DescribeParameterGroupsRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/dax-2017-04-19/DescribeParameterGroups

func (*Client) DescribeParametersRequest added in v0.9.0 

func (c *Client) DescribeParametersRequest(input *DescribeParametersInput) DescribeParametersRequest

DescribeParametersRequest returns a request value for making API operation for Amazon DynamoDB Accelerator (DAX).

Returns the detailed parameter list for a particular parameter group. 

// Example sending a request using DescribeParametersRequest.
req := client.DescribeParametersRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/dax-2017-04-19/DescribeParameters

func (*Client) DescribeSubnetGroupsRequest added in v0.9.0 

func (c *Client) DescribeSubnetGroupsRequest(input *DescribeSubnetGroupsInput) DescribeSubnetGroupsRequest

DescribeSubnetGroupsRequest returns a request value for making API operation for Amazon DynamoDB Accelerator (DAX).

Returns a list of subnet group descriptions. If a subnet group name is specified, the list will contain only the description of that group. 

// Example sending a request using DescribeSubnetGroupsRequest.
req := client.DescribeSubnetGroupsRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/dax-2017-04-19/DescribeSubnetGroups

func (*Client) IncreaseReplicationFactorRequest added in v0.9.0 

func (c *Client) IncreaseReplicationFactorRequest(input *IncreaseReplicationFactorInput) IncreaseReplicationFactorRequest

IncreaseReplicationFactorRequest returns a request value for making API operation for Amazon DynamoDB Accelerator (DAX).

Adds one or more nodes to a DAX cluster. 

// Example sending a request using IncreaseReplicationFactorRequest.
req := client.IncreaseReplicationFactorRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/dax-2017-04-19/IncreaseReplicationFactor

func (*Client) ListTagsRequest added in v0.9.0 

func (c *Client) ListTagsRequest(input *ListTagsInput) ListTagsRequest

ListTagsRequest returns a request value for making API operation for Amazon DynamoDB Accelerator (DAX).

List all of the tags for a DAX cluster. You can call ListTags up to 10 times per second, per account. 

// Example sending a request using ListTagsRequest.
req := client.ListTagsRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/dax-2017-04-19/ListTags

func (*Client) RebootNodeRequest added in v0.9.0 

func (c *Client) RebootNodeRequest(input *RebootNodeInput) RebootNodeRequest

RebootNodeRequest returns a request value for making API operation for Amazon DynamoDB Accelerator (DAX).

Reboots a single node of a DAX cluster. The reboot action takes place as soon as possible. During the reboot, the node status is set to REBOOTING.

RebootNode restarts the DAX engine process and does not remove the contents of the cache. 

// Example sending a request using RebootNodeRequest.
req := client.RebootNodeRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/dax-2017-04-19/RebootNode

func (*Client) TagResourceRequest added in v0.9.0 

func (c *Client) TagResourceRequest(input *TagResourceInput) TagResourceRequest

TagResourceRequest returns a request value for making API operation for Amazon DynamoDB Accelerator (DAX).

Associates a set of tags with a DAX resource. You can call TagResource up to 5 times per second, per account. 

// Example sending a request using TagResourceRequest.
req := client.TagResourceRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/dax-2017-04-19/TagResource

func (*Client) UntagResourceRequest added in v0.9.0 

func (c *Client) UntagResourceRequest(input *UntagResourceInput) UntagResourceRequest

UntagResourceRequest returns a request value for making API operation for Amazon DynamoDB Accelerator (DAX).

Removes the association of tags from a DAX resource. You can call UntagResource up to 5 times per second, per account. 

// Example sending a request using UntagResourceRequest.
req := client.UntagResourceRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/dax-2017-04-19/UntagResource

func (*Client) UpdateClusterRequest added in v0.9.0 

func (c *Client) UpdateClusterRequest(input *UpdateClusterInput) UpdateClusterRequest

UpdateClusterRequest returns a request value for making API operation for Amazon DynamoDB Accelerator (DAX).

Modifies the settings for a DAX cluster. You can use this action to change one or more cluster configuration parameters by specifying the parameters and the new values. 

// Example sending a request using UpdateClusterRequest.
req := client.UpdateClusterRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/dax-2017-04-19/UpdateCluster

func (*Client) UpdateParameterGroupRequest added in v0.9.0 

func (c *Client) UpdateParameterGroupRequest(input *UpdateParameterGroupInput) UpdateParameterGroupRequest

UpdateParameterGroupRequest returns a request value for making API operation for Amazon DynamoDB Accelerator (DAX).

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

// Example sending a request using UpdateParameterGroupRequest.
req := client.UpdateParameterGroupRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/dax-2017-04-19/UpdateParameterGroup

func (*Client) UpdateSubnetGroupRequest added in v0.9.0 

func (c *Client) UpdateSubnetGroupRequest(input *UpdateSubnetGroupInput) UpdateSubnetGroupRequest

UpdateSubnetGroupRequest returns a request value for making API operation for Amazon DynamoDB Accelerator (DAX).

Modifies an existing subnet group. 

// Example sending a request using UpdateSubnetGroupRequest.
req := client.UpdateSubnetGroupRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/dax-2017-04-19/UpdateSubnetGroup

type Cluster 

type Cluster struct {

	// The number of nodes in the cluster that are active (i.e., capable of serving
	// requests).
	ActiveNodes *int64 `type:"integer"`

	// The Amazon Resource Name (ARN) that uniquely identifies the cluster.
	ClusterArn *string `type:"string"`

	// The configuration endpoint for this DAX cluster, consisting of a DNS name
	// and a port number. Client applications can specify this endpoint, rather
	// than an individual node endpoint, and allow the DAX client software to intelligently
	// route requests and responses to nodes in the DAX cluster.
	ClusterDiscoveryEndpoint *Endpoint `type:"structure"`

	// The name of the DAX cluster.
	ClusterName *string `type:"string"`

	// The description of the cluster.
	Description *string `type:"string"`

	// A valid Amazon Resource Name (ARN) that identifies an IAM role. At runtime,
	// DAX will assume this role and use the role's permissions to access DynamoDB
	// on your behalf.
	IamRoleArn *string `type:"string"`

	// A list of nodes to be removed from the cluster.
	NodeIdsToRemove []string `type:"list"`

	// The node type for the nodes in the cluster. (All nodes in a DAX cluster are
	// of the same type.)
	NodeType *string `type:"string"`

	// A list of nodes that are currently in the cluster.
	Nodes []Node `type:"list"`

	// Describes a notification topic and its status. Notification topics are used
	// for publishing DAX events to subscribers using Amazon Simple Notification
	// Service (SNS).
	NotificationConfiguration *NotificationConfiguration `type:"structure"`

	// The parameter group being used by nodes in the cluster.
	ParameterGroup *ParameterGroupStatus `type:"structure"`

	// A range of time when maintenance of DAX cluster software will be performed.
	// For example: sun:01:00-sun:09:00. Cluster maintenance normally takes less
	// than 30 minutes, and is performed automatically within the maintenance window.
	PreferredMaintenanceWindow *string `type:"string"`

	// The description of the server-side encryption status on the specified DAX
	// cluster.
	SSEDescription *SSEDescription `type:"structure"`

	// A list of security groups, and the status of each, for the nodes in the cluster.
	SecurityGroups []SecurityGroupMembership `type:"list"`

	// The current status of the cluster.
	Status *string `type:"string"`

	// The subnet group where the DAX cluster is running.
	SubnetGroup *string `type:"string"`

	// The total number of nodes in the cluster.
	TotalNodes *int64 `type:"integer"`
	// contains filtered or unexported fields
}

Contains all of the attributes of a specific DAX cluster.

func (Cluster) String 

func (s Cluster) String() string

String returns the string representation

type CreateClusterInput 

type CreateClusterInput struct {

	// The Availability Zones (AZs) in which the cluster nodes will reside after
	// the cluster has been created or updated. If provided, the length of this
	// list must equal the ReplicationFactor parameter. If you omit this parameter,
	// DAX will spread the nodes across Availability Zones for the highest availability.
	AvailabilityZones []string `type:"list"`

	// The cluster identifier. This parameter is stored as a lowercase string.
	//
	// Constraints:
	//
	//    * A name must contain from 1 to 20 alphanumeric characters or hyphens.
	//
	//    * The first character must be a letter.
	//
	//    * A name cannot end with a hyphen or contain two consecutive hyphens.
	//
	// ClusterName is a required field
	ClusterName *string `type:"string" required:"true"`

	// A description of the cluster.
	Description *string `type:"string"`

	// A valid Amazon Resource Name (ARN) that identifies an IAM role. At runtime,
	// DAX will assume this role and use the role's permissions to access DynamoDB
	// on your behalf.
	//
	// IamRoleArn is a required field
	IamRoleArn *string `type:"string" required:"true"`

	// The compute and memory capacity of the nodes in the cluster.
	//
	// NodeType is a required field
	NodeType *string `type:"string" required:"true"`

	// The Amazon Resource Name (ARN) of the Amazon SNS topic to which notifications
	// will be sent.
	//
	// The Amazon SNS topic owner must be same as the DAX cluster owner.
	NotificationTopicArn *string `type:"string"`

	// The parameter group to be associated with the DAX cluster.
	ParameterGroupName *string `type:"string"`

	// Specifies the weekly time range during which maintenance on the DAX cluster
	// is performed. It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi
	// (24H Clock UTC). The minimum maintenance window is a 60 minute period. Valid
	// values for ddd are:
	//
	//    * sun
	//
	//    * mon
	//
	//    * tue
	//
	//    * wed
	//
	//    * thu
	//
	//    * fri
	//
	//    * sat
	//
	// Example: sun:05:00-sun:09:00
	//
	// If you don't specify a preferred maintenance window when you create or modify
	// a cache cluster, DAX assigns a 60-minute maintenance window on a randomly
	// selected day of the week.
	PreferredMaintenanceWindow *string `type:"string"`

	// The number of nodes in the DAX cluster. A replication factor of 1 will create
	// a single-node cluster, without any read replicas. For additional fault tolerance,
	// you can create a multiple node cluster with one or more read replicas. To
	// do this, set ReplicationFactor to a number between 3 (one primary and two
	// read replicas) and 10 (one primary and nine read replicas). If the AvailabilityZones
	// parameter is provided, its length must equal the ReplicationFactor.
	//
	// AWS recommends that you have at least two read replicas per cluster.
	//
	// ReplicationFactor is a required field
	ReplicationFactor *int64 `type:"integer" required:"true"`

	// Represents the settings used to enable server-side encryption on the cluster.
	SSESpecification *SSESpecification `type:"structure"`

	// A list of security group IDs to be assigned to each node in the DAX cluster.
	// (Each of the security group ID is system-generated.)
	//
	// If this parameter is not specified, DAX assigns the default VPC security
	// group to each node.
	SecurityGroupIds []string `type:"list"`

	// The name of the subnet group to be used for the replication group.
	//
	// DAX clusters can only run in an Amazon VPC environment. All of the subnets
	// that you specify in a subnet group must exist in the same VPC.
	SubnetGroupName *string `type:"string"`

	// A set of tags to associate with the DAX cluster.
	Tags []Tag `type:"list"`
	// contains filtered or unexported fields
}

func (CreateClusterInput) String 

func (s CreateClusterInput) String() string

String returns the string representation

func (*CreateClusterInput) Validate 

func (s *CreateClusterInput) Validate() error

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

type CreateClusterOutput 

type CreateClusterOutput struct {

	// A description of the DAX cluster that you have created.
	Cluster *Cluster `type:"structure"`
	// contains filtered or unexported fields
}

func (CreateClusterOutput) String 

func (s CreateClusterOutput) String() string

String returns the string representation

type CreateClusterRequest 

type CreateClusterRequest struct {
	*aws.Request
	Input *CreateClusterInput
	Copy  func(*CreateClusterInput) CreateClusterRequest
}

CreateClusterRequest is the request type for the CreateCluster API operation.

func (CreateClusterRequest) Send 

func (r CreateClusterRequest) Send(ctx context.Context) (*CreateClusterResponse, error)

Send marshals and sends the CreateCluster API request.

type CreateClusterResponse added in v0.9.0 

type CreateClusterResponse struct {
	*CreateClusterOutput
	// contains filtered or unexported fields
}

CreateClusterResponse is the response type for the CreateCluster API operation.

func (*CreateClusterResponse) SDKResponseMetdata added in v0.9.0 

func (r *CreateClusterResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the CreateCluster request.

type CreateParameterGroupInput 

type CreateParameterGroupInput struct {

	// A description of the parameter group.
	Description *string `type:"string"`

	// The name of the parameter group to apply to all of the clusters in this replication
	// group.
	//
	// ParameterGroupName is a required field
	ParameterGroupName *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (CreateParameterGroupInput) String 

func (s CreateParameterGroupInput) String() string

String returns the string representation

func (*CreateParameterGroupInput) Validate 

func (s *CreateParameterGroupInput) Validate() error

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

type CreateParameterGroupOutput 

type CreateParameterGroupOutput struct {

	// Represents the output of a CreateParameterGroup action.
	ParameterGroup *ParameterGroup `type:"structure"`
	// contains filtered or unexported fields
}

func (CreateParameterGroupOutput) String 

func (s CreateParameterGroupOutput) String() string

String returns the string representation

type CreateParameterGroupRequest 

type CreateParameterGroupRequest struct {
	*aws.Request
	Input *CreateParameterGroupInput
	Copy  func(*CreateParameterGroupInput) CreateParameterGroupRequest
}

CreateParameterGroupRequest is the request type for the CreateParameterGroup API operation.

func (CreateParameterGroupRequest) Send 

func (r CreateParameterGroupRequest) Send(ctx context.Context) (*CreateParameterGroupResponse, error)

Send marshals and sends the CreateParameterGroup API request.

type CreateParameterGroupResponse added in v0.9.0 

type CreateParameterGroupResponse struct {
	*CreateParameterGroupOutput
	// contains filtered or unexported fields
}

CreateParameterGroupResponse is the response type for the CreateParameterGroup API operation.

func (*CreateParameterGroupResponse) SDKResponseMetdata added in v0.9.0 

func (r *CreateParameterGroupResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the CreateParameterGroup request.

type CreateSubnetGroupInput 

type CreateSubnetGroupInput struct {

	// A description for the subnet group
	Description *string `type:"string"`

	// A name for the subnet group. This value is stored as a lowercase string.
	//
	// SubnetGroupName is a required field
	SubnetGroupName *string `type:"string" required:"true"`

	// A list of VPC subnet IDs for the subnet group.
	//
	// SubnetIds is a required field
	SubnetIds []string `type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (CreateSubnetGroupInput) String 

func (s CreateSubnetGroupInput) String() string

String returns the string representation

func (*CreateSubnetGroupInput) Validate 

func (s *CreateSubnetGroupInput) Validate() error

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

type CreateSubnetGroupOutput 

type CreateSubnetGroupOutput struct {

	// Represents the output of a CreateSubnetGroup operation.
	SubnetGroup *SubnetGroup `type:"structure"`
	// contains filtered or unexported fields
}

func (CreateSubnetGroupOutput) String 

func (s CreateSubnetGroupOutput) String() string

String returns the string representation

type CreateSubnetGroupRequest 

type CreateSubnetGroupRequest struct {
	*aws.Request
	Input *CreateSubnetGroupInput
	Copy  func(*CreateSubnetGroupInput) CreateSubnetGroupRequest
}

CreateSubnetGroupRequest is the request type for the CreateSubnetGroup API operation.

func (CreateSubnetGroupRequest) Send 

func (r CreateSubnetGroupRequest) Send(ctx context.Context) (*CreateSubnetGroupResponse, error)

Send marshals and sends the CreateSubnetGroup API request.

type CreateSubnetGroupResponse added in v0.9.0 

type CreateSubnetGroupResponse struct {
	*CreateSubnetGroupOutput
	// contains filtered or unexported fields
}

CreateSubnetGroupResponse is the response type for the CreateSubnetGroup API operation.

func (*CreateSubnetGroupResponse) SDKResponseMetdata added in v0.9.0 

func (r *CreateSubnetGroupResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the CreateSubnetGroup request.

type DecreaseReplicationFactorInput 

type DecreaseReplicationFactorInput struct {

	// The Availability Zone(s) from which to remove nodes.
	AvailabilityZones []string `type:"list"`

	// The name of the DAX cluster from which you want to remove nodes.
	//
	// ClusterName is a required field
	ClusterName *string `type:"string" required:"true"`

	// The new number of nodes for the DAX cluster.
	//
	// NewReplicationFactor is a required field
	NewReplicationFactor *int64 `type:"integer" required:"true"`

	// The unique identifiers of the nodes to be removed from the cluster.
	NodeIdsToRemove []string `type:"list"`
	// contains filtered or unexported fields
}

func (DecreaseReplicationFactorInput) String 

func (s DecreaseReplicationFactorInput) String() string

String returns the string representation

func (*DecreaseReplicationFactorInput) Validate 

func (s *DecreaseReplicationFactorInput) Validate() error

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

type DecreaseReplicationFactorOutput 

type DecreaseReplicationFactorOutput struct {

	// A description of the DAX cluster, after you have decreased its replication
	// factor.
	Cluster *Cluster `type:"structure"`
	// contains filtered or unexported fields
}

func (DecreaseReplicationFactorOutput) String 

func (s DecreaseReplicationFactorOutput) String() string

String returns the string representation

type DecreaseReplicationFactorRequest 

type DecreaseReplicationFactorRequest struct {
	*aws.Request
	Input *DecreaseReplicationFactorInput
	Copy  func(*DecreaseReplicationFactorInput) DecreaseReplicationFactorRequest
}

DecreaseReplicationFactorRequest is the request type for the DecreaseReplicationFactor API operation.

func (DecreaseReplicationFactorRequest) Send 

func (r DecreaseReplicationFactorRequest) Send(ctx context.Context) (*DecreaseReplicationFactorResponse, error)

Send marshals and sends the DecreaseReplicationFactor API request.

type DecreaseReplicationFactorResponse added in v0.9.0 

type DecreaseReplicationFactorResponse struct {
	*DecreaseReplicationFactorOutput
	// contains filtered or unexported fields
}

DecreaseReplicationFactorResponse is the response type for the DecreaseReplicationFactor API operation.

func (*DecreaseReplicationFactorResponse) SDKResponseMetdata added in v0.9.0 

func (r *DecreaseReplicationFactorResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DecreaseReplicationFactor request.

type DeleteClusterInput 

type DeleteClusterInput struct {

	// The name of the cluster to be deleted.
	//
	// ClusterName is a required field
	ClusterName *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteClusterInput) String 

func (s DeleteClusterInput) String() string

String returns the string representation

func (*DeleteClusterInput) Validate 

func (s *DeleteClusterInput) Validate() error

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

type DeleteClusterOutput 

type DeleteClusterOutput struct {

	// A description of the DAX cluster that is being deleted.
	Cluster *Cluster `type:"structure"`
	// contains filtered or unexported fields
}

func (DeleteClusterOutput) String 

func (s DeleteClusterOutput) String() string

String returns the string representation

type DeleteClusterRequest 

type DeleteClusterRequest struct {
	*aws.Request
	Input *DeleteClusterInput
	Copy  func(*DeleteClusterInput) DeleteClusterRequest
}

DeleteClusterRequest is the request type for the DeleteCluster API operation.

func (DeleteClusterRequest) Send 

func (r DeleteClusterRequest) Send(ctx context.Context) (*DeleteClusterResponse, error)

Send marshals and sends the DeleteCluster API request.

type DeleteClusterResponse added in v0.9.0 

type DeleteClusterResponse struct {
	*DeleteClusterOutput
	// contains filtered or unexported fields
}

DeleteClusterResponse is the response type for the DeleteCluster API operation.

func (*DeleteClusterResponse) SDKResponseMetdata added in v0.9.0 

func (r *DeleteClusterResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DeleteCluster request.

type DeleteParameterGroupInput 

type DeleteParameterGroupInput struct {

	// The name of the parameter group to delete.
	//
	// ParameterGroupName is a required field
	ParameterGroupName *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteParameterGroupInput) String 

func (s DeleteParameterGroupInput) String() string

String returns the string representation

func (*DeleteParameterGroupInput) Validate 

func (s *DeleteParameterGroupInput) Validate() error

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

type DeleteParameterGroupOutput 

type DeleteParameterGroupOutput struct {

	// A user-specified message for this action (i.e., a reason for deleting the
	// parameter group).
	DeletionMessage *string `type:"string"`
	// contains filtered or unexported fields
}

func (DeleteParameterGroupOutput) String 

func (s DeleteParameterGroupOutput) String() string

String returns the string representation

type DeleteParameterGroupRequest 

type DeleteParameterGroupRequest struct {
	*aws.Request
	Input *DeleteParameterGroupInput
	Copy  func(*DeleteParameterGroupInput) DeleteParameterGroupRequest
}

DeleteParameterGroupRequest is the request type for the DeleteParameterGroup API operation.

func (DeleteParameterGroupRequest) Send 

func (r DeleteParameterGroupRequest) Send(ctx context.Context) (*DeleteParameterGroupResponse, error)

Send marshals and sends the DeleteParameterGroup API request.

type DeleteParameterGroupResponse added in v0.9.0 

type DeleteParameterGroupResponse struct {
	*DeleteParameterGroupOutput
	// contains filtered or unexported fields
}

DeleteParameterGroupResponse is the response type for the DeleteParameterGroup API operation.

func (*DeleteParameterGroupResponse) SDKResponseMetdata added in v0.9.0 

func (r *DeleteParameterGroupResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DeleteParameterGroup request.

type DeleteSubnetGroupInput 

type DeleteSubnetGroupInput struct {

	// The name of the subnet group to delete.
	//
	// SubnetGroupName is a required field
	SubnetGroupName *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteSubnetGroupInput) String 

func (s DeleteSubnetGroupInput) String() string

String returns the string representation

func (*DeleteSubnetGroupInput) Validate 

func (s *DeleteSubnetGroupInput) Validate() error

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

type DeleteSubnetGroupOutput 

type DeleteSubnetGroupOutput struct {

	// A user-specified message for this action (i.e., a reason for deleting the
	// subnet group).
	DeletionMessage *string `type:"string"`
	// contains filtered or unexported fields
}

func (DeleteSubnetGroupOutput) String 

func (s DeleteSubnetGroupOutput) String() string

String returns the string representation

type DeleteSubnetGroupRequest 

type DeleteSubnetGroupRequest struct {
	*aws.Request
	Input *DeleteSubnetGroupInput
	Copy  func(*DeleteSubnetGroupInput) DeleteSubnetGroupRequest
}

DeleteSubnetGroupRequest is the request type for the DeleteSubnetGroup API operation.

func (DeleteSubnetGroupRequest) Send 

func (r DeleteSubnetGroupRequest) Send(ctx context.Context) (*DeleteSubnetGroupResponse, error)

Send marshals and sends the DeleteSubnetGroup API request.

type DeleteSubnetGroupResponse added in v0.9.0 

type DeleteSubnetGroupResponse struct {
	*DeleteSubnetGroupOutput
	// contains filtered or unexported fields
}

DeleteSubnetGroupResponse is the response type for the DeleteSubnetGroup API operation.

func (*DeleteSubnetGroupResponse) SDKResponseMetdata added in v0.9.0 

func (r *DeleteSubnetGroupResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DeleteSubnetGroup request.

type DescribeClustersInput 

type DescribeClustersInput struct {

	// The names of the DAX clusters being described.
	ClusterNames []string `type:"list"`

	// The maximum number of results to include in the response. If more results
	// exist than the specified MaxResults value, a token is included in the response
	// so that the remaining results can be retrieved.
	//
	// The value for MaxResults must be between 20 and 100.
	MaxResults *int64 `type:"integer"`

	// An optional token returned from a prior request. Use this token for pagination
	// of results from this action. If this parameter is specified, the response
	// includes only results beyond the token, up to the value specified by MaxResults.
	NextToken *string `type:"string"`
	// contains filtered or unexported fields
}

func (DescribeClustersInput) String 

func (s DescribeClustersInput) String() string

String returns the string representation

type DescribeClustersOutput 

type DescribeClustersOutput struct {

	// The descriptions of your DAX clusters, in response to a DescribeClusters
	// request.
	Clusters []Cluster `type:"list"`

	// Provides an identifier to allow retrieval of paginated results.
	NextToken *string `type:"string"`
	// contains filtered or unexported fields
}

func (DescribeClustersOutput) String 

func (s DescribeClustersOutput) String() string

String returns the string representation

type DescribeClustersRequest 

type DescribeClustersRequest struct {
	*aws.Request
	Input *DescribeClustersInput
	Copy  func(*DescribeClustersInput) DescribeClustersRequest
}

DescribeClustersRequest is the request type for the DescribeClusters API operation.

func (DescribeClustersRequest) Send 

func (r DescribeClustersRequest) Send(ctx context.Context) (*DescribeClustersResponse, error)

Send marshals and sends the DescribeClusters API request.

type DescribeClustersResponse added in v0.9.0 

type DescribeClustersResponse struct {
	*DescribeClustersOutput
	// contains filtered or unexported fields
}

DescribeClustersResponse is the response type for the DescribeClusters API operation.

func (*DescribeClustersResponse) SDKResponseMetdata added in v0.9.0 

func (r *DescribeClustersResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DescribeClusters request.

type DescribeDefaultParametersInput 

type DescribeDefaultParametersInput struct {

	// The maximum number of results to include in the response. If more results
	// exist than the specified MaxResults value, a token is included in the response
	// so that the remaining results can be retrieved.
	//
	// The value for MaxResults must be between 20 and 100.
	MaxResults *int64 `type:"integer"`

	// An optional token returned from a prior request. Use this token for pagination
	// of results from this action. If this parameter is specified, the response
	// includes only results beyond the token, up to the value specified by MaxResults.
	NextToken *string `type:"string"`
	// contains filtered or unexported fields
}

func (DescribeDefaultParametersInput) String 

func (s DescribeDefaultParametersInput) String() string

String returns the string representation

type DescribeDefaultParametersOutput 

type DescribeDefaultParametersOutput struct {

	// Provides an identifier to allow retrieval of paginated results.
	NextToken *string `type:"string"`

	// A list of parameters. Each element in the list represents one parameter.
	Parameters []Parameter `type:"list"`
	// contains filtered or unexported fields
}

func (DescribeDefaultParametersOutput) String 

func (s DescribeDefaultParametersOutput) String() string

String returns the string representation

type DescribeDefaultParametersRequest 

type DescribeDefaultParametersRequest struct {
	*aws.Request
	Input *DescribeDefaultParametersInput
	Copy  func(*DescribeDefaultParametersInput) DescribeDefaultParametersRequest
}

DescribeDefaultParametersRequest is the request type for the DescribeDefaultParameters API operation.

func (DescribeDefaultParametersRequest) Send 

func (r DescribeDefaultParametersRequest) Send(ctx context.Context) (*DescribeDefaultParametersResponse, error)

Send marshals and sends the DescribeDefaultParameters API request.

type DescribeDefaultParametersResponse added in v0.9.0 

type DescribeDefaultParametersResponse struct {
	*DescribeDefaultParametersOutput
	// contains filtered or unexported fields
}

DescribeDefaultParametersResponse is the response type for the DescribeDefaultParameters API operation.

func (*DescribeDefaultParametersResponse) SDKResponseMetdata added in v0.9.0 

func (r *DescribeDefaultParametersResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DescribeDefaultParameters request.

type DescribeEventsInput 

type DescribeEventsInput struct {

	// The number of minutes' worth of events to retrieve.
	Duration *int64 `type:"integer"`

	// The end of the time interval for which to retrieve events, specified in ISO
	// 8601 format.
	EndTime *time.Time `type:"timestamp"`

	// The maximum number of results to include in the response. If more results
	// exist than the specified MaxResults value, a token is included in the response
	// so that the remaining results can be retrieved.
	//
	// The value for MaxResults must be between 20 and 100.
	MaxResults *int64 `type:"integer"`

	// An optional token returned from a prior request. Use this token for pagination
	// of results from this action. If this parameter is specified, the response
	// includes only results beyond the token, up to the value specified by MaxResults.
	NextToken *string `type:"string"`

	// The identifier of the event source for which events will be returned. If
	// not specified, then all sources are included in the response.
	SourceName *string `type:"string"`

	// The event source to retrieve events for. If no value is specified, all events
	// are returned.
	SourceType SourceType `type:"string" enum:"true"`

	// The beginning of the time interval to retrieve events for, specified in ISO
	// 8601 format.
	StartTime *time.Time `type:"timestamp"`
	// contains filtered or unexported fields
}

func (DescribeEventsInput) String 

func (s DescribeEventsInput) String() string

String returns the string representation

type DescribeEventsOutput 

type DescribeEventsOutput struct {

	// An array of events. Each element in the array represents one event.
	Events []Event `type:"list"`

	// Provides an identifier to allow retrieval of paginated results.
	NextToken *string `type:"string"`
	// contains filtered or unexported fields
}

func (DescribeEventsOutput) String 

func (s DescribeEventsOutput) String() string

String returns the string representation

type DescribeEventsRequest 

type DescribeEventsRequest struct {
	*aws.Request
	Input *DescribeEventsInput
	Copy  func(*DescribeEventsInput) DescribeEventsRequest
}

DescribeEventsRequest is the request type for the DescribeEvents API operation.

func (DescribeEventsRequest) Send 

func (r DescribeEventsRequest) Send(ctx context.Context) (*DescribeEventsResponse, error)

Send marshals and sends the DescribeEvents API request.

type DescribeEventsResponse added in v0.9.0 

type DescribeEventsResponse struct {
	*DescribeEventsOutput
	// contains filtered or unexported fields
}

DescribeEventsResponse is the response type for the DescribeEvents API operation.

func (*DescribeEventsResponse) SDKResponseMetdata added in v0.9.0 

func (r *DescribeEventsResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DescribeEvents request.

type DescribeParameterGroupsInput 

type DescribeParameterGroupsInput struct {

	// The maximum number of results to include in the response. If more results
	// exist than the specified MaxResults value, a token is included in the response
	// so that the remaining results can be retrieved.
	//
	// The value for MaxResults must be between 20 and 100.
	MaxResults *int64 `type:"integer"`

	// An optional token returned from a prior request. Use this token for pagination
	// of results from this action. If this parameter is specified, the response
	// includes only results beyond the token, up to the value specified by MaxResults.
	NextToken *string `type:"string"`

	// The names of the parameter groups.
	ParameterGroupNames []string `type:"list"`
	// contains filtered or unexported fields
}

func (DescribeParameterGroupsInput) String 

func (s DescribeParameterGroupsInput) String() string

String returns the string representation

type DescribeParameterGroupsOutput 

type DescribeParameterGroupsOutput struct {

	// Provides an identifier to allow retrieval of paginated results.
	NextToken *string `type:"string"`

	// An array of parameter groups. Each element in the array represents one parameter
	// group.
	ParameterGroups []ParameterGroup `type:"list"`
	// contains filtered or unexported fields
}

func (DescribeParameterGroupsOutput) String 

func (s DescribeParameterGroupsOutput) String() string

String returns the string representation

type DescribeParameterGroupsRequest 

type DescribeParameterGroupsRequest struct {
	*aws.Request
	Input *DescribeParameterGroupsInput
	Copy  func(*DescribeParameterGroupsInput) DescribeParameterGroupsRequest
}

DescribeParameterGroupsRequest is the request type for the DescribeParameterGroups API operation.

func (DescribeParameterGroupsRequest) Send 

func (r DescribeParameterGroupsRequest) Send(ctx context.Context) (*DescribeParameterGroupsResponse, error)

Send marshals and sends the DescribeParameterGroups API request.

type DescribeParameterGroupsResponse added in v0.9.0 

type DescribeParameterGroupsResponse struct {
	*DescribeParameterGroupsOutput
	// contains filtered or unexported fields
}

DescribeParameterGroupsResponse is the response type for the DescribeParameterGroups API operation.

func (*DescribeParameterGroupsResponse) SDKResponseMetdata added in v0.9.0 

func (r *DescribeParameterGroupsResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DescribeParameterGroups request.

type DescribeParametersInput 

type DescribeParametersInput struct {

	// The maximum number of results to include in the response. If more results
	// exist than the specified MaxResults value, a token is included in the response
	// so that the remaining results can be retrieved.
	//
	// The value for MaxResults must be between 20 and 100.
	MaxResults *int64 `type:"integer"`

	// An optional token returned from a prior request. Use this token for pagination
	// of results from this action. If this parameter is specified, the response
	// includes only results beyond the token, up to the value specified by MaxResults.
	NextToken *string `type:"string"`

	// The name of the parameter group.
	//
	// ParameterGroupName is a required field
	ParameterGroupName *string `type:"string" required:"true"`

	// How the parameter is defined. For example, system denotes a system-defined
	// parameter.
	Source *string `type:"string"`
	// contains filtered or unexported fields
}

func (DescribeParametersInput) String 

func (s DescribeParametersInput) String() string

String returns the string representation

func (*DescribeParametersInput) Validate 

func (s *DescribeParametersInput) Validate() error

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

type DescribeParametersOutput 

type DescribeParametersOutput struct {

	// Provides an identifier to allow retrieval of paginated results.
	NextToken *string `type:"string"`

	// A list of parameters within a parameter group. Each element in the list represents
	// one parameter.
	Parameters []Parameter `type:"list"`
	// contains filtered or unexported fields
}

func (DescribeParametersOutput) String 

func (s DescribeParametersOutput) String() string

String returns the string representation

type DescribeParametersRequest 

type DescribeParametersRequest struct {
	*aws.Request
	Input *DescribeParametersInput
	Copy  func(*DescribeParametersInput) DescribeParametersRequest
}

DescribeParametersRequest is the request type for the DescribeParameters API operation.

func (DescribeParametersRequest) Send 

func (r DescribeParametersRequest) Send(ctx context.Context) (*DescribeParametersResponse, error)

Send marshals and sends the DescribeParameters API request.

type DescribeParametersResponse added in v0.9.0 

type DescribeParametersResponse struct {
	*DescribeParametersOutput
	// contains filtered or unexported fields
}

DescribeParametersResponse is the response type for the DescribeParameters API operation.

func (*DescribeParametersResponse) SDKResponseMetdata added in v0.9.0 

func (r *DescribeParametersResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DescribeParameters request.

type DescribeSubnetGroupsInput 

type DescribeSubnetGroupsInput struct {

	// The maximum number of results to include in the response. If more results
	// exist than the specified MaxResults value, a token is included in the response
	// so that the remaining results can be retrieved.
	//
	// The value for MaxResults must be between 20 and 100.
	MaxResults *int64 `type:"integer"`

	// An optional token returned from a prior request. Use this token for pagination
	// of results from this action. If this parameter is specified, the response
	// includes only results beyond the token, up to the value specified by MaxResults.
	NextToken *string `type:"string"`

	// The name of the subnet group.
	SubnetGroupNames []string `type:"list"`
	// contains filtered or unexported fields
}

func (DescribeSubnetGroupsInput) String 

func (s DescribeSubnetGroupsInput) String() string

String returns the string representation

type DescribeSubnetGroupsOutput 

type DescribeSubnetGroupsOutput struct {

	// Provides an identifier to allow retrieval of paginated results.
	NextToken *string `type:"string"`

	// An array of subnet groups. Each element in the array represents a single
	// subnet group.
	SubnetGroups []SubnetGroup `type:"list"`
	// contains filtered or unexported fields
}

func (DescribeSubnetGroupsOutput) String 

func (s DescribeSubnetGroupsOutput) String() string

String returns the string representation

type DescribeSubnetGroupsRequest 

type DescribeSubnetGroupsRequest struct {
	*aws.Request
	Input *DescribeSubnetGroupsInput
	Copy  func(*DescribeSubnetGroupsInput) DescribeSubnetGroupsRequest
}

DescribeSubnetGroupsRequest is the request type for the DescribeSubnetGroups API operation.

func (DescribeSubnetGroupsRequest) Send 

func (r DescribeSubnetGroupsRequest) Send(ctx context.Context) (*DescribeSubnetGroupsResponse, error)

Send marshals and sends the DescribeSubnetGroups API request.

type DescribeSubnetGroupsResponse added in v0.9.0 

type DescribeSubnetGroupsResponse struct {
	*DescribeSubnetGroupsOutput
	// contains filtered or unexported fields
}

DescribeSubnetGroupsResponse is the response type for the DescribeSubnetGroups API operation.

func (*DescribeSubnetGroupsResponse) SDKResponseMetdata added in v0.9.0 

func (r *DescribeSubnetGroupsResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DescribeSubnetGroups request.

type Endpoint 

type Endpoint struct {

	// The DNS hostname of the endpoint.
	Address *string `type:"string"`

	// The port number that applications should use to connect to the endpoint.
	Port *int64 `type:"integer"`
	// contains filtered or unexported fields
}

Represents the information required for client programs to connect to the configuration endpoint for a DAX cluster, or to an individual node within the cluster.

func (Endpoint) String 

func (s Endpoint) String() string

String returns the string representation

type Event 

type Event struct {

	// The date and time when the event occurred.
	Date *time.Time `type:"timestamp"`

	// A user-defined message associated with the event.
	Message *string `type:"string"`

	// The source of the event. For example, if the event occurred at the node level,
	// the source would be the node ID.
	SourceName *string `type:"string"`

	// Specifies the origin of this event - a cluster, a parameter group, a node
	// ID, etc.
	SourceType SourceType `type:"string" enum:"true"`
	// contains filtered or unexported fields
}

Represents a single occurrence of something interesting within the system. Some examples of events are creating a DAX cluster, adding or removing a node, or rebooting a node.

func (Event) String 

func (s Event) String() string

String returns the string representation

type IncreaseReplicationFactorInput 

type IncreaseReplicationFactorInput struct {

	// The Availability Zones (AZs) in which the cluster nodes will be created.
	// All nodes belonging to the cluster are placed in these Availability Zones.
	// Use this parameter if you want to distribute the nodes across multiple AZs.
	AvailabilityZones []string `type:"list"`

	// The name of the DAX cluster that will receive additional nodes.
	//
	// ClusterName is a required field
	ClusterName *string `type:"string" required:"true"`

	// The new number of nodes for the DAX cluster.
	//
	// NewReplicationFactor is a required field
	NewReplicationFactor *int64 `type:"integer" required:"true"`
	// contains filtered or unexported fields
}

func (IncreaseReplicationFactorInput) String 

func (s IncreaseReplicationFactorInput) String() string

String returns the string representation

func (*IncreaseReplicationFactorInput) Validate 

func (s *IncreaseReplicationFactorInput) Validate() error

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

type IncreaseReplicationFactorOutput 

type IncreaseReplicationFactorOutput struct {

	// A description of the DAX cluster. with its new replication factor.
	Cluster *Cluster `type:"structure"`
	// contains filtered or unexported fields
}

func (IncreaseReplicationFactorOutput) String 

func (s IncreaseReplicationFactorOutput) String() string

String returns the string representation

type IncreaseReplicationFactorRequest 

type IncreaseReplicationFactorRequest struct {
	*aws.Request
	Input *IncreaseReplicationFactorInput
	Copy  func(*IncreaseReplicationFactorInput) IncreaseReplicationFactorRequest
}

IncreaseReplicationFactorRequest is the request type for the IncreaseReplicationFactor API operation.

func (IncreaseReplicationFactorRequest) Send 

func (r IncreaseReplicationFactorRequest) Send(ctx context.Context) (*IncreaseReplicationFactorResponse, error)

Send marshals and sends the IncreaseReplicationFactor API request.

type IncreaseReplicationFactorResponse added in v0.9.0 

type IncreaseReplicationFactorResponse struct {
	*IncreaseReplicationFactorOutput
	// contains filtered or unexported fields
}

IncreaseReplicationFactorResponse is the response type for the IncreaseReplicationFactor API operation.

func (*IncreaseReplicationFactorResponse) SDKResponseMetdata added in v0.9.0 

func (r *IncreaseReplicationFactorResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the IncreaseReplicationFactor request.

type IsModifiable 

type IsModifiable string
const (
	IsModifiableTrue        IsModifiable = "TRUE"
	IsModifiableFalse       IsModifiable = "FALSE"
	IsModifiableConditional IsModifiable = "CONDITIONAL"
)

Enum values for IsModifiable

func (IsModifiable) MarshalValue added in v0.3.0 

func (enum IsModifiable) MarshalValue() (string, error)

func (IsModifiable) MarshalValueBuf added in v0.3.0 

func (enum IsModifiable) MarshalValueBuf(b []byte) ([]byte, error)

type ListTagsInput 

type ListTagsInput struct {

	// An optional token returned from a prior request. Use this token for pagination
	// of results from this action. If this parameter is specified, the response
	// includes only results beyond the token.
	NextToken *string `type:"string"`

	// The name of the DAX resource to which the tags belong.
	//
	// ResourceName is a required field
	ResourceName *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (ListTagsInput) String 

func (s ListTagsInput) String() string

String returns the string representation

func (*ListTagsInput) Validate 

func (s *ListTagsInput) Validate() error

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

type ListTagsOutput 

type ListTagsOutput struct {

	// If this value is present, there are additional results to be displayed. To
	// retrieve them, call ListTags again, with NextToken set to this value.
	NextToken *string `type:"string"`

	// A list of tags currently associated with the DAX cluster.
	Tags []Tag `type:"list"`
	// contains filtered or unexported fields
}

func (ListTagsOutput) String 

func (s ListTagsOutput) String() string

String returns the string representation

type ListTagsRequest 

type ListTagsRequest struct {
	*aws.Request
	Input *ListTagsInput
	Copy  func(*ListTagsInput) ListTagsRequest
}

ListTagsRequest is the request type for the ListTags API operation.

func (ListTagsRequest) Send 

func (r ListTagsRequest) Send(ctx context.Context) (*ListTagsResponse, error)

Send marshals and sends the ListTags API request.

type ListTagsResponse added in v0.9.0 

type ListTagsResponse struct {
	*ListTagsOutput
	// contains filtered or unexported fields
}

ListTagsResponse is the response type for the ListTags API operation.

func (*ListTagsResponse) SDKResponseMetdata added in v0.9.0 

func (r *ListTagsResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the ListTags request.

type Node 

type Node struct {

	// The Availability Zone (AZ) in which the node has been deployed.
	AvailabilityZone *string `type:"string"`

	// The endpoint for the node, consisting of a DNS name and a port number. Client
	// applications can connect directly to a node endpoint, if desired (as an alternative
	// to allowing DAX client software to intelligently route requests and responses
	// to nodes in the DAX cluster.
	Endpoint *Endpoint `type:"structure"`

	// The date and time (in UNIX epoch format) when the node was launched.
	NodeCreateTime *time.Time `type:"timestamp"`

	// A system-generated identifier for the node.
	NodeId *string `type:"string"`

	// The current status of the node. For example: available.
	NodeStatus *string `type:"string"`

	// The status of the parameter group associated with this node. For example,
	// in-sync.
	ParameterGroupStatus *string `type:"string"`
	// contains filtered or unexported fields
}

Represents an individual node within a DAX cluster.

func (Node) String 

func (s Node) String() string

String returns the string representation

type NodeTypeSpecificValue 

type NodeTypeSpecificValue struct {

	// A node type to which the parameter value applies.
	NodeType *string `type:"string"`

	// The parameter value for this node type.
	Value *string `type:"string"`
	// contains filtered or unexported fields
}

Represents a parameter value that is applicable to a particular node type.

func (NodeTypeSpecificValue) String 

func (s NodeTypeSpecificValue) String() string

String returns the string representation

type NotificationConfiguration 

type NotificationConfiguration struct {

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

	// The current state of the topic.
	TopicStatus *string `type:"string"`
	// contains filtered or unexported fields
}

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

func (NotificationConfiguration) String 

func (s NotificationConfiguration) String() string

String returns the string representation

type Parameter 

type Parameter struct {

	// A range of values within which the parameter can be set.
	AllowedValues *string `type:"string"`

	// The conditions under which changes to this parameter can be applied. For
	// example, requires-reboot indicates that a new value for this parameter will
	// only take effect if a node is rebooted.
	ChangeType ChangeType `type:"string" enum:"true"`

	// The data type of the parameter. For example, integer:
	DataType *string `type:"string"`

	// A description of the parameter
	Description *string `type:"string"`

	// Whether the customer is allowed to modify the parameter.
	IsModifiable IsModifiable `type:"string" enum:"true"`

	// A list of node types, and specific parameter values for each node.
	NodeTypeSpecificValues []NodeTypeSpecificValue `type:"list"`

	// The name of the parameter.
	ParameterName *string `type:"string"`

	// Determines whether the parameter can be applied to any nodes, or only nodes
	// of a particular type.
	ParameterType ParameterType `type:"string" enum:"true"`

	// The value for the parameter.
	ParameterValue *string `type:"string"`

	// How the parameter is defined. For example, system denotes a system-defined
	// parameter.
	Source *string `type:"string"`
	// contains filtered or unexported fields
}

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

func (Parameter) String 

func (s Parameter) String() string

String returns the string representation

type ParameterGroup 

type ParameterGroup struct {

	// A description of the parameter group.
	Description *string `type:"string"`

	// The name of the parameter group.
	ParameterGroupName *string `type:"string"`
	// contains filtered or unexported fields
}

A named set of parameters that are applied to all of the nodes in a DAX cluster.

func (ParameterGroup) String 

func (s ParameterGroup) String() string

String returns the string representation

type ParameterGroupStatus 

type ParameterGroupStatus struct {

	// The node IDs of one or more nodes to be rebooted.
	NodeIdsToReboot []string `type:"list"`

	// The status of parameter updates.
	ParameterApplyStatus *string `type:"string"`

	// The name of the parameter group.
	ParameterGroupName *string `type:"string"`
	// contains filtered or unexported fields
}

The status of a parameter group.

func (ParameterGroupStatus) String 

func (s ParameterGroupStatus) String() string

String returns the string representation

type ParameterNameValue 

type ParameterNameValue struct {

	// The name of the parameter.
	ParameterName *string `type:"string"`

	// The value of the parameter.
	ParameterValue *string `type:"string"`
	// contains filtered or unexported fields
}

An individual DAX parameter.

func (ParameterNameValue) String 

func (s ParameterNameValue) String() string

String returns the string representation

type ParameterType 

type ParameterType string
const (
	ParameterTypeDefault          ParameterType = "DEFAULT"
	ParameterTypeNodeTypeSpecific ParameterType = "NODE_TYPE_SPECIFIC"
)

Enum values for ParameterType

func (ParameterType) MarshalValue added in v0.3.0 

func (enum ParameterType) MarshalValue() (string, error)

func (ParameterType) MarshalValueBuf added in v0.3.0 

func (enum ParameterType) MarshalValueBuf(b []byte) ([]byte, error)

type RebootNodeInput 

type RebootNodeInput struct {

	// The name of the DAX cluster containing the node to be rebooted.
	//
	// ClusterName is a required field
	ClusterName *string `type:"string" required:"true"`

	// The system-assigned ID of the node to be rebooted.
	//
	// NodeId is a required field
	NodeId *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (RebootNodeInput) String 

func (s RebootNodeInput) String() string

String returns the string representation

func (*RebootNodeInput) Validate 

func (s *RebootNodeInput) Validate() error

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

type RebootNodeOutput 

type RebootNodeOutput struct {

	// A description of the DAX cluster after a node has been rebooted.
	Cluster *Cluster `type:"structure"`
	// contains filtered or unexported fields
}

func (RebootNodeOutput) String 

func (s RebootNodeOutput) String() string

String returns the string representation

type RebootNodeRequest 

type RebootNodeRequest struct {
	*aws.Request
	Input *RebootNodeInput
	Copy  func(*RebootNodeInput) RebootNodeRequest
}

RebootNodeRequest is the request type for the RebootNode API operation.

func (RebootNodeRequest) Send 

func (r RebootNodeRequest) Send(ctx context.Context) (*RebootNodeResponse, error)

Send marshals and sends the RebootNode API request.

type RebootNodeResponse added in v0.9.0 

type RebootNodeResponse struct {
	*RebootNodeOutput
	// contains filtered or unexported fields
}

RebootNodeResponse is the response type for the RebootNode API operation.

func (*RebootNodeResponse) SDKResponseMetdata added in v0.9.0 

func (r *RebootNodeResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the RebootNode request.

type SSEDescription added in v0.5.0 

type SSEDescription struct {

	// The current state of server-side encryption:
	//
	//    * ENABLING - Server-side encryption is being enabled.
	//
	//    * ENABLED - Server-side encryption is enabled.
	//
	//    * DISABLING - Server-side encryption is being disabled.
	//
	//    * DISABLED - Server-side encryption is disabled.
	Status SSEStatus `type:"string" enum:"true"`
	// contains filtered or unexported fields
}

The description of the server-side encryption status on the specified DAX cluster.

func (SSEDescription) String added in v0.5.0 

func (s SSEDescription) String() string

String returns the string representation

type SSESpecification added in v0.5.0 

type SSESpecification struct {

	// Indicates whether server-side encryption is enabled (true) or disabled (false)
	// on the cluster.
	//
	// Enabled is a required field
	Enabled *bool `type:"boolean" required:"true"`
	// contains filtered or unexported fields
}

Represents the settings used to enable server-side encryption.

func (SSESpecification) String added in v0.5.0 

func (s SSESpecification) String() string

String returns the string representation

func (*SSESpecification) Validate added in v0.5.0 

func (s *SSESpecification) Validate() error

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

type SSEStatus added in v0.5.0 

type SSEStatus string
const (
	SSEStatusEnabling  SSEStatus = "ENABLING"
	SSEStatusEnabled   SSEStatus = "ENABLED"
	SSEStatusDisabling SSEStatus = "DISABLING"
	SSEStatusDisabled  SSEStatus = "DISABLED"
)

Enum values for SSEStatus

func (SSEStatus) MarshalValue added in v0.5.0 

func (enum SSEStatus) MarshalValue() (string, error)

func (SSEStatus) MarshalValueBuf added in v0.5.0 

func (enum SSEStatus) MarshalValueBuf(b []byte) ([]byte, error)

type SecurityGroupMembership 

type SecurityGroupMembership struct {

	// The unique ID for this security group.
	SecurityGroupIdentifier *string `type:"string"`

	// The status of this security group.
	Status *string `type:"string"`
	// contains filtered or unexported fields
}

An individual VPC security group and its status.

func (SecurityGroupMembership) String 

func (s SecurityGroupMembership) String() string

String returns the string representation

type SourceType 

type SourceType string
const (
	SourceTypeCluster        SourceType = "CLUSTER"
	SourceTypeParameterGroup SourceType = "PARAMETER_GROUP"
	SourceTypeSubnetGroup    SourceType = "SUBNET_GROUP"
)

Enum values for SourceType

func (SourceType) MarshalValue added in v0.3.0 

func (enum SourceType) MarshalValue() (string, error)

func (SourceType) MarshalValueBuf added in v0.3.0 

func (enum SourceType) MarshalValueBuf(b []byte) ([]byte, error)

type Subnet 

type Subnet struct {

	// The Availability Zone (AZ) for the subnet.
	SubnetAvailabilityZone *string `type:"string"`

	// The system-assigned identifier for the subnet.
	SubnetIdentifier *string `type:"string"`
	// contains filtered or unexported fields
}

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

func (Subnet) String 

func (s Subnet) String() string

String returns the string representation

type SubnetGroup 

type SubnetGroup struct {

	// The description of the subnet group.
	Description *string `type:"string"`

	// The name of the subnet group.
	SubnetGroupName *string `type:"string"`

	// A list of subnets associated with the subnet group.
	Subnets []Subnet `type:"list"`

	// The Amazon Virtual Private Cloud identifier (VPC ID) of the subnet group.
	VpcId *string `type:"string"`
	// contains filtered or unexported fields
}

Represents the output of one of the following actions:

  • CreateSubnetGroup

  • ModifySubnetGroup

func (SubnetGroup) String 

func (s SubnetGroup) String() string

String returns the string representation

type Tag 

type Tag struct {

	// The key for the tag. Tag keys are case sensitive. Every DAX cluster can only
	// have one tag with the same key. If you try to add an existing tag (same key),
	// the existing tag value will be updated to the new value.
	Key *string `type:"string"`

	// The value of the tag. Tag values are case-sensitive and can be null.
	Value *string `type:"string"`
	// contains filtered or unexported fields
}

A description of a tag. Every tag is a key-value pair. You can add up to 50 tags to a single DAX cluster.

AWS-assigned tag names and values are automatically assigned the aws: prefix, which the user cannot assign. AWS-assigned tag names do not count towards the tag limit of 50. User-assigned tag names have the prefix user:.

You cannot backdate the application of a tag.

func (Tag) String 

func (s Tag) String() string

String returns the string representation

type TagResourceInput 

type TagResourceInput struct {

	// The name of the DAX resource to which tags should be added.
	//
	// ResourceName is a required field
	ResourceName *string `type:"string" required:"true"`

	// The tags to be assigned to the DAX resource.
	//
	// Tags is a required field
	Tags []Tag `type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (TagResourceInput) String 

func (s TagResourceInput) String() string

String returns the string representation

func (*TagResourceInput) Validate 

func (s *TagResourceInput) Validate() error

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

type TagResourceOutput 

type TagResourceOutput struct {

	// The list of tags that are associated with the DAX resource.
	Tags []Tag `type:"list"`
	// contains filtered or unexported fields
}

func (TagResourceOutput) String 

func (s TagResourceOutput) String() string

String returns the string representation

type TagResourceRequest 

type TagResourceRequest struct {
	*aws.Request
	Input *TagResourceInput
	Copy  func(*TagResourceInput) TagResourceRequest
}

TagResourceRequest is the request type for the TagResource API operation.

func (TagResourceRequest) Send 

func (r TagResourceRequest) Send(ctx context.Context) (*TagResourceResponse, error)

Send marshals and sends the TagResource API request.

type TagResourceResponse added in v0.9.0 

type TagResourceResponse struct {
	*TagResourceOutput
	// contains filtered or unexported fields
}

TagResourceResponse is the response type for the TagResource API operation.

func (*TagResourceResponse) SDKResponseMetdata added in v0.9.0 

func (r *TagResourceResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the TagResource request.

type UntagResourceInput 

type UntagResourceInput struct {

	// The name of the DAX resource from which the tags should be removed.
	//
	// ResourceName is a required field
	ResourceName *string `type:"string" required:"true"`

	// A list of tag keys. If the DAX cluster has any tags with these keys, then
	// the tags are removed from the cluster.
	//
	// TagKeys is a required field
	TagKeys []string `type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (UntagResourceInput) String 

func (s UntagResourceInput) String() string

String returns the string representation

func (*UntagResourceInput) Validate 

func (s *UntagResourceInput) Validate() error

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

type UntagResourceOutput 

type UntagResourceOutput struct {

	// The tag keys that have been removed from the cluster.
	Tags []Tag `type:"list"`
	// contains filtered or unexported fields
}

func (UntagResourceOutput) String 

func (s UntagResourceOutput) String() string

String returns the string representation

type UntagResourceRequest 

type UntagResourceRequest struct {
	*aws.Request
	Input *UntagResourceInput
	Copy  func(*UntagResourceInput) UntagResourceRequest
}

UntagResourceRequest is the request type for the UntagResource API operation.

func (UntagResourceRequest) Send 

func (r UntagResourceRequest) Send(ctx context.Context) (*UntagResourceResponse, error)

Send marshals and sends the UntagResource API request.

type UntagResourceResponse added in v0.9.0 

type UntagResourceResponse struct {
	*UntagResourceOutput
	// contains filtered or unexported fields
}

UntagResourceResponse is the response type for the UntagResource API operation.

func (*UntagResourceResponse) SDKResponseMetdata added in v0.9.0 

func (r *UntagResourceResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the UntagResource request.

type UpdateClusterInput 

type UpdateClusterInput struct {

	// The name of the DAX cluster to be modified.
	//
	// ClusterName is a required field
	ClusterName *string `type:"string" required:"true"`

	// A description of the changes being made to the cluster.
	Description *string `type:"string"`

	// The Amazon Resource Name (ARN) that identifies the topic.
	NotificationTopicArn *string `type:"string"`

	// The current state of the topic.
	NotificationTopicStatus *string `type:"string"`

	// The name of a parameter group for this cluster.
	ParameterGroupName *string `type:"string"`

	// A range of time when maintenance of DAX cluster software will be performed.
	// For example: sun:01:00-sun:09:00. Cluster maintenance normally takes less
	// than 30 minutes, and is performed automatically within the maintenance window.
	PreferredMaintenanceWindow *string `type:"string"`

	// A list of user-specified security group IDs to be assigned to each node in
	// the DAX cluster. If this parameter is not specified, DAX assigns the default
	// VPC security group to each node.
	SecurityGroupIds []string `type:"list"`
	// contains filtered or unexported fields
}

func (UpdateClusterInput) String 

func (s UpdateClusterInput) String() string

String returns the string representation

func (*UpdateClusterInput) Validate 

func (s *UpdateClusterInput) Validate() error

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

type UpdateClusterOutput 

type UpdateClusterOutput struct {

	// A description of the DAX cluster, after it has been modified.
	Cluster *Cluster `type:"structure"`
	// contains filtered or unexported fields
}

func (UpdateClusterOutput) String 

func (s UpdateClusterOutput) String() string

String returns the string representation

type UpdateClusterRequest 

type UpdateClusterRequest struct {
	*aws.Request
	Input *UpdateClusterInput
	Copy  func(*UpdateClusterInput) UpdateClusterRequest
}

UpdateClusterRequest is the request type for the UpdateCluster API operation.

func (UpdateClusterRequest) Send 

func (r UpdateClusterRequest) Send(ctx context.Context) (*UpdateClusterResponse, error)

Send marshals and sends the UpdateCluster API request.

type UpdateClusterResponse added in v0.9.0 

type UpdateClusterResponse struct {
	*UpdateClusterOutput
	// contains filtered or unexported fields
}

UpdateClusterResponse is the response type for the UpdateCluster API operation.

func (*UpdateClusterResponse) SDKResponseMetdata added in v0.9.0 

func (r *UpdateClusterResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the UpdateCluster request.

type UpdateParameterGroupInput 

type UpdateParameterGroupInput struct {

	// The name of the parameter group.
	//
	// ParameterGroupName is a required field
	ParameterGroupName *string `type:"string" required:"true"`

	// An array of name-value pairs for the parameters in the group. Each element
	// in the array represents a single parameter.
	//
	// ParameterNameValues is a required field
	ParameterNameValues []ParameterNameValue `type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (UpdateParameterGroupInput) String 

func (s UpdateParameterGroupInput) String() string

String returns the string representation

func (*UpdateParameterGroupInput) Validate 

func (s *UpdateParameterGroupInput) Validate() error

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

type UpdateParameterGroupOutput 

type UpdateParameterGroupOutput struct {

	// The parameter group that has been modified.
	ParameterGroup *ParameterGroup `type:"structure"`
	// contains filtered or unexported fields
}

func (UpdateParameterGroupOutput) String 

func (s UpdateParameterGroupOutput) String() string

String returns the string representation

type UpdateParameterGroupRequest 

type UpdateParameterGroupRequest struct {
	*aws.Request
	Input *UpdateParameterGroupInput
	Copy  func(*UpdateParameterGroupInput) UpdateParameterGroupRequest
}

UpdateParameterGroupRequest is the request type for the UpdateParameterGroup API operation.

func (UpdateParameterGroupRequest) Send 

func (r UpdateParameterGroupRequest) Send(ctx context.Context) (*UpdateParameterGroupResponse, error)

Send marshals and sends the UpdateParameterGroup API request.

type UpdateParameterGroupResponse added in v0.9.0 

type UpdateParameterGroupResponse struct {
	*UpdateParameterGroupOutput
	// contains filtered or unexported fields
}

UpdateParameterGroupResponse is the response type for the UpdateParameterGroup API operation.

func (*UpdateParameterGroupResponse) SDKResponseMetdata added in v0.9.0 

func (r *UpdateParameterGroupResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the UpdateParameterGroup request.

type UpdateSubnetGroupInput 

type UpdateSubnetGroupInput struct {

	// A description of the subnet group.
	Description *string `type:"string"`

	// The name of the subnet group.
	//
	// SubnetGroupName is a required field
	SubnetGroupName *string `type:"string" required:"true"`

	// A list of subnet IDs in the subnet group.
	SubnetIds []string `type:"list"`
	// contains filtered or unexported fields
}

func (UpdateSubnetGroupInput) String 

func (s UpdateSubnetGroupInput) String() string

String returns the string representation

func (*UpdateSubnetGroupInput) Validate 

func (s *UpdateSubnetGroupInput) Validate() error

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

type UpdateSubnetGroupOutput 

type UpdateSubnetGroupOutput struct {

	// The subnet group that has been modified.
	SubnetGroup *SubnetGroup `type:"structure"`
	// contains filtered or unexported fields
}

func (UpdateSubnetGroupOutput) String 

func (s UpdateSubnetGroupOutput) String() string

String returns the string representation

type UpdateSubnetGroupRequest 

type UpdateSubnetGroupRequest struct {
	*aws.Request
	Input *UpdateSubnetGroupInput
	Copy  func(*UpdateSubnetGroupInput) UpdateSubnetGroupRequest
}

UpdateSubnetGroupRequest is the request type for the UpdateSubnetGroup API operation.

func (UpdateSubnetGroupRequest) Send 

func (r UpdateSubnetGroupRequest) Send(ctx context.Context) (*UpdateSubnetGroupResponse, error)

Send marshals and sends the UpdateSubnetGroup API request.

type UpdateSubnetGroupResponse added in v0.9.0 

type UpdateSubnetGroupResponse struct {
	*UpdateSubnetGroupOutput
	// contains filtered or unexported fields
}

UpdateSubnetGroupResponse is the response type for the UpdateSubnetGroup API operation.

func (*UpdateSubnetGroupResponse) SDKResponseMetdata added in v0.9.0 

func (r *UpdateSubnetGroupResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the UpdateSubnetGroup request.

Source Files

View all Source files

Directories

Path Synopsis
Package daxiface provides an interface to enable mocking the Amazon DynamoDB Accelerator (DAX) service client for testing your code.
 Package daxiface provides an interface to enable mocking the Amazon DynamoDB Accelerator (DAX) service client for testing your code.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.