Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . redshift-serverless ]

create-usage-limit

Description

Creates a usage limit for a specified Amazon Redshift Serverless usage type. The usage limit is identified by the returned usage limit identifier.

See also: AWS API Documentation

Synopsis

  create-usage-limit
--amount <value>
[--breach-action <value>]
[--period <value>]
--resource-arn <value>
--usage-type <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]

Options

--amount (long)

The limit amount. If time-based, this amount is in Redshift Processing Units (RPU) consumed per hour. If data-based, this amount is in terabytes (TB) of data transferred between Regions in cross-account sharing. The value must be a positive number.

--breach-action (string)

The action that Amazon Redshift Serverless takes when the limit is reached. The default is log.

Possible values:

• log
• emit-metric
• deactivate

--period (string)

The time period that the amount applies to. A weekly period begins on Sunday. The default is monthly.

Possible values:

• daily
• weekly
• monthly

--resource-arn (string)

The Amazon Resource Name (ARN) of the Amazon Redshift Serverless resource to create the usage limit for.

--usage-type (string)

The type of Amazon Redshift Serverless usage to create a usage limit for.

Possible values:

• serverless-compute
• cross-region-datasharing

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command's default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination.

--output (string)

The formatting style for command output.

• json
• text
• table

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

• on
• off
• auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

Output

usageLimit -> (structure)

The returned usage limit object.

amount -> (long)

The limit amount. If time-based, this amount is in RPUs consumed per hour. If data-based, this amount is in terabytes (TB). The value must be a positive number.

breachAction -> (string)

The action that Amazon Redshift Serverless takes when the limit is reached.

period -> (string)

The time period that the amount applies to. A weekly period begins on Sunday. The default is monthly.

resourceArn -> (string)

The Amazon Resource Name (ARN) that identifies the Amazon Redshift Serverless resource.

usageLimitArn -> (string)

The Amazon Resource Name (ARN) of the resource associated with the usage limit.

usageLimitId -> (string)

The identifier of the usage limit.

usageType -> (string)

The Amazon Redshift Serverless feature to limit.