SDK for PHP 3.x

Amazon DynamoDB Accelerator (DAX) 2017-04-19

Client: Aws\DAX\DAXClient
Service ID: dax
Version: 2017-04-19

This page describes the parameters and results for the operations of the Amazon DynamoDB Accelerator (DAX) (2017-04-19), and shows how to use the Aws\DAX\DAXClient object to call the described operations. This documentation is specific to the 2017-04-19 API version of the service.

Operation Summary

Each of the following operations can be created from a client using $client->getCommand('CommandName'), where "CommandName" is the name of one of the following operations. Note: a command is a value that encapsulates an operation and the parameters used to create an HTTP request.

You can also create and send a command immediately using the magic methods available on a client object: $client->commandName(/* parameters */). You can send the command asynchronously (returning a promise) by appending the word "Async" to the operation name: $client->commandNameAsync(/* parameters */).

CreateCluster ( array $params = [] )
Creates a DAX cluster.
CreateParameterGroup ( array $params = [] )
Creates a new parameter group.
CreateSubnetGroup ( array $params = [] )
Creates a new subnet group.
DecreaseReplicationFactor ( array $params = [] )
Removes one or more nodes from a DAX cluster.
DeleteCluster ( array $params = [] )
Deletes a previously provisioned DAX cluster.
DeleteParameterGroup ( array $params = [] )
Deletes the specified parameter group.
DeleteSubnetGroup ( array $params = [] )
Deletes a subnet group.
DescribeClusters ( array $params = [] )
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.
DescribeDefaultParameters ( array $params = [] )
Returns the default system parameter information for the DAX caching software.
DescribeEvents ( array $params = [] )
Returns events related to DAX clusters and parameter groups.
DescribeParameterGroups ( array $params = [] )
Returns a list of parameter group descriptions.
DescribeParameters ( array $params = [] )
Returns the detailed parameter list for a particular parameter group.
DescribeSubnetGroups ( array $params = [] )
Returns a list of subnet group descriptions.
IncreaseReplicationFactor ( array $params = [] )
Adds one or more nodes to a DAX cluster.
ListTags ( array $params = [] )
List all of the tags for a DAX cluster.
RebootNode ( array $params = [] )
Reboots a single node of a DAX cluster.
TagResource ( array $params = [] )
Associates a set of tags with a DAX resource.
UntagResource ( array $params = [] )
Removes the association of tags from a DAX resource.
UpdateCluster ( array $params = [] )
Modifies the settings for a DAX cluster.
UpdateParameterGroup ( array $params = [] )
Modifies the parameters of a parameter group.
UpdateSubnetGroup ( array $params = [] )
Modifies an existing subnet group.

Operations

CreateCluster 

$result = $client->createCluster([/* ... */]);
$promise = $client->createClusterAsync([/* ... */]);

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

Parameter Syntax

$result = $client->createCluster([
    'AvailabilityZones' => ['<string>', ...],
    'ClusterEndpointEncryptionType' => 'NONE|TLS',
    'ClusterName' => '<string>', // REQUIRED
    'Description' => '<string>',
    'IamRoleArn' => '<string>', // REQUIRED
    'NodeType' => '<string>', // REQUIRED
    'NotificationTopicArn' => '<string>',
    'ParameterGroupName' => '<string>',
    'PreferredMaintenanceWindow' => '<string>',
    'ReplicationFactor' => <integer>, // REQUIRED
    'SSESpecification' => [
        'Enabled' => true || false, // REQUIRED
    ],
    'SecurityGroupIds' => ['<string>', ...],
    'SubnetGroupName' => '<string>',
    'Tags' => [
        [
            'Key' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
]);

Parameter Details

Members
AvailabilityZones
Type: Array of strings

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

ClusterEndpointEncryptionType
Type: string

The type of encryption the cluster's endpoint should support. Values are:

  • NONE for no encryption

  • TLS for Transport Layer Security

ClusterName
Required: Yes
Type: string

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.

Description
Type: string

A description of the cluster.

IamRoleArn
Required: Yes
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.

NodeType
Required: Yes
Type: string

The compute and memory capacity of the nodes in the cluster.

NotificationTopicArn
Type: string

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.

ParameterGroupName
Type: string

The parameter group to be associated with the DAX cluster.

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

ReplicationFactor
Required: Yes
Type: int

The number of nodes in the DAX cluster. A replication factor of 1 will create a single-node cluster, without any read replicas. For additional fault tolerance, you can create a multiple node cluster with one or more read replicas. To do this, set ReplicationFactor to a number between 3 (one primary and two read replicas) and 10 (one primary and nine read replicas). If the AvailabilityZones parameter is provided, its length must equal the ReplicationFactor.

AWS recommends that you have at least two read replicas per cluster.

SSESpecification
Type: SSESpecification structure

Represents the settings used to enable server-side encryption on the cluster.

SecurityGroupIds
Type: Array of strings

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.

SubnetGroupName
Type: string

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.

Tags
Type: Array of Tag structures

A set of tags to associate with the DAX cluster.

Result Syntax

[
    'Cluster' => [
        'ActiveNodes' => <integer>,
        'ClusterArn' => '<string>',
        'ClusterDiscoveryEndpoint' => [
            'Address' => '<string>',
            'Port' => <integer>,
            'URL' => '<string>',
        ],
        'ClusterEndpointEncryptionType' => 'NONE|TLS',
        'ClusterName' => '<string>',
        'Description' => '<string>',
        'IamRoleArn' => '<string>',
        'NodeIdsToRemove' => ['<string>', ...],
        'NodeType' => '<string>',
        'Nodes' => [
            [
                'AvailabilityZone' => '<string>',
                'Endpoint' => [
                    'Address' => '<string>',
                    'Port' => <integer>,
                    'URL' => '<string>',
                ],
                'NodeCreateTime' => <DateTime>,
                'NodeId' => '<string>',
                'NodeStatus' => '<string>',
                'ParameterGroupStatus' => '<string>',
            ],
            // ...
        ],
        'NotificationConfiguration' => [
            'TopicArn' => '<string>',
            'TopicStatus' => '<string>',
        ],
        'ParameterGroup' => [
            'NodeIdsToReboot' => ['<string>', ...],
            'ParameterApplyStatus' => '<string>',
            'ParameterGroupName' => '<string>',
        ],
        'PreferredMaintenanceWindow' => '<string>',
        'SSEDescription' => [
            'Status' => 'ENABLING|ENABLED|DISABLING|DISABLED',
        ],
        'SecurityGroups' => [
            [
                'SecurityGroupIdentifier' => '<string>',
                'Status' => '<string>',
            ],
            // ...
        ],
        'Status' => '<string>',
        'SubnetGroup' => '<string>',
        'TotalNodes' => <integer>,
    ],
]

Result Details

Members
Cluster
Type: Cluster structure

A description of the DAX cluster that you have created.

Errors

ClusterAlreadyExistsFault:

You already have a DAX cluster with the given identifier.

InvalidClusterStateFault:

The requested DAX cluster is not in the available state.

InsufficientClusterCapacityFault:

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

SubnetGroupNotFoundFault:

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

InvalidParameterGroupStateFault:

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

ParameterGroupNotFoundFault:

The specified parameter group does not exist.

ClusterQuotaForCustomerExceededFault:

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

NodeQuotaForClusterExceededFault:

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

NodeQuotaForCustomerExceededFault:

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

InvalidVPCNetworkStateFault:

The VPC network is in an invalid state.

TagQuotaPerResourceExceeded:

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

ServiceLinkedRoleNotFoundFault:

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

InvalidParameterValueException:

The value for a parameter is invalid.

InvalidParameterCombinationException:

Two or more incompatible parameters were specified.

ServiceQuotaExceededException:

You have reached the maximum number of x509 certificates that can be created for encrypted clusters in a 30 day period. Contact AWS customer support to discuss options for continuing to create encrypted clusters.

CreateParameterGroup 

$result = $client->createParameterGroup([/* ... */]);
$promise = $client->createParameterGroupAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->createParameterGroup([
    'Description' => '<string>',
    'ParameterGroupName' => '<string>', // REQUIRED
]);

Parameter Details

Members
Description
Type: string

A description of the parameter group.

ParameterGroupName
Required: Yes
Type: string

The name of the parameter group to apply to all of the clusters in this replication group.

Result Syntax

[
    'ParameterGroup' => [
        'Description' => '<string>',
        'ParameterGroupName' => '<string>',
    ],
]

Result Details

Members
ParameterGroup
Type: ParameterGroup structure

Represents the output of a CreateParameterGroup action.

Errors

ParameterGroupQuotaExceededFault:

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

ParameterGroupAlreadyExistsFault:

The specified parameter group already exists.

InvalidParameterGroupStateFault:

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

ServiceLinkedRoleNotFoundFault:

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

InvalidParameterValueException:

The value for a parameter is invalid.

InvalidParameterCombinationException:

Two or more incompatible parameters were specified.

CreateSubnetGroup 

$result = $client->createSubnetGroup([/* ... */]);
$promise = $client->createSubnetGroupAsync([/* ... */]);

Creates a new subnet group.

Parameter Syntax

$result = $client->createSubnetGroup([
    'Description' => '<string>',
    'SubnetGroupName' => '<string>', // REQUIRED
    'SubnetIds' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Members
Description
Type: string

A description for the subnet group

SubnetGroupName
Required: Yes
Type: string

A name for the subnet group. This value is stored as a lowercase string.

SubnetIds
Required: Yes
Type: Array of strings

A list of VPC subnet IDs for the subnet group.

Result Syntax

[
    'SubnetGroup' => [
        'Description' => '<string>',
        'SubnetGroupName' => '<string>',
        'Subnets' => [
            [
                'SubnetAvailabilityZone' => '<string>',
                'SubnetIdentifier' => '<string>',
            ],
            // ...
        ],
        'VpcId' => '<string>',
    ],
]

Result Details

Members
SubnetGroup
Type: SubnetGroup structure

Represents the output of a CreateSubnetGroup operation.

Errors

SubnetGroupAlreadyExistsFault:

The specified subnet group already exists.

SubnetGroupQuotaExceededFault:

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

SubnetQuotaExceededFault:

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

InvalidSubnet:

An invalid subnet identifier was specified.

ServiceLinkedRoleNotFoundFault:

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

DecreaseReplicationFactor 

$result = $client->decreaseReplicationFactor([/* ... */]);
$promise = $client->decreaseReplicationFactorAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->decreaseReplicationFactor([
    'AvailabilityZones' => ['<string>', ...],
    'ClusterName' => '<string>', // REQUIRED
    'NewReplicationFactor' => <integer>, // REQUIRED
    'NodeIdsToRemove' => ['<string>', ...],
]);

Parameter Details

Members
AvailabilityZones
Type: Array of strings

The Availability Zone(s) from which to remove nodes.

ClusterName
Required: Yes
Type: string

The name of the DAX cluster from which you want to remove nodes.

NewReplicationFactor
Required: Yes
Type: int

The new number of nodes for the DAX cluster.

NodeIdsToRemove
Type: Array of strings

The unique identifiers of the nodes to be removed from the cluster.

Result Syntax

[
    'Cluster' => [
        'ActiveNodes' => <integer>,
        'ClusterArn' => '<string>',
        'ClusterDiscoveryEndpoint' => [
            'Address' => '<string>',
            'Port' => <integer>,
            'URL' => '<string>',
        ],
        'ClusterEndpointEncryptionType' => 'NONE|TLS',
        'ClusterName' => '<string>',
        'Description' => '<string>',
        'IamRoleArn' => '<string>',
        'NodeIdsToRemove' => ['<string>', ...],
        'NodeType' => '<string>',
        'Nodes' => [
            [
                'AvailabilityZone' => '<string>',
                'Endpoint' => [
                    'Address' => '<string>',
                    'Port' => <integer>,
                    'URL' => '<string>',
                ],
                'NodeCreateTime' => <DateTime>,
                'NodeId' => '<string>',
                'NodeStatus' => '<string>',
                'ParameterGroupStatus' => '<string>',
            ],
            // ...
        ],
        'NotificationConfiguration' => [
            'TopicArn' => '<string>',
            'TopicStatus' => '<string>',
        ],
        'ParameterGroup' => [
            'NodeIdsToReboot' => ['<string>', ...],
            'ParameterApplyStatus' => '<string>',
            'ParameterGroupName' => '<string>',
        ],
        'PreferredMaintenanceWindow' => '<string>',
        'SSEDescription' => [
            'Status' => 'ENABLING|ENABLED|DISABLING|DISABLED',
        ],
        'SecurityGroups' => [
            [
                'SecurityGroupIdentifier' => '<string>',
                'Status' => '<string>',
            ],
            // ...
        ],
        'Status' => '<string>',
        'SubnetGroup' => '<string>',
        'TotalNodes' => <integer>,
    ],
]

Result Details

Members
Cluster
Type: Cluster structure

A description of the DAX cluster, after you have decreased its replication factor.

Errors

ClusterNotFoundFault:

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

NodeNotFoundFault:

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

InvalidClusterStateFault:

The requested DAX cluster is not in the available state.

ServiceLinkedRoleNotFoundFault:

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

InvalidParameterValueException:

The value for a parameter is invalid.

InvalidParameterCombinationException:

Two or more incompatible parameters were specified.

DeleteCluster 

$result = $client->deleteCluster([/* ... */]);
$promise = $client->deleteClusterAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->deleteCluster([
    'ClusterName' => '<string>', // REQUIRED
]);

Parameter Details

Members
ClusterName
Required: Yes
Type: string

The name of the cluster to be deleted.

Result Syntax

[
    'Cluster' => [
        'ActiveNodes' => <integer>,
        'ClusterArn' => '<string>',
        'ClusterDiscoveryEndpoint' => [
            'Address' => '<string>',
            'Port' => <integer>,
            'URL' => '<string>',
        ],
        'ClusterEndpointEncryptionType' => 'NONE|TLS',
        'ClusterName' => '<string>',
        'Description' => '<string>',
        'IamRoleArn' => '<string>',
        'NodeIdsToRemove' => ['<string>', ...],
        'NodeType' => '<string>',
        'Nodes' => [
            [
                'AvailabilityZone' => '<string>',
                'Endpoint' => [
                    'Address' => '<string>',
                    'Port' => <integer>,
                    'URL' => '<string>',
                ],
                'NodeCreateTime' => <DateTime>,
                'NodeId' => '<string>',
                'NodeStatus' => '<string>',
                'ParameterGroupStatus' => '<string>',
            ],
            // ...
        ],
        'NotificationConfiguration' => [
            'TopicArn' => '<string>',
            'TopicStatus' => '<string>',
        ],
        'ParameterGroup' => [
            'NodeIdsToReboot' => ['<string>', ...],
            'ParameterApplyStatus' => '<string>',
            'ParameterGroupName' => '<string>',
        ],
        'PreferredMaintenanceWindow' => '<string>',
        'SSEDescription' => [
            'Status' => 'ENABLING|ENABLED|DISABLING|DISABLED',
        ],
        'SecurityGroups' => [
            [
                'SecurityGroupIdentifier' => '<string>',
                'Status' => '<string>',
            ],
            // ...
        ],
        'Status' => '<string>',
        'SubnetGroup' => '<string>',
        'TotalNodes' => <integer>,
    ],
]

Result Details

Members
Cluster
Type: Cluster structure

A description of the DAX cluster that is being deleted.

Errors

ClusterNotFoundFault:

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

InvalidClusterStateFault:

The requested DAX cluster is not in the available state.

ServiceLinkedRoleNotFoundFault:

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

InvalidParameterValueException:

The value for a parameter is invalid.

InvalidParameterCombinationException:

Two or more incompatible parameters were specified.

DeleteParameterGroup 

$result = $client->deleteParameterGroup([/* ... */]);
$promise = $client->deleteParameterGroupAsync([/* ... */]);

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

Parameter Syntax

$result = $client->deleteParameterGroup([
    'ParameterGroupName' => '<string>', // REQUIRED
]);

Parameter Details

Members
ParameterGroupName
Required: Yes
Type: string

The name of the parameter group to delete.

Result Syntax

[
    'DeletionMessage' => '<string>',
]

Result Details

Members
DeletionMessage
Type: string

A user-specified message for this action (i.e., a reason for deleting the parameter group).

Errors

InvalidParameterGroupStateFault:

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

ParameterGroupNotFoundFault:

The specified parameter group does not exist.

ServiceLinkedRoleNotFoundFault:

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

InvalidParameterValueException:

The value for a parameter is invalid.

InvalidParameterCombinationException:

Two or more incompatible parameters were specified.

DeleteSubnetGroup 

$result = $client->deleteSubnetGroup([/* ... */]);
$promise = $client->deleteSubnetGroupAsync([/* ... */]);

Deletes a subnet group.

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

Parameter Syntax

$result = $client->deleteSubnetGroup([
    'SubnetGroupName' => '<string>', // REQUIRED
]);

Parameter Details

Members
SubnetGroupName
Required: Yes
Type: string

The name of the subnet group to delete.

Result Syntax

[
    'DeletionMessage' => '<string>',
]

Result Details

Members
DeletionMessage
Type: string

A user-specified message for this action (i.e., a reason for deleting the subnet group).

Errors

SubnetGroupInUseFault:

The specified subnet group is currently in use.

SubnetGroupNotFoundFault:

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

ServiceLinkedRoleNotFoundFault:

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

DescribeClusters 

$result = $client->describeClusters([/* ... */]);
$promise = $client->describeClustersAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->describeClusters([
    'ClusterNames' => ['<string>', ...],
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members
ClusterNames
Type: Array of strings

The names of the DAX clusters being described.

MaxResults
Type: int

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.

NextToken
Type: string

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.

Result Syntax

[
    'Clusters' => [
        [
            'ActiveNodes' => <integer>,
            'ClusterArn' => '<string>',
            'ClusterDiscoveryEndpoint' => [
                'Address' => '<string>',
                'Port' => <integer>,
                'URL' => '<string>',
            ],
            'ClusterEndpointEncryptionType' => 'NONE|TLS',
            'ClusterName' => '<string>',
            'Description' => '<string>',
            'IamRoleArn' => '<string>',
            'NodeIdsToRemove' => ['<string>', ...],
            'NodeType' => '<string>',
            'Nodes' => [
                [
                    'AvailabilityZone' => '<string>',
                    'Endpoint' => [
                        'Address' => '<string>',
                        'Port' => <integer>,
                        'URL' => '<string>',
                    ],
                    'NodeCreateTime' => <DateTime>,
                    'NodeId' => '<string>',
                    'NodeStatus' => '<string>',
                    'ParameterGroupStatus' => '<string>',
                ],
                // ...
            ],
            'NotificationConfiguration' => [
                'TopicArn' => '<string>',
                'TopicStatus' => '<string>',
            ],
            'ParameterGroup' => [
                'NodeIdsToReboot' => ['<string>', ...],
                'ParameterApplyStatus' => '<string>',
                'ParameterGroupName' => '<string>',
            ],
            'PreferredMaintenanceWindow' => '<string>',
            'SSEDescription' => [
                'Status' => 'ENABLING|ENABLED|DISABLING|DISABLED',
            ],
            'SecurityGroups' => [
                [
                    'SecurityGroupIdentifier' => '<string>',
                    'Status' => '<string>',
                ],
                // ...
            ],
            'Status' => '<string>',
            'SubnetGroup' => '<string>',
            'TotalNodes' => <integer>,
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members
Clusters
Type: Array of Cluster structures

The descriptions of your DAX clusters, in response to a DescribeClusters request.

NextToken
Type: string

Provides an identifier to allow retrieval of paginated results.

Errors

ClusterNotFoundFault:

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

ServiceLinkedRoleNotFoundFault:

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

InvalidParameterValueException:

The value for a parameter is invalid.

InvalidParameterCombinationException:

Two or more incompatible parameters were specified.

DescribeDefaultParameters 

$result = $client->describeDefaultParameters([/* ... */]);
$promise = $client->describeDefaultParametersAsync([/* ... */]);

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

Parameter Syntax

$result = $client->describeDefaultParameters([
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members
MaxResults
Type: int

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.

NextToken
Type: string

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.

Result Syntax

[
    'NextToken' => '<string>',
    'Parameters' => [
        [
            'AllowedValues' => '<string>',
            'ChangeType' => 'IMMEDIATE|REQUIRES_REBOOT',
            'DataType' => '<string>',
            'Description' => '<string>',
            'IsModifiable' => 'TRUE|FALSE|CONDITIONAL',
            'NodeTypeSpecificValues' => [
                [
                    'NodeType' => '<string>',
                    'Value' => '<string>',
                ],
                // ...
            ],
            'ParameterName' => '<string>',
            'ParameterType' => 'DEFAULT|NODE_TYPE_SPECIFIC',
            'ParameterValue' => '<string>',
            'Source' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members
NextToken
Type: string

Provides an identifier to allow retrieval of paginated results.

Parameters
Type: Array of Parameter structures

A list of parameters. Each element in the list represents one parameter.

Errors

ServiceLinkedRoleNotFoundFault:

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

InvalidParameterValueException:

The value for a parameter is invalid.

InvalidParameterCombinationException:

Two or more incompatible parameters were specified.

DescribeEvents 

$result = $client->describeEvents([/* ... */]);
$promise = $client->describeEventsAsync([/* ... */]);

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

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

Parameter Syntax

$result = $client->describeEvents([
    'Duration' => <integer>,
    'EndTime' => <integer || string || DateTime>,
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'SourceName' => '<string>',
    'SourceType' => 'CLUSTER|PARAMETER_GROUP|SUBNET_GROUP',
    'StartTime' => <integer || string || DateTime>,
]);

Parameter Details

Members
Duration
Type: int

The number of minutes' worth of events to retrieve.

EndTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

The end of the time interval for which to retrieve events, specified in ISO 8601 format.

MaxResults
Type: int

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.

NextToken
Type: string

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.

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

SourceType
Type: string

The event source to retrieve events for. If no value is specified, all events are returned.

StartTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

The beginning of the time interval to retrieve events for, specified in ISO 8601 format.

Result Syntax

[
    'Events' => [
        [
            'Date' => <DateTime>,
            'Message' => '<string>',
            'SourceName' => '<string>',
            'SourceType' => 'CLUSTER|PARAMETER_GROUP|SUBNET_GROUP',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members
Events
Type: Array of Event structures

An array of events. Each element in the array represents one event.

NextToken
Type: string

Provides an identifier to allow retrieval of paginated results.

Errors

ServiceLinkedRoleNotFoundFault:

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

InvalidParameterValueException:

The value for a parameter is invalid.

InvalidParameterCombinationException:

Two or more incompatible parameters were specified.

DescribeParameterGroups 

$result = $client->describeParameterGroups([/* ... */]);
$promise = $client->describeParameterGroupsAsync([/* ... */]);

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

Parameter Syntax

$result = $client->describeParameterGroups([
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'ParameterGroupNames' => ['<string>', ...],
]);

Parameter Details

Members
MaxResults
Type: int

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.

NextToken
Type: string

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.

ParameterGroupNames
Type: Array of strings

The names of the parameter groups.

Result Syntax

[
    'NextToken' => '<string>',
    'ParameterGroups' => [
        [
            'Description' => '<string>',
            'ParameterGroupName' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members
NextToken
Type: string

Provides an identifier to allow retrieval of paginated results.

ParameterGroups
Type: Array of ParameterGroup structures

An array of parameter groups. Each element in the array represents one parameter group.

Errors

ParameterGroupNotFoundFault:

The specified parameter group does not exist.

ServiceLinkedRoleNotFoundFault:

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

InvalidParameterValueException:

The value for a parameter is invalid.

InvalidParameterCombinationException:

Two or more incompatible parameters were specified.

DescribeParameters 

$result = $client->describeParameters([/* ... */]);
$promise = $client->describeParametersAsync([/* ... */]);

Returns the detailed parameter list for a particular parameter group.

Parameter Syntax

$result = $client->describeParameters([
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'ParameterGroupName' => '<string>', // REQUIRED
    'Source' => '<string>',
]);

Parameter Details

Members
MaxResults
Type: int

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.

NextToken
Type: string

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.

ParameterGroupName
Required: Yes
Type: string

The name of the parameter group.

Source
Type: string

How the parameter is defined. For example, system denotes a system-defined parameter.

Result Syntax

[
    'NextToken' => '<string>',
    'Parameters' => [
        [
            'AllowedValues' => '<string>',
            'ChangeType' => 'IMMEDIATE|REQUIRES_REBOOT',
            'DataType' => '<string>',
            'Description' => '<string>',
            'IsModifiable' => 'TRUE|FALSE|CONDITIONAL',
            'NodeTypeSpecificValues' => [
                [
                    'NodeType' => '<string>',
                    'Value' => '<string>',
                ],
                // ...
            ],
            'ParameterName' => '<string>',
            'ParameterType' => 'DEFAULT|NODE_TYPE_SPECIFIC',
            'ParameterValue' => '<string>',
            'Source' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members
NextToken
Type: string

Provides an identifier to allow retrieval of paginated results.

Parameters
Type: Array of Parameter structures

A list of parameters within a parameter group. Each element in the list represents one parameter.

Errors

ParameterGroupNotFoundFault:

The specified parameter group does not exist.

ServiceLinkedRoleNotFoundFault:

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

InvalidParameterValueException:

The value for a parameter is invalid.

InvalidParameterCombinationException:

Two or more incompatible parameters were specified.

DescribeSubnetGroups 

$result = $client->describeSubnetGroups([/* ... */]);
$promise = $client->describeSubnetGroupsAsync([/* ... */]);

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

Parameter Syntax

$result = $client->describeSubnetGroups([
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'SubnetGroupNames' => ['<string>', ...],
]);

Parameter Details

Members
MaxResults
Type: int

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.

NextToken
Type: string

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.

SubnetGroupNames
Type: Array of strings

The name of the subnet group.

Result Syntax

[
    'NextToken' => '<string>',
    'SubnetGroups' => [
        [
            'Description' => '<string>',
            'SubnetGroupName' => '<string>',
            'Subnets' => [
                [
                    'SubnetAvailabilityZone' => '<string>',
                    'SubnetIdentifier' => '<string>',
                ],
                // ...
            ],
            'VpcId' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members
NextToken
Type: string

Provides an identifier to allow retrieval of paginated results.

SubnetGroups
Type: Array of SubnetGroup structures

An array of subnet groups. Each element in the array represents a single subnet group.

Errors

SubnetGroupNotFoundFault:

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

ServiceLinkedRoleNotFoundFault:

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

IncreaseReplicationFactor 

$result = $client->increaseReplicationFactor([/* ... */]);
$promise = $client->increaseReplicationFactorAsync([/* ... */]);

Adds one or more nodes to a DAX cluster.

Parameter Syntax

$result = $client->increaseReplicationFactor([
    'AvailabilityZones' => ['<string>', ...],
    'ClusterName' => '<string>', // REQUIRED
    'NewReplicationFactor' => <integer>, // REQUIRED
]);

Parameter Details

Members
AvailabilityZones
Type: Array of strings

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.

ClusterName
Required: Yes
Type: string

The name of the DAX cluster that will receive additional nodes.

NewReplicationFactor
Required: Yes
Type: int

The new number of nodes for the DAX cluster.

Result Syntax

[
    'Cluster' => [
        'ActiveNodes' => <integer>,
        'ClusterArn' => '<string>',
        'ClusterDiscoveryEndpoint' => [
            'Address' => '<string>',
            'Port' => <integer>,
            'URL' => '<string>',
        ],
        'ClusterEndpointEncryptionType' => 'NONE|TLS',
        'ClusterName' => '<string>',
        'Description' => '<string>',
        'IamRoleArn' => '<string>',
        'NodeIdsToRemove' => ['<string>', ...],
        'NodeType' => '<string>',
        'Nodes' => [
            [
                'AvailabilityZone' => '<string>',
                'Endpoint' => [
                    'Address' => '<string>',
                    'Port' => <integer>,
                    'URL' => '<string>',
                ],
                'NodeCreateTime' => <DateTime>,
                'NodeId' => '<string>',
                'NodeStatus' => '<string>',
                'ParameterGroupStatus' => '<string>',
            ],
            // ...
        ],
        'NotificationConfiguration' => [
            'TopicArn' => '<string>',
            'TopicStatus' => '<string>',
        ],
        'ParameterGroup' => [
            'NodeIdsToReboot' => ['<string>', ...],
            'ParameterApplyStatus' => '<string>',
            'ParameterGroupName' => '<string>',
        ],
        'PreferredMaintenanceWindow' => '<string>',
        'SSEDescription' => [
            'Status' => 'ENABLING|ENABLED|DISABLING|DISABLED',
        ],
        'SecurityGroups' => [
            [
                'SecurityGroupIdentifier' => '<string>',
                'Status' => '<string>',
            ],
            // ...
        ],
        'Status' => '<string>',
        'SubnetGroup' => '<string>',
        'TotalNodes' => <integer>,
    ],
]

Result Details

Members
Cluster
Type: Cluster structure

A description of the DAX cluster. with its new replication factor.

Errors

ClusterNotFoundFault:

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

InvalidClusterStateFault:

The requested DAX cluster is not in the available state.

InsufficientClusterCapacityFault:

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

InvalidVPCNetworkStateFault:

The VPC network is in an invalid state.

NodeQuotaForClusterExceededFault:

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

NodeQuotaForCustomerExceededFault:

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

ServiceLinkedRoleNotFoundFault:

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

InvalidParameterValueException:

The value for a parameter is invalid.

InvalidParameterCombinationException:

Two or more incompatible parameters were specified.

ListTags 

$result = $client->listTags([/* ... */]);
$promise = $client->listTagsAsync([/* ... */]);

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

Parameter Syntax

$result = $client->listTags([
    'NextToken' => '<string>',
    'ResourceName' => '<string>', // REQUIRED
]);

Parameter Details

Members
NextToken
Type: string

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.

ResourceName
Required: Yes
Type: string

The name of the DAX resource to which the tags belong.

Result Syntax

[
    'NextToken' => '<string>',
    'Tags' => [
        [
            'Key' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members
NextToken
Type: string

If this value is present, there are additional results to be displayed. To retrieve them, call ListTags again, with NextToken set to this value.

Tags
Type: Array of Tag structures

A list of tags currently associated with the DAX cluster.

Errors

ClusterNotFoundFault:

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

InvalidARNFault:

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

InvalidClusterStateFault:

The requested DAX cluster is not in the available state.

ServiceLinkedRoleNotFoundFault:

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

InvalidParameterValueException:

The value for a parameter is invalid.

InvalidParameterCombinationException:

Two or more incompatible parameters were specified.

RebootNode 

$result = $client->rebootNode([/* ... */]);
$promise = $client->rebootNodeAsync([/* ... */]);

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

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

Parameter Syntax

$result = $client->rebootNode([
    'ClusterName' => '<string>', // REQUIRED
    'NodeId' => '<string>', // REQUIRED
]);

Parameter Details

Members
ClusterName
Required: Yes
Type: string

The name of the DAX cluster containing the node to be rebooted.

NodeId
Required: Yes
Type: string

The system-assigned ID of the node to be rebooted.

Result Syntax

[
    'Cluster' => [
        'ActiveNodes' => <integer>,
        'ClusterArn' => '<string>',
        'ClusterDiscoveryEndpoint' => [
            'Address' => '<string>',
            'Port' => <integer>,
            'URL' => '<string>',
        ],
        'ClusterEndpointEncryptionType' => 'NONE|TLS',
        'ClusterName' => '<string>',
        'Description' => '<string>',
        'IamRoleArn' => '<string>',
        'NodeIdsToRemove' => ['<string>', ...],
        'NodeType' => '<string>',
        'Nodes' => [
            [
                'AvailabilityZone' => '<string>',
                'Endpoint' => [
                    'Address' => '<string>',
                    'Port' => <integer>,
                    'URL' => '<string>',
                ],
                'NodeCreateTime' => <DateTime>,
                'NodeId' => '<string>',
                'NodeStatus' => '<string>',
                'ParameterGroupStatus' => '<string>',
            ],
            // ...
        ],
        'NotificationConfiguration' => [
            'TopicArn' => '<string>',
            'TopicStatus' => '<string>',
        ],
        'ParameterGroup' => [
            'NodeIdsToReboot' => ['<string>', ...],
            'ParameterApplyStatus' => '<string>',
            'ParameterGroupName' => '<string>',
        ],
        'PreferredMaintenanceWindow' => '<string>',
        'SSEDescription' => [
            'Status' => 'ENABLING|ENABLED|DISABLING|DISABLED',
        ],
        'SecurityGroups' => [
            [
                'SecurityGroupIdentifier' => '<string>',
                'Status' => '<string>',
            ],
            // ...
        ],
        'Status' => '<string>',
        'SubnetGroup' => '<string>',
        'TotalNodes' => <integer>,
    ],
]

Result Details

Members
Cluster
Type: Cluster structure

A description of the DAX cluster after a node has been rebooted.

Errors

ClusterNotFoundFault:

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

NodeNotFoundFault:

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

InvalidClusterStateFault:

The requested DAX cluster is not in the available state.

ServiceLinkedRoleNotFoundFault:

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

InvalidParameterValueException:

The value for a parameter is invalid.

InvalidParameterCombinationException:

Two or more incompatible parameters were specified.

TagResource 

$result = $client->tagResource([/* ... */]);
$promise = $client->tagResourceAsync([/* ... */]);

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

Parameter Syntax

$result = $client->tagResource([
    'ResourceName' => '<string>', // REQUIRED
    'Tags' => [ // REQUIRED
        [
            'Key' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
]);

Parameter Details

Members
ResourceName
Required: Yes
Type: string

The name of the DAX resource to which tags should be added.

Tags
Required: Yes
Type: Array of Tag structures

The tags to be assigned to the DAX resource.

Result Syntax

[
    'Tags' => [
        [
            'Key' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members
Tags
Type: Array of Tag structures

The list of tags that are associated with the DAX resource.

Errors

ClusterNotFoundFault:

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

TagQuotaPerResourceExceeded:

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

InvalidARNFault:

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

InvalidClusterStateFault:

The requested DAX cluster is not in the available state.

ServiceLinkedRoleNotFoundFault:

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

InvalidParameterValueException:

The value for a parameter is invalid.

InvalidParameterCombinationException:

Two or more incompatible parameters were specified.

UntagResource 

$result = $client->untagResource([/* ... */]);
$promise = $client->untagResourceAsync([/* ... */]);

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

Parameter Syntax

$result = $client->untagResource([
    'ResourceName' => '<string>', // REQUIRED
    'TagKeys' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Members
ResourceName
Required: Yes
Type: string

The name of the DAX resource from which the tags should be removed.

TagKeys
Required: Yes
Type: Array of strings

A list of tag keys. If the DAX cluster has any tags with these keys, then the tags are removed from the cluster.

Result Syntax

[
    'Tags' => [
        [
            'Key' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members
Tags
Type: Array of Tag structures

The tag keys that have been removed from the cluster.

Errors

ClusterNotFoundFault:

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

InvalidARNFault:

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

TagNotFoundFault:

The tag does not exist.

InvalidClusterStateFault:

The requested DAX cluster is not in the available state.

ServiceLinkedRoleNotFoundFault:

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

InvalidParameterValueException:

The value for a parameter is invalid.

InvalidParameterCombinationException:

Two or more incompatible parameters were specified.

UpdateCluster 

$result = $client->updateCluster([/* ... */]);
$promise = $client->updateClusterAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->updateCluster([
    'ClusterName' => '<string>', // REQUIRED
    'Description' => '<string>',
    'NotificationTopicArn' => '<string>',
    'NotificationTopicStatus' => '<string>',
    'ParameterGroupName' => '<string>',
    'PreferredMaintenanceWindow' => '<string>',
    'SecurityGroupIds' => ['<string>', ...],
]);

Parameter Details

Members
ClusterName
Required: Yes
Type: string

The name of the DAX cluster to be modified.

Description
Type: string

A description of the changes being made to the cluster.

NotificationTopicArn
Type: string

The Amazon Resource Name (ARN) that identifies the topic.

NotificationTopicStatus
Type: string

The current state of the topic. A value of “active” means that notifications will be sent to the topic. A value of “inactive” means that notifications will not be sent to the topic.

ParameterGroupName
Type: string

The name of a parameter group for this cluster.

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

SecurityGroupIds
Type: Array of strings

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.

Result Syntax

[
    'Cluster' => [
        'ActiveNodes' => <integer>,
        'ClusterArn' => '<string>',
        'ClusterDiscoveryEndpoint' => [
            'Address' => '<string>',
            'Port' => <integer>,
            'URL' => '<string>',
        ],
        'ClusterEndpointEncryptionType' => 'NONE|TLS',
        'ClusterName' => '<string>',
        'Description' => '<string>',
        'IamRoleArn' => '<string>',
        'NodeIdsToRemove' => ['<string>', ...],
        'NodeType' => '<string>',
        'Nodes' => [
            [
                'AvailabilityZone' => '<string>',
                'Endpoint' => [
                    'Address' => '<string>',
                    'Port' => <integer>,
                    'URL' => '<string>',
                ],
                'NodeCreateTime' => <DateTime>,
                'NodeId' => '<string>',
                'NodeStatus' => '<string>',
                'ParameterGroupStatus' => '<string>',
            ],
            // ...
        ],
        'NotificationConfiguration' => [
            'TopicArn' => '<string>',
            'TopicStatus' => '<string>',
        ],
        'ParameterGroup' => [
            'NodeIdsToReboot' => ['<string>', ...],
            'ParameterApplyStatus' => '<string>',
            'ParameterGroupName' => '<string>',
        ],
        'PreferredMaintenanceWindow' => '<string>',
        'SSEDescription' => [
            'Status' => 'ENABLING|ENABLED|DISABLING|DISABLED',
        ],
        'SecurityGroups' => [
            [
                'SecurityGroupIdentifier' => '<string>',
                'Status' => '<string>',
            ],
            // ...
        ],
        'Status' => '<string>',
        'SubnetGroup' => '<string>',
        'TotalNodes' => <integer>,
    ],
]

Result Details

Members
Cluster
Type: Cluster structure

A description of the DAX cluster, after it has been modified.

Errors

InvalidClusterStateFault:

The requested DAX cluster is not in the available state.

ClusterNotFoundFault:

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

InvalidParameterGroupStateFault:

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

ParameterGroupNotFoundFault:

The specified parameter group does not exist.

ServiceLinkedRoleNotFoundFault:

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

InvalidParameterValueException:

The value for a parameter is invalid.

InvalidParameterCombinationException:

Two or more incompatible parameters were specified.

UpdateParameterGroup 

$result = $client->updateParameterGroup([/* ... */]);
$promise = $client->updateParameterGroupAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->updateParameterGroup([
    'ParameterGroupName' => '<string>', // REQUIRED
    'ParameterNameValues' => [ // REQUIRED
        [
            'ParameterName' => '<string>',
            'ParameterValue' => '<string>',
        ],
        // ...
    ],
]);

Parameter Details

Members
ParameterGroupName
Required: Yes
Type: string

The name of the parameter group.

ParameterNameValues
Required: Yes
Type: Array of ParameterNameValue structures

An array of name-value pairs for the parameters in the group. Each element in the array represents a single parameter.

record-ttl-millis and query-ttl-millis are the only supported parameter names. For more details, see Configuring TTL Settings.

Result Syntax

[
    'ParameterGroup' => [
        'Description' => '<string>',
        'ParameterGroupName' => '<string>',
    ],
]

Result Details

Members
ParameterGroup
Type: ParameterGroup structure

The parameter group that has been modified.

Errors

InvalidParameterGroupStateFault:

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

ParameterGroupNotFoundFault:

The specified parameter group does not exist.

ServiceLinkedRoleNotFoundFault:

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

InvalidParameterValueException:

The value for a parameter is invalid.

InvalidParameterCombinationException:

Two or more incompatible parameters were specified.

UpdateSubnetGroup 

$result = $client->updateSubnetGroup([/* ... */]);
$promise = $client->updateSubnetGroupAsync([/* ... */]);

Modifies an existing subnet group.

Parameter Syntax

$result = $client->updateSubnetGroup([
    'Description' => '<string>',
    'SubnetGroupName' => '<string>', // REQUIRED
    'SubnetIds' => ['<string>', ...],
]);

Parameter Details

Members
Description
Type: string

A description of the subnet group.

SubnetGroupName
Required: Yes
Type: string

The name of the subnet group.

SubnetIds
Type: Array of strings

A list of subnet IDs in the subnet group.

Result Syntax

[
    'SubnetGroup' => [
        'Description' => '<string>',
        'SubnetGroupName' => '<string>',
        'Subnets' => [
            [
                'SubnetAvailabilityZone' => '<string>',
                'SubnetIdentifier' => '<string>',
            ],
            // ...
        ],
        'VpcId' => '<string>',
    ],
]

Result Details

Members
SubnetGroup
Type: SubnetGroup structure

The subnet group that has been modified.

Errors

SubnetGroupNotFoundFault:

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

SubnetQuotaExceededFault:

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

SubnetInUse:

The requested subnet is being used by another subnet group.

InvalidSubnet:

An invalid subnet identifier was specified.

ServiceLinkedRoleNotFoundFault:

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

Shapes

Cluster

Description

Contains all of the attributes of a specific DAX cluster.

Members
ActiveNodes
Type: int

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

ClusterArn
Type: string

The Amazon Resource Name (ARN) that uniquely identifies the cluster.

ClusterDiscoveryEndpoint
Type: Endpoint structure

The endpoint for this DAX cluster, consisting of a DNS name, a port number, and a URL. Applications should use the URL to configure the DAX client to find their cluster.

ClusterEndpointEncryptionType
Type: string

The type of encryption supported by the cluster's endpoint. Values are:

  • NONE for no encryption

    TLS for Transport Layer Security

ClusterName
Type: string

The name of the DAX cluster.

Description
Type: string

The description of the cluster.

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

NodeIdsToRemove
Type: Array of strings

A list of nodes to be removed from the cluster.

NodeType
Type: string

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

Nodes
Type: Array of Node structures

A list of nodes that are currently in the cluster.

NotificationConfiguration
Type: NotificationConfiguration structure

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

ParameterGroup
Type: ParameterGroupStatus structure

The parameter group being used by nodes in the cluster.

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

SSEDescription
Type: SSEDescription structure

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

SecurityGroups
Type: Array of SecurityGroupMembership structures

A list of security groups, and the status of each, for the nodes in the cluster.

Status
Type: string

The current status of the cluster.

SubnetGroup
Type: string

The subnet group where the DAX cluster is running.

TotalNodes
Type: int

The total number of nodes in the cluster.

ClusterAlreadyExistsFault

Description

You already have a DAX cluster with the given identifier.

Members

ClusterNotFoundFault

Description

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

Members

ClusterQuotaForCustomerExceededFault

Description

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

Members

Endpoint

Description

Represents the information required for client programs to connect to the endpoint for a DAX cluster.

Members
Address
Type: string

The DNS hostname of the endpoint.

Port
Type: int

The port number that applications should use to connect to the endpoint.

URL
Type: string

The URL that applications should use to connect to the endpoint. The default ports are 8111 for the "dax" protocol and 9111 for the "daxs" protocol.

Event

Description

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.

Members
Date
Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time when the event occurred.

Message
Type: string

A user-defined message associated with the event.

SourceName
Type: string

The source of the event. For example, if the event occurred at the node level, the source would be the node ID.

SourceType
Type: string

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

InsufficientClusterCapacityFault

Description

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

Members

InvalidARNFault

Description

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

Members

InvalidClusterStateFault

Description

The requested DAX cluster is not in the available state.

Members

InvalidParameterCombinationException

Description

Two or more incompatible parameters were specified.

Members
message
Type: string

InvalidParameterGroupStateFault

Description

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

Members

InvalidParameterValueException

Description

The value for a parameter is invalid.

Members
message
Type: string

InvalidSubnet

Description

An invalid subnet identifier was specified.

Members

InvalidVPCNetworkStateFault

Description

The VPC network is in an invalid state.

Members

Node

Description

Represents an individual node within a DAX cluster.

Members
AvailabilityZone
Type: string

The Availability Zone (AZ) in which the node has been deployed.

Endpoint
Type: Endpoint structure

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.

NodeCreateTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

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

NodeId
Type: string

A system-generated identifier for the node.

NodeStatus
Type: string

The current status of the node. For example: available.

ParameterGroupStatus
Type: string

The status of the parameter group associated with this node. For example, in-sync.

NodeNotFoundFault

Description

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

Members

NodeQuotaForClusterExceededFault

Description

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

Members

NodeQuotaForCustomerExceededFault

Description

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

Members

NodeTypeSpecificValue

Description

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

Members
NodeType
Type: string

A node type to which the parameter value applies.

Value
Type: string

The parameter value for this node type.

NotificationConfiguration

Description

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

Members
TopicArn
Type: string

The Amazon Resource Name (ARN) that identifies the topic.

TopicStatus
Type: string

The current state of the topic. A value of “active” means that notifications will be sent to the topic. A value of “inactive” means that notifications will not be sent to the topic.

Parameter

Description

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

Members
AllowedValues
Type: string

A range of values within which the parameter can be set.

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

DataType
Type: string

The data type of the parameter. For example, integer:

Description
Type: string

A description of the parameter

IsModifiable
Type: string

Whether the customer is allowed to modify the parameter.

NodeTypeSpecificValues
Type: Array of NodeTypeSpecificValue structures

A list of node types, and specific parameter values for each node.

ParameterName
Type: string

The name of the parameter.

ParameterType
Type: string

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

ParameterValue
Type: string

The value for the parameter.

Source
Type: string

How the parameter is defined. For example, system denotes a system-defined parameter.

ParameterGroup

Description

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

Members
Description
Type: string

A description of the parameter group.

ParameterGroupName
Type: string

The name of the parameter group.

ParameterGroupAlreadyExistsFault

Description

The specified parameter group already exists.

Members

ParameterGroupNotFoundFault

Description

The specified parameter group does not exist.

Members

ParameterGroupQuotaExceededFault

Description

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

Members

ParameterGroupStatus

Description

The status of a parameter group.

Members
NodeIdsToReboot
Type: Array of strings

The node IDs of one or more nodes to be rebooted.

ParameterApplyStatus
Type: string

The status of parameter updates.

ParameterGroupName
Type: string

The name of the parameter group.

ParameterNameValue

Description

An individual DAX parameter.

Members
ParameterName
Type: string

The name of the parameter.

ParameterValue
Type: string

The value of the parameter.

SSEDescription

Description

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

Members
Status
Type: string

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.

SSESpecification

Description

Represents the settings used to enable server-side encryption.

Members
Enabled
Required: Yes
Type: boolean

Indicates whether server-side encryption is enabled (true) or disabled (false) on the cluster.

SecurityGroupMembership

Description

An individual VPC security group and its status.

Members
SecurityGroupIdentifier
Type: string

The unique ID for this security group.

Status
Type: string

The status of this security group.

ServiceLinkedRoleNotFoundFault

Description

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

Members

ServiceQuotaExceededException

Description

You have reached the maximum number of x509 certificates that can be created for encrypted clusters in a 30 day period. Contact AWS customer support to discuss options for continuing to create encrypted clusters.

Members

Subnet

Description

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.

Members
SubnetAvailabilityZone
Type: string

The Availability Zone (AZ) for the subnet.

SubnetIdentifier
Type: string

The system-assigned identifier for the subnet.

SubnetGroup

Description

Represents the output of one of the following actions:

  • CreateSubnetGroup

  • ModifySubnetGroup

Members
Description
Type: string

The description of the subnet group.

SubnetGroupName
Type: string

The name of the subnet group.

Subnets
Type: Array of Subnet structures

A list of subnets associated with the subnet group.

VpcId
Type: string

The Amazon Virtual Private Cloud identifier (VPC ID) of the subnet group.

SubnetGroupAlreadyExistsFault

Description

The specified subnet group already exists.

Members

SubnetGroupInUseFault

Description

The specified subnet group is currently in use.

Members

SubnetGroupNotFoundFault

Description

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

Members

SubnetGroupQuotaExceededFault

Description

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

Members

SubnetInUse

Description

The requested subnet is being used by another subnet group.

Members

SubnetQuotaExceededFault

Description

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

Members

Tag

Description

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.

Members
Key
Type: string

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.

Value
Type: string

The value of the tag. Tag values are case-sensitive and can be null.

TagNotFoundFault

Description

The tag does not exist.

Members

TagQuotaPerResourceExceeded

Description

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

Members