Class: AWSCDK::Route53Resolver::CfnResolverEndpoint

Inherits:
CfnResource
  • Object
show all
Includes:
IInspectable, ITaggable, Interfaces::AWSRoute53Resolver::IResolverEndpointRef
Defined in:
route53_resolver/cfn_resolver_endpoint.rb

Overview

Creates a Resolver endpoint. There are two types of Resolver endpoints, inbound and outbound:.

  • An inbound Resolver endpoint forwards DNS queries to the DNS service for a VPC from your network.
  • An outbound Resolver endpoint forwards DNS queries from the DNS service for a VPC to your network.
  • You cannot update ResolverEndpointType and IpAddresses in the same request.
  • When you update a dual-stack IP address, you must update both IP addresses. You can’t update only an IPv4 or IPv6 and keep an existing IP address.

See Also:

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props) ⇒ CfnResolverEndpoint

Create a new AWS::Route53Resolver::ResolverEndpoint.

Parameters:



24
25
26
27
28
29
30
 
# File 'route53_resolver/cfn_resolver_endpoint.rb', line 24

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

Class Method Details

.arn_for_resolver_endpoint(resource) ⇒ String

Parameters:

Returns:

  • (String) 


98
99
100
101
 
# File 'route53_resolver/cfn_resolver_endpoint.rb', line 98

def self.arn_for_resolver_endpoint(resource)
  Jsii::Type.check_type(resource, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19yb3V0ZTUzcmVzb2x2ZXIuSVJlc29sdmVyRW5kcG9pbnRSZWYifQ==")), "resource")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_route53resolver.CfnResolverEndpoint", "arnForResolverEndpoint", [resource])
end

.CFN_RESOURCE_TYPE_NAME ⇒ String

The CloudFormation resource type name for this resource class.

Returns:

  • (String) 


205
206
207
 
# File 'route53_resolver/cfn_resolver_endpoint.rb', line 205

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

.is_cfn_resolver_endpoint(x) ⇒ Boolean

Checks whether the given object is a CfnResolverEndpoint.

Parameters:

  • x (Object)

Returns:

  • (Boolean) 


107
108
109
110
 
# File 'route53_resolver/cfn_resolver_endpoint.rb', line 107

def self.is_cfn_resolver_endpoint(x)
  Jsii::Type.check_type(x, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "x")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_route53resolver.CfnResolverEndpoint", "isCfnResolverEndpoint", [x])
end

.jsii_overridable_methods ⇒ Object 



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
92
93
94
 
# File 'route53_resolver/cfn_resolver_endpoint.rb', line 32

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_arn => { kind: :property, name: "attrArn", is_optional: false },
    :attr_direction => { kind: :property, name: "attrDirection", is_optional: false },
    :attr_host_vpc_id => { kind: :property, name: "attrHostVpcId", is_optional: false },
    :attr_ip_address_count => { kind: :property, name: "attrIpAddressCount", is_optional: false },
    :attr_name => { kind: :property, name: "attrName", is_optional: false },
    :attr_outpost_arn => { kind: :property, name: "attrOutpostArn", is_optional: false },
    :attr_preferred_instance_type => { kind: :property, name: "attrPreferredInstanceType", is_optional: false },
    :attr_resolver_endpoint_id => { kind: :property, name: "attrResolverEndpointId", is_optional: false },
    :attr_resolver_endpoint_type => { kind: :property, name: "attrResolverEndpointType", is_optional: false },
    :resolver_endpoint_ref => { kind: :property, name: "resolverEndpointRef", is_optional: false },
    :tags => { kind: :property, name: "tags", is_optional: false },
    :direction => { kind: :property, name: "direction", is_optional: false },
    :ip_addresses => { kind: :property, name: "ipAddresses", is_optional: false },
    :security_group_ids => { kind: :property, name: "securityGroupIds", is_optional: false },
    :dns64_enabled => { kind: :property, name: "dns64Enabled", is_optional: true },
    :ipv6_internet_access_enabled => { kind: :property, name: "ipv6InternetAccessEnabled", is_optional: true },
    :name => { kind: :property, name: "name", is_optional: true },
    :outpost_arn => { kind: :property, name: "outpostArn", is_optional: true },
    :preferred_instance_type => { kind: :property, name: "preferredInstanceType", is_optional: true },
    :protocols => { kind: :property, name: "protocols", is_optional: true },
    :resolver_endpoint_type => { kind: :property, name: "resolverEndpointType", is_optional: true },
    :rni_enhanced_metrics_enabled => { kind: :property, name: "rniEnhancedMetricsEnabled", is_optional: true },
    :tags_raw => { kind: :property, name: "tagsRaw", is_optional: true },
    :target_name_server_metrics_enabled => { kind: :property, name: "targetNameServerMetricsEnabled", 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.



475
476
477
478
 
# File 'route53_resolver/cfn_resolver_endpoint.rb', line 475

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:



487
488
489
490
 
# File 'route53_resolver/cfn_resolver_endpoint.rb', line 487

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:



497
498
499
500
 
# File 'route53_resolver/cfn_resolver_endpoint.rb', line 497

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:



508
509
510
511
512
 
# File 'route53_resolver/cfn_resolver_endpoint.rb', line 508

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.


565
566
567
568
569
 
# File 'route53_resolver/cfn_resolver_endpoint.rb', line 565

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.



575
576
577
578
 
# File 'route53_resolver/cfn_resolver_endpoint.rb', line 575

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.



587
588
589
590
591
 
# File 'route53_resolver/cfn_resolver_endpoint.rb', line 587

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:



600
601
602
603
 
# File 'route53_resolver/cfn_resolver_endpoint.rb', line 600

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:



622
623
624
625
626
627
 
# File 'route53_resolver/cfn_resolver_endpoint.rb', line 622

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_arn ⇒ String

The Amazon Resource Name (ARN) of the resolver endpoint, such as arn:aws:route53resolver:us-east-1:123456789012:resolver-endpoint/resolver-endpoint-a1bzhi .

Returns:

  • (String) 


212
213
214
 
# File 'route53_resolver/cfn_resolver_endpoint.rb', line 212

def attr_arn()
  jsii_get_property("attrArn")
end

#attr_direction ⇒ String

Indicates whether the resolver endpoint allows inbound or outbound DNS queries.

Returns:

  • (String) 


219
220
221
 
# File 'route53_resolver/cfn_resolver_endpoint.rb', line 219

def attr_direction()
  jsii_get_property("attrDirection")
end

#attr_host_vpc_id ⇒ String

The ID of the VPC that you want to create the resolver endpoint in.

Returns:

  • (String) 


226
227
228
 
# File 'route53_resolver/cfn_resolver_endpoint.rb', line 226

def attr_host_vpc_id()
  jsii_get_property("attrHostVpcId")
end

#attr_ip_address_count ⇒ String

The number of IP addresses that the resolver endpoint can use for DNS queries.

Returns:

  • (String) 


233
234
235
 
# File 'route53_resolver/cfn_resolver_endpoint.rb', line 233

def attr_ip_address_count()
  jsii_get_property("attrIpAddressCount")
end

#attr_name ⇒ String

The name that you assigned to the resolver endpoint when you created the endpoint.

Returns:

  • (String) 


240
241
242
 
# File 'route53_resolver/cfn_resolver_endpoint.rb', line 240

def attr_name()
  jsii_get_property("attrName")
end

#attr_outpost_arn ⇒ String

Returns:

  • (String) 


245
246
247
 
# File 'route53_resolver/cfn_resolver_endpoint.rb', line 245

def attr_outpost_arn()
  jsii_get_property("attrOutpostArn")
end

#attr_preferred_instance_type ⇒ String

Returns:

  • (String) 


250
251
252
 
# File 'route53_resolver/cfn_resolver_endpoint.rb', line 250

def attr_preferred_instance_type()
  jsii_get_property("attrPreferredInstanceType")
end

#attr_resolver_endpoint_id ⇒ String

The ID of the resolver endpoint.

Returns:

  • (String) 


257
258
259
 
# File 'route53_resolver/cfn_resolver_endpoint.rb', line 257

def attr_resolver_endpoint_id()
  jsii_get_property("attrResolverEndpointId")
end

#attr_resolver_endpoint_type ⇒ String

Returns:

  • (String) 


262
263
264
 
# File 'route53_resolver/cfn_resolver_endpoint.rb', line 262

def attr_resolver_endpoint_type()
  jsii_get_property("attrResolverEndpointType")
end

#cfn_options ⇒ AWSCDK::ICfnResourceOptions

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

Returns:



158
159
160
 
# File 'route53_resolver/cfn_resolver_endpoint.rb', line 158

def cfn_options()
  jsii_get_property("cfnOptions")
end

#cfn_properties ⇒ Hash{String => Object}

Returns:

  • (Hash{String => Object}) 


163
164
165
 
# File 'route53_resolver/cfn_resolver_endpoint.rb', line 163

def cfn_properties()
  jsii_get_property("cfnProperties")
end

#cfn_property_name(cdk_property_name) ⇒ String?

Parameters:

  • cdk_property_name (String)

Returns:

  • (String, nil) 


631
632
633
634
 
# File 'route53_resolver/cfn_resolver_endpoint.rb', line 631

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


168
169
170
 
# File 'route53_resolver/cfn_resolver_endpoint.rb', line 168

def cfn_property_names()
  jsii_get_property("cfnPropertyNames")
end

#cfn_resource_type ⇒ String

AWS resource type.

Returns:

  • (String) 


175
176
177
 
# File 'route53_resolver/cfn_resolver_endpoint.rb', line 175

def cfn_resource_type()
  jsii_get_property("cfnResourceType")
end

#creation_stack ⇒ Array<String>

Returns:

  • (Array<String>) 


120
121
122
 
# File 'route53_resolver/cfn_resolver_endpoint.rb', line 120

def creation_stack()
  jsii_get_property("creationStack")
end

#direction ⇒ String

Indicates whether the Resolver endpoint allows inbound or outbound DNS queries:.

Returns:

  • (String) 


283
284
285
 
# File 'route53_resolver/cfn_resolver_endpoint.rb', line 283

def direction()
  jsii_get_property("direction")
end

#direction=(value) ⇒ Object 



287
288
289
290
 
# File 'route53_resolver/cfn_resolver_endpoint.rb', line 287

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

#dns64_enabled ⇒ Boolean, ...

Specifies whether DNS64 is enabled for the Inbound Resolver Endpoint.

Returns:



319
320
321
 
# File 'route53_resolver/cfn_resolver_endpoint.rb', line 319

def dns64_enabled()
  jsii_get_property("dns64Enabled")
end

#dns64_enabled=(value) ⇒ Object 



323
324
325
326
 
# File 'route53_resolver/cfn_resolver_endpoint.rb', line 323

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

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

Returns:



180
181
182
 
# File 'route53_resolver/cfn_resolver_endpoint.rb', line 180

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:



644
645
646
647
648
 
# File 'route53_resolver/cfn_resolver_endpoint.rb', line 644

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:



655
656
657
658
 
# File 'route53_resolver/cfn_resolver_endpoint.rb', line 655

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:



725
726
727
728
 
# File 'route53_resolver/cfn_resolver_endpoint.rb', line 725

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

#ip_addresses ⇒ AWSCDK::IResolvable, Array<AWSCDK::IResolvable, AWSCDK::Route53Resolver::CfnResolverEndpoint::IPAddressRequestProperty>

The subnets and IP addresses in your VPC that DNS queries originate from (for outbound endpoints) or that you forward DNS queries to (for inbound endpoints).

Returns:



295
296
297
 
# File 'route53_resolver/cfn_resolver_endpoint.rb', line 295

def ip_addresses()
  jsii_get_property("ipAddresses")
end

#ip_addresses=(value) ⇒ Object 



299
300
301
302
 
# File 'route53_resolver/cfn_resolver_endpoint.rb', line 299

def ip_addresses=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfcm91dGU1M3Jlc29sdmVyLkNmblJlc29sdmVyRW5kcG9pbnQuSXBBZGRyZXNzUmVxdWVzdFByb3BlcnR5In1dfX0sImtpbmQiOiJhcnJheSJ9fV19fQ==")), "ipAddresses")
  jsii_set_property("ipAddresses", value)
end

#ipv6_internet_access_enabled ⇒ Boolean, ...

Specifies whether IPv6 Internet Gateway access is enabled through the Outbound Resolver Endpoint.

Returns:



331
332
333
 
# File 'route53_resolver/cfn_resolver_endpoint.rb', line 331

def ipv6_internet_access_enabled()
  jsii_get_property("ipv6InternetAccessEnabled")
end

#ipv6_internet_access_enabled=(value) ⇒ Object 



335
336
337
338
 
# File 'route53_resolver/cfn_resolver_endpoint.rb', line 335

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


132
133
134
 
# File 'route53_resolver/cfn_resolver_endpoint.rb', line 132

def logical_id()
  jsii_get_property("logicalId")
end

#name ⇒ String?

A friendly name that lets you easily find a configuration in the Resolver dashboard in the Route 53 console.

Returns:

  • (String, nil) 


343
344
345
 
# File 'route53_resolver/cfn_resolver_endpoint.rb', line 343

def name()
  jsii_get_property("name")
end

#name=(value) ⇒ Object 



347
348
349
350
 
# File 'route53_resolver/cfn_resolver_endpoint.rb', line 347

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

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


115
116
117
 
# File 'route53_resolver/cfn_resolver_endpoint.rb', line 115

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:



666
667
668
 
# File 'route53_resolver/cfn_resolver_endpoint.rb', line 666

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:



673
674
675
 
# File 'route53_resolver/cfn_resolver_endpoint.rb', line 673

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

#outpost_arn ⇒ String?

The ARN (Amazon Resource Name) for the Outpost.

Returns:

  • (String, nil) 


355
356
357
 
# File 'route53_resolver/cfn_resolver_endpoint.rb', line 355

def outpost_arn()
  jsii_get_property("outpostArn")
end

#outpost_arn=(value) ⇒ Object 



359
360
361
362
 
# File 'route53_resolver/cfn_resolver_endpoint.rb', line 359

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



466
467
468
469
 
# File 'route53_resolver/cfn_resolver_endpoint.rb', line 466

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

#preferred_instance_type ⇒ String?

The Amazon EC2 instance type.

Returns:

  • (String, nil) 


367
368
369
 
# File 'route53_resolver/cfn_resolver_endpoint.rb', line 367

def preferred_instance_type()
  jsii_get_property("preferredInstanceType")
end

#preferred_instance_type=(value) ⇒ Object 



371
372
373
374
 
# File 'route53_resolver/cfn_resolver_endpoint.rb', line 371

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

#protocols ⇒ Array<String>?

Protocols used for the endpoint.

DoH-FIPS is applicable for a default inbound endpoints only.

Returns:

  • (Array<String>, nil) 


381
382
383
 
# File 'route53_resolver/cfn_resolver_endpoint.rb', line 381

def protocols()
  jsii_get_property("protocols")
end

#protocols=(value) ⇒ Object 



385
386
387
388
 
# File 'route53_resolver/cfn_resolver_endpoint.rb', line 385

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


151
152
153
 
# File 'route53_resolver/cfn_resolver_endpoint.rb', line 151

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:



684
685
686
687
 
# File 'route53_resolver/cfn_resolver_endpoint.rb', line 684

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


691
692
693
694
 
# File 'route53_resolver/cfn_resolver_endpoint.rb', line 691

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:



701
702
703
704
705
 
# File 'route53_resolver/cfn_resolver_endpoint.rb', line 701

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

#resolver_endpoint_ref ⇒ AWSCDK::Interfaces::AWSRoute53Resolver::ResolverEndpointReference

A reference to a ResolverEndpoint resource.

Returns:



269
270
271
 
# File 'route53_resolver/cfn_resolver_endpoint.rb', line 269

def resolver_endpoint_ref()
  jsii_get_property("resolverEndpointRef")
end

#resolver_endpoint_type ⇒ String?

The Resolver endpoint IP address type.

Returns:

  • (String, nil) 


393
394
395
 
# File 'route53_resolver/cfn_resolver_endpoint.rb', line 393

def resolver_endpoint_type()
  jsii_get_property("resolverEndpointType")
end

#resolver_endpoint_type=(value) ⇒ Object 



397
398
399
400
 
# File 'route53_resolver/cfn_resolver_endpoint.rb', line 397

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

#rni_enhanced_metrics_enabled ⇒ Boolean, ...

Indicates whether RNI enhanced metrics are enabled for the Resolver endpoint.

Returns:



405
406
407
 
# File 'route53_resolver/cfn_resolver_endpoint.rb', line 405

def rni_enhanced_metrics_enabled()
  jsii_get_property("rniEnhancedMetricsEnabled")
end

#rni_enhanced_metrics_enabled=(value) ⇒ Object 



409
410
411
412
 
# File 'route53_resolver/cfn_resolver_endpoint.rb', line 409

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

#security_group_ids ⇒ Array<String>

The ID of one or more security groups that control access to this VPC.

Returns:

  • (Array<String>) 


307
308
309
 
# File 'route53_resolver/cfn_resolver_endpoint.rb', line 307

def security_group_ids()
  jsii_get_property("securityGroupIds")
end

#security_group_ids=(value) ⇒ Object 



311
312
313
314
 
# File 'route53_resolver/cfn_resolver_endpoint.rb', line 311

def security_group_ids=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "securityGroupIds")
  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.



710
711
712
 
# File 'route53_resolver/cfn_resolver_endpoint.rb', line 710

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:



141
142
143
 
# File 'route53_resolver/cfn_resolver_endpoint.rb', line 141

def stack()
  jsii_get_property("stack")
end

#tags ⇒ AWSCDK::TagManager

Tag Manager which manages the tags for this resource.

Returns:



276
277
278
 
# File 'route53_resolver/cfn_resolver_endpoint.rb', line 276

def tags()
  jsii_get_property("tags")
end

#tags_raw ⇒ Array<AWSCDK::CfnTag>?

Route 53 Resolver doesn't support updating tags through CloudFormation.

Returns:



417
418
419
 
# File 'route53_resolver/cfn_resolver_endpoint.rb', line 417

def tags_raw()
  jsii_get_property("tagsRaw")
end

#tags_raw=(value) ⇒ Object 



421
422
423
424
425
 
# File 'route53_resolver/cfn_resolver_endpoint.rb', line 421

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

#target_name_server_metrics_enabled ⇒ Boolean, ...

Indicates whether target name server metrics are enabled for the outbound Resolver endpoint.

Returns:



430
431
432
 
# File 'route53_resolver/cfn_resolver_endpoint.rb', line 430

def target_name_server_metrics_enabled()
  jsii_get_property("targetNameServerMetricsEnabled")
end

#target_name_server_metrics_enabled=(value) ⇒ Object 



434
435
436
437
 
# File 'route53_resolver/cfn_resolver_endpoint.rb', line 434

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

#to_string ⇒ String

Returns a string representation of this construct.

Returns:

  • (String) —

    a string representation of this resource



442
443
444
 
# File 'route53_resolver/cfn_resolver_endpoint.rb', line 442

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


188
189
190
 
# File 'route53_resolver/cfn_resolver_endpoint.rb', line 188

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


198
199
200
 
# File 'route53_resolver/cfn_resolver_endpoint.rb', line 198

def updated_properties()
  jsii_get_property("updatedProperties")
end

#validate_properties(_properties) ⇒ void

This method returns an undefined value.

Parameters:

  • _properties (Object) 


716
717
718
719
 
# File 'route53_resolver/cfn_resolver_endpoint.rb', line 716

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) 


455
456
457
458
459
460
 
# File 'route53_resolver/cfn_resolver_endpoint.rb', line 455

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