Skip to content

Changes information about the DomainName resource

Description

Changes information about the DomainName resource.

Usage

apigateway_update_domain_name(domainName, domainNameId, patchOperations)

Arguments

  • domainName

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

  • domainNameId

    The identifier for the domain name resource. Supported only for private custom domain names.

  • patchOperations

    For more information about supported patch operations, see Patch Operations.

Value

A list with the following syntax:

list(
  domainName = "string",
  domainNameId = "string",
  domainNameArn = "string",
  certificateName = "string",
  certificateArn = "string",
  certificateUploadDate = as.POSIXct(
    "2015-01-01"
  ),
  regionalDomainName = "string",
  regionalHostedZoneId = "string",
  regionalCertificateName = "string",
  regionalCertificateArn = "string",
  distributionDomainName = "string",
  distributionHostedZoneId = "string",
  endpointConfiguration = list(
    types = list(
      "REGIONAL"|"EDGE"|"PRIVATE"
    ),
    ipAddressType = "ipv4"|"dualstack",
    vpcEndpointIds = list(
      "string"
    )
  ),
  domainNameStatus = "AVAILABLE"|"UPDATING"|"PENDING"|"PENDING_CERTIFICATE_REIMPORT"|"PENDING_OWNERSHIP_VERIFICATION"|"FAILED",
  domainNameStatusMessage = "string",
  securityPolicy = "TLS_1_0"|"TLS_1_2"|"SecurityPolicy_TLS13_1_3_2025_09"|"SecurityPolicy_TLS13_1_3_FIPS_2025_09"|"SecurityPolicy_TLS13_1_2_PFS_PQ_2025_09"|"SecurityPolicy_TLS13_1_2_FIPS_PQ_2025_09"|"SecurityPolicy_TLS13_1_2_FIPS_PFS_PQ_2025_09"|"SecurityPolicy_TLS13_1_2_Ext2_PQ_2025_09"|"SecurityPolicy_TLS13_1_2_Ext2_FIPS_PQ_2025_09"|"SecurityPolicy_TLS13_1_2_PQ_2025_09"|"SecurityPolicy_TLS13_1_2_2021_06"|"SecurityPolicy_TLS13_2025_EDGE"|"SecurityPolicy_TLS12_PFS_2025_EDGE"|"SecurityPolicy_TLS12_2018_EDGE",
  endpointAccessMode = "BASIC"|"STRICT",
  tags = list(
    "string"
  ),
  mutualTlsAuthentication = list(
    truststoreUri = "string",
    truststoreVersion = "string",
    truststoreWarnings = list(
      "string"
    )
  ),
  ownershipVerificationCertificateArn = "string",
  managementPolicy = "string",
  policy = "string",
  routingMode = "BASE_PATH_MAPPING_ONLY"|"ROUTING_RULE_ONLY"|"ROUTING_RULE_THEN_BASE_PATH_MAPPING"
)

Request syntax

svc$update_domain_name(
  domainName = "string",
  domainNameId = "string",
  patchOperations = list(
    list(
      op = "add"|"remove"|"replace"|"move"|"copy"|"test",
      path = "string",
      value = "string",
      from = "string"
    )
  )
)