VpcEndpointService¶
-
class
aws_cdk.aws_ec2.
VpcEndpointService
(scope, id, *, vpc_endpoint_service_load_balancers, acceptance_required=None, vpc_endpoint_service_name=None, whitelisted_principals=None)¶ Bases:
aws_cdk.core.Resource
(experimental) A VPC endpoint service.
- Stability
experimental
- Resource
AWS::EC2::VPCEndpointService
- Parameters
scope (
Construct
) –id (
str
) –vpc_endpoint_service_load_balancers (
List
[IVpcEndpointServiceLoadBalancer
]) – (experimental) One or more load balancers to host the VPC Endpoint Service.acceptance_required (
Optional
[bool
]) – (experimental) Whether requests from service consumers to connect to the service through an endpoint must be accepted. Default: truevpc_endpoint_service_name (
Optional
[str
]) – (deprecated) Name of the Vpc Endpoint Service. Default: - CDK generated namewhitelisted_principals (
Optional
[List
[ArnPrincipal
]]) – (experimental) IAM users, IAM roles, or AWS accounts to allow inbound connections from. These principals can connect to your service using VPC endpoints. Takes a list of one or more ArnPrincipal. Default: - no principals
- Stability
experimental
Methods
-
apply_removal_policy
(policy)¶ Apply the given removal policy to this resource.
The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you’ve removed it from the CDK application or because you’ve made a change that requires the resource to be replaced.
The resource can be deleted (
RemovalPolicy.DELETE
), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN
).- Parameters
policy (
RemovalPolicy
) –- Return type
None
-
to_string
()¶ Returns a string representation of this construct.
- Return type
str
Attributes
-
acceptance_required
¶ (experimental) Whether to require manual acceptance of new connections to the service.
- Stability
experimental
- Return type
bool
-
env
¶ The environment this resource belongs to.
For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.
- Return type
-
node
¶ The construct tree node associated with this construct.
- Return type
-
vpc_endpoint_service_id
¶ (experimental) The id of the VPC Endpoint Service, like vpce-svc-xxxxxxxxxxxxxxxx.
- Stability
experimental
- Attribute
true
- Return type
str
-
vpc_endpoint_service_load_balancers
¶ (experimental) One or more network load balancers to host the service.
- Stability
experimental
- Attribute
true
- Return type
-
vpc_endpoint_service_name
¶ (experimental) The service name of the VPC Endpoint Service that clients use to connect to, like com.amazonaws.vpce..vpce-svc-xxxxxxxxxxxxxxxx.
- Stability
experimental
- Attribute
true
- Return type
str
-
whitelisted_principals
¶ (experimental) One or more Principal ARNs to allow inbound connections to.
- Stability
experimental
- Return type
List
[ArnPrincipal
]
Static Methods
-
classmethod
is_construct
(x)¶ Return whether the given object is a Construct.
- Parameters
x (
Any
) –- Return type
bool
-
classmethod
is_resource
(construct)¶ Check whether the given construct is a Resource.
- Parameters
construct (
IConstruct
) –- Return type
bool