Package software.amazon.awscdk.services.apprunner

Class CfnVpcIngressConnection

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.core.Construct
software.amazon.awscdk.core.CfnElement
software.amazon.awscdk.core.CfnRefElement
software.amazon.awscdk.core.CfnResource
software.amazon.awscdk.services.apprunner.CfnVpcIngressConnection
All Implemented Interfaces:
IConstruct, IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:40.036Z") @Stability(Stable) public class CfnVpcIngressConnection extends CfnResource implements IInspectable
A CloudFormation AWS::AppRunner::VpcIngressConnection.

Specify an AWS App Runner VPC Ingress Connection by using the AWS::AppRunner::VpcIngressConnection resource in an AWS CloudFormation template.

The AWS::AppRunner::VpcIngressConnection resource is an AWS App Runner resource type that specifies an App Runner VPC Ingress Connection.

App Runner requires this resource when you want to associate your App Runner service to an Amazon VPC endpoint.

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.apprunner.*;
 CfnVpcIngressConnection cfnVpcIngressConnection = CfnVpcIngressConnection.Builder.create(this, "MyCfnVpcIngressConnection")
         .ingressVpcConfiguration(IngressVpcConfigurationProperty.builder()
                 .vpcEndpointId("vpcEndpointId")
                 .vpcId("vpcId")
                 .build())
         .serviceArn("serviceArn")
         // the properties below are optional
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .vpcIngressConnectionName("vpcIngressConnectionName")
         .build();

  • 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

    • CfnVpcIngressConnection

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

    • CfnVpcIngressConnection

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

    • CfnVpcIngressConnection

      @Stability(Stable) public CfnVpcIngressConnection(@NotNull Construct scope, @NotNull String id, @NotNull CfnVpcIngressConnectionProps props)
      Create a new AWS::AppRunner::VpcIngressConnection.

      Parameters:
      scope -
      • scope in which this resource is defined.
      This parameter is required.
      id -
      • scoped id of the resource.
      This parameter is required.
      props -
      • resource properties.
      This parameter is required.

  • Method Details

    • 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.

    • getAttrDomainName

      @Stability(Stable) @NotNull public String getAttrDomainName()
      The domain name associated with the VPC Ingress Connection resource.

    • getAttrStatus

      @Stability(Stable) @NotNull public String getAttrStatus()
      The current status of the VPC Ingress Connection.

      The VPC Ingress Connection displays one of the following statuses: AVAILABLE , PENDING_CREATION , PENDING_DELETION , FAILED_CREATION , FAILED_DELETION , PENDNG_UPDATE , FAILED_UPDATE , and DELETED .

    • getAttrVpcIngressConnectionArn

      @Stability(Stable) @NotNull public String getAttrVpcIngressConnectionArn()
      The Amazon Resource Name (ARN) of the VPC Ingress Connection.

    • getCfnProperties

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

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      An optional list of metadata items that you can associate with the VPC Ingress Connection resource.

      A tag is a key-value pair.

    • getIngressVpcConfiguration

      @Stability(Stable) @NotNull public Object getIngressVpcConfiguration()
      Specifications for the customer’s Amazon VPC and the related AWS PrivateLink VPC endpoint that are used to create the VPC Ingress Connection resource.

    • setIngressVpcConfiguration

      @Stability(Stable) public void setIngressVpcConfiguration(@NotNull IResolvable value)
      Specifications for the customer’s Amazon VPC and the related AWS PrivateLink VPC endpoint that are used to create the VPC Ingress Connection resource.

    • setIngressVpcConfiguration

      @Stability(Stable) public void setIngressVpcConfiguration(@NotNull CfnVpcIngressConnection.IngressVpcConfigurationProperty value)
      Specifications for the customer’s Amazon VPC and the related AWS PrivateLink VPC endpoint that are used to create the VPC Ingress Connection resource.

    • getServiceArn

      @Stability(Stable) @NotNull public String getServiceArn()
      The Amazon Resource Name (ARN) for this App Runner service that is used to create the VPC Ingress Connection resource.

    • setServiceArn

      @Stability(Stable) public void setServiceArn(@NotNull String value)
      The Amazon Resource Name (ARN) for this App Runner service that is used to create the VPC Ingress Connection resource.

    • getVpcIngressConnectionName

      @Stability(Stable) @Nullable public String getVpcIngressConnectionName()
      The customer-provided VPC Ingress Connection name.

    • setVpcIngressConnectionName

      @Stability(Stable) public void setVpcIngressConnectionName(@Nullable String value)
      The customer-provided VPC Ingress Connection name.