Package software.amazon.awscdk.services.vpclattice

Class CfnResourceGateway

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.vpclattice.CfnResourceGateway
All Implemented Interfaces:
IInspectable, IEnvironmentAware, IResourceGatewayRef, ITaggableV2, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.119.0 (build 1634eac)", date="2025-12-01T16:02:31.315Z") @Stability(Stable) public class CfnResourceGateway extends CfnResource implements IInspectable, IResourceGatewayRef, ITaggableV2
A resource gateway is a point of ingress into the VPC where a resource resides.

It spans multiple Availability Zones. For your resource to be accessible from all Availability Zones, you should create your resource gateways to span as many Availability Zones as possible. A VPC can have multiple resource gateways.

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.vpclattice.*;
 CfnResourceGateway cfnResourceGateway = CfnResourceGateway.Builder.create(this, "MyCfnResourceGateway")
         .name("name")
         .subnetIds(List.of("subnetIds"))
         .vpcIdentifier("vpcIdentifier")
         // the properties below are optional
         .ipAddressType("ipAddressType")
         .ipv4AddressesPerEni(123)
         .securityGroupIds(List.of("securityGroupIds"))
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();

See Also:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnResourceGateway

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

    • CfnResourceGateway

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

    • CfnResourceGateway

      @Stability(Stable) public CfnResourceGateway(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnResourceGatewayProps props)
      Create a new AWS::VpcLattice::ResourceGateway.

      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties. This parameter is required.

  • Method Details

    • arnForResourceGateway

      @Stability(Stable) @NotNull public static String arnForResourceGateway(@NotNull IResourceGatewayRef resource)
      Parameters:
      resource - This parameter is required.

    • isCfnResourceGateway

      @Stability(Stable) @NotNull public static Boolean isCfnResourceGateway(@NotNull Object x)
      Checks whether the given object is a CfnResourceGateway.

      Parameters:
      x - This parameter is required.

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrArn

      @Stability(Stable) @NotNull public String getAttrArn()
      The Amazon Resource Name (ARN) of the resource gateway.

    • getAttrId

      @Stability(Stable) @NotNull public String getAttrId()
      The ID of the resource gateway.

    • getCdkTagManager

      @Stability(Stable) @NotNull public TagManager getCdkTagManager()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getCdkTagManager in interface ITaggableV2

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getResourceGatewayRef

      @Stability(Stable) @NotNull public ResourceGatewayReference getResourceGatewayRef()
      A reference to a ResourceGateway resource.
      Specified by:
      getResourceGatewayRef in interface IResourceGatewayRef

    • getName

      @Stability(Stable) @NotNull public String getName()
      The name of the resource gateway.

    • setName

      @Stability(Stable) public void setName(@NotNull String value)
      The name of the resource gateway.

    • getSubnetIds

      @Stability(Stable) @NotNull public List<String> getSubnetIds()
      The IDs of the VPC subnets for the resource gateway.

    • setSubnetIds

      @Stability(Stable) public void setSubnetIds(@NotNull List<String> value)
      The IDs of the VPC subnets for the resource gateway.

    • getVpcIdentifier

      @Stability(Stable) @NotNull public String getVpcIdentifier()
      The ID of the VPC for the resource gateway.

    • setVpcIdentifier

      @Stability(Stable) public void setVpcIdentifier(@NotNull String value)
      The ID of the VPC for the resource gateway.

    • getIpAddressType

      @Stability(Stable) @Nullable public String getIpAddressType()
      The type of IP address used by the resource gateway.

    • setIpAddressType

      @Stability(Stable) public void setIpAddressType(@Nullable String value)
      The type of IP address used by the resource gateway.

    • getIpv4AddressesPerEni

      @Stability(Stable) @Nullable public Number getIpv4AddressesPerEni()
      The number of IPv4 addresses in each ENI for the resource gateway.

    • setIpv4AddressesPerEni

      @Stability(Stable) public void setIpv4AddressesPerEni(@Nullable Number value)
      The number of IPv4 addresses in each ENI for the resource gateway.

    • getSecurityGroupIds

      @Stability(Stable) @Nullable public List<String> getSecurityGroupIds()
      The IDs of the security groups applied to the resource gateway.

    • setSecurityGroupIds

      @Stability(Stable) public void setSecurityGroupIds(@Nullable List<String> value)
      The IDs of the security groups applied to the resource gateway.

    • getTags

      @Stability(Stable) @Nullable public List<CfnTag> getTags()
      The tags for the resource gateway.

    • setTags

      @Stability(Stable) public void setTags(@Nullable List<CfnTag> value)
      The tags for the resource gateway.