Class: AWSCDK::EC2::CfnInstanceConnectEndpoint

Inherits:
CfnResource
  • Object
show all
Includes:
IInspectable, ITaggableV2, Interfaces::AWSEC2::IInstanceConnectEndpointRef
Defined in:
ec2/cfn_instance_connect_endpoint.rb

Overview

Creates an EC2 Instance Connect Endpoint.

An EC2 Instance Connect Endpoint allows you to connect to an instance, without requiring the instance to have a public IPv4 address. For more information, see Connect to your instances using EC2 Instance Connect Endpoint in the Amazon EC2 User Guide .

With the replacement update behavior, CloudFormation usually creates the new resource first, changes references to point to the new resource, and then deletes the old resource. However, you can create only one EC2 Instance Connect Endpoint per VPC, so the replacement process fails. If you need to modify an EC2 Instance Connect Endpoint, you must replace the resource manually.

See Also:

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props) ⇒ CfnInstanceConnectEndpoint

Create a new AWS::EC2::InstanceConnectEndpoint.

Parameters:

  • scope (Constructs::Construct) —

    Scope in which this resource is defined.

  • id (String) —

    Construct identifier for this resource (unique in its scope).

  • props (AWSCDK::EC2::CfnInstanceConnectEndpointProps) —

    Resource properties.



22
23
24
25
26
27
28
 
# File 'ec2/cfn_instance_connect_endpoint.rb', line 22

def initialize(scope, id, props)
  props = props.is_a?(Hash) ? ::AWSCDK::EC2::CfnInstanceConnectEndpointProps.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("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfZWMyLkNmbkluc3RhbmNlQ29ubmVjdEVuZHBvaW50UHJvcHMifQ==")), "props")
  Jsii::Object.instance_method(:initialize).bind(self).call(scope, id, props)
end

Class Method Details

.arn_for_instance_connect_endpoint(resource) ⇒ String

Parameters:

Returns:

  • (String) 


90
91
92
93
 
# File 'ec2/cfn_instance_connect_endpoint.rb', line 90

def self.arn_for_instance_connect_endpoint(resource)
  Jsii::Type.check_type(resource, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19lYzIuSUluc3RhbmNlQ29ubmVjdEVuZHBvaW50UmVmIn0=")), "resource")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_ec2.CfnInstanceConnectEndpoint", "arnForInstanceConnectEndpoint", [resource])
end

.CFN_RESOURCE_TYPE_NAME ⇒ String

The CloudFormation resource type name for this resource class.

Returns:

  • (String) 


223
224
225
 
# File 'ec2/cfn_instance_connect_endpoint.rb', line 223

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

.from_instance_connect_endpoint_arn(scope, id, arn) ⇒ AWSCDK::Interfaces::AWSEC2::IInstanceConnectEndpointRef

Creates a new IInstanceConnectEndpointRef from an ARN.

Parameters:

  • scope (Constructs::Construct)
  • id (String)
  • arn (String)

Returns:



101
102
103
104
105
106
 
# File 'ec2/cfn_instance_connect_endpoint.rb', line 101

def self.from_instance_connect_endpoint_arn(scope, id, arn)
  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(arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "arn")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_ec2.CfnInstanceConnectEndpoint", "fromInstanceConnectEndpointArn", [scope, id, arn])
end

.from_instance_connect_endpoint_id(scope, id, instance_connect_endpoint_id) ⇒ AWSCDK::Interfaces::AWSEC2::IInstanceConnectEndpointRef

Creates a new IInstanceConnectEndpointRef from a instanceConnectEndpointId.

Parameters:

  • scope (Constructs::Construct)
  • id (String)
  • instance_connect_endpoint_id (String)

Returns:



114
115
116
117
118
119
 
# File 'ec2/cfn_instance_connect_endpoint.rb', line 114

def self.from_instance_connect_endpoint_id(scope, id, instance_connect_endpoint_id)
  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(instance_connect_endpoint_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "instanceConnectEndpointId")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_ec2.CfnInstanceConnectEndpoint", "fromInstanceConnectEndpointId", [scope, id, instance_connect_endpoint_id])
end

.is_cfn_instance_connect_endpoint(x) ⇒ Boolean

Checks whether the given object is a CfnInstanceConnectEndpoint.

Parameters:

  • x (Object)

Returns:

  • (Boolean) 


125
126
127
128
 
# File 'ec2/cfn_instance_connect_endpoint.rb', line 125

def self.is_cfn_instance_connect_endpoint(x)
  Jsii::Type.check_type(x, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "x")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_ec2.CfnInstanceConnectEndpoint", "isCfnInstanceConnectEndpoint", [x])
end

.jsii_overridable_methods ⇒ Object 



30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
 
# File 'ec2/cfn_instance_connect_endpoint.rb', line 30

def self.jsii_overridable_methods
  {
    :node => { kind: :property, name: "node", is_optional: false },
    :creation_stack => { kind: :property, name: "creationStack", is_optional: false },
    :logical_id => { kind: :property, name: "logicalId", is_optional: false },
    :stack => { kind: :property, name: "stack", is_optional: false },
    :ref => { kind: :property, name: "ref", is_optional: false },
    :cfn_options => { kind: :property, name: "cfnOptions", is_optional: false },
    :cfn_properties => { kind: :property, name: "cfnProperties", is_optional: false },
    :cfn_property_names => { kind: :property, name: "cfnPropertyNames", is_optional: false },
    :cfn_resource_type => { kind: :property, name: "cfnResourceType", is_optional: false },
    :env => { kind: :property, name: "env", is_optional: false },
    :updated_properites => { kind: :property, name: "updatedProperites", is_optional: false },
    :updated_properties => { kind: :property, name: "updatedProperties", is_optional: false },
    :attr_availability_zone => { kind: :property, name: "attrAvailabilityZone", is_optional: false },
    :attr_availability_zone_id => { kind: :property, name: "attrAvailabilityZoneId", is_optional: false },
    :attr_created_at => { kind: :property, name: "attrCreatedAt", is_optional: false },
    :attr_id => { kind: :property, name: "attrId", is_optional: false },
    :attr_instance_connect_endpoint_arn => { kind: :property, name: "attrInstanceConnectEndpointArn", is_optional: false },
    :attr_network_interface_ids => { kind: :property, name: "attrNetworkInterfaceIds", is_optional: false },
    :attr_owner_id => { kind: :property, name: "attrOwnerId", is_optional: false },
    :attr_public_dns_names => { kind: :property, name: "attrPublicDnsNames", is_optional: false },
    :attr_state => { kind: :property, name: "attrState", is_optional: false },
    :attr_state_message => { kind: :property, name: "attrStateMessage", is_optional: false },
    :attr_vpc_id => { kind: :property, name: "attrVpcId", is_optional: false },
    :cdk_tag_manager => { kind: :property, name: "cdkTagManager", is_optional: false },
    :instance_connect_endpoint_ref => { kind: :property, name: "instanceConnectEndpointRef", is_optional: false },
    :subnet_id => { kind: :property, name: "subnetId", is_optional: false },
    :client_token => { kind: :property, name: "clientToken", is_optional: true },
    :preserve_client_ip => { kind: :property, name: "preserveClientIp", is_optional: true },
    :security_group_ids => { kind: :property, name: "securityGroupIds", is_optional: true },
    :tags => { kind: :property, name: "tags", is_optional: true },
    :to_string => { kind: :method, name: "toString", is_optional: false },
    :with => { kind: :method, name: "with", is_optional: false },
    :override_logical_id => { kind: :method, name: "overrideLogicalId", is_optional: false },
    :add_deletion_override => { kind: :method, name: "addDeletionOverride", is_optional: false },
    :add_dependency => { kind: :method, name: "addDependency", is_optional: false },
    :add_depends_on => { kind: :method, name: "addDependsOn", is_optional: false },
    :add_metadata => { kind: :method, name: "addMetadata", is_optional: false },
    :add_override => { kind: :method, name: "addOverride", is_optional: false },
    :add_property_deletion_override => { kind: :method, name: "addPropertyDeletionOverride", is_optional: false },
    :add_property_override => { kind: :method, name: "addPropertyOverride", 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 },
    :cfn_property_name => { kind: :method, name: "cfnPropertyName", is_optional: false },
    :get_att => { kind: :method, name: "getAtt", is_optional: false },
    :get_metadata => { kind: :method, name: "getMetadata", is_optional: false },
    :obtain_dependencies => { kind: :method, name: "obtainDependencies", is_optional: false },
    :obtain_resource_dependencies => { kind: :method, name: "obtainResourceDependencies", is_optional: false },
    :remove_dependency => { kind: :method, name: "removeDependency", is_optional: false },
    :render_properties => { kind: :method, name: "renderProperties", is_optional: false },
    :replace_dependency => { kind: :method, name: "replaceDependency", is_optional: false },
    :should_synthesize => { kind: :method, name: "shouldSynthesize", is_optional: false },
    :validate_properties => { kind: :method, name: "validateProperties", is_optional: false },
    :inspect => { kind: :method, name: "inspect", is_optional: false },
  }
end

Instance Method Details

#add_deletion_override(path) ⇒ void

This method returns an undefined value.

Syntactic sugar for addOverride(path, undefined).

Parameters:

  • path (String) —

    The path of the value to delete.



419
420
421
422
 
# File 'ec2/cfn_instance_connect_endpoint.rb', line 419

def add_deletion_override(path)
  Jsii::Type.check_type(path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "path")
  jsii_call_method("addDeletionOverride", [path])
end

#add_dependency(target) ⇒ void

This method returns an undefined value.

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

Parameters:



431
432
433
434
 
# File 'ec2/cfn_instance_connect_endpoint.rb', line 431

def add_dependency(target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  jsii_call_method("addDependency", [target])
end

#add_depends_on(target) ⇒ void

Deprecated.

use addDependency

This method returns an undefined value.

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

Parameters:



441
442
443
444
 
# File 'ec2/cfn_instance_connect_endpoint.rb', line 441

def add_depends_on(target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  jsii_call_method("addDependsOn", [target])
end

#add_metadata(key, value) ⇒ void

This method returns an undefined value.

Add a value to the CloudFormation Resource Metadata.

Parameters:

  • key (String)
  • value (Object)

See Also:



452
453
454
455
456
 
# File 'ec2/cfn_instance_connect_endpoint.rb', line 452

def add_metadata(key, value)
  Jsii::Type.check_type(key, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "key")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value")
  jsii_call_method("addMetadata", [key, value])
end

#add_override(path, value) ⇒ void

This method returns an undefined value.

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use add_property_override or prefix path with "Properties." (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example,

# Example automatically generated from non-compiling source. May contain errors.
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"])
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")

would add the overrides

"Properties": {
  "GlobalSecondaryIndexes": [
    {
      "Projection": {
        "NonKeyAttributes": [ "myattribute" ]
        ...
      }
      ...
    },
    {
      "ProjectionType": "INCLUDE"
      ...
    },
  ]
  ...
}

The value argument to add_override will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

Parameters:

  • path (String) —
    • The path of the property, you can use dot notation to override values in complex types.
  • value (Object) —
    • The value.


509
510
511
512
513
 
# File 'ec2/cfn_instance_connect_endpoint.rb', line 509

def add_override(path, value)
  Jsii::Type.check_type(path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "path")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value")
  jsii_call_method("addOverride", [path, value])
end

#add_property_deletion_override(property_path) ⇒ void

This method returns an undefined value.

Adds an override that deletes the value of a property from the resource definition.

Parameters:

  • property_path (String) —

    The path to the property.



519
520
521
522
 
# File 'ec2/cfn_instance_connect_endpoint.rb', line 519

def add_property_deletion_override(property_path)
  Jsii::Type.check_type(property_path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "propertyPath")
  jsii_call_method("addPropertyDeletionOverride", [property_path])
end

#add_property_override(property_path, value) ⇒ void

This method returns an undefined value.

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

Parameters:

  • property_path (String) —

    The path of the property.

  • value (Object) —

    The value.



531
532
533
534
535
 
# File 'ec2/cfn_instance_connect_endpoint.rb', line 531

def add_property_override(property_path, value)
  Jsii::Type.check_type(property_path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "propertyPath")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value")
  jsii_call_method("addPropertyOverride", [property_path, value])
end

#apply_cross_stack_reference_strength(strength) ⇒ void

This method returns an undefined value.

Sets the cross-stack reference strength for this resource.

When set, any cross-stack reference to this resource will use the specified strength instead of the global default from the consuming stack's context.

Parameters:



544
545
546
547
 
# File 'ec2/cfn_instance_connect_endpoint.rb', line 544

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 = nil, options = nil) ⇒ void

This method returns an undefined value.

Sets the deletion policy of the resource based on the removal policy specified.

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). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:

Parameters:

See Also:



566
567
568
569
570
571
 
# File 'ec2/cfn_instance_connect_endpoint.rb', line 566

def apply_removal_policy(policy = nil, options = nil)
  Jsii::Type.check_type(policy, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZW1vdmFsUG9saWN5In0=")), "policy") unless policy.nil?
  options = options.is_a?(Hash) ? ::AWSCDK::RemovalPolicyOptions.new(**options.transform_keys(&:to_sym)) : options
  Jsii::Type.check_type(options, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZW1vdmFsUG9saWN5T3B0aW9ucyJ9")), "options") unless options.nil?
  jsii_call_method("applyRemovalPolicy", [policy, options])
end

#attr_availability_zone ⇒ String

The Availability Zone of the EC2 Instance Connect Endpoint.

Returns:

  • (String) 


230
231
232
 
# File 'ec2/cfn_instance_connect_endpoint.rb', line 230

def attr_availability_zone()
  jsii_get_property("attrAvailabilityZone")
end

#attr_availability_zone_id ⇒ String

The ID of the Availability Zone of the EC2 Instance Connect Endpoint.

Returns:

  • (String) 


237
238
239
 
# File 'ec2/cfn_instance_connect_endpoint.rb', line 237

def attr_availability_zone_id()
  jsii_get_property("attrAvailabilityZoneId")
end

#attr_created_at ⇒ String

The date and time that the EC2 Instance Connect Endpoint was created.

Returns:

  • (String) 


244
245
246
 
# File 'ec2/cfn_instance_connect_endpoint.rb', line 244

def attr_created_at()
  jsii_get_property("attrCreatedAt")
end

#attr_id ⇒ String

The ID of the EC2 Instance Connect Endpoint.

Returns:

  • (String) 


251
252
253
 
# File 'ec2/cfn_instance_connect_endpoint.rb', line 251

def attr_id()
  jsii_get_property("attrId")
end

#attr_instance_connect_endpoint_arn ⇒ String

The Amazon Resource Name (ARN) of the EC2 Instance Connect Endpoint.

Returns:

  • (String) 


258
259
260
 
# File 'ec2/cfn_instance_connect_endpoint.rb', line 258

def attr_instance_connect_endpoint_arn()
  jsii_get_property("attrInstanceConnectEndpointArn")
end

#attr_network_interface_ids ⇒ Array<String>

The ID of the elastic network interface that Amazon EC2 automatically created when creating the EC2 Instance Connect Endpoint.

Returns:

  • (Array<String>) 


265
266
267
 
# File 'ec2/cfn_instance_connect_endpoint.rb', line 265

def attr_network_interface_ids()
  jsii_get_property("attrNetworkInterfaceIds")
end

#attr_owner_id ⇒ String

The ID of the AWS account that created the EC2 Instance Connect Endpoint.

Returns:

  • (String) 


272
273
274
 
# File 'ec2/cfn_instance_connect_endpoint.rb', line 272

def attr_owner_id()
  jsii_get_property("attrOwnerId")
end

#attr_public_dns_names ⇒ AWSCDK::IResolvable

The public DNS names of the endpoint, including IPv4-only and dualstack DNS names.

Returns:



279
280
281
 
# File 'ec2/cfn_instance_connect_endpoint.rb', line 279

def attr_public_dns_names()
  jsii_get_property("attrPublicDnsNames")
end

#attr_state ⇒ String

The current state of the EC2 Instance Connect Endpoint.

Returns:

  • (String) 


286
287
288
 
# File 'ec2/cfn_instance_connect_endpoint.rb', line 286

def attr_state()
  jsii_get_property("attrState")
end

#attr_state_message ⇒ String

The message for the current state of the EC2 Instance Connect Endpoint.

Can include a failure message

Returns:

  • (String) 


295
296
297
 
# File 'ec2/cfn_instance_connect_endpoint.rb', line 295

def attr_state_message()
  jsii_get_property("attrStateMessage")
end

#attr_vpc_id ⇒ String

The ID of the VPC in which the EC2 Instance Connect Endpoint was created.

Returns:

  • (String) 


302
303
304
 
# File 'ec2/cfn_instance_connect_endpoint.rb', line 302

def attr_vpc_id()
  jsii_get_property("attrVpcId")
end

#cdk_tag_manager ⇒ AWSCDK::TagManager

Tag Manager which manages the tags for this resource.

Returns:



309
310
311
 
# File 'ec2/cfn_instance_connect_endpoint.rb', line 309

def cdk_tag_manager()
  jsii_get_property("cdkTagManager")
end

#cfn_options ⇒ AWSCDK::ICfnResourceOptions

Options for this resource, such as condition, update policy etc.

Returns:



176
177
178
 
# File 'ec2/cfn_instance_connect_endpoint.rb', line 176

def cfn_options()
  jsii_get_property("cfnOptions")
end

#cfn_properties ⇒ Hash{String => Object}

Returns:

  • (Hash{String => Object}) 


181
182
183
 
# File 'ec2/cfn_instance_connect_endpoint.rb', line 181

def cfn_properties()
  jsii_get_property("cfnProperties")
end

#cfn_property_name(cdk_property_name) ⇒ String?

Parameters:

  • cdk_property_name (String)

Returns:

  • (String, nil) 


575
576
577
578
 
# File 'ec2/cfn_instance_connect_endpoint.rb', line 575

def cfn_property_name(cdk_property_name)
  Jsii::Type.check_type(cdk_property_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "cdkPropertyName")
  jsii_call_method("cfnPropertyName", [cdk_property_name])
end

#cfn_property_names ⇒ Hash{String => String}

Returns:

  • (Hash{String => String}) 


186
187
188
 
# File 'ec2/cfn_instance_connect_endpoint.rb', line 186

def cfn_property_names()
  jsii_get_property("cfnPropertyNames")
end

#cfn_resource_type ⇒ String

AWS resource type.

Returns:

  • (String) 


193
194
195
 
# File 'ec2/cfn_instance_connect_endpoint.rb', line 193

def cfn_resource_type()
  jsii_get_property("cfnResourceType")
end

#client_token ⇒ String?

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

Returns:

  • (String, nil) 


335
336
337
 
# File 'ec2/cfn_instance_connect_endpoint.rb', line 335

def client_token()
  jsii_get_property("clientToken")
end

#client_token=(value) ⇒ Object 



339
340
341
342
 
# File 'ec2/cfn_instance_connect_endpoint.rb', line 339

def client_token=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "clientToken") unless value.nil?
  jsii_set_property("clientToken", value)
end

#creation_stack ⇒ Array<String>

Returns:

  • (Array<String>) 


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

def creation_stack()
  jsii_get_property("creationStack")
end

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

Returns:



198
199
200
 
# File 'ec2/cfn_instance_connect_endpoint.rb', line 198

def env()
  jsii_get_property("env")
end

#get_att(attribute_name, type_hint = nil) ⇒ AWSCDK::Reference

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

Parameters:

Returns:



588
589
590
591
592
 
# File 'ec2/cfn_instance_connect_endpoint.rb', line 588

def get_att(attribute_name, type_hint = nil)
  Jsii::Type.check_type(attribute_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "attributeName")
  Jsii::Type.check_type(type_hint, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZXNvbHV0aW9uVHlwZUhpbnQifQ==")), "typeHint") unless type_hint.nil?
  jsii_call_method("getAtt", [attribute_name, type_hint])
end

#get_metadata(key) ⇒ Object

Retrieve a value value from the CloudFormation Resource Metadata.

Parameters:

  • key (String)

Returns:

  • (Object)

See Also:



599
600
601
602
 
# File 'ec2/cfn_instance_connect_endpoint.rb', line 599

def get_metadata(key)
  Jsii::Type.check_type(key, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "key")
  jsii_call_method("getMetadata", [key])
end

#inspect(inspector) ⇒ void

This method returns an undefined value.

Examines the CloudFormation resource and discloses attributes.

Parameters:



669
670
671
672
 
# File 'ec2/cfn_instance_connect_endpoint.rb', line 669

def inspect(inspector)
  Jsii::Type.check_type(inspector, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5UcmVlSW5zcGVjdG9yIn0=")), "inspector")
  jsii_call_method("inspect", [inspector])
end

#instance_connect_endpoint_ref ⇒ AWSCDK::Interfaces::AWSEC2::InstanceConnectEndpointReference

A reference to a InstanceConnectEndpoint resource.

Returns:



316
317
318
 
# File 'ec2/cfn_instance_connect_endpoint.rb', line 316

def instance_connect_endpoint_ref()
  jsii_get_property("instanceConnectEndpointRef")
end

#logical_id ⇒ String

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use override_logical_id(new_logical_id).

Returns:

  • (String) 


150
151
152
 
# File 'ec2/cfn_instance_connect_endpoint.rb', line 150

def logical_id()
  jsii_get_property("logicalId")
end

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


133
134
135
 
# File 'ec2/cfn_instance_connect_endpoint.rb', line 133

def node()
  jsii_get_property("node")
end

#obtain_dependencies ⇒ Array<AWSCDK::CfnResource, AWSCDK::Stack>

Retrieves an array of resources this resource depends on.

This assembles dependencies on resources across stacks (including nested stacks) automatically.

Returns:



610
611
612
 
# File 'ec2/cfn_instance_connect_endpoint.rb', line 610

def obtain_dependencies()
  jsii_call_method("obtainDependencies", [])
end

#obtain_resource_dependencies ⇒ Array<AWSCDK::CfnResource>

Get a shallow copy of dependencies between this resource and other resources in the same stack.

Returns:



617
618
619
 
# File 'ec2/cfn_instance_connect_endpoint.rb', line 617

def obtain_resource_dependencies()
  jsii_call_method("obtainResourceDependencies", [])
end

#override_logical_id(new_logical_id) ⇒ void

This method returns an undefined value.

Overrides the auto-generated logical ID with a specific ID.

Parameters:

  • new_logical_id (String) —

    The new logical ID to use for this stack element.



410
411
412
413
 
# File 'ec2/cfn_instance_connect_endpoint.rb', line 410

def override_logical_id(new_logical_id)
  Jsii::Type.check_type(new_logical_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "newLogicalId")
  jsii_call_method("overrideLogicalId", [new_logical_id])
end

#preserve_client_ip ⇒ Boolean, ...

Indicates whether the client IP address is preserved as the source.

The following are the possible values.

Returns:



349
350
351
 
# File 'ec2/cfn_instance_connect_endpoint.rb', line 349

def preserve_client_ip()
  jsii_get_property("preserveClientIp")
end

#preserve_client_ip=(value) ⇒ Object 



353
354
355
356
 
# File 'ec2/cfn_instance_connect_endpoint.rb', line 353

def preserve_client_ip=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "preserveClientIp") unless value.nil?
  jsii_set_property("preserveClientIp", value)
end

#ref ⇒ String

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

Returns:

  • (String) 


169
170
171
 
# File 'ec2/cfn_instance_connect_endpoint.rb', line 169

def ref()
  jsii_get_property("ref")
end

#remove_dependency(target) ⇒ void

This method returns an undefined value.

Indicates that this resource no longer depends on another resource.

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.

Parameters:



628
629
630
631
 
# File 'ec2/cfn_instance_connect_endpoint.rb', line 628

def remove_dependency(target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  jsii_call_method("removeDependency", [target])
end

#render_properties(props) ⇒ Hash{String => Object}

Parameters:

  • props (Hash{String => Object})

Returns:

  • (Hash{String => Object}) 


635
636
637
638
 
# File 'ec2/cfn_instance_connect_endpoint.rb', line 635

def render_properties(props)
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6ImFueSJ9LCJraW5kIjoibWFwIn19")), "props")
  jsii_call_method("renderProperties", [props])
end

#replace_dependency(target, new_target) ⇒ void

This method returns an undefined value.

Replaces one dependency with another.

Parameters:



645
646
647
648
649
 
# File 'ec2/cfn_instance_connect_endpoint.rb', line 645

def replace_dependency(target, new_target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  Jsii::Type.check_type(new_target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "newTarget")
  jsii_call_method("replaceDependency", [target, new_target])
end

#security_group_ids ⇒ Array<String>?

One or more security groups to associate with the endpoint.

Returns:

  • (Array<String>, nil) 


361
362
363
 
# File 'ec2/cfn_instance_connect_endpoint.rb', line 361

def security_group_ids()
  jsii_get_property("securityGroupIds")
end

#security_group_ids=(value) ⇒ Object 



365
366
367
368
 
# File 'ec2/cfn_instance_connect_endpoint.rb', line 365

def security_group_ids=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "securityGroupIds") unless value.nil?
  jsii_set_property("securityGroupIds", value)
end

#should_synthesize ⇒ Boolean

Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.

Returns:

  • (Boolean) —

    true if the resource should be included or false is the resource should be omitted.



654
655
656
 
# File 'ec2/cfn_instance_connect_endpoint.rb', line 654

def should_synthesize()
  jsii_call_method("shouldSynthesize", [])
end

#stack ⇒ AWSCDK::Stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

Returns:



159
160
161
 
# File 'ec2/cfn_instance_connect_endpoint.rb', line 159

def stack()
  jsii_get_property("stack")
end

#subnet_id ⇒ String

The ID of the subnet in which to create the EC2 Instance Connect Endpoint.

Returns:

  • (String) 


323
324
325
 
# File 'ec2/cfn_instance_connect_endpoint.rb', line 323

def subnet_id()
  jsii_get_property("subnetId")
end

#subnet_id=(value) ⇒ Object 



327
328
329
330
 
# File 'ec2/cfn_instance_connect_endpoint.rb', line 327

def subnet_id=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "subnetId")
  jsii_set_property("subnetId", value)
end

#tags ⇒ Array<AWSCDK::CfnTag>?

The tags to apply to the EC2 Instance Connect Endpoint during creation.

Returns:



373
374
375
 
# File 'ec2/cfn_instance_connect_endpoint.rb', line 373

def tags()
  jsii_get_property("tags")
end

#tags=(value) ⇒ Object 



377
378
379
380
381
 
# File 'ec2/cfn_instance_connect_endpoint.rb', line 377

def tags=(value)
  value = value.is_a?(Array) ? value.map { |jsii_v0| jsii_v0.is_a?(Hash) ? ::AWSCDK::CfnTag.new(**jsii_v0.transform_keys(&:to_sym)) : jsii_v0 } : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7ImZxbiI6ImF3cy1jZGstbGliLkNmblRhZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "tags") unless value.nil?
  jsii_set_property("tags", value)
end

#to_string ⇒ String

Returns a string representation of this construct.

Returns:

  • (String) —

    a string representation of this resource



386
387
388
 
# File 'ec2/cfn_instance_connect_endpoint.rb', line 386

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

#updated_properites ⇒ Hash{String => Object}

Deprecated.

use updatedProperties Return properties modified after initiation Resources that expose mutable properties should override this function to collect and return the properties object for this resource.

Deprecated.

Returns:

  • (Hash{String => Object}) 


206
207
208
 
# File 'ec2/cfn_instance_connect_endpoint.rb', line 206

def updated_properites()
  jsii_get_property("updatedProperites")
end

#updated_properties ⇒ Hash{String => Object}

Return properties modified after initiation.

Resources that expose mutable properties should override this function to collect and return the properties object for this resource.

Returns:

  • (Hash{String => Object}) 


216
217
218
 
# File 'ec2/cfn_instance_connect_endpoint.rb', line 216

def updated_properties()
  jsii_get_property("updatedProperties")
end

#validate_properties(_properties) ⇒ void

This method returns an undefined value.

Parameters:

  • _properties (Object) 


660
661
662
663
 
# File 'ec2/cfn_instance_connect_endpoint.rb', line 660

def validate_properties(_properties)
  Jsii::Type.check_type(_properties, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "_properties")
  jsii_call_method("validateProperties", [_properties])
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) 


399
400
401
402
403
404
 
# File 'ec2/cfn_instance_connect_endpoint.rb', line 399

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