[ aws . ec2 ]

modify-networking-flex-cost-allocation-policy

Description

Modifies a flex cost allocation policy. Changing a policy document or ShowBackEnabled creates a new version of the policy. Changing only the description doesn’t create a new version.

A policy can have up to 100 versions. Versions are never removed, so after a policy reaches 100 versions, you can’t change its policy document or ShowBackEnabled . Policies that are managed by a declarative policy aren’t subject to this limit.

See also: AWS API Documentation

Synopsis

  modify-networking-flex-cost-allocation-policy
--fca-policy-id <value>
[--nat-fca-policy-document <value>]
[--instance-fca-policy-document <value>]
[--pcx-fca-policy-document <value>]
[--show-back-enabled | --no-show-back-enabled]
[--description <value>]
[--client-token <value>]
[--dry-run | --no-dry-run]
[--cli-input-json | --cli-input-yaml]
[--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>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]
[--cli-error-format <value>]
[--help]

Options

--fca-policy-id (string) [required]

The ID of the flex cost allocation policy to modify. This parameter is required.

Constraints:

• min: 22
• max: 22
• pattern: fcap-[a-f0-9]{17}

--nat-fca-policy-document (structure)

The updated policy document that defines cost allocation for NAT gateways.

ReportingGranularity -> (list) [required]

The resource granularity level at which networking costs are allocated. This parameter is required. Specify exactly one value. Valid values are eni , ec2 , subnet , vpc , account , and cidr .

Constraints:

• min: 1
• max: 1

(string)

The resource granularity level at which networking costs are allocated. Valid values are eni , ec2 , subnet , vpc , account , peering-id , and cidr .

Which values you can use depends on the policy document. peering-id is valid only in a PcxFcaPolicyDocument .

Possible values:

• eni
• ec2
• subnet
• vpc
• account
• peering-id
• cidr

Dimensions -> (list) [required]

The cost dimensions to report. This parameter is required. Valid values are data-transfer and data-processing .

Constraints:

• min: 1
• max: 2

(string)

A cost dimension used for allocation. Valid values are data-transfer and data-processing . data-processing is valid only in a NatFcaPolicyDocument .

Possible values:

• data-transfer
• data-processing

CidrRangeSpecifications -> (structure)

The CIDR range mappings to use for cost allocation. Specify this value when ReportingGranularity is cidr , and omit it otherwise.

PrefixesType -> (string) [required]

The type of prefixes to use. This parameter is required. Valid values are source-prefixes and destination-prefixes .

Constraints:

• min: 1
• max: 64

Prefixes -> (list) [required]

The CIDR range to label mappings. You can specify from 1 to 100 mappings. This parameter is required.

Constraints:

• min: 1
• max: 100

(structure)

Maps a CIDR range to a label for cost allocation reporting.

CidrRange -> (string) [required]

The CIDR range. This parameter is required.

Constraints:

• min: 1
• max: 43

CidrLabel -> (string) [required]

The label to assign to the CIDR range. The label can be up to 64 characters long. It can contain letters, numbers, hyphens (- ), and underscores (_ ), and must start with a letter or a number. This parameter is required.

Constraints:

• min: 1
• max: 64
• pattern: [a-zA-Z0-9][a-zA-Z0-9_\-]{0,63}

JSON Syntax:

{
  "ReportingGranularity": ["eni"|"ec2"|"subnet"|"vpc"|"account"|"peering-id"|"cidr", ...],
  "Dimensions": ["data-transfer"|"data-processing", ...],
  "CidrRangeSpecifications": {
    "PrefixesType": "string",
    "Prefixes": [
      {
        "CidrRange": "string",
        "CidrLabel": "string"
      }
      ...
    ]
  }
}

--instance-fca-policy-document (structure)

The updated policy document that defines cost allocation for EC2 instances.

ReportingGranularity -> (list) [required]

The resource granularity level at which networking costs are allocated. This parameter is required. Specify exactly one value. Valid values are eni , ec2 , subnet , vpc , account , and cidr .

Constraints:

• min: 1
• max: 1

(string)

The resource granularity level at which networking costs are allocated. Valid values are eni , ec2 , subnet , vpc , account , peering-id , and cidr .

Which values you can use depends on the policy document. peering-id is valid only in a PcxFcaPolicyDocument .

Possible values:

• eni
• ec2
• subnet
• vpc
• account
• peering-id
• cidr

Dimensions -> (list) [required]

The cost dimensions to report. This parameter is required. The only valid value is data-transfer .

Constraints:

• min: 1
• max: 2

(string)

A cost dimension used for allocation. Valid values are data-transfer and data-processing . data-processing is valid only in a NatFcaPolicyDocument .

Possible values:

• data-transfer
• data-processing

CidrRangeSpecifications -> (structure)

The CIDR range mappings to use for cost allocation. Specify this value when ReportingGranularity is cidr , and omit it otherwise.

PrefixesType -> (string) [required]

The type of prefixes to use. This parameter is required. Valid values are source-prefixes and destination-prefixes .

Constraints:

• min: 1
• max: 64

Prefixes -> (list) [required]

The CIDR range to label mappings. You can specify from 1 to 100 mappings. This parameter is required.

Constraints:

• min: 1
• max: 100

(structure)

Maps a CIDR range to a label for cost allocation reporting.

CidrRange -> (string) [required]

The CIDR range. This parameter is required.

Constraints:

• min: 1
• max: 43

CidrLabel -> (string) [required]

The label to assign to the CIDR range. The label can be up to 64 characters long. It can contain letters, numbers, hyphens (- ), and underscores (_ ), and must start with a letter or a number. This parameter is required.

Constraints:

• min: 1
• max: 64
• pattern: [a-zA-Z0-9][a-zA-Z0-9_\-]{0,63}

JSON Syntax:

{
  "ReportingGranularity": ["eni"|"ec2"|"subnet"|"vpc"|"account"|"peering-id"|"cidr", ...],
  "Dimensions": ["data-transfer"|"data-processing", ...],
  "CidrRangeSpecifications": {
    "PrefixesType": "string",
    "Prefixes": [
      {
        "CidrRange": "string",
        "CidrLabel": "string"
      }
      ...
    ]
  }
}

--pcx-fca-policy-document (structure)

The updated policy document that defines cost allocation for Amazon VPC peering connections.

ReportingGranularity -> (list) [required]

The resource granularity level at which networking costs are allocated. This parameter is required. Specify exactly one value. Valid values are eni , ec2 , subnet , vpc , account , peering-id , and cidr .

Constraints:

• min: 1
• max: 1

(string)

The resource granularity level at which networking costs are allocated. Valid values are eni , ec2 , subnet , vpc , account , peering-id , and cidr .

Which values you can use depends on the policy document. peering-id is valid only in a PcxFcaPolicyDocument .

Possible values:

• eni
• ec2
• subnet
• vpc
• account
• peering-id
• cidr

Dimensions -> (list) [required]

The cost dimensions to report. This parameter is required. The only valid value is data-transfer .

Constraints:

• min: 1
• max: 2

(string)

A cost dimension used for allocation. Valid values are data-transfer and data-processing . data-processing is valid only in a NatFcaPolicyDocument .

Possible values:

• data-transfer
• data-processing

CidrRangeSpecifications -> (structure)

The CIDR range mappings to use for cost allocation. Specify this value when ReportingGranularity is cidr , and omit it otherwise.

PrefixesType -> (string) [required]

The type of prefixes to use. This parameter is required. Valid values are source-prefixes and destination-prefixes .

Constraints:

• min: 1
• max: 64

Prefixes -> (list) [required]

The CIDR range to label mappings. You can specify from 1 to 100 mappings. This parameter is required.

Constraints:

• min: 1
• max: 100

(structure)

Maps a CIDR range to a label for cost allocation reporting.

CidrRange -> (string) [required]

The CIDR range. This parameter is required.

Constraints:

• min: 1
• max: 43

CidrLabel -> (string) [required]

The label to assign to the CIDR range. The label can be up to 64 characters long. It can contain letters, numbers, hyphens (- ), and underscores (_ ), and must start with a letter or a number. This parameter is required.

Constraints:

• min: 1
• max: 64
• pattern: [a-zA-Z0-9][a-zA-Z0-9_\-]{0,63}

JSON Syntax:

{
  "ReportingGranularity": ["eni"|"ec2"|"subnet"|"vpc"|"account"|"peering-id"|"cidr", ...],
  "Dimensions": ["data-transfer"|"data-processing", ...],
  "CidrRangeSpecifications": {
    "PrefixesType": "string",
    "Prefixes": [
      {
        "CidrRange": "string",
        "CidrLabel": "string"
      }
      ...
    ]
  }
}

--show-back-enabled | --no-show-back-enabled (boolean)

Specifies whether showback reporting is enabled for the policy. If you omit this parameter, the current setting is unchanged.

--description (string)

A description for the policy. The description can be up to 1024 characters long.

--client-token (string)

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring idempotency .

--dry-run | --no-dry-run (boolean)

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation . Otherwise, it is UnauthorizedOperation .

--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.

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. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

• json
• text
• table
• yaml
• yaml-stream
• off

--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.

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

• base64
• raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input parameters.

--cli-error-format (string)

The formatting style for error output. By default, errors are displayed in enhanced format.

• legacy
• json
• yaml
• text
• table
• enhanced

--help (boolean)

Display help for the command/subcommand.

Output

FcaPolicyId -> (string)

The ID of the flex cost allocation policy.

Constraints:

• min: 22
• max: 22
• pattern: fcap-[a-f0-9]{17}

UpdatedAt -> (timestamp)

The date and time when the policy was updated.

Version -> (integer)

The version number of the policy that this modification created.

Constraints:

• min: 1
• max: 2147483647

VersionExpectedEffectiveAt -> (timestamp)

The date and time when the new version of the policy is expected to apply to network traffic.