types

package
v0.26.0 Latest Latest
Warning

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

Go to latest
Published: Oct 1, 2020 License: Apache-2.0 Imports: 3 Imported by: 9

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type ChangeType

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

Enum values for ChangeType

type Cluster

type Cluster struct {

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

	// The parameter group being used by nodes in the cluster.
	ParameterGroup *ParameterGroupStatus

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

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

	// The description of the cluster.
	Description *string

	// The number of nodes in the cluster that are active (i.e., capable of serving
	// requests).
	ActiveNodes *int32

	// A list of nodes that are currently in the cluster.
	Nodes []*Node

	// The subnet group where the DAX cluster is running.
	SubnetGroup *string

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

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

	// A list of nodes to be removed from the cluster.
	NodeIdsToRemove []*string

	// The current status of the cluster.
	Status *string

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

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

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

	// The total number of nodes in the cluster.
	TotalNodes *int32

	// The name of the DAX cluster.
	ClusterName *string
}

Contains all of the attributes of a specific DAX cluster.

type ClusterAlreadyExistsFault

type ClusterAlreadyExistsFault struct {
	Message *string
}

You already have a DAX cluster with the given identifier.

func (*ClusterAlreadyExistsFault) Error

func (e *ClusterAlreadyExistsFault) Error() string

func (*ClusterAlreadyExistsFault) ErrorCode

func (e *ClusterAlreadyExistsFault) ErrorCode() string

func (*ClusterAlreadyExistsFault) ErrorFault

func (*ClusterAlreadyExistsFault) ErrorMessage

func (e *ClusterAlreadyExistsFault) ErrorMessage() string

type ClusterNotFoundFault

type ClusterNotFoundFault struct {
	Message *string
}

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

func (*ClusterNotFoundFault) Error

func (e *ClusterNotFoundFault) Error() string

func (*ClusterNotFoundFault) ErrorCode

func (e *ClusterNotFoundFault) ErrorCode() string

func (*ClusterNotFoundFault) ErrorFault

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

func (*ClusterNotFoundFault) ErrorMessage

func (e *ClusterNotFoundFault) ErrorMessage() string

type ClusterQuotaForCustomerExceededFault

type ClusterQuotaForCustomerExceededFault struct {
	Message *string
}

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

func (*ClusterQuotaForCustomerExceededFault) Error

func (*ClusterQuotaForCustomerExceededFault) ErrorCode

func (*ClusterQuotaForCustomerExceededFault) ErrorFault

func (*ClusterQuotaForCustomerExceededFault) ErrorMessage

func (e *ClusterQuotaForCustomerExceededFault) ErrorMessage() string

type Endpoint

type Endpoint struct {

	// The port number that applications should use to connect to the endpoint.
	Port *int32

	// The DNS hostname of the endpoint.
	Address *string
}

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.

type Event

type Event struct {

	// A user-defined message associated with the event.
	Message *string

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

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

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

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.

type InsufficientClusterCapacityFault

type InsufficientClusterCapacityFault struct {
	Message *string
}

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

func (*InsufficientClusterCapacityFault) Error

func (*InsufficientClusterCapacityFault) ErrorCode

func (*InsufficientClusterCapacityFault) ErrorFault

func (*InsufficientClusterCapacityFault) ErrorMessage

func (e *InsufficientClusterCapacityFault) ErrorMessage() string

type InvalidARNFault

type InvalidARNFault struct {
	Message *string
}

The Amazon Resource Name (ARN) supplied in the request is not valid.

func (*InvalidARNFault) Error

func (e *InvalidARNFault) Error() string

func (*InvalidARNFault) ErrorCode

func (e *InvalidARNFault) ErrorCode() string

func (*InvalidARNFault) ErrorFault

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

func (*InvalidARNFault) ErrorMessage

func (e *InvalidARNFault) ErrorMessage() string

type InvalidClusterStateFault

type InvalidClusterStateFault struct {
	Message *string
}

The requested DAX cluster is not in the available state.

func (*InvalidClusterStateFault) Error

func (e *InvalidClusterStateFault) Error() string

func (*InvalidClusterStateFault) ErrorCode

func (e *InvalidClusterStateFault) ErrorCode() string

func (*InvalidClusterStateFault) ErrorFault

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

func (*InvalidClusterStateFault) ErrorMessage

func (e *InvalidClusterStateFault) ErrorMessage() string

type InvalidParameterCombinationException

type InvalidParameterCombinationException struct {
	Message *string
}

Two or more incompatible parameters were specified.

func (*InvalidParameterCombinationException) Error

func (*InvalidParameterCombinationException) ErrorCode

func (*InvalidParameterCombinationException) ErrorFault

func (*InvalidParameterCombinationException) ErrorMessage

func (e *InvalidParameterCombinationException) ErrorMessage() string

type InvalidParameterGroupStateFault

type InvalidParameterGroupStateFault struct {
	Message *string
}

One or more parameters in a parameter group are in an invalid state.

func (*InvalidParameterGroupStateFault) Error

func (*InvalidParameterGroupStateFault) ErrorCode

func (e *InvalidParameterGroupStateFault) ErrorCode() string

func (*InvalidParameterGroupStateFault) ErrorFault

func (*InvalidParameterGroupStateFault) ErrorMessage

func (e *InvalidParameterGroupStateFault) ErrorMessage() string

type InvalidParameterValueException

type InvalidParameterValueException struct {
	Message *string
}

The value for a parameter is invalid.

func (*InvalidParameterValueException) Error

func (*InvalidParameterValueException) ErrorCode

func (e *InvalidParameterValueException) ErrorCode() string

func (*InvalidParameterValueException) ErrorFault

func (*InvalidParameterValueException) ErrorMessage

func (e *InvalidParameterValueException) ErrorMessage() string

type InvalidSubnet

type InvalidSubnet struct {
	Message *string
}

An invalid subnet identifier was specified.

func (*InvalidSubnet) Error

func (e *InvalidSubnet) Error() string

func (*InvalidSubnet) ErrorCode

func (e *InvalidSubnet) ErrorCode() string

func (*InvalidSubnet) ErrorFault

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

func (*InvalidSubnet) ErrorMessage

func (e *InvalidSubnet) ErrorMessage() string

type InvalidVPCNetworkStateFault

type InvalidVPCNetworkStateFault struct {
	Message *string
}

The VPC network is in an invalid state.

func (*InvalidVPCNetworkStateFault) Error

func (*InvalidVPCNetworkStateFault) ErrorCode

func (e *InvalidVPCNetworkStateFault) ErrorCode() string

func (*InvalidVPCNetworkStateFault) ErrorFault

func (*InvalidVPCNetworkStateFault) ErrorMessage

func (e *InvalidVPCNetworkStateFault) ErrorMessage() string

type IsModifiable

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

Enum values for IsModifiable

type Node

type Node struct {

	// A system-generated identifier for the node.
	NodeId *string

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

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

	// The current status of the node. For example: available.
	NodeStatus *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

	// The status of the parameter group associated with this node. For example,
	// in-sync.
	ParameterGroupStatus *string
}

Represents an individual node within a DAX cluster.

type NodeNotFoundFault

type NodeNotFoundFault struct {
	Message *string
}

None of the nodes in the cluster have the given node ID.

func (*NodeNotFoundFault) Error

func (e *NodeNotFoundFault) Error() string

func (*NodeNotFoundFault) ErrorCode

func (e *NodeNotFoundFault) ErrorCode() string

func (*NodeNotFoundFault) ErrorFault

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

func (*NodeNotFoundFault) ErrorMessage

func (e *NodeNotFoundFault) ErrorMessage() string

type NodeQuotaForClusterExceededFault

type NodeQuotaForClusterExceededFault struct {
	Message *string
}

You have attempted to exceed the maximum number of nodes for a DAX cluster.

func (*NodeQuotaForClusterExceededFault) Error

func (*NodeQuotaForClusterExceededFault) ErrorCode

func (*NodeQuotaForClusterExceededFault) ErrorFault

func (*NodeQuotaForClusterExceededFault) ErrorMessage

func (e *NodeQuotaForClusterExceededFault) ErrorMessage() string

type NodeQuotaForCustomerExceededFault

type NodeQuotaForCustomerExceededFault struct {
	Message *string
}

You have attempted to exceed the maximum number of nodes for your AWS account.

func (*NodeQuotaForCustomerExceededFault) Error

func (*NodeQuotaForCustomerExceededFault) ErrorCode

func (*NodeQuotaForCustomerExceededFault) ErrorFault

func (*NodeQuotaForCustomerExceededFault) ErrorMessage

func (e *NodeQuotaForCustomerExceededFault) ErrorMessage() string

type NodeTypeSpecificValue

type NodeTypeSpecificValue struct {

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

	// The parameter value for this node type.
	Value *string
}

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

type NotificationConfiguration

type NotificationConfiguration struct {

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

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

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

type Parameter

type Parameter struct {

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

	// How the parameter is defined. For example, system denotes a system-defined
	// parameter.
	Source *string

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

	// A description of the parameter
	Description *string

	// A list of node types, and specific parameter values for each node.
	NodeTypeSpecificValues []*NodeTypeSpecificValue

	// Determines whether the parameter can be applied to any nodes, or only nodes of a
	// particular type.
	ParameterType ParameterType

	// Whether the customer is allowed to modify the parameter.
	IsModifiable IsModifiable

	// The value for the parameter.
	ParameterValue *string

	// The name of the parameter.
	ParameterName *string

	// A range of values within which the parameter can be set.
	AllowedValues *string
}

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

type ParameterGroup

type ParameterGroup struct {

	// The name of the parameter group.
	ParameterGroupName *string

	// A description of the parameter group.
	Description *string
}

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

type ParameterGroupAlreadyExistsFault

type ParameterGroupAlreadyExistsFault struct {
	Message *string
}

The specified parameter group already exists.

func (*ParameterGroupAlreadyExistsFault) Error

func (*ParameterGroupAlreadyExistsFault) ErrorCode

func (*ParameterGroupAlreadyExistsFault) ErrorFault

func (*ParameterGroupAlreadyExistsFault) ErrorMessage

func (e *ParameterGroupAlreadyExistsFault) ErrorMessage() string

type ParameterGroupNotFoundFault

type ParameterGroupNotFoundFault struct {
	Message *string
}

The specified parameter group does not exist.

func (*ParameterGroupNotFoundFault) Error

func (*ParameterGroupNotFoundFault) ErrorCode

func (e *ParameterGroupNotFoundFault) ErrorCode() string

func (*ParameterGroupNotFoundFault) ErrorFault

func (*ParameterGroupNotFoundFault) ErrorMessage

func (e *ParameterGroupNotFoundFault) ErrorMessage() string

type ParameterGroupQuotaExceededFault

type ParameterGroupQuotaExceededFault struct {
	Message *string
}

You have attempted to exceed the maximum number of parameter groups.

func (*ParameterGroupQuotaExceededFault) Error

func (*ParameterGroupQuotaExceededFault) ErrorCode

func (*ParameterGroupQuotaExceededFault) ErrorFault

func (*ParameterGroupQuotaExceededFault) ErrorMessage

func (e *ParameterGroupQuotaExceededFault) ErrorMessage() string

type ParameterGroupStatus

type ParameterGroupStatus struct {

	// The name of the parameter group.
	ParameterGroupName *string

	// The node IDs of one or more nodes to be rebooted.
	NodeIdsToReboot []*string

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

The status of a parameter group.

type ParameterNameValue

type ParameterNameValue struct {

	// The value of the parameter.
	ParameterValue *string

	// The name of the parameter.
	ParameterName *string
}

An individual DAX parameter.

type ParameterType

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

Enum values for ParameterType

type SSEDescription

type SSEDescription struct {

	// The current state of server-side encryption:
	//
	//     * ENABLING - Server-side
	// encryption is being enabled.
	//
	//     * ENABLED - Server-side encryption is
	// enabled.
	//
	//     * DISABLING - Server-side encryption is being disabled.
	//
	//     *
	// DISABLED - Server-side encryption is disabled.
	Status SSEStatus
}

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

type SSESpecification

type SSESpecification struct {

	// Indicates whether server-side encryption is enabled (true) or disabled (false)
	// on the cluster.
	//
	// This member is required.
	Enabled *bool
}

Represents the settings used to enable server-side encryption.

type SSEStatus

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

Enum values for SSEStatus

type SecurityGroupMembership

type SecurityGroupMembership struct {

	// The status of this security group.
	Status *string

	// The unique ID for this security group.
	SecurityGroupIdentifier *string
}

An individual VPC security group and its status.

type ServiceLinkedRoleNotFoundFault

type ServiceLinkedRoleNotFoundFault struct {
	Message *string
}

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

func (*ServiceLinkedRoleNotFoundFault) Error

func (*ServiceLinkedRoleNotFoundFault) ErrorCode

func (e *ServiceLinkedRoleNotFoundFault) ErrorCode() string

func (*ServiceLinkedRoleNotFoundFault) ErrorFault

func (*ServiceLinkedRoleNotFoundFault) ErrorMessage

func (e *ServiceLinkedRoleNotFoundFault) ErrorMessage() string

type SourceType

type SourceType string
const (
	SourceTypeCluster         SourceType = "CLUSTER"
	SourceTypeParameter_group SourceType = "PARAMETER_GROUP"
	SourceTypeSubnet_group    SourceType = "SUBNET_GROUP"
)

Enum values for SourceType

type Subnet

type Subnet struct {

	// The system-assigned identifier for the subnet.
	SubnetIdentifier *string

	// The Availability Zone (AZ) for the subnet.
	SubnetAvailabilityZone *string
}

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.

type SubnetGroup

type SubnetGroup struct {

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

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

	// The description of the subnet group.
	Description *string

	// The name of the subnet group.
	SubnetGroupName *string
}

Represents the output of one of the following actions:

*

CreateSubnetGroup

  • ModifySubnetGroup

type SubnetGroupAlreadyExistsFault

type SubnetGroupAlreadyExistsFault struct {
	Message *string
}

The specified subnet group already exists.

func (*SubnetGroupAlreadyExistsFault) Error

func (*SubnetGroupAlreadyExistsFault) ErrorCode

func (e *SubnetGroupAlreadyExistsFault) ErrorCode() string

func (*SubnetGroupAlreadyExistsFault) ErrorFault

func (*SubnetGroupAlreadyExistsFault) ErrorMessage

func (e *SubnetGroupAlreadyExistsFault) ErrorMessage() string

type SubnetGroupInUseFault

type SubnetGroupInUseFault struct {
	Message *string
}

The specified subnet group is currently in use.

func (*SubnetGroupInUseFault) Error

func (e *SubnetGroupInUseFault) Error() string

func (*SubnetGroupInUseFault) ErrorCode

func (e *SubnetGroupInUseFault) ErrorCode() string

func (*SubnetGroupInUseFault) ErrorFault

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

func (*SubnetGroupInUseFault) ErrorMessage

func (e *SubnetGroupInUseFault) ErrorMessage() string

type SubnetGroupNotFoundFault

type SubnetGroupNotFoundFault struct {
	Message *string
}

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

func (*SubnetGroupNotFoundFault) Error

func (e *SubnetGroupNotFoundFault) Error() string

func (*SubnetGroupNotFoundFault) ErrorCode

func (e *SubnetGroupNotFoundFault) ErrorCode() string

func (*SubnetGroupNotFoundFault) ErrorFault

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

func (*SubnetGroupNotFoundFault) ErrorMessage

func (e *SubnetGroupNotFoundFault) ErrorMessage() string

type SubnetGroupQuotaExceededFault

type SubnetGroupQuotaExceededFault struct {
	Message *string
}

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

func (*SubnetGroupQuotaExceededFault) Error

func (*SubnetGroupQuotaExceededFault) ErrorCode

func (e *SubnetGroupQuotaExceededFault) ErrorCode() string

func (*SubnetGroupQuotaExceededFault) ErrorFault

func (*SubnetGroupQuotaExceededFault) ErrorMessage

func (e *SubnetGroupQuotaExceededFault) ErrorMessage() string

type SubnetInUse

type SubnetInUse struct {
	Message *string
}

The requested subnet is being used by another subnet group.

func (*SubnetInUse) Error

func (e *SubnetInUse) Error() string

func (*SubnetInUse) ErrorCode

func (e *SubnetInUse) ErrorCode() string

func (*SubnetInUse) ErrorFault

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

func (*SubnetInUse) ErrorMessage

func (e *SubnetInUse) ErrorMessage() string

type SubnetQuotaExceededFault

type SubnetQuotaExceededFault struct {
	Message *string
}

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

func (*SubnetQuotaExceededFault) Error

func (e *SubnetQuotaExceededFault) Error() string

func (*SubnetQuotaExceededFault) ErrorCode

func (e *SubnetQuotaExceededFault) ErrorCode() string

func (*SubnetQuotaExceededFault) ErrorFault

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

func (*SubnetQuotaExceededFault) ErrorMessage

func (e *SubnetQuotaExceededFault) ErrorMessage() string

type Tag

type Tag struct {

	// The key for the tag. 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

	// The value of the tag. Tag values are case-sensitive and can be null.
	Value *string
}

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.

type TagNotFoundFault

type TagNotFoundFault struct {
	Message *string
}

The tag does not exist.

func (*TagNotFoundFault) Error

func (e *TagNotFoundFault) Error() string

func (*TagNotFoundFault) ErrorCode

func (e *TagNotFoundFault) ErrorCode() string

func (*TagNotFoundFault) ErrorFault

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

func (*TagNotFoundFault) ErrorMessage

func (e *TagNotFoundFault) ErrorMessage() string

type TagQuotaPerResourceExceeded

type TagQuotaPerResourceExceeded struct {
	Message *string
}

You have exceeded the maximum number of tags for this DAX cluster.

func (*TagQuotaPerResourceExceeded) Error

func (*TagQuotaPerResourceExceeded) ErrorCode

func (e *TagQuotaPerResourceExceeded) ErrorCode() string

func (*TagQuotaPerResourceExceeded) ErrorFault

func (*TagQuotaPerResourceExceeded) ErrorMessage

func (e *TagQuotaPerResourceExceeded) ErrorMessage() string

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL