Package software.amazon.awscdk.services.ec2

Class CfnVPCEndpointServicePermissions

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

All Implemented Interfaces:

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

@Generated(value="jsii-pacmak/1.97.0 (build 729de35)",
           date="2024-04-24T21:00:28.771Z")
@Stability(Stable)
public class CfnVPCEndpointServicePermissions
extends CfnResource
implements IInspectable

Grant or revoke permissions for service consumers (users, IAM roles, and AWS accounts) to connect to a VPC endpoint service.

If you grant permissions to all principals, the service is public. Any users who know the name of a public service can send a request to attach an endpoint. If the service does not require manual approval, attachments are automatically approved.

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.*;
 CfnVPCEndpointServicePermissions cfnVPCEndpointServicePermissions = CfnVPCEndpointServicePermissions.Builder.create(this, "MyCfnVPCEndpointServicePermissions")
         .serviceId("serviceId")
         // the properties below are optional
         .allowedPrincipals(List.of("allowedPrincipals"))
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

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	CfnVPCEndpointServicePermissions(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnVPCEndpointServicePermissions(software.amazon.jsii.JsiiObjectRef objRef)
	CfnVPCEndpointServicePermissions(software.constructs.Construct scope, String id, CfnVPCEndpointServicePermissionsProps props)

Method Summary

Modifier and Type	Method	Description
List<String>	getAllowedPrincipals()	The Amazon Resource Names (ARN) of one or more principals (for example, users, IAM roles, and AWS accounts ).
protected Map<String,Object>	getCfnProperties()
String	getServiceId()	The ID of the service.
void	inspect(TreeInspector inspector)	Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setAllowedPrincipals(List<String> value)	The Amazon Resource Names (ARN) of one or more principals (for example, users, IAM roles, and AWS accounts ).
void	setServiceId(String value)	The ID of the service.

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

CfnVPCEndpointServicePermissions

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

CfnVPCEndpointServicePermissions

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

CfnVPCEndpointServicePermissions

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

getCfnProperties

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

Overrides:

getCfnProperties in class CfnResource

getServiceId

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

The ID of the service.

setServiceId

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

The ID of the service.

getAllowedPrincipals

@Stability(Stable)
@Nullable
public List<String> getAllowedPrincipals()

The Amazon Resource Names (ARN) of one or more principals (for example, users, IAM roles, and AWS accounts ).

setAllowedPrincipals

@Stability(Stable)
public void setAllowedPrincipals(@Nullable
 List<String> value)

The Amazon Resource Names (ARN) of one or more principals (for example, users, IAM roles, and AWS accounts ).