1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. apigateway
  5. getDomainNameV2

We recommend new projects start with resources from the AWS provider.

Viewing docs for AWS Cloud Control v1.59.0
published on Monday, Mar 30, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-aws-native

aws-native.apigateway.getDomainNameV2

aws-native logo

We recommend new projects start with resources from the AWS provider.

Viewing docs for AWS Cloud Control v1.59.0
published on Monday, Mar 30, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-aws-native

    Resource Type definition for AWS::ApiGateway::DomainNameV2.

    Using getDomainNameV2

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getDomainNameV2(args: GetDomainNameV2Args, opts?: InvokeOptions): Promise<GetDomainNameV2Result>
function getDomainNameV2Output(args: GetDomainNameV2OutputArgs, opts?: InvokeOptions): Output<GetDomainNameV2Result>
    def get_domain_name_v2(domain_name_arn: Optional[str] = None,
                       opts: Optional[InvokeOptions] = None) -> GetDomainNameV2Result
def get_domain_name_v2_output(domain_name_arn: Optional[pulumi.Input[str]] = None,
                       opts: Optional[InvokeOptions] = None) -> Output[GetDomainNameV2Result]
    func LookupDomainNameV2(ctx *Context, args *LookupDomainNameV2Args, opts ...InvokeOption) (*LookupDomainNameV2Result, error)
func LookupDomainNameV2Output(ctx *Context, args *LookupDomainNameV2OutputArgs, opts ...InvokeOption) LookupDomainNameV2ResultOutput

    > Note: This function is named LookupDomainNameV2 in the Go SDK.

    public static class GetDomainNameV2 
{
    public static Task<GetDomainNameV2Result> InvokeAsync(GetDomainNameV2Args args, InvokeOptions? opts = null)
    public static Output<GetDomainNameV2Result> Invoke(GetDomainNameV2InvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetDomainNameV2Result> getDomainNameV2(GetDomainNameV2Args args, InvokeOptions options)
public static Output<GetDomainNameV2Result> getDomainNameV2(GetDomainNameV2Args args, InvokeOptions options)

    fn::invoke:
  function: aws-native:apigateway:getDomainNameV2
  arguments:
    # arguments dictionary

    The following arguments are supported:

    DomainNameArn string
    The amazon resource name (ARN) of the domain name resource.
    DomainNameArn string
    The amazon resource name (ARN) of the domain name resource.
    domainNameArn String
    The amazon resource name (ARN) of the domain name resource.
    domainNameArn string
    The amazon resource name (ARN) of the domain name resource.
    domain_name_arn str
    The amazon resource name (ARN) of the domain name resource.
    domainNameArn String
    The amazon resource name (ARN) of the domain name resource.

    getDomainNameV2 Result

    The following output properties are available:

    CertificateArn string
    The reference to an AWS -managed certificate that will be used by the private endpoint for this domain name. AWS Certificate Manager is the only supported source.
    DomainNameArn string
    The amazon resource name (ARN) of the domain name resource.
    DomainNameId string
    The domain name ID.
    EndpointAccessMode string
    The endpoint access mode for your DomainName.
    Policy object

    A stringified JSON policy document that applies to the execute-api service for this DomainName regardless of the caller and Method configuration. You can use Fn::ToJsonString to enter your policy . For more information, see Fn::ToJsonString .

    Search the CloudFormation User Guide for AWS::ApiGateway::DomainNameV2 for more information about the expected schema for this property.

    RoutingMode Pulumi.AwsNative.ApiGateway.DomainNameV2RoutingMode
    The valid routing modes are [BASE_PATH_MAPPING_ONLY], [ROUTING_RULE_THEN_BASE_PATH_MAPPING] and [ROUTING_RULE_ONLY]. All other inputs are invalid.
    Tags List<Pulumi.AwsNative.Outputs.Tag>
    The collection of tags. Each tag element is associated with a given resource.
    CertificateArn string
    The reference to an AWS -managed certificate that will be used by the private endpoint for this domain name. AWS Certificate Manager is the only supported source.
    DomainNameArn string
    The amazon resource name (ARN) of the domain name resource.
    DomainNameId string
    The domain name ID.
    EndpointAccessMode string
    The endpoint access mode for your DomainName.
    Policy interface{}

    A stringified JSON policy document that applies to the execute-api service for this DomainName regardless of the caller and Method configuration. You can use Fn::ToJsonString to enter your policy . For more information, see Fn::ToJsonString .

    Search the CloudFormation User Guide for AWS::ApiGateway::DomainNameV2 for more information about the expected schema for this property.

    RoutingMode DomainNameV2RoutingMode
    The valid routing modes are [BASE_PATH_MAPPING_ONLY], [ROUTING_RULE_THEN_BASE_PATH_MAPPING] and [ROUTING_RULE_ONLY]. All other inputs are invalid.
    Tags Tag
    The collection of tags. Each tag element is associated with a given resource.
    certificateArn String
    The reference to an AWS -managed certificate that will be used by the private endpoint for this domain name. AWS Certificate Manager is the only supported source.
    domainNameArn String
    The amazon resource name (ARN) of the domain name resource.
    domainNameId String
    The domain name ID.
    endpointAccessMode String
    The endpoint access mode for your DomainName.
    policy Object

    A stringified JSON policy document that applies to the execute-api service for this DomainName regardless of the caller and Method configuration. You can use Fn::ToJsonString to enter your policy . For more information, see Fn::ToJsonString .

    Search the CloudFormation User Guide for AWS::ApiGateway::DomainNameV2 for more information about the expected schema for this property.

    routingMode DomainNameV2RoutingMode
    The valid routing modes are [BASE_PATH_MAPPING_ONLY], [ROUTING_RULE_THEN_BASE_PATH_MAPPING] and [ROUTING_RULE_ONLY]. All other inputs are invalid.
    tags List<Tag>
    The collection of tags. Each tag element is associated with a given resource.
    certificateArn string
    The reference to an AWS -managed certificate that will be used by the private endpoint for this domain name. AWS Certificate Manager is the only supported source.
    domainNameArn string
    The amazon resource name (ARN) of the domain name resource.
    domainNameId string
    The domain name ID.
    endpointAccessMode string
    The endpoint access mode for your DomainName.
    policy any

    A stringified JSON policy document that applies to the execute-api service for this DomainName regardless of the caller and Method configuration. You can use Fn::ToJsonString to enter your policy . For more information, see Fn::ToJsonString .

    Search the CloudFormation User Guide for AWS::ApiGateway::DomainNameV2 for more information about the expected schema for this property.

    routingMode DomainNameV2RoutingMode
    The valid routing modes are [BASE_PATH_MAPPING_ONLY], [ROUTING_RULE_THEN_BASE_PATH_MAPPING] and [ROUTING_RULE_ONLY]. All other inputs are invalid.
    tags Tag[]
    The collection of tags. Each tag element is associated with a given resource.
    certificate_arn str
    The reference to an AWS -managed certificate that will be used by the private endpoint for this domain name. AWS Certificate Manager is the only supported source.
    domain_name_arn str
    The amazon resource name (ARN) of the domain name resource.
    domain_name_id str
    The domain name ID.
    endpoint_access_mode str
    The endpoint access mode for your DomainName.
    policy Any

    A stringified JSON policy document that applies to the execute-api service for this DomainName regardless of the caller and Method configuration. You can use Fn::ToJsonString to enter your policy . For more information, see Fn::ToJsonString .

    Search the CloudFormation User Guide for AWS::ApiGateway::DomainNameV2 for more information about the expected schema for this property.

    routing_mode DomainNameV2RoutingMode
    The valid routing modes are [BASE_PATH_MAPPING_ONLY], [ROUTING_RULE_THEN_BASE_PATH_MAPPING] and [ROUTING_RULE_ONLY]. All other inputs are invalid.
    tags Sequence[root_Tag]
    The collection of tags. Each tag element is associated with a given resource.
    certificateArn String
    The reference to an AWS -managed certificate that will be used by the private endpoint for this domain name. AWS Certificate Manager is the only supported source.
    domainNameArn String
    The amazon resource name (ARN) of the domain name resource.
    domainNameId String
    The domain name ID.
    endpointAccessMode String
    The endpoint access mode for your DomainName.
    policy Any

    A stringified JSON policy document that applies to the execute-api service for this DomainName regardless of the caller and Method configuration. You can use Fn::ToJsonString to enter your policy . For more information, see Fn::ToJsonString .

    Search the CloudFormation User Guide for AWS::ApiGateway::DomainNameV2 for more information about the expected schema for this property.

    routingMode "BASE_PATH_MAPPING_ONLY" | "ROUTING_RULE_THEN_BASE_PATH_MAPPING" | "ROUTING_RULE_ONLY"
    The valid routing modes are [BASE_PATH_MAPPING_ONLY], [ROUTING_RULE_THEN_BASE_PATH_MAPPING] and [ROUTING_RULE_ONLY]. All other inputs are invalid.
    tags List<Property Map>
    The collection of tags. Each tag element is associated with a given resource.

    Supporting Types

    DomainNameV2RoutingMode

    Tag

    Key string
    The key name of the tag
    Value string
    The value of the tag
    Key string
    The key name of the tag
    Value string
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key str
    The key name of the tag
    value str
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    We recommend new projects start with resources from the AWS provider.

    Viewing docs for AWS Cloud Control v1.59.0
    published on Monday, Mar 30, 2026 by Pulumi
    Schema (JSON)
    pulumi/pulumi-aws-native
      Try Pulumi Cloud free. Your team will thank you.