[ aws . route53globalresolver ]

get-core-network-endpoint

Description

Retrieves information about a core network endpoint.

Warning

Route 53 Global Resolver is a global service that supports resolvers in multiple Amazon Web Services Regions, but you must specify the US East (Ohio) Region to create, update, or otherwise work with Route 53 Global Resolver resources. That is, for example, specify --region us-east-2 on Amazon Web Services CLI commands.

See also: AWS API Documentation

Synopsis

  get-core-network-endpoint
--core-network-endpoint-id <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]

Options

--core-network-endpoint-id (string) [required]

The unique identifier of the core network endpoint to retrieve information about.

Constraints:

  • min: 1
  • max: 64
  • pattern: [-.a-zA-Z0-9]+

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

arn -> (string)

The Amazon Resource Name (ARN) of the core network endpoint.

Constraints:

  • min: 1
  • max: 2048
  • pattern: arn:[-.a-z0-9]{1,63}:[-.a-z0-9]{1,63}:[-.a-z0-9]{0,63}:[-.a-z0-9]{0,63}:[^/].{0,1023}

availableRegions -> (list)

The Amazon Web Services Regions in which the core network endpoint is available.

(string)

Constraints:

  • min: 0
  • max: 32

coreNetworkArn -> (string)

The Amazon Resource Name (ARN) of the Amazon Web Services Cloud WAN core network connected to the endpoint.

Constraints:

  • min: 1
  • max: 2048
  • pattern: arn:[-.a-z0-9]{1,63}:[-.a-z0-9]{1,63}:[-.a-z0-9]{0,63}:[-.a-z0-9]{0,63}:[^/].{0,1023}

createdAt -> (timestamp)

The date and time when the core network endpoint was created.

globalResolverId -> (string)

The ID of the Route 53 Global Resolver associated with the core network endpoint.

Constraints:

  • min: 1
  • max: 64
  • pattern: [-.a-zA-Z0-9]+

id -> (string)

The unique identifier of the core network endpoint.

Constraints:

  • min: 1
  • max: 64
  • pattern: [-.a-zA-Z0-9]+

ipAddresses -> (list)

The IP addresses that the core network endpoint uses to resolve DNS queries within the Amazon Web Services Cloud WAN core network.

(structure)

A DNS IP address configuration returned for a core network endpoint. Each item describes an IP address that the endpoint uses to receive DNS queries, along with its DNS label and name, and the scope and Amazon Web Services Regions in which the address applies.

ipv4Address -> (string)

The IPv4 address that the core network endpoint uses to receive DNS queries.

Constraints:

  • min: 1
  • max: 15
  • pattern: ((25[0-5]|(2[0-4]|1\d|[1-9]|)\d)\.?\b){4}

ipv6Address -> (string)

The IPv6 address that the core network endpoint uses to receive DNS queries.

Constraints:

  • min: 1
  • max: 39
  • pattern: (?:[A-Fa-f0-9]{0,4}:){2,7}[A-Fa-f0-9]{1,4}

dnsLabel -> (string) [required]

The DNS label associated with the IP address.

Constraints:

  • min: 1
  • max: 32

dnsName -> (string)

The fully qualified DNS name associated with the IP address.

Constraints:

  • min: 1
  • max: 256

regionScope -> (string) [required]

Indicates whether the IP address applies to all Amazon Web Services Regions or only to the specific Regions that you identify. When the value is REGIONAL , the Regions are listed in the regions field.

Possible values:

  • ALL
  • REGIONAL

regions -> (list)

The Amazon Web Services Regions in which the IP address applies when the region scope is REGIONAL .

(string)

Constraints:

  • min: 0
  • max: 32

name -> (string)

The name of the core network endpoint.

Constraints:

  • min: 1
  • max: 64
  • pattern: (?!^[0-9]+$)([a-zA-Z0-9-_/' ']+)

status -> (string)

The current status of the core network endpoint.

Possible values:

  • CREATING
  • OPERATIONAL
  • UPDATING
  • DELETING

updatedAt -> (timestamp)

The date and time when the core network endpoint was last updated.