Package software.amazon.awscdk.services.apprunner

Class CfnVpcConnector

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.CfnVpcConnector
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.015Z") @Stability(Stable) public class CfnVpcConnector extends CfnResource implements IInspectable
A CloudFormation AWS::AppRunner::VpcConnector.

Specify an AWS App Runner VPC connector by using the AWS::AppRunner::VpcConnector resource in an AWS CloudFormation template.

The AWS::AppRunner::VpcConnector resource is an AWS App Runner resource type that specifies an App Runner VPC connector.

App Runner requires this resource when you want to associate your App Runner service to a custom Amazon Virtual Private Cloud ( Amazon VPC ).

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.*;
 CfnVpcConnector cfnVpcConnector = CfnVpcConnector.Builder.create(this, "MyCfnVpcConnector")
         .subnets(List.of("subnets"))
         // the properties below are optional
         .securityGroups(List.of("securityGroups"))
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .vpcConnectorName("vpcConnectorName")
         .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

    • CfnVpcConnector

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

    • CfnVpcConnector

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

    • CfnVpcConnector

      @Stability(Stable) public CfnVpcConnector(@NotNull Construct scope, @NotNull String id, @NotNull CfnVpcConnectorProps props)
      Create a new AWS::AppRunner::VpcConnector.

      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.

    • getAttrVpcConnectorArn

      @Stability(Stable) @NotNull public String getAttrVpcConnectorArn()
      The Amazon Resource Name (ARN) of this VPC connector.

    • getAttrVpcConnectorRevision

      @Stability(Stable) @NotNull public Number getAttrVpcConnectorRevision()
      The revision of this VPC connector.

      It's unique among all the active connectors ( "Status": "ACTIVE" ) that share the same Name .

      At this time, App Runner supports only one revision per name.

    • getCfnProperties

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

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      A list of metadata items that you can associate with your VPC connector resource.

      A tag is a key-value pair.

    • getSubnets

      @Stability(Stable) @NotNull public List<String> getSubnets()
      A list of IDs of subnets that App Runner should use when it associates your service with a custom Amazon VPC.

      Specify IDs of subnets of a single Amazon VPC. App Runner determines the Amazon VPC from the subnets you specify.

      App Runner currently only provides support for IPv4.

    • setSubnets

      @Stability(Stable) public void setSubnets(@NotNull List<String> value)
      A list of IDs of subnets that App Runner should use when it associates your service with a custom Amazon VPC.

      Specify IDs of subnets of a single Amazon VPC. App Runner determines the Amazon VPC from the subnets you specify.

      App Runner currently only provides support for IPv4.

    • getSecurityGroups

      @Stability(Stable) @Nullable public List<String> getSecurityGroups()
      A list of IDs of security groups that App Runner should use for access to AWS resources under the specified subnets.

      If not specified, App Runner uses the default security group of the Amazon VPC. The default security group allows all outbound traffic.

    • setSecurityGroups

      @Stability(Stable) public void setSecurityGroups(@Nullable List<String> value)
      A list of IDs of security groups that App Runner should use for access to AWS resources under the specified subnets.

      If not specified, App Runner uses the default security group of the Amazon VPC. The default security group allows all outbound traffic.

    • getVpcConnectorName

      @Stability(Stable) @Nullable public String getVpcConnectorName()
      A name for the VPC connector.

      If you don't specify a name, AWS CloudFormation generates a name for your VPC connector.

    • setVpcConnectorName

      @Stability(Stable) public void setVpcConnectorName(@Nullable String value)
      A name for the VPC connector.

      If you don't specify a name, AWS CloudFormation generates a name for your VPC connector.