Skip to content

Describe Custom Domains

apprunner_describe_custom_domains R Documentation

Return a description of custom domain names that are associated with an App Runner service

Description

Return a description of custom domain names that are associated with an App Runner service.

Usage

apprunner_describe_custom_domains(ServiceArn, NextToken, MaxResults)

Arguments

ServiceArn

[required] The Amazon Resource Name (ARN) of the App Runner service that you want associated custom domain names to be described for.

NextToken

A token from a previous result page. It's used for a paginated request. The request retrieves the next result page. All other parameter values must be identical to the ones that are specified in the initial request.

If you don't specify NextToken, the request retrieves the first result page.

MaxResults

The maximum number of results that each response (result page) can include. It's used for a paginated request.

If you don't specify MaxResults, the request retrieves all available results in a single response.

Value

A list with the following syntax:

list(
  DNSTarget = "string",
  ServiceArn = "string",
  CustomDomains = list(
    list(
      DomainName = "string",
      EnableWWWSubdomain = TRUE|FALSE,
      CertificateValidationRecords = list(
        list(
          Name = "string",
          Type = "string",
          Value = "string",
          Status = "PENDING_VALIDATION"|"SUCCESS"|"FAILED"
        )
      ),
      Status = "CREATING"|"CREATE_FAILED"|"ACTIVE"|"DELETING"|"DELETE_FAILED"|"PENDING_CERTIFICATE_DNS_VALIDATION"|"BINDING_CERTIFICATE"
    )
  ),
  VpcDNSTargets = list(
    list(
      VpcIngressConnectionArn = "string",
      VpcId = "string",
      DomainName = "string"
    )
  ),
  NextToken = "string"
)

Request syntax

svc$describe_custom_domains(
  ServiceArn = "string",
  NextToken = "string",
  MaxResults = 123
)