Class: AWSCDK::EC2::CfnVerifiedAccessEndpoint

Inherits:
CfnResource
  • Object
show all
Includes:
IInspectable, ITaggable, Interfaces::AWSEC2::IVerifiedAccessEndpointRef
Defined in:
ec2/cfn_verified_access_endpoint.rb

Overview

An AWS Verified Access endpoint specifies the application that AWS Verified Access provides access to.

It must be attached to an AWS Verified Access group. An AWS Verified Access endpoint must also have an attached access policy before you attached it to a group.

See Also:

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props) ⇒ CfnVerifiedAccessEndpoint

Create a new AWS::EC2::VerifiedAccessEndpoint.

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::CfnVerifiedAccessEndpointProps) —

    Resource properties.



20
21
22
23
24
25
26
 
# File 'ec2/cfn_verified_access_endpoint.rb', line 20

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

Class Method Details

.arn_for_verified_access_endpoint(resource) ⇒ String

Parameters:

Returns:

  • (String) 


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

def self.arn_for_verified_access_endpoint(resource)
  Jsii::Type.check_type(resource, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19lYzIuSVZlcmlmaWVkQWNjZXNzRW5kcG9pbnRSZWYifQ==")), "resource")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_ec2.CfnVerifiedAccessEndpoint", "arnForVerifiedAccessEndpoint", [resource])
end

.CFN_RESOURCE_TYPE_NAME ⇒ String

The CloudFormation resource type name for this resource class.

Returns:

  • (String) 


215
216
217
 
# File 'ec2/cfn_verified_access_endpoint.rb', line 215

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

.from_verified_access_endpoint_id(scope, id, verified_access_endpoint_id) ⇒ AWSCDK::Interfaces::AWSEC2::IVerifiedAccessEndpointRef

Creates a new IVerifiedAccessEndpointRef from a verifiedAccessEndpointId.

Parameters:

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

Returns:



106
107
108
109
110
111
 
# File 'ec2/cfn_verified_access_endpoint.rb', line 106

def self.from_verified_access_endpoint_id(scope, id, verified_access_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(verified_access_endpoint_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "verifiedAccessEndpointId")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_ec2.CfnVerifiedAccessEndpoint", "fromVerifiedAccessEndpointId", [scope, id, verified_access_endpoint_id])
end

.is_cfn_verified_access_endpoint(x) ⇒ Boolean

Checks whether the given object is a CfnVerifiedAccessEndpoint.

Parameters:

  • x (Object)

Returns:

  • (Boolean) 


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

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

.jsii_overridable_methods ⇒ Object 



28
29
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
87
88
89
90
91
 
# File 'ec2/cfn_verified_access_endpoint.rb', line 28

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_creation_time => { kind: :property, name: "attrCreationTime", is_optional: false },
    :attr_device_validation_domain => { kind: :property, name: "attrDeviceValidationDomain", is_optional: false },
    :attr_endpoint_domain => { kind: :property, name: "attrEndpointDomain", is_optional: false },
    :attr_last_updated_time => { kind: :property, name: "attrLastUpdatedTime", is_optional: false },
    :attr_status => { kind: :property, name: "attrStatus", is_optional: false },
    :attr_verified_access_endpoint_id => { kind: :property, name: "attrVerifiedAccessEndpointId", is_optional: false },
    :attr_verified_access_instance_id => { kind: :property, name: "attrVerifiedAccessInstanceId", is_optional: false },
    :tags => { kind: :property, name: "tags", is_optional: false },
    :verified_access_endpoint_ref => { kind: :property, name: "verifiedAccessEndpointRef", is_optional: false },
    :attachment_type => { kind: :property, name: "attachmentType", is_optional: false },
    :endpoint_type => { kind: :property, name: "endpointType", is_optional: false },
    :verified_access_group_id => { kind: :property, name: "verifiedAccessGroupId", is_optional: false },
    :application_domain => { kind: :property, name: "applicationDomain", is_optional: true },
    :cidr_options => { kind: :property, name: "cidrOptions", is_optional: true },
    :description => { kind: :property, name: "description", is_optional: true },
    :domain_certificate_arn => { kind: :property, name: "domainCertificateArn", is_optional: true },
    :endpoint_domain_prefix => { kind: :property, name: "endpointDomainPrefix", is_optional: true },
    :load_balancer_options => { kind: :property, name: "loadBalancerOptions", is_optional: true },
    :network_interface_options => { kind: :property, name: "networkInterfaceOptions", is_optional: true },
    :policy_document => { kind: :property, name: "policyDocument", is_optional: true },
    :policy_enabled => { kind: :property, name: "policyEnabled", is_optional: true },
    :rds_options => { kind: :property, name: "rdsOptions", is_optional: true },
    :security_group_ids => { kind: :property, name: "securityGroupIds", is_optional: true },
    :sse_specification => { kind: :property, name: "sseSpecification", is_optional: true },
    :tags_raw => { kind: :property, name: "tagsRaw", 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.



516
517
518
519
 
# File 'ec2/cfn_verified_access_endpoint.rb', line 516

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:



528
529
530
531
 
# File 'ec2/cfn_verified_access_endpoint.rb', line 528

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:



538
539
540
541
 
# File 'ec2/cfn_verified_access_endpoint.rb', line 538

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:



549
550
551
552
553
 
# File 'ec2/cfn_verified_access_endpoint.rb', line 549

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.


606
607
608
609
610
 
# File 'ec2/cfn_verified_access_endpoint.rb', line 606

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.



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

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.



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

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

#application_domain ⇒ String?

The DNS name for users to reach your application.

Returns:

  • (String, nil) 


321
322
323
 
# File 'ec2/cfn_verified_access_endpoint.rb', line 321

def application_domain()
  jsii_get_property("applicationDomain")
end

#application_domain=(value) ⇒ Object 



325
326
327
328
 
# File 'ec2/cfn_verified_access_endpoint.rb', line 325

def application_domain=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "applicationDomain") unless value.nil?
  jsii_set_property("applicationDomain", 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:



641
642
643
644
 
# File 'ec2/cfn_verified_access_endpoint.rb', line 641

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:



663
664
665
666
667
668
 
# File 'ec2/cfn_verified_access_endpoint.rb', line 663

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

#attachment_type ⇒ String

The type of attachment used to provide connectivity between the AWS Verified Access endpoint and the application.

Returns:

  • (String) 


285
286
287
 
# File 'ec2/cfn_verified_access_endpoint.rb', line 285

def attachment_type()
  jsii_get_property("attachmentType")
end

#attachment_type=(value) ⇒ Object 



289
290
291
292
 
# File 'ec2/cfn_verified_access_endpoint.rb', line 289

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

#attr_creation_time ⇒ String

The creation time.

Returns:

  • (String) 


222
223
224
 
# File 'ec2/cfn_verified_access_endpoint.rb', line 222

def attr_creation_time()
  jsii_get_property("attrCreationTime")
end

#attr_device_validation_domain ⇒ String

Use this to construct the redirect URI to add to your OIDC provider's allow list.

Returns:

  • (String) 


229
230
231
 
# File 'ec2/cfn_verified_access_endpoint.rb', line 229

def attr_device_validation_domain()
  jsii_get_property("attrDeviceValidationDomain")
end

#attr_endpoint_domain ⇒ String

The DNS name generated for the endpoint.

Returns:

  • (String) 


236
237
238
 
# File 'ec2/cfn_verified_access_endpoint.rb', line 236

def attr_endpoint_domain()
  jsii_get_property("attrEndpointDomain")
end

#attr_last_updated_time ⇒ String

The last updated time.

Returns:

  • (String) 


243
244
245
 
# File 'ec2/cfn_verified_access_endpoint.rb', line 243

def attr_last_updated_time()
  jsii_get_property("attrLastUpdatedTime")
end

#attr_status ⇒ String

The endpoint status.

Returns:

  • (String) 


250
251
252
 
# File 'ec2/cfn_verified_access_endpoint.rb', line 250

def attr_status()
  jsii_get_property("attrStatus")
end

#attr_verified_access_endpoint_id ⇒ String

The ID of the Verified Access endpoint.

Returns:

  • (String) 


257
258
259
 
# File 'ec2/cfn_verified_access_endpoint.rb', line 257

def attr_verified_access_endpoint_id()
  jsii_get_property("attrVerifiedAccessEndpointId")
end

#attr_verified_access_instance_id ⇒ String

The instance identifier.

Returns:

  • (String) 


264
265
266
 
# File 'ec2/cfn_verified_access_endpoint.rb', line 264

def attr_verified_access_instance_id()
  jsii_get_property("attrVerifiedAccessInstanceId")
end

#cfn_options ⇒ AWSCDK::ICfnResourceOptions

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

Returns:



168
169
170
 
# File 'ec2/cfn_verified_access_endpoint.rb', line 168

def cfn_options()
  jsii_get_property("cfnOptions")
end

#cfn_properties ⇒ Hash{String => Object}

Returns:

  • (Hash{String => Object}) 


173
174
175
 
# File 'ec2/cfn_verified_access_endpoint.rb', line 173

def cfn_properties()
  jsii_get_property("cfnProperties")
end

#cfn_property_name(cdk_property_name) ⇒ String?

Parameters:

  • cdk_property_name (String)

Returns:

  • (String, nil) 


672
673
674
675
 
# File 'ec2/cfn_verified_access_endpoint.rb', line 672

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}) 


178
179
180
 
# File 'ec2/cfn_verified_access_endpoint.rb', line 178

def cfn_property_names()
  jsii_get_property("cfnPropertyNames")
end

#cfn_resource_type ⇒ String

AWS resource type.

Returns:

  • (String) 


185
186
187
 
# File 'ec2/cfn_verified_access_endpoint.rb', line 185

def cfn_resource_type()
  jsii_get_property("cfnResourceType")
end

#cidr_options ⇒ AWSCDK::IResolvable, ...

The options for a CIDR endpoint.

Returns:



333
334
335
 
# File 'ec2/cfn_verified_access_endpoint.rb', line 333

def cidr_options()
  jsii_get_property("cidrOptions")
end

#cidr_options=(value) ⇒ Object 



337
338
339
340
341
 
# File 'ec2/cfn_verified_access_endpoint.rb', line 337

def cidr_options=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::EC2::CfnVerifiedAccessEndpoint::CIDROptionsProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19lYzIuQ2ZuVmVyaWZpZWRBY2Nlc3NFbmRwb2ludC5DaWRyT3B0aW9uc1Byb3BlcnR5In1dfX0=")), "cidrOptions") unless value.nil?
  jsii_set_property("cidrOptions", value)
end

#creation_stack ⇒ Array<String>

Returns:

  • (Array<String>) 


130
131
132
 
# File 'ec2/cfn_verified_access_endpoint.rb', line 130

def creation_stack()
  jsii_get_property("creationStack")
end

#description ⇒ String?

A description for the AWS Verified Access endpoint.

Returns:

  • (String, nil) 


346
347
348
 
# File 'ec2/cfn_verified_access_endpoint.rb', line 346

def description()
  jsii_get_property("description")
end

#description=(value) ⇒ Object 



350
351
352
353
 
# File 'ec2/cfn_verified_access_endpoint.rb', line 350

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

#domain_certificate_arn ⇒ String?

The ARN of a public TLS/SSL certificate imported into or created with ACM.

Returns:

  • (String, nil) 


358
359
360
 
# File 'ec2/cfn_verified_access_endpoint.rb', line 358

def domain_certificate_arn()
  jsii_get_property("domainCertificateArn")
end

#domain_certificate_arn=(value) ⇒ Object 



362
363
364
365
 
# File 'ec2/cfn_verified_access_endpoint.rb', line 362

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

#endpoint_domain_prefix ⇒ String?

A custom identifier that is prepended to the DNS name that is generated for the endpoint.

Returns:

  • (String, nil) 


370
371
372
 
# File 'ec2/cfn_verified_access_endpoint.rb', line 370

def endpoint_domain_prefix()
  jsii_get_property("endpointDomainPrefix")
end

#endpoint_domain_prefix=(value) ⇒ Object 



374
375
376
377
 
# File 'ec2/cfn_verified_access_endpoint.rb', line 374

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

#endpoint_type ⇒ String

The type of AWS Verified Access endpoint.

Returns:

  • (String) 


297
298
299
 
# File 'ec2/cfn_verified_access_endpoint.rb', line 297

def endpoint_type()
  jsii_get_property("endpointType")
end

#endpoint_type=(value) ⇒ Object 



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

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

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

Returns:



190
191
192
 
# File 'ec2/cfn_verified_access_endpoint.rb', line 190

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:



685
686
687
688
689
 
# File 'ec2/cfn_verified_access_endpoint.rb', line 685

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:



696
697
698
699
 
# File 'ec2/cfn_verified_access_endpoint.rb', line 696

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:



766
767
768
769
 
# File 'ec2/cfn_verified_access_endpoint.rb', line 766

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

#load_balancer_options ⇒ AWSCDK::IResolvable, ...

The load balancer details if creating the AWS Verified Access endpoint as load-balancer type.

Returns:



382
383
384
 
# File 'ec2/cfn_verified_access_endpoint.rb', line 382

def load_balancer_options()
  jsii_get_property("loadBalancerOptions")
end

#load_balancer_options=(value) ⇒ Object 



386
387
388
389
390
 
# File 'ec2/cfn_verified_access_endpoint.rb', line 386

def load_balancer_options=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::EC2::CfnVerifiedAccessEndpoint::LoadBalancerOptionsProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19lYzIuQ2ZuVmVyaWZpZWRBY2Nlc3NFbmRwb2ludC5Mb2FkQmFsYW5jZXJPcHRpb25zUHJvcGVydHkifV19fQ==")), "loadBalancerOptions") unless value.nil?
  jsii_set_property("loadBalancerOptions", value)
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) 


142
143
144
 
# File 'ec2/cfn_verified_access_endpoint.rb', line 142

def logical_id()
  jsii_get_property("logicalId")
end

#network_interface_options ⇒ AWSCDK::IResolvable, ...

The options for network-interface type endpoint.

Returns:



395
396
397
 
# File 'ec2/cfn_verified_access_endpoint.rb', line 395

def network_interface_options()
  jsii_get_property("networkInterfaceOptions")
end

#network_interface_options=(value) ⇒ Object 



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

def network_interface_options=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::EC2::CfnVerifiedAccessEndpoint::NetworkInterfaceOptionsProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19lYzIuQ2ZuVmVyaWZpZWRBY2Nlc3NFbmRwb2ludC5OZXR3b3JrSW50ZXJmYWNlT3B0aW9uc1Byb3BlcnR5In1dfX0=")), "networkInterfaceOptions") unless value.nil?
  jsii_set_property("networkInterfaceOptions", value)
end

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


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

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:



707
708
709
 
# File 'ec2/cfn_verified_access_endpoint.rb', line 707

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:



714
715
716
 
# File 'ec2/cfn_verified_access_endpoint.rb', line 714

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.



507
508
509
510
 
# File 'ec2/cfn_verified_access_endpoint.rb', line 507

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

#policy_document ⇒ String?

The Verified Access policy document.

Returns:

  • (String, nil) 


408
409
410
 
# File 'ec2/cfn_verified_access_endpoint.rb', line 408

def policy_document()
  jsii_get_property("policyDocument")
end

#policy_document=(value) ⇒ Object 



412
413
414
415
 
# File 'ec2/cfn_verified_access_endpoint.rb', line 412

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

#policy_enabled ⇒ Boolean, ...

The status of the Verified Access policy.

Returns:



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

def policy_enabled()
  jsii_get_property("policyEnabled")
end

#policy_enabled=(value) ⇒ Object 



424
425
426
427
 
# File 'ec2/cfn_verified_access_endpoint.rb', line 424

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

#rds_options ⇒ AWSCDK::IResolvable, ...

The options for an RDS endpoint.

Returns:



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

def rds_options()
  jsii_get_property("rdsOptions")
end

#rds_options=(value) ⇒ Object 



436
437
438
439
440
 
# File 'ec2/cfn_verified_access_endpoint.rb', line 436

def rds_options=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::EC2::CfnVerifiedAccessEndpoint::RDSOptionsProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19lYzIuQ2ZuVmVyaWZpZWRBY2Nlc3NFbmRwb2ludC5SZHNPcHRpb25zUHJvcGVydHkifV19fQ==")), "rdsOptions") unless value.nil?
  jsii_set_property("rdsOptions", 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) 


161
162
163
 
# File 'ec2/cfn_verified_access_endpoint.rb', line 161

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:



725
726
727
728
 
# File 'ec2/cfn_verified_access_endpoint.rb', line 725

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}) 


732
733
734
735
 
# File 'ec2/cfn_verified_access_endpoint.rb', line 732

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:



742
743
744
745
746
 
# File 'ec2/cfn_verified_access_endpoint.rb', line 742

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>?

The IDs of the security groups for the endpoint.

Returns:

  • (Array<String>, nil) 


445
446
447
 
# File 'ec2/cfn_verified_access_endpoint.rb', line 445

def security_group_ids()
  jsii_get_property("securityGroupIds")
end

#security_group_ids=(value) ⇒ Object 



449
450
451
452
 
# File 'ec2/cfn_verified_access_endpoint.rb', line 449

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.



751
752
753
 
# File 'ec2/cfn_verified_access_endpoint.rb', line 751

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

#sse_specification ⇒ AWSCDK::IResolvable, ...

The options for additional server side encryption.

Returns:



457
458
459
 
# File 'ec2/cfn_verified_access_endpoint.rb', line 457

def sse_specification()
  jsii_get_property("sseSpecification")
end

#sse_specification=(value) ⇒ Object 



461
462
463
464
465
 
# File 'ec2/cfn_verified_access_endpoint.rb', line 461

def sse_specification=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::EC2::CfnVerifiedAccessEndpoint::SseSpecificationProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19lYzIuQ2ZuVmVyaWZpZWRBY2Nlc3NFbmRwb2ludC5Tc2VTcGVjaWZpY2F0aW9uUHJvcGVydHkifV19fQ==")), "sseSpecification") unless value.nil?
  jsii_set_property("sseSpecification", value)
end

#stack ⇒ AWSCDK::Stack

The stack in which this element is defined.

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

Returns:



151
152
153
 
# File 'ec2/cfn_verified_access_endpoint.rb', line 151

def stack()
  jsii_get_property("stack")
end

#tags ⇒ AWSCDK::TagManager

Tag Manager which manages the tags for this resource.

Returns:



271
272
273
 
# File 'ec2/cfn_verified_access_endpoint.rb', line 271

def tags()
  jsii_get_property("tags")
end

#tags_raw ⇒ Array<AWSCDK::CfnTag>?

The tags.

Returns:



470
471
472
 
# File 'ec2/cfn_verified_access_endpoint.rb', line 470

def tags_raw()
  jsii_get_property("tagsRaw")
end

#tags_raw=(value) ⇒ Object 



474
475
476
477
478
 
# File 'ec2/cfn_verified_access_endpoint.rb', line 474

def tags_raw=(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=")), "tagsRaw") unless value.nil?
  jsii_set_property("tagsRaw", value)
end

#to_string ⇒ String

Returns a string representation of this construct.

Returns:

  • (String) —

    a string representation of this resource



483
484
485
 
# File 'ec2/cfn_verified_access_endpoint.rb', line 483

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}) 


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

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}) 


208
209
210
 
# File 'ec2/cfn_verified_access_endpoint.rb', line 208

def updated_properties()
  jsii_get_property("updatedProperties")
end

#validate_properties(_properties) ⇒ void

This method returns an undefined value.

Parameters:

  • _properties (Object) 


757
758
759
760
 
# File 'ec2/cfn_verified_access_endpoint.rb', line 757

def validate_properties(_properties)
  Jsii::Type.check_type(_properties, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "_properties")
  jsii_call_method("validateProperties", [_properties])
end

#verified_access_endpoint_ref ⇒ AWSCDK::Interfaces::AWSEC2::VerifiedAccessEndpointReference

A reference to a VerifiedAccessEndpoint resource.

Returns:



278
279
280
 
# File 'ec2/cfn_verified_access_endpoint.rb', line 278

def verified_access_endpoint_ref()
  jsii_get_property("verifiedAccessEndpointRef")
end

#verified_access_group_id ⇒ String

The ID of the AWS Verified Access group.

Returns:

  • (String) 


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

def verified_access_group_id()
  jsii_get_property("verifiedAccessGroupId")
end

#verified_access_group_id=(value) ⇒ Object 



313
314
315
316
 
# File 'ec2/cfn_verified_access_endpoint.rb', line 313

def verified_access_group_id=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "verifiedAccessGroupId")
  jsii_set_property("verifiedAccessGroupId", value)
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) 


496
497
498
499
500
501
 
# File 'ec2/cfn_verified_access_endpoint.rb', line 496

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