Package software.amazon.awscdk.services.ec2

Class CfnVPCEndpointConnectionNotification

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.ec2.CfnVPCEndpointConnectionNotification

All Implemented Interfaces:

IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.98.0 (build 00b106d)",
           date="2024-05-08T21:35:06.035Z")
@Stability(Stable)
public class CfnVPCEndpointConnectionNotification
extends CfnResource
implements IInspectable

Specifies a connection notification for a VPC endpoint or VPC endpoint service.

A connection notification notifies you of specific endpoint events. You must create an SNS topic to receive notifications. For more information, see Create a Topic in the Amazon Simple Notification Service Developer Guide .

You can create a connection notification for interface endpoints only.

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.ec2.*;
 CfnVPCEndpointConnectionNotification cfnVPCEndpointConnectionNotification = CfnVPCEndpointConnectionNotification.Builder.create(this, "MyCfnVPCEndpointConnectionNotification")
         .connectionEvents(List.of("connectionEvents"))
         .connectionNotificationArn("connectionNotificationArn")
         // the properties below are optional
         .serviceId("serviceId")
         .vpcEndpointId("vpcEndpointId")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcendpointconnectionnotification.html

Nested Class Summary

Nested Classes

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

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

software.amazon.jsii.JsiiObject.InitializationMode

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

software.constructs.IConstruct.Jsii$Default

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

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Field Summary

Fields

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

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CfnVPCEndpointConnectionNotification(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnVPCEndpointConnectionNotification(software.amazon.jsii.JsiiObjectRef objRef)
	CfnVPCEndpointConnectionNotification(software.constructs.Construct scope, String id, CfnVPCEndpointConnectionNotificationProps props)

Method Summary

Modifier and Type	Method	Description
String	getAttrVpcEndpointConnectionNotificationId()	The ID of the notification.
protected Map<String,Object>	getCfnProperties()
List<String>	getConnectionEvents()	The endpoint events for which to receive notifications.
String	getConnectionNotificationArn()	The ARN of the SNS topic for the notifications.
String	getServiceId()	The ID of the endpoint service.
String	getVpcEndpointId()	The ID of the endpoint.
void	inspect(TreeInspector inspector)	Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setConnectionEvents(List<String> value)	The endpoint events for which to receive notifications.
void	setConnectionNotificationArn(String value)	The ARN of the SNS topic for the notifications.
void	setServiceId(String value)	The ID of the endpoint service.
void	setVpcEndpointId(String value)	The ID of the endpoint.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, obtainResourceDependencies, removeDependency, replaceDependency, 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 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

CfnVPCEndpointConnectionNotification

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

CfnVPCEndpointConnectionNotification

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

CfnVPCEndpointConnectionNotification

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

getAttrVpcEndpointConnectionNotificationId

@Stability(Stable)
@NotNull
public String getAttrVpcEndpointConnectionNotificationId()

The ID of the notification.

getCfnProperties

@Stability(Stable)
@NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getConnectionEvents

@Stability(Stable)
@NotNull
public List<String> getConnectionEvents()

The endpoint events for which to receive notifications.

setConnectionEvents

@Stability(Stable)
public void setConnectionEvents(@NotNull
 List<String> value)

The endpoint events for which to receive notifications.

getConnectionNotificationArn

@Stability(Stable)
@NotNull
public String getConnectionNotificationArn()

The ARN of the SNS topic for the notifications.

setConnectionNotificationArn

@Stability(Stable)
public void setConnectionNotificationArn(@NotNull
 String value)

The ARN of the SNS topic for the notifications.

getServiceId

@Stability(Stable)
@Nullable
public String getServiceId()

The ID of the endpoint service.

setServiceId

@Stability(Stable)
public void setServiceId(@Nullable
 String value)

The ID of the endpoint service.

getVpcEndpointId

@Stability(Stable)
@Nullable
public String getVpcEndpointId()

The ID of the endpoint.

setVpcEndpointId

@Stability(Stable)
public void setVpcEndpointId(@Nullable
 String value)

The ID of the endpoint.