Package software.amazon.awscdk.services.apprunner

Class CfnVpcConnector

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.apprunner.CfnVpcConnector
All Implemented Interfaces:
IInspectable, ITaggable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.98.0 (build 00b106d)", date="2024-05-08T21:35:02.773Z") @Stability(Stable) public class CfnVpcConnector extends CfnResource implements IInspectable, ITaggable
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();

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

    • CfnVpcConnector

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

    • CfnVpcConnector

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

    • CfnVpcConnector

      @Stability(Stable) public CfnVpcConnector(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnVpcConnectorProps props)
      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

    • 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()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getTags in interface ITaggable

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

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

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

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

    • getTagsRaw

      @Stability(Stable) @Nullable public List<CfnTag> getTagsRaw()
      A list of metadata items that you can associate with your VPC connector resource.

    • setTagsRaw

      @Stability(Stable) public void setTagsRaw(@Nullable List<CfnTag> value)
      A list of metadata items that you can associate with your VPC connector resource.

    • getVpcConnectorName

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

    • setVpcConnectorName

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