Amazonka.DAX.UpdateCluster

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.

Creating a Request

data UpdateCluster

See: newUpdateCluster smart constructor.

Constructors

UpdateCluster'

Fields

• description :: Maybe Text

  A description of the changes being made to the cluster.

• notificationTopicArn :: Maybe Text

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

• notificationTopicStatus :: Maybe Text

  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 :: Maybe Text

  The name of a parameter group for this cluster.

• preferredMaintenanceWindow :: Maybe Text

  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 :: Maybe [Text]

  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.

• clusterName :: Text

  The name of the DAX cluster to be modified.

Instances

ToJSON UpdateCluster

Defined in Amazonka.DAX.UpdateCluster

Methods

toJSON :: UpdateCluster -> Value

toEncoding :: UpdateCluster -> Encoding

toJSONList :: [UpdateCluster] -> Value

toEncodingList :: [UpdateCluster] -> Encoding

ToHeaders UpdateCluster

Defined in Amazonka.DAX.UpdateCluster

Methods

toHeaders :: UpdateCluster -> [Header]

ToPath UpdateCluster

Defined in Amazonka.DAX.UpdateCluster

Methods

toPath :: UpdateCluster -> ByteString

ToQuery UpdateCluster

Defined in Amazonka.DAX.UpdateCluster

Methods

toQuery :: UpdateCluster -> QueryString

AWSRequest UpdateCluster

Defined in Amazonka.DAX.UpdateCluster

Associated Types

type AWSResponse UpdateCluster

Methods

request :: (Service -> Service) -> UpdateCluster -> Request UpdateCluster

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy UpdateCluster -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse UpdateCluster)))

Generic UpdateCluster

Defined in Amazonka.DAX.UpdateCluster

Associated Types

type Rep UpdateCluster :: Type -> Type

Methods

from :: UpdateCluster -> Rep UpdateCluster x

to :: Rep UpdateCluster x -> UpdateCluster

Read UpdateCluster

Defined in Amazonka.DAX.UpdateCluster

Methods

readsPrec :: Int -> ReadS UpdateCluster

readList :: ReadS [UpdateCluster]

readPrec :: ReadPrec UpdateCluster

readListPrec :: ReadPrec [UpdateCluster]

Show UpdateCluster

Defined in Amazonka.DAX.UpdateCluster

Methods

showsPrec :: Int -> UpdateCluster -> ShowS

show :: UpdateCluster -> String

showList :: [UpdateCluster] -> ShowS

NFData UpdateCluster

Defined in Amazonka.DAX.UpdateCluster

Methods

rnf :: UpdateCluster -> ()

Eq UpdateCluster

Defined in Amazonka.DAX.UpdateCluster

Methods

(==) :: UpdateCluster -> UpdateCluster -> Bool

(/=) :: UpdateCluster -> UpdateCluster -> Bool

Hashable UpdateCluster

Defined in Amazonka.DAX.UpdateCluster

Methods

hashWithSalt :: Int -> UpdateCluster -> Int

hash :: UpdateCluster -> Int

type AWSResponse UpdateCluster

Defined in Amazonka.DAX.UpdateCluster

type AWSResponse UpdateCluster = UpdateClusterResponse

type Rep UpdateCluster

Defined in Amazonka.DAX.UpdateCluster

type Rep UpdateCluster = D1 ('MetaData "UpdateCluster" "Amazonka.DAX.UpdateCluster" "amazonka-dynamodb-dax-2.0-FwsdPL1z9NS2dTys8oHQ2n" 'False) (C1 ('MetaCons "UpdateCluster'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "notificationTopicArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "notificationTopicStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 ('MetaSel ('Just "parameterGroupName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "preferredMaintenanceWindow") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "securityGroupIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 ('MetaSel ('Just "clusterName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newUpdateCluster

Arguments

:: Text

UpdateCluster

-> UpdateCluster

Create a value of UpdateCluster with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

UpdateCluster, updateCluster_description - A description of the changes being made to the cluster.

$sel:notificationTopicArn:UpdateCluster', updateCluster_notificationTopicArn - The Amazon Resource Name (ARN) that identifies the topic.

$sel:notificationTopicStatus:UpdateCluster', updateCluster_notificationTopicStatus - 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.

UpdateCluster, updateCluster_parameterGroupName - The name of a parameter group for this cluster.

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

$sel:securityGroupIds:UpdateCluster', updateCluster_securityGroupIds - 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.

UpdateCluster, updateCluster_clusterName - The name of the DAX cluster to be modified.

Request Lenses

updateCluster_description :: Lens' UpdateCluster (Maybe Text)

A description of the changes being made to the cluster.

updateCluster_notificationTopicArn :: Lens' UpdateCluster (Maybe Text)

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

updateCluster_notificationTopicStatus :: Lens' UpdateCluster (Maybe Text)

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.

updateCluster_parameterGroupName :: Lens' UpdateCluster (Maybe Text)

The name of a parameter group for this cluster.

updateCluster_preferredMaintenanceWindow :: Lens' UpdateCluster (Maybe Text)

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.

updateCluster_securityGroupIds :: Lens' UpdateCluster (Maybe [Text])

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.

updateCluster_clusterName :: Lens' UpdateCluster Text

The name of the DAX cluster to be modified.

Destructuring the Response

data UpdateClusterResponse

See: newUpdateClusterResponse smart constructor.

Constructors

UpdateClusterResponse'

Fields

• cluster :: Maybe Cluster

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

• httpStatus :: Int

  The response's http status code.

Instances

Generic UpdateClusterResponse

Defined in Amazonka.DAX.UpdateCluster

Associated Types

type Rep UpdateClusterResponse :: Type -> Type

Methods

from :: UpdateClusterResponse -> Rep UpdateClusterResponse x

to :: Rep UpdateClusterResponse x -> UpdateClusterResponse

Read UpdateClusterResponse

Defined in Amazonka.DAX.UpdateCluster

Methods

readsPrec :: Int -> ReadS UpdateClusterResponse

readList :: ReadS [UpdateClusterResponse]

readPrec :: ReadPrec UpdateClusterResponse

readListPrec :: ReadPrec [UpdateClusterResponse]

Show UpdateClusterResponse

Defined in Amazonka.DAX.UpdateCluster

Methods

showsPrec :: Int -> UpdateClusterResponse -> ShowS

show :: UpdateClusterResponse -> String

showList :: [UpdateClusterResponse] -> ShowS

NFData UpdateClusterResponse

Defined in Amazonka.DAX.UpdateCluster

Methods

rnf :: UpdateClusterResponse -> ()

Eq UpdateClusterResponse

Defined in Amazonka.DAX.UpdateCluster

Methods

(==) :: UpdateClusterResponse -> UpdateClusterResponse -> Bool

(/=) :: UpdateClusterResponse -> UpdateClusterResponse -> Bool

type Rep UpdateClusterResponse

Defined in Amazonka.DAX.UpdateCluster

type Rep UpdateClusterResponse = D1 ('MetaData "UpdateClusterResponse" "Amazonka.DAX.UpdateCluster" "amazonka-dynamodb-dax-2.0-FwsdPL1z9NS2dTys8oHQ2n" 'False) (C1 ('MetaCons "UpdateClusterResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "cluster") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Cluster)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newUpdateClusterResponse

Arguments

:: Int

$sel:httpStatus:UpdateClusterResponse'

-> UpdateClusterResponse

Create a value of UpdateClusterResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:cluster:UpdateClusterResponse', updateClusterResponse_cluster - A description of the DAX cluster, after it has been modified.

$sel:httpStatus:UpdateClusterResponse', updateClusterResponse_httpStatus - The response's http status code.

Response Lenses

updateClusterResponse_cluster :: Lens' UpdateClusterResponse (Maybe Cluster)

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

updateClusterResponse_httpStatus :: Lens' UpdateClusterResponse Int

The response's http status code.