[ aws . apigateway ]

update-domain-name

Description

Changes information about the DomainName resource.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  update-domain-name
--domain-name <value>
[--patch-operations <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--cli-auto-prompt <value>]

Options

--domain-name (string)

[Required] The name of the DomainName resource to be changed.

--patch-operations (list)

A list of update operations to be applied to the specified resource and in the order specified in this list.

(structure)

A single patch operation to apply to the specified resource. Please refer to http://tools.ietf.org/html/rfc6902#section-4 for an explanation of how each operation is used.

op -> (string)

An update operation to be performed with this PATCH request. The valid value can be add , remove , replace or copy . Not all valid operations are supported for a given resource. Support of the operations depends on specific operational contexts. Attempts to apply an unsupported operation on a resource will return an error message.

path -> (string)

The op operation’s target, as identified by a JSON Pointer value that references a location within the targeted resource. For example, if the target resource has an updateable property of {"name":"value"} , the path for this property is /name . If the name property value is a JSON object (e.g., {"name": {"child/name": "child-value"}} ), the path for the child/name property will be /name/child~1name . Any slash (“/”) character appearing in path names must be escaped with “~1”, as shown in the example above. Each op operation can have only one path associated with it.

value -> (string)

The new target value of the update operation. It is applicable for the add or replace operation. When using AWS CLI to update a property of a JSON value, enclose the JSON object with a pair of single quotes in a Linux shell, e.g., ‘{“a”: …}’. In a Windows shell, see Using JSON for Parameters .

from -> (string)

The copy update operation’s source as identified by a JSON-Pointer value referencing the location within the targeted resource to copy the value from. For example, to promote a canary deployment, you copy the canary deployment ID to the affiliated deployment ID by calling a PATCH request on a Stage resource with "op":"copy" , "from":"/canarySettings/deploymentId" and "path":"/deploymentId" .

Shorthand Syntax:

op=string,path=string,value=string,from=string ...

JSON Syntax:

[
  {
    "op": "add"|"remove"|"replace"|"move"|"copy"|"test",
    "path": "string",
    "value": "string",
    "from": "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.

--cli-auto-prompt (boolean) Automatically prompt for CLI input parameters.

See ‘aws help’ for descriptions of global parameters.

Examples

To change the certificate name for a custom domain name

The following update-domain-name example changes the certificate name for a custom domain.

aws apigateway update-domain-name \
    --domain-name api.domain.tld \
    --patch-operations op='replace',path='/certificateArn',value='arn:aws:acm:us-west-2:111122223333:certificate/CERTEXAMPLE123EXAMPLE'

Output:

{
    "domainName": "api.domain.tld",
    "distributionDomainName": "d123456789012.cloudfront.net",
    "certificateArn": "arn:aws:acm:us-west-2:111122223333:certificate/CERTEXAMPLE123EXAMPLE",
    "certificateUploadDate": 1462565487
}

For more information, see Set up Custom Domain Name for an API in API Gateway in the Amazon API Gateway Developer Guide.

Output

domainName -> (string)

The custom domain name as an API host name, for example, my-api.example.com .

certificateName -> (string)

The name of the certificate that will be used by edge-optimized endpoint for this domain name.

certificateArn -> (string)

The reference to an AWS-managed certificate that will be used by edge-optimized endpoint for this domain name. AWS Certificate Manager is the only supported source.

certificateUploadDate -> (timestamp)

The timestamp when the certificate that was used by edge-optimized endpoint for this domain name was uploaded.

regionalDomainName -> (string)

The domain name associated with the regional endpoint for this custom domain name. You set up this association by adding a DNS record that points the custom domain name to this regional domain name. The regional domain name is returned by API Gateway when you create a regional endpoint.

regionalHostedZoneId -> (string)

The region-specific Amazon Route 53 Hosted Zone ID of the regional endpoint. For more information, see Set up a Regional Custom Domain Name and AWS Regions and Endpoints for API Gateway .

regionalCertificateName -> (string)

The name of the certificate that will be used for validating the regional domain name.

regionalCertificateArn -> (string)

The reference to an AWS-managed certificate that will be used for validating the regional domain name. AWS Certificate Manager is the only supported source.

distributionDomainName -> (string)

The domain name of the Amazon CloudFront distribution associated with this custom domain name for an edge-optimized endpoint. You set up this association when adding a DNS record pointing the custom domain name to this distribution name. For more information about CloudFront distributions, see the Amazon CloudFront documentation .

distributionHostedZoneId -> (string)

The region-agnostic Amazon Route 53 Hosted Zone ID of the edge-optimized endpoint. The valid value is Z2FDTNDATAQYW2 for all the regions. For more information, see Set up a Regional Custom Domain Name and AWS Regions and Endpoints for API Gateway .

endpointConfiguration -> (structure)

The endpoint configuration of this DomainName showing the endpoint types of the domain name.

types -> (list)

A list of endpoint types of an API ( RestApi ) or its custom domain name ( DomainName ). For an edge-optimized API and its custom domain name, the endpoint type is "EDGE" . For a regional API and its custom domain name, the endpoint type is REGIONAL . For a private API, the endpoint type is PRIVATE .

(string)

The endpoint type. The valid values are EDGE for edge-optimized API setup, most suitable for mobile applications; REGIONAL for regional API endpoint setup, most suitable for calling from AWS Region; and PRIVATE for private APIs.

vpcEndpointIds -> (list)

A list of VpcEndpointIds of an API ( RestApi ) against which to create Route53 ALIASes. It is only supported for PRIVATE endpoint type.

(string)

domainNameStatus -> (string)

The status of the DomainName migration. The valid values are AVAILABLE and UPDATING . If the status is UPDATING , the domain cannot be modified further until the existing operation is complete. If it is AVAILABLE , the domain can be updated.

domainNameStatusMessage -> (string)

An optional text message containing detailed information about status of the DomainName migration.

securityPolicy -> (string)

The Transport Layer Security (TLS) version + cipher suite for this DomainName . The valid values are TLS_1_0 and TLS_1_2 .

tags -> (map)

The collection of tags. Each tag element is associated with a given resource.

key -> (string)

value -> (string)