dax

package
v1.13.22 Latest Latest
Warning

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

Go to latest
Published: Mar 27, 2018 License: Apache-2.0 Imports: 7 Imported by: 0

Documentation

Overview

Package dax provides the client and types for making API requests to Amazon DynamoDB Accelerator (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 contact Amazon DynamoDB Accelerator (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 DynamoDB Accelerator (DAX) client DAX 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 (
	// ChangeTypeImmediate is a ChangeType enum value
	ChangeTypeImmediate = "IMMEDIATE"

	// ChangeTypeRequiresReboot is a ChangeType enum value
	ChangeTypeRequiresReboot = "REQUIRES_REBOOT"
)
View Source
const (
	// IsModifiableTrue is a IsModifiable enum value
	IsModifiableTrue = "TRUE"

	// IsModifiableFalse is a IsModifiable enum value
	IsModifiableFalse = "FALSE"

	// IsModifiableConditional is a IsModifiable enum value
	IsModifiableConditional = "CONDITIONAL"
)
View Source
const (
	// ParameterTypeDefault is a ParameterType enum value
	ParameterTypeDefault = "DEFAULT"

	// ParameterTypeNodeTypeSpecific is a ParameterType enum value
	ParameterTypeNodeTypeSpecific = "NODE_TYPE_SPECIFIC"
)
View Source
const (
	// SourceTypeCluster is a SourceType enum value
	SourceTypeCluster = "CLUSTER"

	// SourceTypeParameterGroup is a SourceType enum value
	SourceTypeParameterGroup = "PARAMETER_GROUP"

	// SourceTypeSubnetGroup is a SourceType enum value
	SourceTypeSubnetGroup = "SUBNET_GROUP"
)
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"

	// 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"
)
View Source
const (
	ServiceName = "dax"       // Service endpoint prefix API calls made to.
	EndpointsID = ServiceName // Service ID for Regions and Endpoints metadata.
)

Service information constants

Variables

This section is empty.

Functions

This section is empty.

Types

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

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

func (s Cluster) GoString() string

GoString returns the string representation

func (*Cluster) SetActiveNodes

func (s *Cluster) SetActiveNodes(v int64) *Cluster

SetActiveNodes sets the ActiveNodes field's value.

func (*Cluster) SetClusterArn

func (s *Cluster) SetClusterArn(v string) *Cluster

SetClusterArn sets the ClusterArn field's value.

func (*Cluster) SetClusterDiscoveryEndpoint

func (s *Cluster) SetClusterDiscoveryEndpoint(v *Endpoint) *Cluster

SetClusterDiscoveryEndpoint sets the ClusterDiscoveryEndpoint field's value.

func (*Cluster) SetClusterName

func (s *Cluster) SetClusterName(v string) *Cluster

SetClusterName sets the ClusterName field's value.

func (*Cluster) SetDescription

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

SetDescription sets the Description field's value.

func (*Cluster) SetIamRoleArn

func (s *Cluster) SetIamRoleArn(v string) *Cluster

SetIamRoleArn sets the IamRoleArn field's value.

func (*Cluster) SetNodeIdsToRemove

func (s *Cluster) SetNodeIdsToRemove(v []*string) *Cluster

SetNodeIdsToRemove sets the NodeIdsToRemove field's value.

func (*Cluster) SetNodeType

func (s *Cluster) SetNodeType(v string) *Cluster

SetNodeType sets the NodeType field's value.

func (*Cluster) SetNodes

func (s *Cluster) SetNodes(v []*Node) *Cluster

SetNodes sets the Nodes field's value.

func (*Cluster) SetNotificationConfiguration

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

SetNotificationConfiguration sets the NotificationConfiguration field's value.

func (*Cluster) SetParameterGroup

func (s *Cluster) SetParameterGroup(v *ParameterGroupStatus) *Cluster

SetParameterGroup sets the ParameterGroup field's value.

func (*Cluster) SetPreferredMaintenanceWindow

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

SetPreferredMaintenanceWindow sets the PreferredMaintenanceWindow field's value.

func (*Cluster) SetSecurityGroups

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

SetSecurityGroups sets the SecurityGroups field's value.

func (*Cluster) SetStatus

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

SetStatus sets the Status field's value.

func (*Cluster) SetSubnetGroup

func (s *Cluster) SetSubnetGroup(v string) *Cluster

SetSubnetGroup sets the SubnetGroup field's value.

func (*Cluster) SetTotalNodes

func (s *Cluster) SetTotalNodes(v int64) *Cluster

SetTotalNodes sets the TotalNodes field's value.

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 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 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 2 or more.
	//
	// AWS recommends that you have at least two read replicas per cluster.
	//
	// ReplicationFactor is a required field
	ReplicationFactor *int64 `type:"integer" required:"true"`

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

func (s CreateClusterInput) GoString() string

GoString returns the string representation

func (*CreateClusterInput) SetAvailabilityZones

func (s *CreateClusterInput) SetAvailabilityZones(v []*string) *CreateClusterInput

SetAvailabilityZones sets the AvailabilityZones field's value.

func (*CreateClusterInput) SetClusterName

func (s *CreateClusterInput) SetClusterName(v string) *CreateClusterInput

SetClusterName sets the ClusterName field's value.

func (*CreateClusterInput) SetDescription

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

SetDescription sets the Description field's value.

func (*CreateClusterInput) SetIamRoleArn

func (s *CreateClusterInput) SetIamRoleArn(v string) *CreateClusterInput

SetIamRoleArn sets the IamRoleArn field's value.

func (*CreateClusterInput) SetNodeType

func (s *CreateClusterInput) SetNodeType(v string) *CreateClusterInput

SetNodeType sets the NodeType field's value.

func (*CreateClusterInput) SetNotificationTopicArn

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

SetNotificationTopicArn sets the NotificationTopicArn field's value.

func (*CreateClusterInput) SetParameterGroupName

func (s *CreateClusterInput) SetParameterGroupName(v string) *CreateClusterInput

SetParameterGroupName sets the ParameterGroupName field's value.

func (*CreateClusterInput) SetPreferredMaintenanceWindow

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

SetPreferredMaintenanceWindow sets the PreferredMaintenanceWindow field's value.

func (*CreateClusterInput) SetReplicationFactor

func (s *CreateClusterInput) SetReplicationFactor(v int64) *CreateClusterInput

SetReplicationFactor sets the ReplicationFactor field's value.

func (*CreateClusterInput) SetSecurityGroupIds

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

SetSecurityGroupIds sets the SecurityGroupIds field's value.

func (*CreateClusterInput) SetSubnetGroupName

func (s *CreateClusterInput) SetSubnetGroupName(v string) *CreateClusterInput

SetSubnetGroupName sets the SubnetGroupName field's value.

func (*CreateClusterInput) SetTags

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

SetTags sets the Tags field's value.

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) GoString

func (s CreateClusterOutput) GoString() string

GoString returns the string representation

func (*CreateClusterOutput) SetCluster

func (s *CreateClusterOutput) SetCluster(v *Cluster) *CreateClusterOutput

SetCluster sets the Cluster field's value.

func (CreateClusterOutput) String

func (s CreateClusterOutput) String() string

String returns the string representation

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) GoString

func (s CreateParameterGroupInput) GoString() string

GoString returns the string representation

func (*CreateParameterGroupInput) SetDescription

SetDescription sets the Description field's value.

func (*CreateParameterGroupInput) SetParameterGroupName

func (s *CreateParameterGroupInput) SetParameterGroupName(v string) *CreateParameterGroupInput

SetParameterGroupName sets the ParameterGroupName field's value.

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) GoString

func (s CreateParameterGroupOutput) GoString() string

GoString returns the string representation

func (*CreateParameterGroupOutput) SetParameterGroup

SetParameterGroup sets the ParameterGroup field's value.

func (CreateParameterGroupOutput) String

String returns the string representation

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) GoString

func (s CreateSubnetGroupInput) GoString() string

GoString returns the string representation

func (*CreateSubnetGroupInput) SetDescription

SetDescription sets the Description field's value.

func (*CreateSubnetGroupInput) SetSubnetGroupName

func (s *CreateSubnetGroupInput) SetSubnetGroupName(v string) *CreateSubnetGroupInput

SetSubnetGroupName sets the SubnetGroupName field's value.

func (*CreateSubnetGroupInput) SetSubnetIds

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

SetSubnetIds sets the SubnetIds field's value.

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) GoString

func (s CreateSubnetGroupOutput) GoString() string

GoString returns the string representation

func (*CreateSubnetGroupOutput) SetSubnetGroup

SetSubnetGroup sets the SubnetGroup field's value.

func (CreateSubnetGroupOutput) String

func (s CreateSubnetGroupOutput) String() string

String returns the string representation

type DAX

type DAX struct {
	*client.Client
}

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

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

func New

func New(p client.ConfigProvider, cfgs ...*aws.Config) *DAX

New creates a new instance of the DAX client with a session. If additional configuration is needed for the client instance use the optional aws.Config parameter to add your extra config.

Example:

// Create a DAX client from just a session.
svc := dax.New(mySession)

// Create a DAX client with additional configuration
svc := dax.New(mySession, aws.NewConfig().WithRegion("us-west-2"))

func (*DAX) CreateCluster

func (c *DAX) CreateCluster(input *CreateClusterInput) (*CreateClusterOutput, error)

CreateCluster API operation for Amazon DynamoDB Accelerator (DAX).

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon DynamoDB Accelerator (DAX)'s API operation CreateCluster for usage and error information.

Returned Error Codes:

  • ErrCodeClusterAlreadyExistsFault "ClusterAlreadyExistsFault" You already have a DAX cluster with the given identifier.

  • ErrCodeInvalidClusterStateFault "InvalidClusterStateFault" The requested DAX cluster is not in the available state.

  • ErrCodeInsufficientClusterCapacityFault "InsufficientClusterCapacityFault" There are not enough system resources to create the cluster you requested (or to resize an already-existing cluster).

  • ErrCodeSubnetGroupNotFoundFault "SubnetGroupNotFoundFault" The requested subnet group name does not refer to an existing subnet group.

  • ErrCodeInvalidParameterGroupStateFault "InvalidParameterGroupStateFault" One or more parameters in a parameter group are in an invalid state.

  • ErrCodeParameterGroupNotFoundFault "ParameterGroupNotFoundFault" The specified parameter group does not exist.

  • ErrCodeClusterQuotaForCustomerExceededFault "ClusterQuotaForCustomerExceededFault" You have attempted to exceed the maximum number of DAX clusters for your AWS account.

  • ErrCodeNodeQuotaForClusterExceededFault "NodeQuotaForClusterExceededFault" You have attempted to exceed the maximum number of nodes for a DAX cluster.

  • ErrCodeNodeQuotaForCustomerExceededFault "NodeQuotaForCustomerExceededFault" You have attempted to exceed the maximum number of nodes for your AWS account.

  • ErrCodeInvalidVPCNetworkStateFault "InvalidVPCNetworkStateFault" The VPC network is in an invalid state.

  • ErrCodeTagQuotaPerResourceExceeded "TagQuotaPerResourceExceeded" You have exceeded the maximum number of tags for this DAX cluster.

  • ErrCodeInvalidParameterValueException "InvalidParameterValueException" The value for a parameter is invalid.

  • ErrCodeInvalidParameterCombinationException "InvalidParameterCombinationException" Two or more incompatible parameters were specified.

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

func (*DAX) CreateClusterRequest

func (c *DAX) CreateClusterRequest(input *CreateClusterInput) (req *request.Request, output *CreateClusterOutput)

CreateClusterRequest generates a "aws/request.Request" representing the client's request for the CreateCluster operation. The "output" return value will be populated with the request's response once the request complets successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateCluster for more information on using the CreateCluster API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the CreateClusterRequest method.
req, resp := client.CreateClusterRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*DAX) CreateClusterWithContext

func (c *DAX) CreateClusterWithContext(ctx aws.Context, input *CreateClusterInput, opts ...request.Option) (*CreateClusterOutput, error)

CreateClusterWithContext is the same as CreateCluster with the addition of the ability to pass a context and additional request options.

See CreateCluster for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*DAX) CreateParameterGroup

func (c *DAX) CreateParameterGroup(input *CreateParameterGroupInput) (*CreateParameterGroupOutput, error)

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon DynamoDB Accelerator (DAX)'s API operation CreateParameterGroup for usage and error information.

Returned Error Codes:

  • ErrCodeParameterGroupQuotaExceededFault "ParameterGroupQuotaExceededFault" You have attempted to exceed the maximum number of parameter groups.

  • ErrCodeParameterGroupAlreadyExistsFault "ParameterGroupAlreadyExistsFault" The specified parameter group already exists.

  • ErrCodeInvalidParameterGroupStateFault "InvalidParameterGroupStateFault" One or more parameters in a parameter group are in an invalid state.

  • ErrCodeInvalidParameterValueException "InvalidParameterValueException" The value for a parameter is invalid.

  • ErrCodeInvalidParameterCombinationException "InvalidParameterCombinationException" Two or more incompatible parameters were specified.

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

func (*DAX) CreateParameterGroupRequest

func (c *DAX) CreateParameterGroupRequest(input *CreateParameterGroupInput) (req *request.Request, output *CreateParameterGroupOutput)

CreateParameterGroupRequest generates a "aws/request.Request" representing the client's request for the CreateParameterGroup operation. The "output" return value will be populated with the request's response once the request complets successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateParameterGroup for more information on using the CreateParameterGroup API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the CreateParameterGroupRequest method.
req, resp := client.CreateParameterGroupRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*DAX) CreateParameterGroupWithContext

func (c *DAX) CreateParameterGroupWithContext(ctx aws.Context, input *CreateParameterGroupInput, opts ...request.Option) (*CreateParameterGroupOutput, error)

CreateParameterGroupWithContext is the same as CreateParameterGroup with the addition of the ability to pass a context and additional request options.

See CreateParameterGroup for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*DAX) CreateSubnetGroup

func (c *DAX) CreateSubnetGroup(input *CreateSubnetGroupInput) (*CreateSubnetGroupOutput, error)

CreateSubnetGroup API operation for Amazon DynamoDB Accelerator (DAX).

Creates a new subnet group.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon DynamoDB Accelerator (DAX)'s API operation CreateSubnetGroup for usage and error information.

Returned Error Codes:

  • ErrCodeSubnetGroupAlreadyExistsFault "SubnetGroupAlreadyExistsFault" The specified subnet group already exists.

  • ErrCodeSubnetGroupQuotaExceededFault "SubnetGroupQuotaExceededFault" The request cannot be processed because it would exceed the allowed number of subnets in a subnet group.

  • ErrCodeSubnetQuotaExceededFault "SubnetQuotaExceededFault" The request cannot be processed because it would exceed the allowed number of subnets in a subnet group.

  • ErrCodeInvalidSubnet "InvalidSubnet" An invalid subnet identifier was specified.

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

func (*DAX) CreateSubnetGroupRequest

func (c *DAX) CreateSubnetGroupRequest(input *CreateSubnetGroupInput) (req *request.Request, output *CreateSubnetGroupOutput)

CreateSubnetGroupRequest generates a "aws/request.Request" representing the client's request for the CreateSubnetGroup operation. The "output" return value will be populated with the request's response once the request complets successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateSubnetGroup for more information on using the CreateSubnetGroup API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the CreateSubnetGroupRequest method.
req, resp := client.CreateSubnetGroupRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*DAX) CreateSubnetGroupWithContext

func (c *DAX) CreateSubnetGroupWithContext(ctx aws.Context, input *CreateSubnetGroupInput, opts ...request.Option) (*CreateSubnetGroupOutput, error)

CreateSubnetGroupWithContext is the same as CreateSubnetGroup with the addition of the ability to pass a context and additional request options.

See CreateSubnetGroup for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*DAX) DecreaseReplicationFactor

func (c *DAX) DecreaseReplicationFactor(input *DecreaseReplicationFactorInput) (*DecreaseReplicationFactorOutput, error)

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon DynamoDB Accelerator (DAX)'s API operation DecreaseReplicationFactor for usage and error information.

Returned Error Codes:

  • ErrCodeClusterNotFoundFault "ClusterNotFoundFault" The requested cluster ID does not refer to an existing DAX cluster.

  • ErrCodeNodeNotFoundFault "NodeNotFoundFault" None of the nodes in the cluster have the given node ID.

  • ErrCodeInvalidClusterStateFault "InvalidClusterStateFault" The requested DAX cluster is not in the available state.

  • ErrCodeInvalidParameterValueException "InvalidParameterValueException" The value for a parameter is invalid.

  • ErrCodeInvalidParameterCombinationException "InvalidParameterCombinationException" Two or more incompatible parameters were specified.

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

func (*DAX) DecreaseReplicationFactorRequest

func (c *DAX) DecreaseReplicationFactorRequest(input *DecreaseReplicationFactorInput) (req *request.Request, output *DecreaseReplicationFactorOutput)

DecreaseReplicationFactorRequest generates a "aws/request.Request" representing the client's request for the DecreaseReplicationFactor operation. The "output" return value will be populated with the request's response once the request complets successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DecreaseReplicationFactor for more information on using the DecreaseReplicationFactor API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DecreaseReplicationFactorRequest method.
req, resp := client.DecreaseReplicationFactorRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*DAX) DecreaseReplicationFactorWithContext

func (c *DAX) DecreaseReplicationFactorWithContext(ctx aws.Context, input *DecreaseReplicationFactorInput, opts ...request.Option) (*DecreaseReplicationFactorOutput, error)

DecreaseReplicationFactorWithContext is the same as DecreaseReplicationFactor with the addition of the ability to pass a context and additional request options.

See DecreaseReplicationFactor for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*DAX) DeleteCluster

func (c *DAX) DeleteCluster(input *DeleteClusterInput) (*DeleteClusterOutput, error)

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon DynamoDB Accelerator (DAX)'s API operation DeleteCluster for usage and error information.

Returned Error Codes:

  • ErrCodeClusterNotFoundFault "ClusterNotFoundFault" The requested cluster ID does not refer to an existing DAX cluster.

  • ErrCodeInvalidClusterStateFault "InvalidClusterStateFault" The requested DAX cluster is not in the available state.

  • ErrCodeInvalidParameterValueException "InvalidParameterValueException" The value for a parameter is invalid.

  • ErrCodeInvalidParameterCombinationException "InvalidParameterCombinationException" Two or more incompatible parameters were specified.

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

func (*DAX) DeleteClusterRequest

func (c *DAX) DeleteClusterRequest(input *DeleteClusterInput) (req *request.Request, output *DeleteClusterOutput)

DeleteClusterRequest generates a "aws/request.Request" representing the client's request for the DeleteCluster operation. The "output" return value will be populated with the request's response once the request complets successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteCluster for more information on using the DeleteCluster API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DeleteClusterRequest method.
req, resp := client.DeleteClusterRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*DAX) DeleteClusterWithContext

func (c *DAX) DeleteClusterWithContext(ctx aws.Context, input *DeleteClusterInput, opts ...request.Option) (*DeleteClusterOutput, error)

DeleteClusterWithContext is the same as DeleteCluster with the addition of the ability to pass a context and additional request options.

See DeleteCluster for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*DAX) DeleteParameterGroup

func (c *DAX) DeleteParameterGroup(input *DeleteParameterGroupInput) (*DeleteParameterGroupOutput, error)

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon DynamoDB Accelerator (DAX)'s API operation DeleteParameterGroup for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidParameterGroupStateFault "InvalidParameterGroupStateFault" One or more parameters in a parameter group are in an invalid state.

  • ErrCodeParameterGroupNotFoundFault "ParameterGroupNotFoundFault" The specified parameter group does not exist.

  • ErrCodeInvalidParameterValueException "InvalidParameterValueException" The value for a parameter is invalid.

  • ErrCodeInvalidParameterCombinationException "InvalidParameterCombinationException" Two or more incompatible parameters were specified.

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

func (*DAX) DeleteParameterGroupRequest

func (c *DAX) DeleteParameterGroupRequest(input *DeleteParameterGroupInput) (req *request.Request, output *DeleteParameterGroupOutput)

DeleteParameterGroupRequest generates a "aws/request.Request" representing the client's request for the DeleteParameterGroup operation. The "output" return value will be populated with the request's response once the request complets successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteParameterGroup for more information on using the DeleteParameterGroup API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DeleteParameterGroupRequest method.
req, resp := client.DeleteParameterGroupRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*DAX) DeleteParameterGroupWithContext

func (c *DAX) DeleteParameterGroupWithContext(ctx aws.Context, input *DeleteParameterGroupInput, opts ...request.Option) (*DeleteParameterGroupOutput, error)

DeleteParameterGroupWithContext is the same as DeleteParameterGroup with the addition of the ability to pass a context and additional request options.

See DeleteParameterGroup for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*DAX) DeleteSubnetGroup

func (c *DAX) DeleteSubnetGroup(input *DeleteSubnetGroupInput) (*DeleteSubnetGroupOutput, error)

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon DynamoDB Accelerator (DAX)'s API operation DeleteSubnetGroup for usage and error information.

Returned Error Codes:

  • ErrCodeSubnetGroupInUseFault "SubnetGroupInUseFault" The specified subnet group is currently in use.

  • ErrCodeSubnetGroupNotFoundFault "SubnetGroupNotFoundFault" The requested subnet group name does not refer to an existing subnet group.

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

func (*DAX) DeleteSubnetGroupRequest

func (c *DAX) DeleteSubnetGroupRequest(input *DeleteSubnetGroupInput) (req *request.Request, output *DeleteSubnetGroupOutput)

DeleteSubnetGroupRequest generates a "aws/request.Request" representing the client's request for the DeleteSubnetGroup operation. The "output" return value will be populated with the request's response once the request complets successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteSubnetGroup for more information on using the DeleteSubnetGroup API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DeleteSubnetGroupRequest method.
req, resp := client.DeleteSubnetGroupRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*DAX) DeleteSubnetGroupWithContext

func (c *DAX) DeleteSubnetGroupWithContext(ctx aws.Context, input *DeleteSubnetGroupInput, opts ...request.Option) (*DeleteSubnetGroupOutput, error)

DeleteSubnetGroupWithContext is the same as DeleteSubnetGroup with the addition of the ability to pass a context and additional request options.

See DeleteSubnetGroup for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*DAX) DescribeClusters

func (c *DAX) DescribeClusters(input *DescribeClustersInput) (*DescribeClustersOutput, error)

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon DynamoDB Accelerator (DAX)'s API operation DescribeClusters for usage and error information.

Returned Error Codes:

  • ErrCodeClusterNotFoundFault "ClusterNotFoundFault" The requested cluster ID does not refer to an existing DAX cluster.

  • ErrCodeInvalidParameterValueException "InvalidParameterValueException" The value for a parameter is invalid.

  • ErrCodeInvalidParameterCombinationException "InvalidParameterCombinationException" Two or more incompatible parameters were specified.

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

func (*DAX) DescribeClustersRequest

func (c *DAX) DescribeClustersRequest(input *DescribeClustersInput) (req *request.Request, output *DescribeClustersOutput)

DescribeClustersRequest generates a "aws/request.Request" representing the client's request for the DescribeClusters operation. The "output" return value will be populated with the request's response once the request complets successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeClusters for more information on using the DescribeClusters API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribeClustersRequest method.
req, resp := client.DescribeClustersRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*DAX) DescribeClustersWithContext

func (c *DAX) DescribeClustersWithContext(ctx aws.Context, input *DescribeClustersInput, opts ...request.Option) (*DescribeClustersOutput, error)

DescribeClustersWithContext is the same as DescribeClusters with the addition of the ability to pass a context and additional request options.

See DescribeClusters for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*DAX) DescribeDefaultParameters

func (c *DAX) DescribeDefaultParameters(input *DescribeDefaultParametersInput) (*DescribeDefaultParametersOutput, error)

DescribeDefaultParameters API operation for Amazon DynamoDB Accelerator (DAX).

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon DynamoDB Accelerator (DAX)'s API operation DescribeDefaultParameters for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidParameterValueException "InvalidParameterValueException" The value for a parameter is invalid.

  • ErrCodeInvalidParameterCombinationException "InvalidParameterCombinationException" Two or more incompatible parameters were specified.

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

func (*DAX) DescribeDefaultParametersRequest

func (c *DAX) DescribeDefaultParametersRequest(input *DescribeDefaultParametersInput) (req *request.Request, output *DescribeDefaultParametersOutput)

DescribeDefaultParametersRequest generates a "aws/request.Request" representing the client's request for the DescribeDefaultParameters operation. The "output" return value will be populated with the request's response once the request complets successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeDefaultParameters for more information on using the DescribeDefaultParameters API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribeDefaultParametersRequest method.
req, resp := client.DescribeDefaultParametersRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*DAX) DescribeDefaultParametersWithContext

func (c *DAX) DescribeDefaultParametersWithContext(ctx aws.Context, input *DescribeDefaultParametersInput, opts ...request.Option) (*DescribeDefaultParametersOutput, error)

DescribeDefaultParametersWithContext is the same as DescribeDefaultParameters with the addition of the ability to pass a context and additional request options.

See DescribeDefaultParameters for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*DAX) DescribeEvents

func (c *DAX) DescribeEvents(input *DescribeEventsInput) (*DescribeEventsOutput, error)

DescribeEvents 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 hour are returned; however, you can retrieve up to 14 days' worth of events if necessary.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon DynamoDB Accelerator (DAX)'s API operation DescribeEvents for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidParameterValueException "InvalidParameterValueException" The value for a parameter is invalid.

  • ErrCodeInvalidParameterCombinationException "InvalidParameterCombinationException" Two or more incompatible parameters were specified.

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

func (*DAX) DescribeEventsRequest

func (c *DAX) DescribeEventsRequest(input *DescribeEventsInput) (req *request.Request, output *DescribeEventsOutput)

DescribeEventsRequest generates a "aws/request.Request" representing the client's request for the DescribeEvents operation. The "output" return value will be populated with the request's response once the request complets successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeEvents for more information on using the DescribeEvents API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribeEventsRequest method.
req, resp := client.DescribeEventsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*DAX) DescribeEventsWithContext

func (c *DAX) DescribeEventsWithContext(ctx aws.Context, input *DescribeEventsInput, opts ...request.Option) (*DescribeEventsOutput, error)

DescribeEventsWithContext is the same as DescribeEvents with the addition of the ability to pass a context and additional request options.

See DescribeEvents for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*DAX) DescribeParameterGroups

func (c *DAX) DescribeParameterGroups(input *DescribeParameterGroupsInput) (*DescribeParameterGroupsOutput, error)

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon DynamoDB Accelerator (DAX)'s API operation DescribeParameterGroups for usage and error information.

Returned Error Codes:

  • ErrCodeParameterGroupNotFoundFault "ParameterGroupNotFoundFault" The specified parameter group does not exist.

  • ErrCodeInvalidParameterValueException "InvalidParameterValueException" The value for a parameter is invalid.

  • ErrCodeInvalidParameterCombinationException "InvalidParameterCombinationException" Two or more incompatible parameters were specified.

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

func (*DAX) DescribeParameterGroupsRequest

func (c *DAX) DescribeParameterGroupsRequest(input *DescribeParameterGroupsInput) (req *request.Request, output *DescribeParameterGroupsOutput)

DescribeParameterGroupsRequest generates a "aws/request.Request" representing the client's request for the DescribeParameterGroups operation. The "output" return value will be populated with the request's response once the request complets successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeParameterGroups for more information on using the DescribeParameterGroups API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribeParameterGroupsRequest method.
req, resp := client.DescribeParameterGroupsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*DAX) DescribeParameterGroupsWithContext

func (c *DAX) DescribeParameterGroupsWithContext(ctx aws.Context, input *DescribeParameterGroupsInput, opts ...request.Option) (*DescribeParameterGroupsOutput, error)

DescribeParameterGroupsWithContext is the same as DescribeParameterGroups with the addition of the ability to pass a context and additional request options.

See DescribeParameterGroups for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*DAX) DescribeParameters

func (c *DAX) DescribeParameters(input *DescribeParametersInput) (*DescribeParametersOutput, error)

DescribeParameters API operation for Amazon DynamoDB Accelerator (DAX).

Returns the detailed parameter list for a particular parameter group.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon DynamoDB Accelerator (DAX)'s API operation DescribeParameters for usage and error information.

Returned Error Codes:

  • ErrCodeParameterGroupNotFoundFault "ParameterGroupNotFoundFault" The specified parameter group does not exist.

  • ErrCodeInvalidParameterValueException "InvalidParameterValueException" The value for a parameter is invalid.

  • ErrCodeInvalidParameterCombinationException "InvalidParameterCombinationException" Two or more incompatible parameters were specified.

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

func (*DAX) DescribeParametersRequest

func (c *DAX) DescribeParametersRequest(input *DescribeParametersInput) (req *request.Request, output *DescribeParametersOutput)

DescribeParametersRequest generates a "aws/request.Request" representing the client's request for the DescribeParameters operation. The "output" return value will be populated with the request's response once the request complets successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeParameters for more information on using the DescribeParameters API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribeParametersRequest method.
req, resp := client.DescribeParametersRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*DAX) DescribeParametersWithContext

func (c *DAX) DescribeParametersWithContext(ctx aws.Context, input *DescribeParametersInput, opts ...request.Option) (*DescribeParametersOutput, error)

DescribeParametersWithContext is the same as DescribeParameters with the addition of the ability to pass a context and additional request options.

See DescribeParameters for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*DAX) DescribeSubnetGroups

func (c *DAX) DescribeSubnetGroups(input *DescribeSubnetGroupsInput) (*DescribeSubnetGroupsOutput, error)

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon DynamoDB Accelerator (DAX)'s API operation DescribeSubnetGroups for usage and error information.

Returned Error Codes:

  • ErrCodeSubnetGroupNotFoundFault "SubnetGroupNotFoundFault" The requested subnet group name does not refer to an existing subnet group.

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

func (*DAX) DescribeSubnetGroupsRequest

func (c *DAX) DescribeSubnetGroupsRequest(input *DescribeSubnetGroupsInput) (req *request.Request, output *DescribeSubnetGroupsOutput)

DescribeSubnetGroupsRequest generates a "aws/request.Request" representing the client's request for the DescribeSubnetGroups operation. The "output" return value will be populated with the request's response once the request complets successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeSubnetGroups for more information on using the DescribeSubnetGroups API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribeSubnetGroupsRequest method.
req, resp := client.DescribeSubnetGroupsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*DAX) DescribeSubnetGroupsWithContext

func (c *DAX) DescribeSubnetGroupsWithContext(ctx aws.Context, input *DescribeSubnetGroupsInput, opts ...request.Option) (*DescribeSubnetGroupsOutput, error)

DescribeSubnetGroupsWithContext is the same as DescribeSubnetGroups with the addition of the ability to pass a context and additional request options.

See DescribeSubnetGroups for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*DAX) IncreaseReplicationFactor

func (c *DAX) IncreaseReplicationFactor(input *IncreaseReplicationFactorInput) (*IncreaseReplicationFactorOutput, error)

IncreaseReplicationFactor API operation for Amazon DynamoDB Accelerator (DAX).

Adds one or more nodes to a DAX cluster.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon DynamoDB Accelerator (DAX)'s API operation IncreaseReplicationFactor for usage and error information.

Returned Error Codes:

  • ErrCodeClusterNotFoundFault "ClusterNotFoundFault" The requested cluster ID does not refer to an existing DAX cluster.

  • ErrCodeInvalidClusterStateFault "InvalidClusterStateFault" The requested DAX cluster is not in the available state.

  • ErrCodeInsufficientClusterCapacityFault "InsufficientClusterCapacityFault" There are not enough system resources to create the cluster you requested (or to resize an already-existing cluster).

  • ErrCodeInvalidVPCNetworkStateFault "InvalidVPCNetworkStateFault" The VPC network is in an invalid state.

  • ErrCodeNodeQuotaForClusterExceededFault "NodeQuotaForClusterExceededFault" You have attempted to exceed the maximum number of nodes for a DAX cluster.

  • ErrCodeNodeQuotaForCustomerExceededFault "NodeQuotaForCustomerExceededFault" You have attempted to exceed the maximum number of nodes for your AWS account.

  • ErrCodeInvalidParameterValueException "InvalidParameterValueException" The value for a parameter is invalid.

  • ErrCodeInvalidParameterCombinationException "InvalidParameterCombinationException" Two or more incompatible parameters were specified.

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

func (*DAX) IncreaseReplicationFactorRequest

func (c *DAX) IncreaseReplicationFactorRequest(input *IncreaseReplicationFactorInput) (req *request.Request, output *IncreaseReplicationFactorOutput)

IncreaseReplicationFactorRequest generates a "aws/request.Request" representing the client's request for the IncreaseReplicationFactor operation. The "output" return value will be populated with the request's response once the request complets successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See IncreaseReplicationFactor for more information on using the IncreaseReplicationFactor API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the IncreaseReplicationFactorRequest method.
req, resp := client.IncreaseReplicationFactorRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*DAX) IncreaseReplicationFactorWithContext

func (c *DAX) IncreaseReplicationFactorWithContext(ctx aws.Context, input *IncreaseReplicationFactorInput, opts ...request.Option) (*IncreaseReplicationFactorOutput, error)

IncreaseReplicationFactorWithContext is the same as IncreaseReplicationFactor with the addition of the ability to pass a context and additional request options.

See IncreaseReplicationFactor for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*DAX) ListTags

func (c *DAX) ListTags(input *ListTagsInput) (*ListTagsOutput, error)

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon DynamoDB Accelerator (DAX)'s API operation ListTags for usage and error information.

Returned Error Codes:

  • ErrCodeClusterNotFoundFault "ClusterNotFoundFault" The requested cluster ID does not refer to an existing DAX cluster.

  • ErrCodeInvalidARNFault "InvalidARNFault" The Amazon Resource Name (ARN) supplied in the request is not valid.

  • ErrCodeInvalidClusterStateFault "InvalidClusterStateFault" The requested DAX cluster is not in the available state.

  • ErrCodeInvalidParameterValueException "InvalidParameterValueException" The value for a parameter is invalid.

  • ErrCodeInvalidParameterCombinationException "InvalidParameterCombinationException" Two or more incompatible parameters were specified.

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

func (*DAX) ListTagsRequest

func (c *DAX) ListTagsRequest(input *ListTagsInput) (req *request.Request, output *ListTagsOutput)

ListTagsRequest generates a "aws/request.Request" representing the client's request for the ListTags operation. The "output" return value will be populated with the request's response once the request complets successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListTags for more information on using the ListTags API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ListTagsRequest method.
req, resp := client.ListTagsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*DAX) ListTagsWithContext

func (c *DAX) ListTagsWithContext(ctx aws.Context, input *ListTagsInput, opts ...request.Option) (*ListTagsOutput, error)

ListTagsWithContext is the same as ListTags with the addition of the ability to pass a context and additional request options.

See ListTags for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*DAX) RebootNode

func (c *DAX) RebootNode(input *RebootNodeInput) (*RebootNodeOutput, error)

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon DynamoDB Accelerator (DAX)'s API operation RebootNode for usage and error information.

Returned Error Codes:

  • ErrCodeClusterNotFoundFault "ClusterNotFoundFault" The requested cluster ID does not refer to an existing DAX cluster.

  • ErrCodeNodeNotFoundFault "NodeNotFoundFault" None of the nodes in the cluster have the given node ID.

  • ErrCodeInvalidClusterStateFault "InvalidClusterStateFault" The requested DAX cluster is not in the available state.

  • ErrCodeInvalidParameterValueException "InvalidParameterValueException" The value for a parameter is invalid.

  • ErrCodeInvalidParameterCombinationException "InvalidParameterCombinationException" Two or more incompatible parameters were specified.

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

func (*DAX) RebootNodeRequest

func (c *DAX) RebootNodeRequest(input *RebootNodeInput) (req *request.Request, output *RebootNodeOutput)

RebootNodeRequest generates a "aws/request.Request" representing the client's request for the RebootNode operation. The "output" return value will be populated with the request's response once the request complets successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See RebootNode for more information on using the RebootNode API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the RebootNodeRequest method.
req, resp := client.RebootNodeRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*DAX) RebootNodeWithContext

func (c *DAX) RebootNodeWithContext(ctx aws.Context, input *RebootNodeInput, opts ...request.Option) (*RebootNodeOutput, error)

RebootNodeWithContext is the same as RebootNode with the addition of the ability to pass a context and additional request options.

See RebootNode for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*DAX) TagResource

func (c *DAX) TagResource(input *TagResourceInput) (*TagResourceOutput, error)

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon DynamoDB Accelerator (DAX)'s API operation TagResource for usage and error information.

Returned Error Codes:

  • ErrCodeClusterNotFoundFault "ClusterNotFoundFault" The requested cluster ID does not refer to an existing DAX cluster.

  • ErrCodeTagQuotaPerResourceExceeded "TagQuotaPerResourceExceeded" You have exceeded the maximum number of tags for this DAX cluster.

  • ErrCodeInvalidARNFault "InvalidARNFault" The Amazon Resource Name (ARN) supplied in the request is not valid.

  • ErrCodeInvalidClusterStateFault "InvalidClusterStateFault" The requested DAX cluster is not in the available state.

  • ErrCodeInvalidParameterValueException "InvalidParameterValueException" The value for a parameter is invalid.

  • ErrCodeInvalidParameterCombinationException "InvalidParameterCombinationException" Two or more incompatible parameters were specified.

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

func (*DAX) TagResourceRequest

func (c *DAX) TagResourceRequest(input *TagResourceInput) (req *request.Request, output *TagResourceOutput)

TagResourceRequest generates a "aws/request.Request" representing the client's request for the TagResource operation. The "output" return value will be populated with the request's response once the request complets successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See TagResource for more information on using the TagResource API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the TagResourceRequest method.
req, resp := client.TagResourceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*DAX) TagResourceWithContext

func (c *DAX) TagResourceWithContext(ctx aws.Context, input *TagResourceInput, opts ...request.Option) (*TagResourceOutput, error)

TagResourceWithContext is the same as TagResource with the addition of the ability to pass a context and additional request options.

See TagResource for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*DAX) UntagResource

func (c *DAX) UntagResource(input *UntagResourceInput) (*UntagResourceOutput, error)

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon DynamoDB Accelerator (DAX)'s API operation UntagResource for usage and error information.

Returned Error Codes:

  • ErrCodeClusterNotFoundFault "ClusterNotFoundFault" The requested cluster ID does not refer to an existing DAX cluster.

  • ErrCodeInvalidARNFault "InvalidARNFault" The Amazon Resource Name (ARN) supplied in the request is not valid.

  • ErrCodeTagNotFoundFault "TagNotFoundFault" The tag does not exist.

  • ErrCodeInvalidClusterStateFault "InvalidClusterStateFault" The requested DAX cluster is not in the available state.

  • ErrCodeInvalidParameterValueException "InvalidParameterValueException" The value for a parameter is invalid.

  • ErrCodeInvalidParameterCombinationException "InvalidParameterCombinationException" Two or more incompatible parameters were specified.

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

func (*DAX) UntagResourceRequest

func (c *DAX) UntagResourceRequest(input *UntagResourceInput) (req *request.Request, output *UntagResourceOutput)

UntagResourceRequest generates a "aws/request.Request" representing the client's request for the UntagResource operation. The "output" return value will be populated with the request's response once the request complets successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UntagResource for more information on using the UntagResource API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the UntagResourceRequest method.
req, resp := client.UntagResourceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*DAX) UntagResourceWithContext

func (c *DAX) UntagResourceWithContext(ctx aws.Context, input *UntagResourceInput, opts ...request.Option) (*UntagResourceOutput, error)

UntagResourceWithContext is the same as UntagResource with the addition of the ability to pass a context and additional request options.

See UntagResource for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*DAX) UpdateCluster

func (c *DAX) UpdateCluster(input *UpdateClusterInput) (*UpdateClusterOutput, error)

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon DynamoDB Accelerator (DAX)'s API operation UpdateCluster for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidClusterStateFault "InvalidClusterStateFault" The requested DAX cluster is not in the available state.

  • ErrCodeClusterNotFoundFault "ClusterNotFoundFault" The requested cluster ID does not refer to an existing DAX cluster.

  • ErrCodeInvalidParameterGroupStateFault "InvalidParameterGroupStateFault" One or more parameters in a parameter group are in an invalid state.

  • ErrCodeParameterGroupNotFoundFault "ParameterGroupNotFoundFault" The specified parameter group does not exist.

  • ErrCodeInvalidParameterValueException "InvalidParameterValueException" The value for a parameter is invalid.

  • ErrCodeInvalidParameterCombinationException "InvalidParameterCombinationException" Two or more incompatible parameters were specified.

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

func (*DAX) UpdateClusterRequest

func (c *DAX) UpdateClusterRequest(input *UpdateClusterInput) (req *request.Request, output *UpdateClusterOutput)

UpdateClusterRequest generates a "aws/request.Request" representing the client's request for the UpdateCluster operation. The "output" return value will be populated with the request's response once the request complets successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpdateCluster for more information on using the UpdateCluster API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the UpdateClusterRequest method.
req, resp := client.UpdateClusterRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*DAX) UpdateClusterWithContext

func (c *DAX) UpdateClusterWithContext(ctx aws.Context, input *UpdateClusterInput, opts ...request.Option) (*UpdateClusterOutput, error)

UpdateClusterWithContext is the same as UpdateCluster with the addition of the ability to pass a context and additional request options.

See UpdateCluster for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*DAX) UpdateParameterGroup

func (c *DAX) UpdateParameterGroup(input *UpdateParameterGroupInput) (*UpdateParameterGroupOutput, error)

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon DynamoDB Accelerator (DAX)'s API operation UpdateParameterGroup for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidParameterGroupStateFault "InvalidParameterGroupStateFault" One or more parameters in a parameter group are in an invalid state.

  • ErrCodeParameterGroupNotFoundFault "ParameterGroupNotFoundFault" The specified parameter group does not exist.

  • ErrCodeInvalidParameterValueException "InvalidParameterValueException" The value for a parameter is invalid.

  • ErrCodeInvalidParameterCombinationException "InvalidParameterCombinationException" Two or more incompatible parameters were specified.

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

func (*DAX) UpdateParameterGroupRequest

func (c *DAX) UpdateParameterGroupRequest(input *UpdateParameterGroupInput) (req *request.Request, output *UpdateParameterGroupOutput)

UpdateParameterGroupRequest generates a "aws/request.Request" representing the client's request for the UpdateParameterGroup operation. The "output" return value will be populated with the request's response once the request complets successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpdateParameterGroup for more information on using the UpdateParameterGroup API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the UpdateParameterGroupRequest method.
req, resp := client.UpdateParameterGroupRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*DAX) UpdateParameterGroupWithContext

func (c *DAX) UpdateParameterGroupWithContext(ctx aws.Context, input *UpdateParameterGroupInput, opts ...request.Option) (*UpdateParameterGroupOutput, error)

UpdateParameterGroupWithContext is the same as UpdateParameterGroup with the addition of the ability to pass a context and additional request options.

See UpdateParameterGroup for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*DAX) UpdateSubnetGroup

func (c *DAX) UpdateSubnetGroup(input *UpdateSubnetGroupInput) (*UpdateSubnetGroupOutput, error)

UpdateSubnetGroup API operation for Amazon DynamoDB Accelerator (DAX).

Modifies an existing subnet group.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon DynamoDB Accelerator (DAX)'s API operation UpdateSubnetGroup for usage and error information.

Returned Error Codes:

  • ErrCodeSubnetGroupNotFoundFault "SubnetGroupNotFoundFault" The requested subnet group name does not refer to an existing subnet group.

  • ErrCodeSubnetQuotaExceededFault "SubnetQuotaExceededFault" The request cannot be processed because it would exceed the allowed number of subnets in a subnet group.

  • ErrCodeSubnetInUse "SubnetInUse" The requested subnet is being used by another subnet group.

  • ErrCodeInvalidSubnet "InvalidSubnet" An invalid subnet identifier was specified.

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

func (*DAX) UpdateSubnetGroupRequest

func (c *DAX) UpdateSubnetGroupRequest(input *UpdateSubnetGroupInput) (req *request.Request, output *UpdateSubnetGroupOutput)

UpdateSubnetGroupRequest generates a "aws/request.Request" representing the client's request for the UpdateSubnetGroup operation. The "output" return value will be populated with the request's response once the request complets successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpdateSubnetGroup for more information on using the UpdateSubnetGroup API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the UpdateSubnetGroupRequest method.
req, resp := client.UpdateSubnetGroupRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*DAX) UpdateSubnetGroupWithContext

func (c *DAX) UpdateSubnetGroupWithContext(ctx aws.Context, input *UpdateSubnetGroupInput, opts ...request.Option) (*UpdateSubnetGroupOutput, error)

UpdateSubnetGroupWithContext is the same as UpdateSubnetGroup with the addition of the ability to pass a context and additional request options.

See UpdateSubnetGroup for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

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) GoString

GoString returns the string representation

func (*DecreaseReplicationFactorInput) SetAvailabilityZones

SetAvailabilityZones sets the AvailabilityZones field's value.

func (*DecreaseReplicationFactorInput) SetClusterName

SetClusterName sets the ClusterName field's value.

func (*DecreaseReplicationFactorInput) SetNewReplicationFactor

SetNewReplicationFactor sets the NewReplicationFactor field's value.

func (*DecreaseReplicationFactorInput) SetNodeIdsToRemove

SetNodeIdsToRemove sets the NodeIdsToRemove field's value.

func (DecreaseReplicationFactorInput) 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) GoString

GoString returns the string representation

func (*DecreaseReplicationFactorOutput) SetCluster

SetCluster sets the Cluster field's value.

func (DecreaseReplicationFactorOutput) String

String returns the string representation

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) GoString

func (s DeleteClusterInput) GoString() string

GoString returns the string representation

func (*DeleteClusterInput) SetClusterName

func (s *DeleteClusterInput) SetClusterName(v string) *DeleteClusterInput

SetClusterName sets the ClusterName field's value.

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) GoString

func (s DeleteClusterOutput) GoString() string

GoString returns the string representation

func (*DeleteClusterOutput) SetCluster

func (s *DeleteClusterOutput) SetCluster(v *Cluster) *DeleteClusterOutput

SetCluster sets the Cluster field's value.

func (DeleteClusterOutput) String

func (s DeleteClusterOutput) String() string

String returns the string representation

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) GoString

func (s DeleteParameterGroupInput) GoString() string

GoString returns the string representation

func (*DeleteParameterGroupInput) SetParameterGroupName

func (s *DeleteParameterGroupInput) SetParameterGroupName(v string) *DeleteParameterGroupInput

SetParameterGroupName sets the ParameterGroupName field's value.

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) GoString

func (s DeleteParameterGroupOutput) GoString() string

GoString returns the string representation

func (*DeleteParameterGroupOutput) SetDeletionMessage

SetDeletionMessage sets the DeletionMessage field's value.

func (DeleteParameterGroupOutput) String

String returns the string representation

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) GoString

func (s DeleteSubnetGroupInput) GoString() string

GoString returns the string representation

func (*DeleteSubnetGroupInput) SetSubnetGroupName

func (s *DeleteSubnetGroupInput) SetSubnetGroupName(v string) *DeleteSubnetGroupInput

SetSubnetGroupName sets the SubnetGroupName field's value.

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) GoString

func (s DeleteSubnetGroupOutput) GoString() string

GoString returns the string representation

func (*DeleteSubnetGroupOutput) SetDeletionMessage

func (s *DeleteSubnetGroupOutput) SetDeletionMessage(v string) *DeleteSubnetGroupOutput

SetDeletionMessage sets the DeletionMessage field's value.

func (DeleteSubnetGroupOutput) String

func (s DeleteSubnetGroupOutput) String() string

String returns the string representation

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) GoString

func (s DescribeClustersInput) GoString() string

GoString returns the string representation

func (*DescribeClustersInput) SetClusterNames

func (s *DescribeClustersInput) SetClusterNames(v []*string) *DescribeClustersInput

SetClusterNames sets the ClusterNames field's value.

func (*DescribeClustersInput) SetMaxResults

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

SetMaxResults sets the MaxResults field's value.

func (*DescribeClustersInput) SetNextToken

SetNextToken sets the NextToken field's value.

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) GoString

func (s DescribeClustersOutput) GoString() string

GoString returns the string representation

func (*DescribeClustersOutput) SetClusters

SetClusters sets the Clusters field's value.

func (*DescribeClustersOutput) SetNextToken

SetNextToken sets the NextToken field's value.

func (DescribeClustersOutput) String

func (s DescribeClustersOutput) String() string

String returns the string representation

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) GoString

GoString returns the string representation

func (*DescribeDefaultParametersInput) SetMaxResults

SetMaxResults sets the MaxResults field's value.

func (*DescribeDefaultParametersInput) SetNextToken

SetNextToken sets the NextToken field's value.

func (DescribeDefaultParametersInput) 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) GoString

GoString returns the string representation

func (*DescribeDefaultParametersOutput) SetNextToken

SetNextToken sets the NextToken field's value.

func (*DescribeDefaultParametersOutput) SetParameters

SetParameters sets the Parameters field's value.

func (DescribeDefaultParametersOutput) String

String returns the string representation

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" timestampFormat:"unix"`

	// 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 *string `type:"string" enum:"SourceType"`

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

func (DescribeEventsInput) GoString

func (s DescribeEventsInput) GoString() string

GoString returns the string representation

func (*DescribeEventsInput) SetDuration

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

SetDuration sets the Duration field's value.

func (*DescribeEventsInput) SetEndTime

SetEndTime sets the EndTime field's value.

func (*DescribeEventsInput) SetMaxResults

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

SetMaxResults sets the MaxResults field's value.

func (*DescribeEventsInput) SetNextToken

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

SetNextToken sets the NextToken field's value.

func (*DescribeEventsInput) SetSourceName

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

SetSourceName sets the SourceName field's value.

func (*DescribeEventsInput) SetSourceType

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

SetSourceType sets the SourceType field's value.

func (*DescribeEventsInput) SetStartTime

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

SetStartTime sets the StartTime field's value.

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) GoString

func (s DescribeEventsOutput) GoString() string

GoString returns the string representation

func (*DescribeEventsOutput) SetEvents

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

SetEvents sets the Events field's value.

func (*DescribeEventsOutput) SetNextToken

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

SetNextToken sets the NextToken field's value.

func (DescribeEventsOutput) String

func (s DescribeEventsOutput) String() string

String returns the string representation

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) GoString

func (s DescribeParameterGroupsInput) GoString() string

GoString returns the string representation

func (*DescribeParameterGroupsInput) SetMaxResults

SetMaxResults sets the MaxResults field's value.

func (*DescribeParameterGroupsInput) SetNextToken

SetNextToken sets the NextToken field's value.

func (*DescribeParameterGroupsInput) SetParameterGroupNames

func (s *DescribeParameterGroupsInput) SetParameterGroupNames(v []*string) *DescribeParameterGroupsInput

SetParameterGroupNames sets the ParameterGroupNames field's value.

func (DescribeParameterGroupsInput) 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) GoString

GoString returns the string representation

func (*DescribeParameterGroupsOutput) SetNextToken

SetNextToken sets the NextToken field's value.

func (*DescribeParameterGroupsOutput) SetParameterGroups

SetParameterGroups sets the ParameterGroups field's value.

func (DescribeParameterGroupsOutput) String

String returns the string representation

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) GoString

func (s DescribeParametersInput) GoString() string

GoString returns the string representation

func (*DescribeParametersInput) SetMaxResults

SetMaxResults sets the MaxResults field's value.

func (*DescribeParametersInput) SetNextToken

SetNextToken sets the NextToken field's value.

func (*DescribeParametersInput) SetParameterGroupName

func (s *DescribeParametersInput) SetParameterGroupName(v string) *DescribeParametersInput

SetParameterGroupName sets the ParameterGroupName field's value.

func (*DescribeParametersInput) SetSource

SetSource sets the Source field's value.

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) GoString

func (s DescribeParametersOutput) GoString() string

GoString returns the string representation

func (*DescribeParametersOutput) SetNextToken

SetNextToken sets the NextToken field's value.

func (*DescribeParametersOutput) SetParameters

SetParameters sets the Parameters field's value.

func (DescribeParametersOutput) String

func (s DescribeParametersOutput) String() string

String returns the string representation

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) GoString

func (s DescribeSubnetGroupsInput) GoString() string

GoString returns the string representation

func (*DescribeSubnetGroupsInput) SetMaxResults

SetMaxResults sets the MaxResults field's value.

func (*DescribeSubnetGroupsInput) SetNextToken

SetNextToken sets the NextToken field's value.

func (*DescribeSubnetGroupsInput) SetSubnetGroupNames

func (s *DescribeSubnetGroupsInput) SetSubnetGroupNames(v []*string) *DescribeSubnetGroupsInput

SetSubnetGroupNames sets the SubnetGroupNames field's value.

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) GoString

func (s DescribeSubnetGroupsOutput) GoString() string

GoString returns the string representation

func (*DescribeSubnetGroupsOutput) SetNextToken

SetNextToken sets the NextToken field's value.

func (*DescribeSubnetGroupsOutput) SetSubnetGroups

SetSubnetGroups sets the SubnetGroups field's value.

func (DescribeSubnetGroupsOutput) String

String returns the string representation

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) GoString

func (s Endpoint) GoString() string

GoString returns the string representation

func (*Endpoint) SetAddress

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

SetAddress sets the Address field's value.

func (*Endpoint) SetPort

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

SetPort sets the Port field's value.

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" timestampFormat:"unix"`

	// 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 *string `type:"string" enum:"SourceType"`
	// contains filtered or unexported fields
}

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

func (Event) GoString

func (s Event) GoString() string

GoString returns the string representation

func (*Event) SetDate

func (s *Event) SetDate(v time.Time) *Event

SetDate sets the Date field's value.

func (*Event) SetMessage

func (s *Event) SetMessage(v string) *Event

SetMessage sets the Message field's value.

func (*Event) SetSourceName

func (s *Event) SetSourceName(v string) *Event

SetSourceName sets the SourceName field's value.

func (*Event) SetSourceType

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

SetSourceType sets the SourceType field's value.

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) GoString

GoString returns the string representation

func (*IncreaseReplicationFactorInput) SetAvailabilityZones

SetAvailabilityZones sets the AvailabilityZones field's value.

func (*IncreaseReplicationFactorInput) SetClusterName

SetClusterName sets the ClusterName field's value.

func (*IncreaseReplicationFactorInput) SetNewReplicationFactor

SetNewReplicationFactor sets the NewReplicationFactor field's value.

func (IncreaseReplicationFactorInput) 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) GoString

GoString returns the string representation

func (*IncreaseReplicationFactorOutput) SetCluster

SetCluster sets the Cluster field's value.

func (IncreaseReplicationFactorOutput) String

String returns the string representation

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) GoString

func (s ListTagsInput) GoString() string

GoString returns the string representation

func (*ListTagsInput) SetNextToken

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

SetNextToken sets the NextToken field's value.

func (*ListTagsInput) SetResourceName

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

SetResourceName sets the ResourceName field's value.

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) GoString

func (s ListTagsOutput) GoString() string

GoString returns the string representation

func (*ListTagsOutput) SetNextToken

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

SetNextToken sets the NextToken field's value.

func (*ListTagsOutput) SetTags

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

SetTags sets the Tags field's value.

func (ListTagsOutput) String

func (s ListTagsOutput) String() string

String returns the string representation

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" timestampFormat:"unix"`

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

func (s Node) GoString() string

GoString returns the string representation

func (*Node) SetAvailabilityZone

func (s *Node) SetAvailabilityZone(v string) *Node

SetAvailabilityZone sets the AvailabilityZone field's value.

func (*Node) SetEndpoint

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

SetEndpoint sets the Endpoint field's value.

func (*Node) SetNodeCreateTime

func (s *Node) SetNodeCreateTime(v time.Time) *Node

SetNodeCreateTime sets the NodeCreateTime field's value.

func (*Node) SetNodeId

func (s *Node) SetNodeId(v string) *Node

SetNodeId sets the NodeId field's value.

func (*Node) SetNodeStatus

func (s *Node) SetNodeStatus(v string) *Node

SetNodeStatus sets the NodeStatus field's value.

func (*Node) SetParameterGroupStatus

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

SetParameterGroupStatus sets the ParameterGroupStatus field's value.

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) GoString

func (s NodeTypeSpecificValue) GoString() string

GoString returns the string representation

func (*NodeTypeSpecificValue) SetNodeType

SetNodeType sets the NodeType field's value.

func (*NodeTypeSpecificValue) SetValue

SetValue sets the Value field's value.

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) GoString

func (s NotificationConfiguration) GoString() string

GoString returns the string representation

func (*NotificationConfiguration) SetTopicArn

SetTopicArn sets the TopicArn field's value.

func (*NotificationConfiguration) SetTopicStatus

SetTopicStatus sets the TopicStatus field's value.

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 *string `type:"string" enum:"ChangeType"`

	// 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 *string `type:"string" enum:"IsModifiable"`

	// 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 *string `type:"string" enum:"ParameterType"`

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

func (s Parameter) GoString() string

GoString returns the string representation

func (*Parameter) SetAllowedValues

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

SetAllowedValues sets the AllowedValues field's value.

func (*Parameter) SetChangeType

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

SetChangeType sets the ChangeType field's value.

func (*Parameter) SetDataType

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

SetDataType sets the DataType field's value.

func (*Parameter) SetDescription

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

SetDescription sets the Description field's value.

func (*Parameter) SetIsModifiable

func (s *Parameter) SetIsModifiable(v string) *Parameter

SetIsModifiable sets the IsModifiable field's value.

func (*Parameter) SetNodeTypeSpecificValues

func (s *Parameter) SetNodeTypeSpecificValues(v []*NodeTypeSpecificValue) *Parameter

SetNodeTypeSpecificValues sets the NodeTypeSpecificValues field's value.

func (*Parameter) SetParameterName

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

SetParameterName sets the ParameterName field's value.

func (*Parameter) SetParameterType

func (s *Parameter) SetParameterType(v string) *Parameter

SetParameterType sets the ParameterType field's value.

func (*Parameter) SetParameterValue

func (s *Parameter) SetParameterValue(v string) *Parameter

SetParameterValue sets the ParameterValue field's value.

func (*Parameter) SetSource

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

SetSource sets the Source field's value.

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) GoString

func (s ParameterGroup) GoString() string

GoString returns the string representation

func (*ParameterGroup) SetDescription

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

SetDescription sets the Description field's value.

func (*ParameterGroup) SetParameterGroupName

func (s *ParameterGroup) SetParameterGroupName(v string) *ParameterGroup

SetParameterGroupName sets the ParameterGroupName field's value.

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) GoString

func (s ParameterGroupStatus) GoString() string

GoString returns the string representation

func (*ParameterGroupStatus) SetNodeIdsToReboot

func (s *ParameterGroupStatus) SetNodeIdsToReboot(v []*string) *ParameterGroupStatus

SetNodeIdsToReboot sets the NodeIdsToReboot field's value.

func (*ParameterGroupStatus) SetParameterApplyStatus

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

SetParameterApplyStatus sets the ParameterApplyStatus field's value.

func (*ParameterGroupStatus) SetParameterGroupName

func (s *ParameterGroupStatus) SetParameterGroupName(v string) *ParameterGroupStatus

SetParameterGroupName sets the ParameterGroupName field's value.

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) GoString

func (s ParameterNameValue) GoString() string

GoString returns the string representation

func (*ParameterNameValue) SetParameterName

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

SetParameterName sets the ParameterName field's value.

func (*ParameterNameValue) SetParameterValue

func (s *ParameterNameValue) SetParameterValue(v string) *ParameterNameValue

SetParameterValue sets the ParameterValue field's value.

func (ParameterNameValue) String

func (s ParameterNameValue) String() string

String returns the string representation

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) GoString

func (s RebootNodeInput) GoString() string

GoString returns the string representation

func (*RebootNodeInput) SetClusterName

func (s *RebootNodeInput) SetClusterName(v string) *RebootNodeInput

SetClusterName sets the ClusterName field's value.

func (*RebootNodeInput) SetNodeId

func (s *RebootNodeInput) SetNodeId(v string) *RebootNodeInput

SetNodeId sets the NodeId field's value.

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) GoString

func (s RebootNodeOutput) GoString() string

GoString returns the string representation

func (*RebootNodeOutput) SetCluster

func (s *RebootNodeOutput) SetCluster(v *Cluster) *RebootNodeOutput

SetCluster sets the Cluster field's value.

func (RebootNodeOutput) String

func (s RebootNodeOutput) String() string

String returns the string representation

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) GoString

func (s SecurityGroupMembership) GoString() string

GoString returns the string representation

func (*SecurityGroupMembership) SetSecurityGroupIdentifier

func (s *SecurityGroupMembership) SetSecurityGroupIdentifier(v string) *SecurityGroupMembership

SetSecurityGroupIdentifier sets the SecurityGroupIdentifier field's value.

func (*SecurityGroupMembership) SetStatus

SetStatus sets the Status field's value.

func (SecurityGroupMembership) String

func (s SecurityGroupMembership) String() string

String returns the string representation

type Subnet

type Subnet struct {

	// The Availability Zone (AZ) for subnet 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) GoString

func (s Subnet) GoString() string

GoString returns the string representation

func (*Subnet) SetSubnetAvailabilityZone

func (s *Subnet) SetSubnetAvailabilityZone(v string) *Subnet

SetSubnetAvailabilityZone sets the SubnetAvailabilityZone field's value.

func (*Subnet) SetSubnetIdentifier

func (s *Subnet) SetSubnetIdentifier(v string) *Subnet

SetSubnetIdentifier sets the SubnetIdentifier field's value.

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) GoString

func (s SubnetGroup) GoString() string

GoString returns the string representation

func (*SubnetGroup) SetDescription

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

SetDescription sets the Description field's value.

func (*SubnetGroup) SetSubnetGroupName

func (s *SubnetGroup) SetSubnetGroupName(v string) *SubnetGroup

SetSubnetGroupName sets the SubnetGroupName field's value.

func (*SubnetGroup) SetSubnets

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

SetSubnets sets the Subnets field's value.

func (*SubnetGroup) SetVpcId

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

SetVpcId sets the VpcId field's value.

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) GoString

func (s Tag) GoString() string

GoString returns the string representation

func (*Tag) SetKey

func (s *Tag) SetKey(v string) *Tag

SetKey sets the Key field's value.

func (*Tag) SetValue

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

SetValue sets the Value field's value.

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) GoString

func (s TagResourceInput) GoString() string

GoString returns the string representation

func (*TagResourceInput) SetResourceName

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

SetResourceName sets the ResourceName field's value.

func (*TagResourceInput) SetTags

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

SetTags sets the Tags field's value.

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) GoString

func (s TagResourceOutput) GoString() string

GoString returns the string representation

func (*TagResourceOutput) SetTags

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

SetTags sets the Tags field's value.

func (TagResourceOutput) String

func (s TagResourceOutput) String() string

String returns the string representation

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) GoString

func (s UntagResourceInput) GoString() string

GoString returns the string representation

func (*UntagResourceInput) SetResourceName

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

SetResourceName sets the ResourceName field's value.

func (*UntagResourceInput) SetTagKeys

func (s *UntagResourceInput) SetTagKeys(v []*string) *UntagResourceInput

SetTagKeys sets the TagKeys field's value.

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) GoString

func (s UntagResourceOutput) GoString() string

GoString returns the string representation

func (*UntagResourceOutput) SetTags

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

SetTags sets the Tags field's value.

func (UntagResourceOutput) String

func (s UntagResourceOutput) String() string

String returns the string representation

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) GoString

func (s UpdateClusterInput) GoString() string

GoString returns the string representation

func (*UpdateClusterInput) SetClusterName

func (s *UpdateClusterInput) SetClusterName(v string) *UpdateClusterInput

SetClusterName sets the ClusterName field's value.

func (*UpdateClusterInput) SetDescription

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

SetDescription sets the Description field's value.

func (*UpdateClusterInput) SetNotificationTopicArn

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

SetNotificationTopicArn sets the NotificationTopicArn field's value.

func (*UpdateClusterInput) SetNotificationTopicStatus

func (s *UpdateClusterInput) SetNotificationTopicStatus(v string) *UpdateClusterInput

SetNotificationTopicStatus sets the NotificationTopicStatus field's value.

func (*UpdateClusterInput) SetParameterGroupName

func (s *UpdateClusterInput) SetParameterGroupName(v string) *UpdateClusterInput

SetParameterGroupName sets the ParameterGroupName field's value.

func (*UpdateClusterInput) SetPreferredMaintenanceWindow

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

SetPreferredMaintenanceWindow sets the PreferredMaintenanceWindow field's value.

func (*UpdateClusterInput) SetSecurityGroupIds

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

SetSecurityGroupIds sets the SecurityGroupIds field's value.

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) GoString

func (s UpdateClusterOutput) GoString() string

GoString returns the string representation

func (*UpdateClusterOutput) SetCluster

func (s *UpdateClusterOutput) SetCluster(v *Cluster) *UpdateClusterOutput

SetCluster sets the Cluster field's value.

func (UpdateClusterOutput) String

func (s UpdateClusterOutput) String() string

String returns the string representation

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) GoString

func (s UpdateParameterGroupInput) GoString() string

GoString returns the string representation

func (*UpdateParameterGroupInput) SetParameterGroupName

func (s *UpdateParameterGroupInput) SetParameterGroupName(v string) *UpdateParameterGroupInput

SetParameterGroupName sets the ParameterGroupName field's value.

func (*UpdateParameterGroupInput) SetParameterNameValues

SetParameterNameValues sets the ParameterNameValues field's value.

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) GoString

func (s UpdateParameterGroupOutput) GoString() string

GoString returns the string representation

func (*UpdateParameterGroupOutput) SetParameterGroup

SetParameterGroup sets the ParameterGroup field's value.

func (UpdateParameterGroupOutput) String

String returns the string representation

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) GoString

func (s UpdateSubnetGroupInput) GoString() string

GoString returns the string representation

func (*UpdateSubnetGroupInput) SetDescription

SetDescription sets the Description field's value.

func (*UpdateSubnetGroupInput) SetSubnetGroupName

func (s *UpdateSubnetGroupInput) SetSubnetGroupName(v string) *UpdateSubnetGroupInput

SetSubnetGroupName sets the SubnetGroupName field's value.

func (*UpdateSubnetGroupInput) SetSubnetIds

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

SetSubnetIds sets the SubnetIds field's value.

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) GoString

func (s UpdateSubnetGroupOutput) GoString() string

GoString returns the string representation

func (*UpdateSubnetGroupOutput) SetSubnetGroup

SetSubnetGroup sets the SubnetGroup field's value.

func (UpdateSubnetGroupOutput) String

func (s UpdateSubnetGroupOutput) String() string

String returns the string representation

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