Package software.amazon.awscdk.cloud_assembly_schema

Interface HostedZoneContextQuery

All Superinterfaces:

ContextLookupRoleOptions, software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

HostedZoneContextQuery.Jsii$Proxy

@Generated(value="jsii-pacmak/1.106.0 (build e852934)",
           date="2025-02-26T00:07:48.338Z")
@Stability(Stable)
public interface HostedZoneContextQuery
extends software.amazon.jsii.JsiiSerializable, ContextLookupRoleOptions

Query to hosted zone context provider.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.cloud_assembly_schema.*;
 Object assumeRoleAdditionalOptions;
 HostedZoneContextQuery hostedZoneContextQuery = HostedZoneContextQuery.builder()
         .account("account")
         .domainName("domainName")
         .region("region")
         // the properties below are optional
         .assumeRoleAdditionalOptions(Map.of(
                 "assumeRoleAdditionalOptionsKey", assumeRoleAdditionalOptions))
         .lookupRoleArn("lookupRoleArn")
         .lookupRoleExternalId("lookupRoleExternalId")
         .privateZone(false)
         .vpcId("vpcId")
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	HostedZoneContextQuery.Builder	A builder for HostedZoneContextQuery
static final class	HostedZoneContextQuery.Jsii$Proxy	An implementation for HostedZoneContextQuery

Method Summary

Modifier and Type	Method	Description
static HostedZoneContextQuery.Builder	builder()
String	getDomainName()	The domain name e.g.
default Boolean	getPrivateZone()	True if the zone you want to find is a private hosted zone.
default String	getVpcId()	The VPC ID to that the private zone must be associated with.

Methods inherited from interface software.amazon.awscdk.cloud_assembly_schema.ContextLookupRoleOptions

getAccount, getAssumeRoleAdditionalOptions, getLookupRoleArn, getLookupRoleExternalId, getRegion

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getDomainName

@Stability(Stable)
@NotNull
String getDomainName()

The domain name e.g. example.com to lookup.

getPrivateZone

@Stability(Stable)
@Nullable
default Boolean getPrivateZone()

True if the zone you want to find is a private hosted zone.

Default: false

getVpcId

@Stability(Stable)
@Nullable
default String getVpcId()

The VPC ID to that the private zone must be associated with.

If you provide VPC ID and privateZone is false, this will return no results and raise an error.

Default: - Required if privateZone=true

builder

@Stability(Stable)
static HostedZoneContextQuery.Builder builder()

Returns:

a HostedZoneContextQuery.Builder of HostedZoneContextQuery