[ 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
See ‘aws help’ for descriptions of global parameters.
Synopsis¶
create-usage-limit
--amount <value>
[--breach-action <value>]
[--period <value>]
--resource-arn <value>
--usage-type <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <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 | --cli-input-yaml (string)
Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those 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. This may not be specified along with --cli-input-yaml.
--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. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.
See ‘aws help’ for descriptions of global parameters.
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.