Creates a health check source, which defines the virtual private cloud (VPC), subnets, and security groups from which Route 53 sends private endpoint health check requests. To use this operation, you must have the route53:CreateHealthCheckSource permission. You must also have permission to create a service-linked role.
Specify a VPC, one subnet in each Availability Zone that Route 53 uses for private endpoint health checks in the Amazon Web Services Region, and one or more security groups for each subnet. The security groups must allow outbound traffic to the endpoints that you want to check.
Route 53 creates a health check source asynchronously, and the initial HealthCheckSourceStatus is CREATE_PENDING . Call GetHealthCheckSource until the status is CREATE_COMPLETED before you create health checks that use the source. You can’t change the configuration of a health check source after you create it.
If AWS Identity and Access Management (IAM) is still deleting the Route 53 service-linked role for your account, the request fails with InvalidInput . Retry after the deletion completes.
See also: AWS API Documentation
create-health-check-source
[--caller-reference <value>]
--health-check-source-config <value>
[--tags <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]
--caller-reference (string)
A unique, case-sensitive identifier that ensures that the operation completes no more than one time. If you retry a
CreateHealthCheckSourcerequest with the sameCallerReferenceand the same settings as a previous request, Route 53 returns the existing health check source without creating a duplicate. If that health check source has a status ofCREATE_FAILED, Route 53 tries to create it again. To create a new health check source after a failure, specify a new value forCallerReference. If a health check source with the sameCallerReferencealready exists and the settings differ, Route 53 returns aHealthCheckSourceAlreadyExistserror.Constraints:
- min:
1- max:
64
--health-check-source-config (structure) [required]
A complex type that contains the virtual private cloud (VPC), subnets, and security groups for the health check source.
VpcId -> (string) [required]
The ID of the virtual private cloud (VPC) that contains the subnets for the health check source. All subnets in
SubnetConfigurationListmust belong to this VPC.Constraints:
- max:
1024SubnetConfigurationList -> (list) [required]
A complex type that contains two or three
SubnetConfigurationelements, one in each Availability Zone that Route 53 uses for private endpoint health checks in the Amazon Web Services Region. The Availability Zones must be distinct. Route 53 creates network interfaces in each subnet and sends health check requests from all of them.Constraints:
- min:
2- max:
3(structure)
A complex type that identifies one subnet for a health check source and the security groups that Route 53 associates with the network interfaces that it creates in that subnet.
SubnetId -> (string) [required]
The ID of the subnet that Route 53 uses to send health check requests.
Constraints:
- min:
1- max:
64AvailabilityZoneId -> (string) [required]
The ID of the Availability Zone that contains the subnet, for example
use1-az1. Specify the Availability Zone ID, not the Availability Zone name.Constraints:
- min:
1- max:
64SecurityGroupIdList -> (list) [required]
The IDs of the security groups in the same virtual private cloud (VPC) to associate with the network interfaces that Route 53 creates in this subnet. The security groups must allow outbound traffic to the endpoints that the health checks monitor.
Constraints:
- min:
1- max:
10(string)
Constraints:
- min:
1- max:
64
JSON Syntax:
{
"VpcId": "string",
"SubnetConfigurationList": [
{
"SubnetId": "string",
"AvailabilityZoneId": "string",
"SecurityGroupIdList": ["string", ...]
}
...
]
}
--tags (list)
A complex type that contains a list of the tags that you want to apply to the health check source when you create it.
Constraints:
- min:
1- max:
10(structure)
A complex type that contains information about a tag that you want to add or edit for the specified health check or hosted zone.
Key -> (string)
The value of
Keydepends on the operation that you want to perform:
- Add a tag to a health check or hosted zone :
Keyis the name that you want to give the new tag.- Edit a tag :
Keyis the name of the tag that you want to change theValuefor.- Delete a key :
Keyis the name of the tag you want to remove.- Give a name to a health check : Edit the default
Nametag. In the Amazon Route 53 console, the list of your health checks includes a Name column that lets you see the name that you’ve given to each health check.Constraints:
- max:
128Value -> (string)
The value of
Valuedepends on the operation that you want to perform:
- Add a tag to a health check or hosted zone :
Valueis the value that you want to give the new tag.- Edit a tag :
Valueis the new value that you want to assign the tag.Constraints:
- max:
256
Shorthand Syntax:
Key=string,Value=string ...
JSON Syntax:
[
{
"Key": "string",
"Value": "string"
}
...
]
--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.
HealthCheckSourceId -> (string)
The ID of the new health check source. Route 53 assigns this ID when it creates the source.
Constraints:
- min:
1- max:
64
HealthCheckSourceStatus -> (string)
The current status of the health check source. Immediately after you create a health check source, the status is
CREATE_PENDING. If the request is a retry with the sameCallerReference, the status is the current status of the existing health check source.Possible values:
CREATE_PENDINGCREATE_IN_PROGRESSCREATE_COMPLETEDCREATE_FAILEDDELETE_PENDINGDELETE_IN_PROGRESSDELETE_COMPLETEDDELETE_FAILED
Location -> (string)
The unique URL representing the new health check source.
Constraints:
- max:
1024