[ aws . ec2 ]

associate-networking-flex-cost-allocation-policy

Description

Associates a flex cost allocation policy with one or more network resources. You can associate the policy directly with specific resources by resource ID, or you can associate it with a scope of resources in an account, Amazon VPC, or subnet.

The following limits apply:

  • A request can associate up to 20 resources.
  • A policy can have up to 100 active associations.
  • A network resource can have only one active association, across all policies. If a resource is already associated, the response includes it in the failures with the code ResourceAlreadyAssociated .

See also: AWS API Documentation

Synopsis

  associate-networking-flex-cost-allocation-policy
--fca-policy-id <value>
[--network-resource-ids <value>]
[--network-resource-scope <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 associate. This parameter is required.

Constraints:

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

--network-resource-ids (list)

The IDs of the network resources to associate with the policy. You can specify from 1 to 20 resource IDs.

You must specify NetworkResourceIds , NetworkResourceScope , or both. A request can include at most 20 distinct resources in total.

Constraints:

  • min: 1
  • max: 20

(string)

Syntax:

"string" "string" ...

--network-resource-scope (structure)

The scope of network resources to associate with the policy. Use a scope to associate the policy with the resources in an account, Amazon VPC, or subnet.

You must specify NetworkResourceScope , NetworkResourceIds , or both.

ResourceType -> (string) [required]

The type of scope. This parameter is required. Valid values are account , vpc , and subnet .

Possible values:

  • account
  • vpc
  • subnet

ResourceIds -> (list) [required]

The IDs of the resources owned by you that define the scope. You can specify from 1 to 20 IDs. This parameter is required.

Constraints:

  • min: 1
  • max: 20

(string)

Shorthand Syntax:

ResourceType=string,ResourceIds=string,string

JSON Syntax:

{
  "ResourceType": "account"|"vpc"|"subnet",
  "ResourceIds": ["string", ...]
}

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

FcaPolicyAssociations -> (list)

Information about the policy associations that were created.

(structure)

Describes an association between a flex cost allocation policy and a network resource.

FcaPolicyAssociationId -> (string)

The ID of the policy association.

Constraints:

  • min: 27
  • max: 27
  • pattern: fcapassoc-[a-f0-9]{17}

FcaPolicyId -> (string)

The ID of the policy.

Constraints:

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

NetworkResourceId -> (string)

The ID of the associated network resource.

OwnerAccount -> (string)

The ID of the account that owns the association.

AssociatedAt -> (timestamp)

The date and time when the association was created.

ExpectedEffectiveAt -> (timestamp)

The date and time when the association is expected to apply to network traffic.

AssociationMode -> (string)

The mode of the association. Valid values:

  • direct - The policy is associated with specific resources by resource ID.
  • scope - The policy is associated with a scope of resources in an account, Amazon VPC, or subnet.

Possible values:

  • direct
  • scope

ManagedBy -> (string)

The entity that manages the association. Valid values are:

  • account - The account that owns the association created it.
  • declarative-policy - An Amazon Web Services Organizations declarative policy created the association. You can’t remove the association.

Possible values:

  • account
  • declarative-policy

FcaPolicyAssociationFailures -> (list)

Information about the network resources that could not be associated with the policy.

(structure)

Describes a policy, association, or network resource that a Networking Flexible Cost Allocation operation failed to process.

ResourceId -> (string)

The ID of the resource that could not be processed.

FailureCode -> (string)

The code that identifies the type of failure. Possible values are:

  • ResourceNotFound - (DeleteNetworkingFlexCostAllocationPolicies ) The policy doesn’t exist or isn’t owned by your account.
  • InvalidResourceState - (DeleteNetworkingFlexCostAllocationPolicies ) The policy has active associations.
  • InvalidResource - (AssociateNetworkingFlexCostAllocationPolicy ) The resource ID is malformed, the resource type doesn’t match the policy, or the scope is an account other than yours. (DisassociateNetworkingFlexCostAllocationPolicy ) The association doesn’t exist or was already removed.
  • ResourceAlreadyAssociated - (AssociateNetworkingFlexCostAllocationPolicy ) The resource already has an active association.
  • InternalError - An internal error occurred. Retry the request.

FailureReason -> (string)

The reason for the failure.