Package software.amazon.awscdk.services.rtbfabric

Class CfnResponderGateway

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.rtbfabric.CfnResponderGateway
All Implemented Interfaces:
IInspectable, IEnvironmentAware, IResponderGatewayRef, ITaggableV2, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.121.0 (build d7af9b9)", date="2025-12-18T18:20:17.011Z") @Stability(Stable) public class CfnResponderGateway extends CfnResource implements IInspectable, IResponderGatewayRef, ITaggableV2
Creates a responder gateway.

A domain name or managed endpoint is required.

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.rtbfabric.*;
 CfnResponderGateway cfnResponderGateway = CfnResponderGateway.Builder.create(this, "MyCfnResponderGateway")
         .port(123)
         .protocol("protocol")
         .securityGroupIds(List.of("securityGroupIds"))
         .subnetIds(List.of("subnetIds"))
         .vpcId("vpcId")
         // the properties below are optional
         .description("description")
         .domainName("domainName")
         .managedEndpointConfiguration(ManagedEndpointConfigurationProperty.builder()
                 .autoScalingGroupsConfiguration(AutoScalingGroupsConfigurationProperty.builder()
                         .autoScalingGroupNameList(List.of("autoScalingGroupNameList"))
                         .roleArn("roleArn")
                         .build())
                 .eksEndpointsConfiguration(EksEndpointsConfigurationProperty.builder()
                         .clusterApiServerCaCertificateChain("clusterApiServerCaCertificateChain")
                         .clusterApiServerEndpointUri("clusterApiServerEndpointUri")
                         .clusterName("clusterName")
                         .endpointsResourceName("endpointsResourceName")
                         .endpointsResourceNamespace("endpointsResourceNamespace")
                         .roleArn("roleArn")
                         .build())
                 .build())
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .trustStoreConfiguration(TrustStoreConfigurationProperty.builder()
                 .certificateAuthorityCertificates(List.of("certificateAuthorityCertificates"))
                 .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

    • CfnResponderGateway

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

    • CfnResponderGateway

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

    • CfnResponderGateway

      @Stability(Stable) public CfnResponderGateway(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnResponderGatewayProps props)
      Create a new AWS::RTBFabric::ResponderGateway.

      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

    • arnForResponderGateway

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

    • isCfnResponderGateway

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

      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()

    • getAttrCreatedTimestamp

      @Stability(Stable) @NotNull public String getAttrCreatedTimestamp()

    • getAttrGatewayId

      @Stability(Stable) @NotNull public String getAttrGatewayId()

    • getAttrResponderGatewayStatus

      @Stability(Stable) @NotNull public String getAttrResponderGatewayStatus()

    • getAttrUpdatedTimestamp

      @Stability(Stable) @NotNull public String getAttrUpdatedTimestamp()

    • 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

    • getResponderGatewayRef

      @Stability(Stable) @NotNull public ResponderGatewayReference getResponderGatewayRef()
      A reference to a ResponderGateway resource.
      Specified by:
      getResponderGatewayRef in interface IResponderGatewayRef

    • getPort

      @Stability(Stable) @NotNull public Number getPort()
      The networking port to use.

    • setPort

      @Stability(Stable) public void setPort(@NotNull Number value)
      The networking port to use.

    • getProtocol

      @Stability(Stable) @NotNull public String getProtocol()
      The networking protocol to use.

    • setProtocol

      @Stability(Stable) public void setProtocol(@NotNull String value)
      The networking protocol to use.

    • getSecurityGroupIds

      @Stability(Stable) @NotNull public List<String> getSecurityGroupIds()
      The unique identifiers of the security groups.

    • setSecurityGroupIds

      @Stability(Stable) public void setSecurityGroupIds(@NotNull List<String> value)
      The unique identifiers of the security groups.

    • getSubnetIds

      @Stability(Stable) @NotNull public List<String> getSubnetIds()
      The unique identifiers of the subnets.

    • setSubnetIds

      @Stability(Stable) public void setSubnetIds(@NotNull List<String> value)
      The unique identifiers of the subnets.

    • getVpcId

      @Stability(Stable) @NotNull public String getVpcId()
      The unique identifier of the Virtual Private Cloud (VPC).

    • setVpcId

      @Stability(Stable) public void setVpcId(@NotNull String value)
      The unique identifier of the Virtual Private Cloud (VPC).

    • getDescription

      @Stability(Stable) @Nullable public String getDescription()
      An optional description for the responder gateway.

    • setDescription

      @Stability(Stable) public void setDescription(@Nullable String value)
      An optional description for the responder gateway.

    • getDomainName

      @Stability(Stable) @Nullable public String getDomainName()
      The domain name for the responder gateway.

    • setDomainName

      @Stability(Stable) public void setDomainName(@Nullable String value)
      The domain name for the responder gateway.

    • getManagedEndpointConfiguration

      @Stability(Stable) @Nullable public Object getManagedEndpointConfiguration()
      The configuration for the managed endpoint.

      Returns union: either IResolvable or CfnResponderGateway.ManagedEndpointConfigurationProperty

    • setManagedEndpointConfiguration

      @Stability(Stable) public void setManagedEndpointConfiguration(@Nullable IResolvable value)
      The configuration for the managed endpoint.

    • setManagedEndpointConfiguration

      @Stability(Stable) public void setManagedEndpointConfiguration(@Nullable CfnResponderGateway.ManagedEndpointConfigurationProperty value)
      The configuration for the managed endpoint.

    • getTags

      @Stability(Stable) @Nullable public List<CfnTag> getTags()
      A map of the key-value pairs of the tag or tags to assign to the resource.

    • setTags

      @Stability(Stable) public void setTags(@Nullable List<CfnTag> value)
      A map of the key-value pairs of the tag or tags to assign to the resource.

    • getTrustStoreConfiguration

      @Stability(Stable) @Nullable public Object getTrustStoreConfiguration()
      The configuration of the trust store.

      Returns union: either IResolvable or CfnResponderGateway.TrustStoreConfigurationProperty

    • setTrustStoreConfiguration

      @Stability(Stable) public void setTrustStoreConfiguration(@Nullable IResolvable value)
      The configuration of the trust store.

    • setTrustStoreConfiguration

      @Stability(Stable) public void setTrustStoreConfiguration(@Nullable CfnResponderGateway.TrustStoreConfigurationProperty value)
      The configuration of the trust store.