Class: AWSCDK::ServiceDiscovery::IPInstance

Inherits:
InstanceBase
  • Object
show all
Defined in:
service_discovery/ip_instance.rb

Overview

Instance that is accessible using an IP address.

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props) ⇒ IPInstance

Returns a new instance of IPInstance.

Parameters:



11
12
13
14
15
16
17
 
# File 'service_discovery/ip_instance.rb', line 11

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

Class Method Details

.jsii_overridable_methods ⇒ Object 



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

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 },
    :instance_id => { kind: :property, name: "instanceId", is_optional: false },
    :instance_ref => { kind: :property, name: "instanceRef", is_optional: false },
    :service => { kind: :property, name: "service", is_optional: false },
    :ipv4 => { kind: :property, name: "ipv4", is_optional: false },
    :ipv6 => { kind: :property, name: "ipv6", is_optional: false },
    :port => { kind: :property, name: "port", 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 },
    :unique_instance_id => { kind: :method, name: "uniqueInstanceId", is_optional: false },
  }
end

.PROPERTY_INJECTION_ID ⇒ String

Uniquely identifies this class.

Returns:

  • (String) 


109
110
111
 
# File 'service_discovery/ip_instance.rb', line 109

def self.PROPERTY_INJECTION_ID()
  Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_servicediscovery.IpInstance", "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:



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

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:



184
185
186
187
 
# File 'service_discovery/ip_instance.rb', line 184

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:



60
61
62
 
# File 'service_discovery/ip_instance.rb', line 60

def env()
  jsii_get_property("env")
end

#generate_physical_name ⇒ String

Returns:

  • (String) 


190
191
192
 
# File 'service_discovery/ip_instance.rb', line 190

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) 


204
205
206
207
208
209
 
# File 'service_discovery/ip_instance.rb', line 204

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) 


219
220
221
222
 
# File 'service_discovery/ip_instance.rb', line 219

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

#instance_id ⇒ String

The Id of the instance.

Returns:

  • (String) 


88
89
90
 
# File 'service_discovery/ip_instance.rb', line 88

def instance_id()
  jsii_get_property("instanceId")
end

#instance_ref ⇒ AWSCDK::Interfaces::AWSServicediscovery::InstanceReference

A reference to a Instance resource.

Returns:



95
96
97
 
# File 'service_discovery/ip_instance.rb', line 95

def instance_ref()
  jsii_get_property("instanceRef")
end

#ipv4 ⇒ String

The Ipv4 address of the instance, or blank string if none available.

Returns:

  • (String) 


116
117
118
 
# File 'service_discovery/ip_instance.rb', line 116

def ipv4()
  jsii_get_property("ipv4")
end

#ipv6 ⇒ String

The Ipv6 address of the instance, or blank string if none available.

Returns:

  • (String) 


123
124
125
 
# File 'service_discovery/ip_instance.rb', line 123

def ipv6()
  jsii_get_property("ipv6")
end

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


45
46
47
 
# File 'service_discovery/ip_instance.rb', line 45

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) 


74
75
76
 
# File 'service_discovery/ip_instance.rb', line 74

def physical_name()
  jsii_get_property("physicalName")
end

#port ⇒ Numeric

The exposed port of the instance.

Returns:

  • (Numeric) 


130
131
132
 
# File 'service_discovery/ip_instance.rb', line 130

def port()
  jsii_get_property("port")
end

#service ⇒ AWSCDK::ServiceDiscovery::IService

The Cloudmap service to which the instance is registered.

Returns:



102
103
104
 
# File 'service_discovery/ip_instance.rb', line 102

def service()
  jsii_get_property("service")
end

#stack ⇒ AWSCDK::Stack

The stack in which this resource is defined.

Returns:



81
82
83
 
# File 'service_discovery/ip_instance.rb', line 81

def stack()
  jsii_get_property("stack")
end

#to_string ⇒ String

Returns a string representation of this construct.

Returns:

  • (String) 


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

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

#unique_instance_id ⇒ String

Generate a unique instance Id that is safe to pass to CloudMap.

Returns:

  • (String) 


227
228
229
 
# File 'service_discovery/ip_instance.rb', line 227

def unique_instance_id()
  jsii_call_method("uniqueInstanceId", [])
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) 


150
151
152
153
154
155
 
# File 'service_discovery/ip_instance.rb', line 150

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