software.amazon.awscdk.services.ec2

Class CfnVPCEndpointService

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

All Implemented Interfaces:

IConstruct, IDependable, IInspectable

@Generated(value="jsii-pacmak/1.71.0 (build f1f58ae)",
           date="2022-11-29T04:32:20.494Z")
public class CfnVPCEndpointService
extends CfnResource
implements IInspectable

A CloudFormation `AWS::EC2::VPCEndpointService`.

Creates a VPC endpoint service configuration to which service consumers ( AWS accounts, IAM users, and IAM roles) can connect.

To create an endpoint service configuration, you must first create one of the following for your service:

• A Network Load Balancer . Service consumers connect to your service using an interface endpoint.
• A Gateway Load Balancer . Service consumers connect to your service using a Gateway Load Balancer endpoint.

For more information, see the AWS PrivateLink User Guide .

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.*;
 CfnVPCEndpointService cfnVPCEndpointService = CfnVPCEndpointService.Builder.create(this, "MyCfnVPCEndpointService")
         .acceptanceRequired(false)
         .contributorInsightsEnabled(false)
         .gatewayLoadBalancerArns(List.of("gatewayLoadBalancerArns"))
         .networkLoadBalancerArns(List.of("networkLoadBalancerArns"))
         .payerResponsibility("payerResponsibility")
         .build();
 

Nested Class Summary

Nested Classes

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

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

Method Summary

Modifier and Type	Method and Description
java.lang.Object	getAcceptanceRequired() Indicates whether requests from service consumers to create an endpoint to your service must be accepted.
protected java.util.Map<java.lang.String,java.lang.Object>	getCfnProperties()
java.lang.Object	getContributorInsightsEnabled() `AWS::EC2::VPCEndpointService.ContributorInsightsEnabled`.
java.util.List<java.lang.String>	getGatewayLoadBalancerArns() The Amazon Resource Names (ARNs) of one or more Gateway Load Balancers.
java.util.List<java.lang.String>	getNetworkLoadBalancerArns() The Amazon Resource Names (ARNs) of one or more Network Load Balancers for your service.
java.lang.String	getPayerResponsibility() The entity that is responsible for the endpoint costs.
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	setAcceptanceRequired(java.lang.Boolean value) Indicates whether requests from service consumers to create an endpoint to your service must be accepted.
void	setAcceptanceRequired(IResolvable value) Indicates whether requests from service consumers to create an endpoint to your service must be accepted.
void	setContributorInsightsEnabled(java.lang.Boolean value) `AWS::EC2::VPCEndpointService.ContributorInsightsEnabled`.
void	setContributorInsightsEnabled(IResolvable value) `AWS::EC2::VPCEndpointService.ContributorInsightsEnabled`.
void	setGatewayLoadBalancerArns(java.util.List<java.lang.String> value) The Amazon Resource Names (ARNs) of one or more Gateway Load Balancers.
void	setNetworkLoadBalancerArns(java.util.List<java.lang.String> value) The Amazon Resource Names (ARNs) of one or more Network Load Balancers for your service.
void	setPayerResponsibility(java.lang.String value) The entity that is responsible for the endpoint costs.

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

CfnVPCEndpointService

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

CfnVPCEndpointService

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

CfnVPCEndpointService

public CfnVPCEndpointService(Construct scope,
                             java.lang.String id,
                             CfnVPCEndpointServiceProps props)

Create a new `AWS::EC2::VPCEndpointService`.

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.

CfnVPCEndpointService

public CfnVPCEndpointService(Construct scope,
                             java.lang.String id)

Create a new `AWS::EC2::VPCEndpointService`.

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. 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.

getCfnProperties

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

Overrides:

getCfnProperties in class CfnResource

getAcceptanceRequired

public java.lang.Object getAcceptanceRequired()

Indicates whether requests from service consumers to create an endpoint to your service must be accepted.

setAcceptanceRequired

public void setAcceptanceRequired(java.lang.Boolean value)

Indicates whether requests from service consumers to create an endpoint to your service must be accepted.

setAcceptanceRequired

public void setAcceptanceRequired(IResolvable value)

Indicates whether requests from service consumers to create an endpoint to your service must be accepted.

getContributorInsightsEnabled

public java.lang.Object getContributorInsightsEnabled()

`AWS::EC2::VPCEndpointService.ContributorInsightsEnabled`.

setContributorInsightsEnabled

public void setContributorInsightsEnabled(java.lang.Boolean value)

`AWS::EC2::VPCEndpointService.ContributorInsightsEnabled`.

setContributorInsightsEnabled

public void setContributorInsightsEnabled(IResolvable value)

`AWS::EC2::VPCEndpointService.ContributorInsightsEnabled`.

getGatewayLoadBalancerArns

public java.util.List<java.lang.String> getGatewayLoadBalancerArns()

The Amazon Resource Names (ARNs) of one or more Gateway Load Balancers.

setGatewayLoadBalancerArns

public void setGatewayLoadBalancerArns(java.util.List<java.lang.String> value)

The Amazon Resource Names (ARNs) of one or more Gateway Load Balancers.

getNetworkLoadBalancerArns

public java.util.List<java.lang.String> getNetworkLoadBalancerArns()

The Amazon Resource Names (ARNs) of one or more Network Load Balancers for your service.

setNetworkLoadBalancerArns

public void setNetworkLoadBalancerArns(java.util.List<java.lang.String> value)

The Amazon Resource Names (ARNs) of one or more Network Load Balancers for your service.

getPayerResponsibility

public java.lang.String getPayerResponsibility()

The entity that is responsible for the endpoint costs.

The default is the endpoint owner. If you set the payer responsibility to the service owner, you cannot set it back to the endpoint owner.

setPayerResponsibility

public void setPayerResponsibility(java.lang.String value)

The entity that is responsible for the endpoint costs.

The default is the endpoint owner. If you set the payer responsibility to the service owner, you cannot set it back to the endpoint owner.