Module: AWSCDK::ServiceDiscovery::IPrivateDNSNamespace

Includes:
Interfaces::AWSServicediscovery::IPrivateDNSNamespaceRef, INamespace
Included in:
PrivateDNSNamespace
Defined in:
service_discovery/i_private_dns_namespace.rb

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.jsii_overridable_methods ⇒ Object 



103
104
105
106
107
108
109
110
111
112
113
114
115
116
 
# File 'service_discovery/i_private_dns_namespace.rb', line 103

def self.jsii_overridable_methods
  {
    :node => { kind: :property, name: "node", is_optional: false },
    :env => { kind: :property, name: "env", is_optional: false },
    :stack => { kind: :property, name: "stack", is_optional: false },
    :namespace_arn => { kind: :property, name: "namespaceArn", is_optional: false },
    :namespace_id => { kind: :property, name: "namespaceId", is_optional: false },
    :namespace_name => { kind: :property, name: "namespaceName", is_optional: false },
    :type => { kind: :property, name: "type", is_optional: false },
    :private_dns_namespace_ref => { kind: :property, name: "privateDnsNamespaceRef", is_optional: false },
    :with => { kind: :method, name: "with", is_optional: false },
    :apply_removal_policy => { kind: :method, name: "applyRemovalPolicy", is_optional: false },
  }
end

Instance Method Details

#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:



98
99
100
101
 
# File 'service_discovery/i_private_dns_namespace.rb', line 98

def apply_removal_policy(policy)
  Jsii::Type.check_type(policy, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZW1vdmFsUG9saWN5In0=")), "policy")
  jsii_call_method("applyRemovalPolicy", [policy])
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:



26
27
28
 
# File 'service_discovery/i_private_dns_namespace.rb', line 26

def env()
  jsii_get_property("env")
end

#namespace_arn ⇒ String

Namespace ARN for the Namespace.

Returns:

  • (String) 


40
41
42
 
# File 'service_discovery/i_private_dns_namespace.rb', line 40

def namespace_arn()
  jsii_get_property("namespaceArn")
end

#namespace_id ⇒ String

Namespace Id for the Namespace.

Returns:

  • (String) 


47
48
49
 
# File 'service_discovery/i_private_dns_namespace.rb', line 47

def namespace_id()
  jsii_get_property("namespaceId")
end

#namespace_name ⇒ String

A name for the Namespace.

Returns:

  • (String) 


54
55
56
 
# File 'service_discovery/i_private_dns_namespace.rb', line 54

def namespace_name()
  jsii_get_property("namespaceName")
end

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


11
12
13
 
# File 'service_discovery/i_private_dns_namespace.rb', line 11

def node()
  jsii_get_property("node")
end

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

A reference to a PrivateDnsNamespace resource.

Returns:



68
69
70
 
# File 'service_discovery/i_private_dns_namespace.rb', line 68

def private_dns_namespace_ref()
  jsii_get_property("privateDnsNamespaceRef")
end

#stack ⇒ AWSCDK::Stack

The stack in which this resource is defined.

Returns:



33
34
35
 
# File 'service_discovery/i_private_dns_namespace.rb', line 33

def stack()
  jsii_get_property("stack")
end

#type ⇒ AWSCDK::ServiceDiscovery::NamespaceType

Type of Namespace.

Returns:



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

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.

Parameters:

  • mixins (Array<Constructs::IMixin>) —

    The mixins to apply.

Returns:

  • (Constructs::IConstruct) —

    This construct for chaining



79
80
81
82
83
84
 
# File 'service_discovery/i_private_dns_namespace.rb', line 79

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