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, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:36.615Z")
 @Stability(value=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();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnVpcConnector.Builder A fluent builder for CfnVpcConnector.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnVpcConnector(software.constructs.Construct scope, String id, CfnVpcConnectorProps props) Create a new `AWS::AppRunner::VpcConnector`.
protected	CfnVpcConnector(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnVpcConnector(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
String	getAttrVpcConnectorArn() The Amazon Resource Name (ARN) of this VPC connector.
Number	getAttrVpcConnectorRevision() The revision of this VPC connector.
protected Map<String,Object>	getCfnProperties()
List<String>	getSecurityGroups() A list of IDs of security groups that App Runner should use for access to AWS resources under the specified subnets.
List<String>	getSubnets() A list of IDs of subnets that App Runner should use when it associates your service with a custom Amazon VPC.
TagManager	getTags() A list of metadata items that you can associate with your VPC connector resource.
String	getVpcConnectorName() A name for the VPC connector.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setSecurityGroups(List<String> value) A list of IDs of security groups that App Runner should use for access to AWS resources under the specified subnets.
void	setSubnets(List<String> value) A list of IDs of subnets that App Runner should use when it associates your service with a custom Amazon VPC.
void	setVpcConnectorName(String value) A name for the VPC connector.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnVpcConnector

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

CfnVpcConnector

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

CfnVpcConnector

@Stability(value=Stable)
public CfnVpcConnector(@NotNull
                                                software.constructs.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 Detail

inspect

@Stability(value=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(value=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(value=Stable)
 @NotNull
public String getAttrVpcConnectorArn()

The Amazon Resource Name (ARN) of this VPC connector.

getAttrVpcConnectorRevision

@Stability(value=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(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

@Stability(value=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(value=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(value=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(value=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(value=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(value=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(value=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.