Class: AWSCDK::EC2::VPCEndpointService

Inherits:
Resource
  • Object
show all
Includes:
IVPCEndpointService
Defined in:
ec2/vpc_endpoint_service.rb

Overview

A VPC endpoint service.

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props) ⇒ VPCEndpointService

Returns a new instance of VPCEndpointService.

Parameters:



12
13
14
15
16
17
18
 
# File 'ec2/vpc_endpoint_service.rb', line 12

def initialize(scope, id, props)
  props = props.is_a?(Hash) ? ::AWSCDK::EC2::VPCEndpointServiceProps.new(**props.transform_keys(&:to_sym)) : props
  Jsii::Type.check_type(scope, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLkNvbnN0cnVjdCJ9")), "scope")
  Jsii::Type.check_type(id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "id")
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfZWMyLlZwY0VuZHBvaW50U2VydmljZVByb3BzIn0=")), "props")
  Jsii::Object.instance_method(:initialize).bind(self).call(scope, id, props)
end

Class Method Details

.DEFAULT_PREFIX ⇒ String

The default value for a VPC Endpoint Service name prefix, useful if you do not have a synthesize-time region literal available (all you have is { "Ref": "AWS::Region" }).

Returns:

  • (String) 


89
90
91
 
# File 'ec2/vpc_endpoint_service.rb', line 89

def self.DEFAULT_PREFIX()
  Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_ec2.VpcEndpointService", "DEFAULT_PREFIX")
end

.jsii_overridable_methods ⇒ Object 



20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
 
# File 'ec2/vpc_endpoint_service.rb', line 20

def self.jsii_overridable_methods
  {
    :node => { kind: :property, name: "node", is_optional: false },
    :env => { kind: :property, name: "env", is_optional: false },
    :physical_name => { kind: :property, name: "physicalName", is_optional: false },
    :stack => { kind: :property, name: "stack", is_optional: false },
    :acceptance_required => { kind: :property, name: "acceptanceRequired", is_optional: false },
    :allowed_principals => { kind: :property, name: "allowedPrincipals", is_optional: false },
    :vpc_endpoint_service_id => { kind: :property, name: "vpcEndpointServiceId", is_optional: false },
    :vpc_endpoint_service_load_balancers => { kind: :property, name: "vpcEndpointServiceLoadBalancers", is_optional: false },
    :vpc_endpoint_service_name => { kind: :property, name: "vpcEndpointServiceName", is_optional: false },
    :vpc_endpoint_service_ref => { kind: :property, name: "vpcEndpointServiceRef", is_optional: false },
    :contributor_insights_enabled => { kind: :property, name: "contributorInsightsEnabled", is_optional: true },
    :to_string => { kind: :method, name: "toString", is_optional: false },
    :with => { kind: :method, name: "with", is_optional: false },
    :apply_cross_stack_reference_strength => { kind: :method, name: "applyCrossStackReferenceStrength", is_optional: false },
    :apply_removal_policy => { kind: :method, name: "applyRemovalPolicy", is_optional: false },
    :generate_physical_name => { kind: :method, name: "generatePhysicalName", is_optional: false },
    :get_resource_arn_attribute => { kind: :method, name: "getResourceArnAttribute", is_optional: false },
    :get_resource_name_attribute => { kind: :method, name: "getResourceNameAttribute", is_optional: false },
  }
end

.PROPERTY_INJECTION_ID ⇒ String

Uniquely identifies this class.

Returns:

  • (String) 


96
97
98
 
# File 'ec2/vpc_endpoint_service.rb', line 96

def self.PROPERTY_INJECTION_ID()
  Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_ec2.VpcEndpointService", "PROPERTY_INJECTION_ID")
end

Instance Method Details

#acceptance_required ⇒ Boolean

Whether to require manual acceptance of new connections to the service.

Returns:

  • (Boolean) 


103
104
105
 
# File 'ec2/vpc_endpoint_service.rb', line 103

def acceptance_required()
  jsii_get_property("acceptanceRequired")
end

#allowed_principals ⇒ Array<AWSCDK::IAM::ARNPrincipal>

One or more Principal ARNs to allow inbound connections to.

Returns:



110
111
112
 
# File 'ec2/vpc_endpoint_service.rb', line 110

def allowed_principals()
  jsii_get_property("allowedPrincipals")
end

#apply_cross_stack_reference_strength(strength) ⇒ void

This method returns an undefined value.

Override the cross-stack reference strength for this resource.

When set, any cross-stack reference to this resource will use the specified mechanism instead of the global default determined by the @aws-cdk/core:defaultCrossStackReferences context key. This is useful for selectively weakening specific references to avoid the "deadly embrace" problem without changing the app-wide default.

Parameters:



182
183
184
185
 
# File 'ec2/vpc_endpoint_service.rb', line 182

def apply_cross_stack_reference_strength(strength)
  Jsii::Type.check_type(strength, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZWZlcmVuY2VTdHJlbmd0aCJ9")), "strength")
  jsii_call_method("applyCrossStackReferenceStrength", [strength])
end

#apply_removal_policy(policy) ⇒ void

This method returns an undefined value.

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.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

Parameters:



199
200
201
202
 
# File 'ec2/vpc_endpoint_service.rb', line 199

def apply_removal_policy(policy)
  Jsii::Type.check_type(policy, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZW1vdmFsUG9saWN5In0=")), "policy")
  jsii_call_method("applyRemovalPolicy", [policy])
end

#contributor_insights_enabled ⇒ Boolean?

Whether to enable the built-in Contributor Insights rules provided by AWS PrivateLink.

Returns:

  • (Boolean, nil) 


145
146
147
 
# File 'ec2/vpc_endpoint_service.rb', line 145

def contributor_insights_enabled()
  jsii_get_property("contributorInsightsEnabled")
end

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

The environment this resource belongs to.

For resources that are created and managed in a Stack (those created by creating new class instances like new Role(), new Bucket(), etc.), this is always the same as the environment of the stack they belong to.

For referenced resources (those obtained from referencing methods like Role.fromRoleArn(), Bucket.fromBucketName(), etc.), they might be different than the stack they were imported into.

Returns:



61
62
63
 
# File 'ec2/vpc_endpoint_service.rb', line 61

def env()
  jsii_get_property("env")
end

#generate_physical_name ⇒ String

Returns:

  • (String) 


205
206
207
 
# File 'ec2/vpc_endpoint_service.rb', line 205

def generate_physical_name()
  jsii_call_method("generatePhysicalName", [])
end

#get_resource_arn_attribute(arn_attr, arn_components) ⇒ String

Returns an environment-sensitive token that should be used for the resource's "ARN" attribute (e.g. bucket.bucketArn).

Normally, this token will resolve to arn_attr, but if the resource is referenced across environments, arn_components will be used to synthesize a concrete ARN with the resource's physical name. Make sure to reference this.physicalName in arn_components.

Parameters:

  • arn_attr (String) —

    The CFN attribute which resolves to the ARN of the resource.

  • arn_components (AWSCDK::ARNComponents) —

    The format of the ARN of this resource.

Returns:

  • (String) 


219
220
221
222
223
224
 
# File 'ec2/vpc_endpoint_service.rb', line 219

def get_resource_arn_attribute(arn_attr, arn_components)
  Jsii::Type.check_type(arn_attr, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "arnAttr")
  arn_components = arn_components.is_a?(Hash) ? ::AWSCDK::ARNComponents.new(**arn_components.transform_keys(&:to_sym)) : arn_components
  Jsii::Type.check_type(arn_components, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5Bcm5Db21wb25lbnRzIn0=")), "arnComponents")
  jsii_call_method("getResourceArnAttribute", [arn_attr, arn_components])
end

#get_resource_name_attribute(name_attr) ⇒ String

Returns an environment-sensitive token that should be used for the resource's "name" attribute (e.g. bucket.bucketName).

Normally, this token will resolve to name_attr, but if the resource is referenced across environments, it will be resolved to this.physicalName, which will be a concrete name.

Parameters:

  • name_attr (String) —

    The CFN attribute which resolves to the resource's name.

Returns:

  • (String) 


234
235
236
237
 
# File 'ec2/vpc_endpoint_service.rb', line 234

def get_resource_name_attribute(name_attr)
  Jsii::Type.check_type(name_attr, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "nameAttr")
  jsii_call_method("getResourceNameAttribute", [name_attr])
end

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


46
47
48
 
# File 'ec2/vpc_endpoint_service.rb', line 46

def node()
  jsii_get_property("node")
end

#physical_name ⇒ String

Returns a string-encoded token that resolves to the physical name that should be passed to the CloudFormation resource.

This value will resolve to one of the following:

  • a concrete value (e.g. "my-awesome-bucket")
  • undefined, when a name should be generated by CloudFormation
  • a concrete name generated automatically during synthesis, in cross-environment scenarios.

Returns:

  • (String) 


75
76
77
 
# File 'ec2/vpc_endpoint_service.rb', line 75

def physical_name()
  jsii_get_property("physicalName")
end

#stack ⇒ AWSCDK::Stack

The stack in which this resource is defined.

Returns:



82
83
84
 
# File 'ec2/vpc_endpoint_service.rb', line 82

def stack()
  jsii_get_property("stack")
end

#to_string ⇒ String

Returns a string representation of this construct.

Returns:

  • (String) 


152
153
154
 
# File 'ec2/vpc_endpoint_service.rb', line 152

def to_string()
  jsii_call_method("toString", [])
end

#vpc_endpoint_service_id ⇒ String

The id of the VPC Endpoint Service, like vpce-svc-xxxxxxxxxxxxxxxx.

Returns:

  • (String) 


117
118
119
 
# File 'ec2/vpc_endpoint_service.rb', line 117

def vpc_endpoint_service_id()
  jsii_get_property("vpcEndpointServiceId")
end

#vpc_endpoint_service_load_balancers ⇒ Array<AWSCDK::EC2::IVPCEndpointServiceLoadBalancer>

One or more network load balancers to host the service.

Returns:



124
125
126
 
# File 'ec2/vpc_endpoint_service.rb', line 124

def vpc_endpoint_service_load_balancers()
  jsii_get_property("vpcEndpointServiceLoadBalancers")
end

#vpc_endpoint_service_name ⇒ String

The service name of the VPC Endpoint Service that clients use to connect to, like com.amazonaws.vpce..vpce-svc-xxxxxxxxxxxxxxxx.

Returns:

  • (String) 


131
132
133
 
# File 'ec2/vpc_endpoint_service.rb', line 131

def vpc_endpoint_service_name()
  jsii_get_property("vpcEndpointServiceName")
end

#vpc_endpoint_service_ref ⇒ AWSCDK::Interfaces::AWSEC2::VPCEndpointServiceReference

A reference to a VPCEndpointService resource.

Returns:



138
139
140
 
# File 'ec2/vpc_endpoint_service.rb', line 138

def vpc_endpoint_service_ref()
  jsii_get_property("vpcEndpointServiceRef")
end

#with(*mixins) ⇒ Constructs::IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

Parameters:

  • mixins (Array<Constructs::IMixin>)

Returns:

  • (Constructs::IConstruct) 


165
166
167
168
169
170
 
# File 'ec2/vpc_endpoint_service.rb', line 165

def with(*mixins)
  mixins.each_with_index do |item, index|
    Jsii::Type.check_type(item, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLklNaXhpbiJ9")), "mixins[#{index}]")
  end
  jsii_call_method("with", [*mixins])
end