Package software.amazon.awscdk.services.route53.targets

Class ApiGateway

java.lang.Object
software.amazon.jsii.JsiiObject
software.amazon.awscdk.services.route53.targets.ApiGatewayDomain
software.amazon.awscdk.services.route53.targets.ApiGateway
All Implemented Interfaces:
IAliasRecordTarget, software.amazon.jsii.JsiiSerializable
@Generated(value="jsii-pacmak/1.101.0 (build b95fe5d)", date="2024-07-22T22:42:57.482Z") @Stability(Stable) public class ApiGateway extends ApiGatewayDomain
Defines an API Gateway REST API as the alias target. Requires that the domain name will be defined through RestApiProps.domainName.

You can direct the alias to any apigateway.DomainName resource through the ApiGatewayDomain class.

Example: 

 import software.amazon.awscdk.services.route53.*;
 import software.amazon.awscdk.services.route53.targets.*;
 RestApi api;
 Object hostedZoneForExampleCom;
 ARecord.Builder.create(this, "CustomDomainAliasRecord")
         .zone(hostedZoneForExampleCom)
         .target(RecordTarget.fromAlias(new ApiGateway(api)))
         .build();

  • Nested Class Summary

    Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

    software.amazon.jsii.JsiiObject.InitializationMode

    Nested classes/interfaces inherited from interface software.amazon.awscdk.services.route53.IAliasRecordTarget

    IAliasRecordTarget.Jsii$Default, IAliasRecordTarget.Jsii$Proxy

  • Constructor Summary

    Constructors
    Modifier
    Constructor
    Description
     
    ApiGateway(RestApiBase api)
     
    protected
    ApiGateway(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
     
    protected
    ApiGateway(software.amazon.jsii.JsiiObjectRef objRef)
     

  • Method Summary

    Methods inherited from class software.amazon.awscdk.services.route53.targets.ApiGatewayDomain

    bind, bind

    Methods inherited from class software.amazon.jsii.JsiiObject

    jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    Methods inherited from interface software.amazon.jsii.JsiiSerializable

    $jsii$toJson

  • Constructor Details

    • ApiGateway

      protected ApiGateway(software.amazon.jsii.JsiiObjectRef objRef)

    • ApiGateway

      protected ApiGateway(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • ApiGateway

      @Stability(Stable) public ApiGateway(@NotNull RestApiBase api)
      Parameters:
      api - This parameter is required.