Amazonka.DocDbElastic.UpdateCluster

Modifies a Elastic DocumentDB cluster. This includes updating admin-username/password, upgrading API version setting up a backup window and maintenance window

Creating a Request

data UpdateCluster

See: newUpdateCluster smart constructor.

Constructors

UpdateCluster'

Fields

• adminUserPassword :: Maybe (Sensitive Text)

  The password for the Elastic DocumentDB cluster administrator. This password can contain any printable ASCII character except forward slash (/), double quote ("), or the "at" symbol (@).

  Constraints: Must contain from 8 to 100 characters.

• authType :: Maybe Auth

  The authentication type for the Elastic DocumentDB cluster.

• clientToken :: Maybe Text

  The client token for the Elastic DocumentDB cluster.

• preferredMaintenanceWindow :: Maybe Text

  The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

  Format: ddd:hh24:mi-ddd:hh24:mi

  Default: a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region, occurring on a random day of the week.

  Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun

  Constraints: Minimum 30-minute window.

• shardCapacity :: Maybe Int

  The capacity of each shard in the Elastic DocumentDB cluster.

• shardCount :: Maybe Int

  The number of shards to create in the Elastic DocumentDB cluster.

• subnetIds :: Maybe [Text]

  The number of shards to create in the Elastic DocumentDB cluster.

• vpcSecurityGroupIds :: Maybe [Text]

  A list of EC2 VPC security groups to associate with the new Elastic DocumentDB cluster.

• clusterArn :: Text

  The arn of the Elastic DocumentDB cluster.

Instances

ToJSON UpdateCluster

Defined in Amazonka.DocDbElastic.UpdateCluster

Methods

toJSON :: UpdateCluster -> Value

toEncoding :: UpdateCluster -> Encoding

toJSONList :: [UpdateCluster] -> Value

toEncodingList :: [UpdateCluster] -> Encoding

ToHeaders UpdateCluster

Defined in Amazonka.DocDbElastic.UpdateCluster

Methods

toHeaders :: UpdateCluster -> [Header]

ToPath UpdateCluster

Defined in Amazonka.DocDbElastic.UpdateCluster

Methods

toPath :: UpdateCluster -> ByteString

ToQuery UpdateCluster

Defined in Amazonka.DocDbElastic.UpdateCluster

Methods

toQuery :: UpdateCluster -> QueryString

AWSRequest UpdateCluster

Defined in Amazonka.DocDbElastic.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.DocDbElastic.UpdateCluster

Associated Types

type Rep UpdateCluster :: Type -> Type

Methods

from :: UpdateCluster -> Rep UpdateCluster x

to :: Rep UpdateCluster x -> UpdateCluster

Show UpdateCluster

Defined in Amazonka.DocDbElastic.UpdateCluster

Methods

showsPrec :: Int -> UpdateCluster -> ShowS

show :: UpdateCluster -> String

showList :: [UpdateCluster] -> ShowS

NFData UpdateCluster

Defined in Amazonka.DocDbElastic.UpdateCluster

Methods

rnf :: UpdateCluster -> ()

Eq UpdateCluster

Defined in Amazonka.DocDbElastic.UpdateCluster

Methods

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

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

Hashable UpdateCluster

Defined in Amazonka.DocDbElastic.UpdateCluster

Methods

hashWithSalt :: Int -> UpdateCluster -> Int

hash :: UpdateCluster -> Int

type AWSResponse UpdateCluster

Defined in Amazonka.DocDbElastic.UpdateCluster

type AWSResponse UpdateCluster = UpdateClusterResponse

type Rep UpdateCluster

Defined in Amazonka.DocDbElastic.UpdateCluster

type Rep UpdateCluster = D1 ('MetaData "UpdateCluster" "Amazonka.DocDbElastic.UpdateCluster" "amazonka-docdb-elastic-2.0-7oyCcw7MbTKKNwZE62fvl3" 'False) (C1 ('MetaCons "UpdateCluster'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "adminUserPassword") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text))) :*: S1 ('MetaSel ('Just "authType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Auth))) :*: (S1 ('MetaSel ('Just "clientToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "preferredMaintenanceWindow") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 ('MetaSel ('Just "shardCapacity") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "shardCount") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int))) :*: (S1 ('MetaSel ('Just "subnetIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: (S1 ('MetaSel ('Just "vpcSecurityGroupIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 ('MetaSel ('Just "clusterArn") '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:

$sel:adminUserPassword:UpdateCluster', updateCluster_adminUserPassword - The password for the Elastic DocumentDB cluster administrator. This password can contain any printable ASCII character except forward slash (/), double quote ("), or the "at" symbol (@).

Constraints: Must contain from 8 to 100 characters.

UpdateCluster, updateCluster_authType - The authentication type for the Elastic DocumentDB cluster.

$sel:clientToken:UpdateCluster', updateCluster_clientToken - The client token for the Elastic DocumentDB cluster.

UpdateCluster, updateCluster_preferredMaintenanceWindow - The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

Format: ddd:hh24:mi-ddd:hh24:mi

Default: a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region, occurring on a random day of the week.

Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun

Constraints: Minimum 30-minute window.

UpdateCluster, updateCluster_shardCapacity - The capacity of each shard in the Elastic DocumentDB cluster.

UpdateCluster, updateCluster_shardCount - The number of shards to create in the Elastic DocumentDB cluster.

UpdateCluster, updateCluster_subnetIds - The number of shards to create in the Elastic DocumentDB cluster.

UpdateCluster, updateCluster_vpcSecurityGroupIds - A list of EC2 VPC security groups to associate with the new Elastic DocumentDB cluster.

UpdateCluster, updateCluster_clusterArn - The arn of the Elastic DocumentDB cluster.

Request Lenses

updateCluster_adminUserPassword :: Lens' UpdateCluster (Maybe Text)

The password for the Elastic DocumentDB cluster administrator. This password can contain any printable ASCII character except forward slash (/), double quote ("), or the "at" symbol (@).

Constraints: Must contain from 8 to 100 characters.

updateCluster_authType :: Lens' UpdateCluster (Maybe Auth)

The authentication type for the Elastic DocumentDB cluster.

updateCluster_clientToken :: Lens' UpdateCluster (Maybe Text)

The client token for the Elastic DocumentDB cluster.

updateCluster_preferredMaintenanceWindow :: Lens' UpdateCluster (Maybe Text)

The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

Format: ddd:hh24:mi-ddd:hh24:mi

Default: a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region, occurring on a random day of the week.

Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun

Constraints: Minimum 30-minute window.

updateCluster_shardCapacity :: Lens' UpdateCluster (Maybe Int)

The capacity of each shard in the Elastic DocumentDB cluster.

updateCluster_shardCount :: Lens' UpdateCluster (Maybe Int)

The number of shards to create in the Elastic DocumentDB cluster.

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

The number of shards to create in the Elastic DocumentDB cluster.

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

A list of EC2 VPC security groups to associate with the new Elastic DocumentDB cluster.

updateCluster_clusterArn :: Lens' UpdateCluster Text

The arn of the Elastic DocumentDB cluster.

Destructuring the Response

data UpdateClusterResponse

See: newUpdateClusterResponse smart constructor.

Constructors

UpdateClusterResponse'

Fields

• httpStatus :: Int

  The response's http status code.

• cluster :: Cluster

  Returns information about the updated Elastic DocumentDB cluster.

Instances

Generic UpdateClusterResponse

Defined in Amazonka.DocDbElastic.UpdateCluster

Associated Types

type Rep UpdateClusterResponse :: Type -> Type

Methods

from :: UpdateClusterResponse -> Rep UpdateClusterResponse x

to :: Rep UpdateClusterResponse x -> UpdateClusterResponse

Read UpdateClusterResponse

Defined in Amazonka.DocDbElastic.UpdateCluster

Methods

readsPrec :: Int -> ReadS UpdateClusterResponse

readList :: ReadS [UpdateClusterResponse]

readPrec :: ReadPrec UpdateClusterResponse

readListPrec :: ReadPrec [UpdateClusterResponse]

Show UpdateClusterResponse

Defined in Amazonka.DocDbElastic.UpdateCluster

Methods

showsPrec :: Int -> UpdateClusterResponse -> ShowS

show :: UpdateClusterResponse -> String

showList :: [UpdateClusterResponse] -> ShowS

NFData UpdateClusterResponse

Defined in Amazonka.DocDbElastic.UpdateCluster

Methods

rnf :: UpdateClusterResponse -> ()

Eq UpdateClusterResponse

Defined in Amazonka.DocDbElastic.UpdateCluster

Methods

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

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

type Rep UpdateClusterResponse

Defined in Amazonka.DocDbElastic.UpdateCluster

type Rep UpdateClusterResponse = D1 ('MetaData "UpdateClusterResponse" "Amazonka.DocDbElastic.UpdateCluster" "amazonka-docdb-elastic-2.0-7oyCcw7MbTKKNwZE62fvl3" 'False) (C1 ('MetaCons "UpdateClusterResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "cluster") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Cluster)))

newUpdateClusterResponse

Arguments

:: Int

$sel:httpStatus:UpdateClusterResponse'

-> Cluster

$sel:cluster: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:httpStatus:UpdateClusterResponse', updateClusterResponse_httpStatus - The response's http status code.

$sel:cluster:UpdateClusterResponse', updateClusterResponse_cluster - Returns information about the updated Elastic DocumentDB cluster.

Response Lenses

updateClusterResponse_httpStatus :: Lens' UpdateClusterResponse Int

The response's http status code.

updateClusterResponse_cluster :: Lens' UpdateClusterResponse Cluster

Returns information about the updated Elastic DocumentDB cluster.