@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)", date="2023-03-22T19:35:43.573Z") public class CfnVpcConnector extends CfnResource implements IInspectable
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();
Modifier and Type | Class and Description |
---|---|
static class |
CfnVpcConnector.Builder
A fluent builder for
CfnVpcConnector . |
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
IConstruct.Jsii$Default
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
|
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) |
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.
|
addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties
getRef
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId
getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate
public static final java.lang.String CFN_RESOURCE_TYPE_NAME
protected CfnVpcConnector(software.amazon.jsii.JsiiObjectRef objRef)
protected CfnVpcConnector(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
public CfnVpcConnector(Construct scope, java.lang.String id, CfnVpcConnectorProps props)
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.public void inspect(TreeInspector inspector)
inspect
in interface IInspectable
inspector
- - tree inspector to collect and process attributes. This parameter is required.protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
renderProperties
in class CfnResource
props
- This parameter is required.public java.lang.String getAttrVpcConnectorArn()
public java.lang.Number getAttrVpcConnectorRevision()
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.
protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()
getCfnProperties
in class CfnResource
public TagManager getTags()
A tag is a key-value pair.
public java.util.List<java.lang.String> getSubnets()
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.
public void setSubnets(java.util.List<java.lang.String> value)
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.
public java.util.List<java.lang.String> getSecurityGroups()
If not specified, App Runner uses the default security group of the Amazon VPC. The default security group allows all outbound traffic.
public void setSecurityGroups(java.util.List<java.lang.String> value)
If not specified, App Runner uses the default security group of the Amazon VPC. The default security group allows all outbound traffic.
public java.lang.String getVpcConnectorName()
If you don't specify a name, AWS CloudFormation generates a name for your VPC connector.
public void setVpcConnectorName(java.lang.String value)
If you don't specify a name, AWS CloudFormation generates a name for your VPC connector.