NAME

Paws::DAX - Perl Interface to AWS Amazon DynamoDB Accelerator (DAX)

SYNOPSIS

  use Paws;

  my $obj = Paws->service('DAX');
  my $res = $obj->Method(
    Arg1 => $val1,
    Arg2 => [ 'V1', 'V2' ],
    # if Arg3 is an object, the HashRef will be used as arguments to the constructor
    # of the arguments type
    Arg3 => { Att1 => 'Val1' },
    # if Arg4 is an array of objects, the HashRefs will be passed as arguments to
    # the constructor of the arguments type
    Arg4 => [ { Att1 => 'Val1'  }, { Att1 => 'Val2' } ],
  );

DESCRIPTION

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

METHODS

CreateCluster(ClusterName => Str, IamRoleArn => Str, NodeType => Str, ReplicationFactor => Int, [AvailabilityZones => ArrayRef[Str|Undef], Description => Str, NotificationTopicArn => Str, ParameterGroupName => Str, PreferredMaintenanceWindow => Str, SecurityGroupIds => ArrayRef[Str|Undef], SubnetGroupName => Str, Tags => ArrayRef[Paws::DAX::Tag]])

Each argument is described in detail in: Paws::DAX::CreateCluster

Returns: a Paws::DAX::CreateClusterResponse instance

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

CreateParameterGroup(ParameterGroupName => Str, [Description => Str])

Each argument is described in detail in: Paws::DAX::CreateParameterGroup

Returns: a Paws::DAX::CreateParameterGroupResponse instance

  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.

CreateSubnetGroup(SubnetGroupName => Str, SubnetIds => ArrayRef[Str|Undef], [Description => Str])

Each argument is described in detail in: Paws::DAX::CreateSubnetGroup

Returns: a Paws::DAX::CreateSubnetGroupResponse instance

  Creates a new subnet group.

DecreaseReplicationFactor(ClusterName => Str, NewReplicationFactor => Int, [AvailabilityZones => ArrayRef[Str|Undef], NodeIdsToRemove => ArrayRef[Str|Undef]])

Each argument is described in detail in: Paws::DAX::DecreaseReplicationFactor

Returns: a Paws::DAX::DecreaseReplicationFactorResponse instance

  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.

DeleteCluster(ClusterName => Str)

Each argument is described in detail in: Paws::DAX::DeleteCluster

Returns: a Paws::DAX::DeleteClusterResponse instance

  Deletes a previously provisioned DAX cluster. I<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.

DeleteParameterGroup(ParameterGroupName => Str)

Each argument is described in detail in: Paws::DAX::DeleteParameterGroup

Returns: a Paws::DAX::DeleteParameterGroupResponse instance

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

DeleteSubnetGroup(SubnetGroupName => Str)

Each argument is described in detail in: Paws::DAX::DeleteSubnetGroup

Returns: a Paws::DAX::DeleteSubnetGroupResponse instance

  Deletes a subnet group.

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

DescribeClusters([ClusterNames => ArrayRef[Str|Undef], MaxResults => Int, NextToken => Str])

Each argument is described in detail in: Paws::DAX::DescribeClusters

Returns: a Paws::DAX::DescribeClustersResponse instance

  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.

DescribeDefaultParameters([MaxResults => Int, NextToken => Str])

Each argument is described in detail in: Paws::DAX::DescribeDefaultParameters

Returns: a Paws::DAX::DescribeDefaultParametersResponse instance

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

DescribeEvents([Duration => Int, EndTime => Str, MaxResults => Int, NextToken => Str, SourceName => Str, SourceType => Str, StartTime => Str])

Each argument is described in detail in: Paws::DAX::DescribeEvents

Returns: a Paws::DAX::DescribeEventsResponse instance

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

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

DescribeParameterGroups([MaxResults => Int, NextToken => Str, ParameterGroupNames => ArrayRef[Str|Undef]])

Each argument is described in detail in: Paws::DAX::DescribeParameterGroups

Returns: a Paws::DAX::DescribeParameterGroupsResponse instance

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

DescribeParameters(ParameterGroupName => Str, [MaxResults => Int, NextToken => Str, Source => Str])

Each argument is described in detail in: Paws::DAX::DescribeParameters

Returns: a Paws::DAX::DescribeParametersResponse instance

  Returns the detailed parameter list for a particular parameter group.

DescribeSubnetGroups([MaxResults => Int, NextToken => Str, SubnetGroupNames => ArrayRef[Str|Undef]])

Each argument is described in detail in: Paws::DAX::DescribeSubnetGroups

Returns: a Paws::DAX::DescribeSubnetGroupsResponse instance

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

IncreaseReplicationFactor(ClusterName => Str, NewReplicationFactor => Int, [AvailabilityZones => ArrayRef[Str|Undef]])

Each argument is described in detail in: Paws::DAX::IncreaseReplicationFactor

Returns: a Paws::DAX::IncreaseReplicationFactorResponse instance

  Adds one or more nodes to a DAX cluster.

ListTags(ResourceName => Str, [NextToken => Str])

Each argument is described in detail in: Paws::DAX::ListTags

Returns: a Paws::DAX::ListTagsResponse instance

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

RebootNode(ClusterName => Str, NodeId => Str)

Each argument is described in detail in: Paws::DAX::RebootNode

Returns: a Paws::DAX::RebootNodeResponse instance

  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.

TagResource(ResourceName => Str, Tags => ArrayRef[Paws::DAX::Tag])

Each argument is described in detail in: Paws::DAX::TagResource

Returns: a Paws::DAX::TagResourceResponse instance

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

UntagResource(ResourceName => Str, TagKeys => ArrayRef[Str|Undef])

Each argument is described in detail in: Paws::DAX::UntagResource

Returns: a Paws::DAX::UntagResourceResponse instance

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

UpdateCluster(ClusterName => Str, [Description => Str, NotificationTopicArn => Str, NotificationTopicStatus => Str, ParameterGroupName => Str, PreferredMaintenanceWindow => Str, SecurityGroupIds => ArrayRef[Str|Undef]])

Each argument is described in detail in: Paws::DAX::UpdateCluster

Returns: a Paws::DAX::UpdateClusterResponse instance

  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.

UpdateParameterGroup(ParameterGroupName => Str, ParameterNameValues => ArrayRef[Paws::DAX::ParameterNameValue])

Each argument is described in detail in: Paws::DAX::UpdateParameterGroup

Returns: a Paws::DAX::UpdateParameterGroupResponse instance

  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.

UpdateSubnetGroup(SubnetGroupName => Str, [Description => Str, SubnetIds => ArrayRef[Str|Undef]])

Each argument is described in detail in: Paws::DAX::UpdateSubnetGroup

Returns: a Paws::DAX::UpdateSubnetGroupResponse instance

  Modifies an existing subnet group.

PAGINATORS

Paginator methods are helpers that repetively call methods that return partial results

SEE ALSO

This service class forms part of Paws

BUGS and CONTRIBUTIONS

The source code is located here: https://github.com/pplu/aws-sdk-perl

Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues

cpanm Paws::SDK::Config

perl -MCPAN -e shell
install Paws::SDK::Config