[ aws . route53profiles ]
Associates a Route 53 Profiles profile with a VPC. A VPC can have up to two Profile associations. A Profile can be associated with up to 1,000 VPCs, and you can request a higher quota for the number of VPCs. For more information, see Quotas on Route 53 Profiles .
Route 53 VPC Resolver evaluates the Profile associations for a VPC in priority order, starting with the lowest Priority value. If the VPC has no other Profile associations, you can omit Priority , and the association gets priority 100. When the VPC already has a Profile association, you must specify a Priority , and each Profile association for the VPC must have a unique priority. To change the priority of an existing association, use UpdateProfileAssociation .
The request fails with a ValidationException in these cases:
Priority , and the VPC already has a Profile association.Name or Priority . To change the priority, use UpdateProfileAssociation .The request fails with a LimitExceededException if the VPC already has the maximum number of Profile associations.
See also: AWS API Documentation
associate-profile
--profile-id <value>
--resource-id <value>
--name <value>
[--tags <value>]
[--priority <value>]
[--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]
--profile-id (string) [required]
ID of the Profile.
Constraints:
- min:
1- max:
64
--resource-id (string) [required]
The ID of the VPC.
Constraints:
- min:
1- max:
64
--name (string) [required]
A name for the association.
Constraints:
- min:
0- max:
64- pattern:
(?!^[0-9]+$)([a-zA-Z0-9\-_' ']+)
--tags (list)
A list of the tag keys and values that you want to identify the Profile association.
Constraints:
- min:
0- max:
200(structure)
Tag for the Profile.
Key -> (string) [required]
Key associated with the
Tag.Constraints:
- min:
1- max:
128Value -> (string) [required]
Value for the Tag.
Constraints:
- min:
0- max:
256
Shorthand Syntax:
Key=string,Value=string ...
JSON Syntax:
[
{
"Key": "string",
"Value": "string"
}
...
]
--priority (integer)
The priority of the Profile association. Route 53 VPC Resolver evaluates the Profile associations for a VPC in priority order, starting with the lowest value.
When the VPC already has a Profile association, you must specify a priority that no other Profile association for the VPC uses. If you omit the priority for the first association with a VPC, the association gets priority 100.
Constraints:
- min:
100- max:
9900
--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.
--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.
--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.
--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.
--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.
--help (boolean)
Display help for the command/subcommand.
To use the following examples, you must have the AWS CLI installed and configured. See the Getting started guide in the AWS CLI User Guide for more information.
Unless otherwise stated, all examples have unix-like quotation rules. These examples will need to be adapted to your terminal’s quoting rules. See Using quotation marks with strings in the AWS CLI User Guide .
To associate a Profile
The following associate-profile example associates a Profile to a VPC.
aws route53profiles associate-profile \
--name test-association \
--profile-id rp-4987774726example \
--resource-id vpc-0af3b96b3example
Output:
{
"ProfileAssociation": {
"CreationTime": 1710851336.527,
"Id": "rpassoc-489ce212fexample",
"ModificationTime": 1710851336.527,
"Name": "test-association",
"OwnerId": "123456789012",
"ProfileId": "rp-4987774726example",
"ResourceId": "vpc-0af3b96b3example",
"Status": "CREATING",
"StatusMessage": "Creating Profile Association"
}
}
For more information, see Using Profiles in the Amazon Route 53 Developer Guide.
ProfileAssociation -> (structure)
The association that you just created. The association has an ID that you can use to identify it in other requests, such as update and delete.
Id -> (string)
ID of the Profile association.
Constraints:
- min:
1- max:
64Name -> (string)
Name of the Profile association.
Constraints:
- min:
0- max:
64- pattern:
(?!^[0-9]+$)([a-zA-Z0-9\-_' ']+)OwnerId -> (string)
Amazon Web Services account ID of the Profile association owner.
Constraints:
- min:
12- max:
32ProfileId -> (string)
ID of the Profile.
Constraints:
- min:
1- max:
64ResourceId -> (string)
The Amazon Resource Name (ARN) of the VPC.
Constraints:
- min:
1- max:
64Status -> (string)
Status of the Profile association.
Possible values:
COMPLETEDELETINGUPDATINGCREATINGDELETEDFAILEDStatusMessage -> (string)
Additional information about the Profile association.CreationTime -> (timestamp)
The date and time that the Profile association was created, in Unix time format and Coordinated Universal Time (UTC).ModificationTime -> (timestamp)
The date and time that the Profile association was modified, in Unix time format and Coordinated Universal Time (UTC).Priority -> (integer)
The priority of the Profile association. Route 53 VPC Resolver evaluates the Profile associations for a VPC in priority order, starting with the lowest value. Associations created without a priority have priority 100.
Constraints:
- min:
100- max:
9900