software.amazon.awscdk.services.apprunner

Class CfnVpcConnector

java.lang.Object

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

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-22T19:35:43.573Z")
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 interface software.amazon.awscdk.core.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

IConstruct.Jsii$Default

Field Summary

Fields

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

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnVpcConnector(Construct scope, java.lang.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
java.lang.String	getAttrVpcConnectorArn() The Amazon Resource Name (ARN) of this VPC connector.
java.lang.Number	getAttrVpcConnectorRevision() The revision of this VPC connector.
protected java.util.Map<java.lang.String,java.lang.Object>	getCfnProperties()
java.util.List<java.lang.String>	getSecurityGroups() A list of IDs of security groups that App Runner should use for access to AWS resources under the specified subnets.
java.util.List<java.lang.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.
java.lang.String	getVpcConnectorName() A name for the VPC connector.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected java.util.Map<java.lang.String,java.lang.Object>	renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
void	setSecurityGroups(java.util.List<java.lang.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(java.util.List<java.lang.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(java.lang.String value) A name for the VPC connector.

Methods inherited from class software.amazon.awscdk.core.CfnResource

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

Methods inherited from class software.amazon.awscdk.core.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.core.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class java.lang.Object

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

Field Detail

CFN_RESOURCE_TYPE_NAME

public static final java.lang.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

public CfnVpcConnector(Construct scope,
                       java.lang.String id,
                       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

public void inspect(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

protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrVpcConnectorArn

public java.lang.String getAttrVpcConnectorArn()

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

getAttrVpcConnectorRevision

public java.lang.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

protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

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

public java.util.List<java.lang.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

public void setSubnets(java.util.List<java.lang.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

public java.util.List<java.lang.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

public void setSecurityGroups(java.util.List<java.lang.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

public java.lang.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

public void setVpcConnectorName(java.lang.String value)

A name for the VPC connector.

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