Package software.amazon.awscdk.services.ec2

Class CfnVPCEndpointServicePermissions

java.lang.Object
software.amazon.jsii.JsiiObject
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.CfnVPCEndpointServicePermissions
All Implemented Interfaces:
IConstruct, IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:39.167Z") @Stability(Stable) public class CfnVPCEndpointServicePermissions extends CfnResource implements IInspectable
A CloudFormation AWS::EC2::VPCEndpointServicePermissions.

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();

  • 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 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 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 ).

      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(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 ).

      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.