Class: AWSCDK::ServiceDiscovery::PrivateDNSNamespace

Inherits:
Resource
  • Object
show all
Includes:
IPrivateDNSNamespace
Defined in:
service_discovery/private_dns_namespace.rb

Overview

Define a Service Discovery HTTP Namespace.

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props) ⇒ PrivateDNSNamespace

Returns a new instance of PrivateDNSNamespace.

Parameters:



12
13
14
15
16
17
18
 
# File 'service_discovery/private_dns_namespace.rb', line 12

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

Class Method Details

.from_private_dns_namespace_attributes(scope, id, attrs) ⇒ AWSCDK::ServiceDiscovery::IPrivateDNSNamespace

Parameters:

Returns:



50
51
52
53
54
55
56
 
# File 'service_discovery/private_dns_namespace.rb', line 50

def self.from_private_dns_namespace_attributes(scope, id, attrs)
  Jsii::Type.check_type(scope, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLkNvbnN0cnVjdCJ9")), "scope")
  Jsii::Type.check_type(id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "id")
  attrs = attrs.is_a?(Hash) ? ::AWSCDK::ServiceDiscovery::PrivateDNSNamespaceAttributes.new(**attrs.transform_keys(&:to_sym)) : attrs
  Jsii::Type.check_type(attrs, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfc2VydmljZWRpc2NvdmVyeS5Qcml2YXRlRG5zTmFtZXNwYWNlQXR0cmlidXRlcyJ9")), "attrs")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_servicediscovery.PrivateDnsNamespace", "fromPrivateDnsNamespaceAttributes", [scope, id, attrs])
end

.jsii_overridable_methods ⇒ Object 



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

def self.jsii_overridable_methods
  {
    :node => { kind: :property, name: "node", is_optional: false },
    :env => { kind: :property, name: "env", is_optional: false },
    :physical_name => { kind: :property, name: "physicalName", is_optional: false },
    :stack => { kind: :property, name: "stack", is_optional: false },
    :namespace_arn => { kind: :property, name: "namespaceArn", is_optional: false },
    :namespace_hosted_zone_id => { kind: :property, name: "namespaceHostedZoneId", is_optional: false },
    :namespace_id => { kind: :property, name: "namespaceId", is_optional: false },
    :namespace_name => { kind: :property, name: "namespaceName", is_optional: false },
    :private_dns_namespace_arn => { kind: :property, name: "privateDnsNamespaceArn", is_optional: false },
    :private_dns_namespace_id => { kind: :property, name: "privateDnsNamespaceId", is_optional: false },
    :private_dns_namespace_name => { kind: :property, name: "privateDnsNamespaceName", is_optional: false },
    :private_dns_namespace_ref => { kind: :property, name: "privateDnsNamespaceRef", is_optional: false },
    :type => { kind: :property, name: "type", is_optional: false },
    :to_string => { kind: :method, name: "toString", is_optional: false },
    :with => { kind: :method, name: "with", is_optional: false },
    :apply_cross_stack_reference_strength => { kind: :method, name: "applyCrossStackReferenceStrength", is_optional: false },
    :apply_removal_policy => { kind: :method, name: "applyRemovalPolicy", is_optional: false },
    :generate_physical_name => { kind: :method, name: "generatePhysicalName", is_optional: false },
    :get_resource_arn_attribute => { kind: :method, name: "getResourceArnAttribute", is_optional: false },
    :get_resource_name_attribute => { kind: :method, name: "getResourceNameAttribute", is_optional: false },
    :create_service => { kind: :method, name: "createService", is_optional: false },
  }
end

.PROPERTY_INJECTION_ID ⇒ String

Uniquely identifies this class.

Returns:

  • (String) 


104
105
106
 
# File 'service_discovery/private_dns_namespace.rb', line 104

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

Instance Method Details

#apply_cross_stack_reference_strength(strength) ⇒ void

This method returns an undefined value.

Override the cross-stack reference strength for this resource.

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

Parameters:



198
199
200
201
 
# File 'service_discovery/private_dns_namespace.rb', line 198

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

#apply_removal_policy(policy) ⇒ void

This method returns an undefined value.

Apply the given removal policy to this resource.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

Parameters:



215
216
217
218
 
# File 'service_discovery/private_dns_namespace.rb', line 215

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

#create_service(id, props = nil) ⇒ AWSCDK::ServiceDiscovery::Service

Creates a service within the namespace.

Parameters:

Returns:



260
261
262
263
264
265
 
# File 'service_discovery/private_dns_namespace.rb', line 260

def create_service(id, props = nil)
  Jsii::Type.check_type(id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "id")
  props = props.is_a?(Hash) ? ::AWSCDK::ServiceDiscovery::DNSServiceProps.new(**props.transform_keys(&:to_sym)) : props
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfc2VydmljZWRpc2NvdmVyeS5EbnNTZXJ2aWNlUHJvcHMifQ==")), "props") unless props.nil?
  jsii_call_method("createService", [id, props])
end

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

The environment this resource belongs to.

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

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

Returns:



76
77
78
 
# File 'service_discovery/private_dns_namespace.rb', line 76

def env()
  jsii_get_property("env")
end

#generate_physical_name ⇒ String

Returns:

  • (String) 


221
222
223
 
# File 'service_discovery/private_dns_namespace.rb', line 221

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

#get_resource_arn_attribute(arn_attr, arn_components) ⇒ String

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

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

Parameters:

  • arn_attr (String) —

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

  • arn_components (AWSCDK::ARNComponents) —

    The format of the ARN of this resource.

Returns:

  • (String) 


235
236
237
238
239
240
 
# File 'service_discovery/private_dns_namespace.rb', line 235

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

#get_resource_name_attribute(name_attr) ⇒ String

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

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

Parameters:

  • name_attr (String) —

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

Returns:

  • (String) 


250
251
252
253
 
# File 'service_discovery/private_dns_namespace.rb', line 250

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

#namespace_arn ⇒ String

Namespace Arn of the namespace.

Returns:

  • (String) 


111
112
113
 
# File 'service_discovery/private_dns_namespace.rb', line 111

def namespace_arn()
  jsii_get_property("namespaceArn")
end

#namespace_hosted_zone_id ⇒ String

ID of hosted zone created by namespace.

Returns:

  • (String) 


118
119
120
 
# File 'service_discovery/private_dns_namespace.rb', line 118

def namespace_hosted_zone_id()
  jsii_get_property("namespaceHostedZoneId")
end

#namespace_id ⇒ String

Namespace Id of the PrivateDnsNamespace.

Returns:

  • (String) 


125
126
127
 
# File 'service_discovery/private_dns_namespace.rb', line 125

def namespace_id()
  jsii_get_property("namespaceId")
end

#namespace_name ⇒ String

The name of the PrivateDnsNamespace.

Returns:

  • (String) 


132
133
134
 
# File 'service_discovery/private_dns_namespace.rb', line 132

def namespace_name()
  jsii_get_property("namespaceName")
end

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


61
62
63
 
# File 'service_discovery/private_dns_namespace.rb', line 61

def node()
  jsii_get_property("node")
end

#physical_name ⇒ String

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

This value will resolve to one of the following:

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

Returns:

  • (String) 


90
91
92
 
# File 'service_discovery/private_dns_namespace.rb', line 90

def physical_name()
  jsii_get_property("physicalName")
end

#private_dns_namespace_arn ⇒ String

Returns:

  • (String) 


137
138
139
 
# File 'service_discovery/private_dns_namespace.rb', line 137

def private_dns_namespace_arn()
  jsii_get_property("privateDnsNamespaceArn")
end

#private_dns_namespace_id ⇒ String

Returns:

  • (String) 


142
143
144
 
# File 'service_discovery/private_dns_namespace.rb', line 142

def private_dns_namespace_id()
  jsii_get_property("privateDnsNamespaceId")
end

#private_dns_namespace_name ⇒ String

Returns:

  • (String) 


147
148
149
 
# File 'service_discovery/private_dns_namespace.rb', line 147

def private_dns_namespace_name()
  jsii_get_property("privateDnsNamespaceName")
end

#private_dns_namespace_ref ⇒ AWSCDK::Interfaces::AWSServicediscovery::PrivateDNSNamespaceReference

A reference to a PrivateDnsNamespace resource.

Returns:



154
155
156
 
# File 'service_discovery/private_dns_namespace.rb', line 154

def private_dns_namespace_ref()
  jsii_get_property("privateDnsNamespaceRef")
end

#stack ⇒ AWSCDK::Stack

The stack in which this resource is defined.

Returns:



97
98
99
 
# File 'service_discovery/private_dns_namespace.rb', line 97

def stack()
  jsii_get_property("stack")
end

#to_string ⇒ String

Returns a string representation of this construct.

Returns:

  • (String) 


168
169
170
 
# File 'service_discovery/private_dns_namespace.rb', line 168

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

#type ⇒ AWSCDK::ServiceDiscovery::NamespaceType

Type of the namespace.

Returns:



161
162
163
 
# File 'service_discovery/private_dns_namespace.rb', line 161

def type()
  jsii_get_property("type")
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) 


181
182
183
184
185
186
 
# File 'service_discovery/private_dns_namespace.rb', line 181

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