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.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:38.376Z")
 @Stability(value=Stable)
public class CfnVPCEndpointServicePermissions
extends CfnResource
implements IInspectable

A CloudFormation `AWS::EC2::VPCEndpointServicePermissions`.

Grant or revoke permissions for service consumers (IAM 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();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static 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.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

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

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

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

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnVPCEndpointServicePermissions(software.constructs.Construct scope, String id, CfnVPCEndpointServicePermissionsProps props) Create a new `AWS::EC2::VPCEndpointServicePermissions`.
protected	CfnVPCEndpointServicePermissions(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnVPCEndpointServicePermissions(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
List<String>	getAllowedPrincipals() The Amazon Resource Names (ARN) of one or more principals (IAM 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 (IAM users, IAM roles, and AWS accounts).
void	setServiceId(String value) The ID of the service.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, 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 Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnVPCEndpointServicePermissions

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

CfnVPCEndpointServicePermissions

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

CfnVPCEndpointServicePermissions

@Stability(value=Stable)
public CfnVPCEndpointServicePermissions(@NotNull
                                                                 software.constructs.Construct scope,
                                                                 @NotNull
                                                                 String id,
                                                                 @NotNull
                                                                 CfnVPCEndpointServicePermissionsProps props)

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

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

@Stability(value=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(value=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(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getServiceId

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

The ID of the service.

setServiceId

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

The ID of the service.

getAllowedPrincipals

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

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

Permissions are granted to the principals in this list. To grant permissions to all principals, specify an asterisk (*). Permissions are revoked for principals not in this list. If the list is empty, then all permissions are revoked.

setAllowedPrincipals

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

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

Permissions are granted to the principals in this list. To grant permissions to all principals, specify an asterisk (*). Permissions are revoked for principals not in this list. If the list is empty, then all permissions are revoked.