software.amazon.awscdk.services.apprunner

Class CfnVpcIngressConnection

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

All Implemented Interfaces:

IConstruct, IDependable, IInspectable

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-22T19:35:43.576Z")
public class CfnVpcIngressConnection
extends CfnResource
implements IInspectable

A CloudFormation `AWS::AppRunner::VpcIngressConnection`.

Specify an AWS App Runner VPC Ingress Connection by using the AWS::AppRunner::VpcIngressConnection resource in an AWS CloudFormation template.

The AWS::AppRunner::VpcIngressConnection resource is an AWS App Runner resource type that specifies an App Runner VPC Ingress Connection.

App Runner requires this resource when you want to associate your App Runner service to an Amazon VPC endpoint.

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.*;
 CfnVpcIngressConnection cfnVpcIngressConnection = CfnVpcIngressConnection.Builder.create(this, "MyCfnVpcIngressConnection")
         .ingressVpcConfiguration(IngressVpcConfigurationProperty.builder()
                 .vpcEndpointId("vpcEndpointId")
                 .vpcId("vpcId")
                 .build())
         .serviceArn("serviceArn")
         // the properties below are optional
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .vpcIngressConnectionName("vpcIngressConnectionName")
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnVpcIngressConnection.Builder A fluent builder for CfnVpcIngressConnection.
static interface	CfnVpcIngressConnection.IngressVpcConfigurationProperty Specifications for the customer’s VPC and related PrivateLink VPC endpoint that are used to associate with the VPC Ingress Connection resource.

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
	CfnVpcIngressConnection(Construct scope, java.lang.String id, CfnVpcIngressConnectionProps props) Create a new `AWS::AppRunner::VpcIngressConnection`.
protected	CfnVpcIngressConnection(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnVpcIngressConnection(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getAttrDomainName() The domain name associated with the VPC Ingress Connection resource.
java.lang.String	getAttrStatus() The current status of the VPC Ingress Connection.
java.lang.String	getAttrVpcIngressConnectionArn() The Amazon Resource Name (ARN) of the VPC Ingress Connection.
protected java.util.Map<java.lang.String,java.lang.Object>	getCfnProperties()
java.lang.Object	getIngressVpcConfiguration() Specifications for the customer’s Amazon VPC and the related AWS PrivateLink VPC endpoint that are used to create the VPC Ingress Connection resource.
java.lang.String	getServiceArn() The Amazon Resource Name (ARN) for this App Runner service that is used to create the VPC Ingress Connection resource.
TagManager	getTags() An optional list of metadata items that you can associate with the VPC Ingress Connection resource.
java.lang.String	getVpcIngressConnectionName() The customer-provided VPC Ingress Connection name.
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	setIngressVpcConfiguration(CfnVpcIngressConnection.IngressVpcConfigurationProperty value) Specifications for the customer’s Amazon VPC and the related AWS PrivateLink VPC endpoint that are used to create the VPC Ingress Connection resource.
void	setIngressVpcConfiguration(IResolvable value) Specifications for the customer’s Amazon VPC and the related AWS PrivateLink VPC endpoint that are used to create the VPC Ingress Connection resource.
void	setServiceArn(java.lang.String value) The Amazon Resource Name (ARN) for this App Runner service that is used to create the VPC Ingress Connection resource.
void	setVpcIngressConnectionName(java.lang.String value) The customer-provided VPC Ingress Connection name.

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

CfnVpcIngressConnection

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

CfnVpcIngressConnection

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

CfnVpcIngressConnection

public CfnVpcIngressConnection(Construct scope,
                               java.lang.String id,
                               CfnVpcIngressConnectionProps props)

Create a new `AWS::AppRunner::VpcIngressConnection`.

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.

getAttrDomainName

public java.lang.String getAttrDomainName()

The domain name associated with the VPC Ingress Connection resource.

getAttrStatus

public java.lang.String getAttrStatus()

The current status of the VPC Ingress Connection.

The VPC Ingress Connection displays one of the following statuses: AVAILABLE , PENDING_CREATION , PENDING_DELETION , FAILED_CREATION , FAILED_DELETION , PENDNG_UPDATE , FAILED_UPDATE , and DELETED .

getAttrVpcIngressConnectionArn

public java.lang.String getAttrVpcIngressConnectionArn()

The Amazon Resource Name (ARN) of the VPC Ingress Connection.

getCfnProperties

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

Overrides:

getCfnProperties in class CfnResource

getTags

public TagManager getTags()

An optional list of metadata items that you can associate with the VPC Ingress Connection resource.

A tag is a key-value pair.

getIngressVpcConfiguration

public java.lang.Object getIngressVpcConfiguration()

Specifications for the customer’s Amazon VPC and the related AWS PrivateLink VPC endpoint that are used to create the VPC Ingress Connection resource.

setIngressVpcConfiguration

public void setIngressVpcConfiguration(IResolvable value)

Specifications for the customer’s Amazon VPC and the related AWS PrivateLink VPC endpoint that are used to create the VPC Ingress Connection resource.

setIngressVpcConfiguration

public void setIngressVpcConfiguration(CfnVpcIngressConnection.IngressVpcConfigurationProperty value)

Specifications for the customer’s Amazon VPC and the related AWS PrivateLink VPC endpoint that are used to create the VPC Ingress Connection resource.

getServiceArn

public java.lang.String getServiceArn()

The Amazon Resource Name (ARN) for this App Runner service that is used to create the VPC Ingress Connection resource.

setServiceArn

public void setServiceArn(java.lang.String value)

The Amazon Resource Name (ARN) for this App Runner service that is used to create the VPC Ingress Connection resource.

getVpcIngressConnectionName

public java.lang.String getVpcIngressConnectionName()

The customer-provided VPC Ingress Connection name.

setVpcIngressConnectionName

public void setVpcIngressConnectionName(java.lang.String value)

The customer-provided VPC Ingress Connection name.