Class: AWSCDK::ServiceDiscovery::Service

Inherits:
Resource
  • Object
show all
Includes:
IService
Defined in:
service_discovery/service.rb

Overview

Define a CloudMap Service.

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props) ⇒ Service

Returns a new instance of Service.

Parameters:



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

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

Class Method Details

.from_service_attributes(scope, id, attrs) ⇒ AWSCDK::ServiceDiscovery::IService

Parameters:

Returns:



52
53
54
55
56
57
58
 
# File 'service_discovery/service.rb', line 52

def self.from_service_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::ServiceAttributes.new(**attrs.transform_keys(&:to_sym)) : attrs
  Jsii::Type.check_type(attrs, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfc2VydmljZWRpc2NvdmVyeS5TZXJ2aWNlQXR0cmlidXRlcyJ9")), "attrs")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_servicediscovery.Service", "fromServiceAttributes", [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
45
46
 
# File 'service_discovery/service.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 },
    :discovery_type => { kind: :property, name: "discoveryType", is_optional: false },
    :dns_record_type => { kind: :property, name: "dnsRecordType", is_optional: false },
    :namespace => { kind: :property, name: "namespace", is_optional: false },
    :routing_policy => { kind: :property, name: "routingPolicy", is_optional: false },
    :service_arn => { kind: :property, name: "serviceArn", is_optional: false },
    :service_id => { kind: :property, name: "serviceId", is_optional: false },
    :service_name => { kind: :property, name: "serviceName", is_optional: false },
    :service_ref => { kind: :property, name: "serviceRef", 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 },
    :register_cname_instance => { kind: :method, name: "registerCnameInstance", is_optional: false },
    :register_ip_instance => { kind: :method, name: "registerIpInstance", is_optional: false },
    :register_load_balancer => { kind: :method, name: "registerLoadBalancer", is_optional: false },
    :register_non_ip_instance => { kind: :method, name: "registerNonIpInstance", is_optional: false },
  }
end

.PROPERTY_INJECTION_ID ⇒ String

Uniquely identifies this class.

Returns:

  • (String) 


106
107
108
 
# File 'service_discovery/service.rb', line 106

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



199
200
201
202
 
# File 'service_discovery/service.rb', line 199

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:



216
217
218
219
 
# File 'service_discovery/service.rb', line 216

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

#discovery_type ⇒ AWSCDK::ServiceDiscovery::DiscoveryType

The discovery type used by this service.

Returns:



113
114
115
 
# File 'service_discovery/service.rb', line 113

def discovery_type()
  jsii_get_property("discoveryType")
end

#dns_record_type ⇒ AWSCDK::ServiceDiscovery::DNSRecordType

The DnsRecordType used by the service.

Returns:



120
121
122
 
# File 'service_discovery/service.rb', line 120

def dns_record_type()
  jsii_get_property("dnsRecordType")
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:



78
79
80
 
# File 'service_discovery/service.rb', line 78

def env()
  jsii_get_property("env")
end

#generate_physical_name ⇒ String

Returns:

  • (String) 


222
223
224
 
# File 'service_discovery/service.rb', line 222

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) 


236
237
238
239
240
241
 
# File 'service_discovery/service.rb', line 236

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) 


251
252
253
254
 
# File 'service_discovery/service.rb', line 251

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 ⇒ AWSCDK::ServiceDiscovery::INamespace

The namespace for the Cloudmap Service.

Returns:



127
128
129
 
# File 'service_discovery/service.rb', line 127

def namespace()
  jsii_get_property("namespace")
end

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


63
64
65
 
# File 'service_discovery/service.rb', line 63

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) 


92
93
94
 
# File 'service_discovery/service.rb', line 92

def physical_name()
  jsii_get_property("physicalName")
end

#register_cname_instance(id, props) ⇒ AWSCDK::ServiceDiscovery::IInstance

Registers a resource that is accessible using a CNAME.

Parameters:

Returns:



261
262
263
264
265
266
 
# File 'service_discovery/service.rb', line 261

def register_cname_instance(id, props)
  Jsii::Type.check_type(id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "id")
  props = props.is_a?(Hash) ? ::AWSCDK::ServiceDiscovery::CnameInstanceBaseProps.new(**props.transform_keys(&:to_sym)) : props
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfc2VydmljZWRpc2NvdmVyeS5DbmFtZUluc3RhbmNlQmFzZVByb3BzIn0=")), "props")
  jsii_call_method("registerCnameInstance", [id, props])
end

#register_ip_instance(id, props) ⇒ AWSCDK::ServiceDiscovery::IInstance

Registers a resource that is accessible using an IP address.

Parameters:

Returns:



273
274
275
276
277
278
 
# File 'service_discovery/service.rb', line 273

def register_ip_instance(id, props)
  Jsii::Type.check_type(id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "id")
  props = props.is_a?(Hash) ? ::AWSCDK::ServiceDiscovery::IPInstanceBaseProps.new(**props.transform_keys(&:to_sym)) : props
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfc2VydmljZWRpc2NvdmVyeS5JcEluc3RhbmNlQmFzZVByb3BzIn0=")), "props")
  jsii_call_method("registerIpInstance", [id, props])
end

#register_load_balancer(id, load_balancer, custom_attributes = nil) ⇒ AWSCDK::ServiceDiscovery::IInstance

Registers an ELB as a new instance with unique name instanceId in this service.

Parameters:

Returns:



286
287
288
289
290
291
 
# File 'service_discovery/service.rb', line 286

def register_load_balancer(id, load_balancer, custom_attributes = nil)
  Jsii::Type.check_type(id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "id")
  Jsii::Type.check_type(load_balancer, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfZWxhc3RpY2xvYWRiYWxhbmNpbmd2Mi5JTG9hZEJhbGFuY2VyVjIifQ==")), "loadBalancer")
  Jsii::Type.check_type(custom_attributes, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoibWFwIn19")), "customAttributes") unless custom_attributes.nil?
  jsii_call_method("registerLoadBalancer", [id, load_balancer, custom_attributes])
end

#register_non_ip_instance(id, props) ⇒ AWSCDK::ServiceDiscovery::IInstance

Registers a resource that is accessible using values other than an IP address or a domain name (CNAME).

Parameters:

Returns:



298
299
300
301
302
303
 
# File 'service_discovery/service.rb', line 298

def register_non_ip_instance(id, props)
  Jsii::Type.check_type(id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "id")
  props = props.is_a?(Hash) ? ::AWSCDK::ServiceDiscovery::NonIPInstanceBaseProps.new(**props.transform_keys(&:to_sym)) : props
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfc2VydmljZWRpc2NvdmVyeS5Ob25JcEluc3RhbmNlQmFzZVByb3BzIn0=")), "props")
  jsii_call_method("registerNonIpInstance", [id, props])
end

#routing_policy ⇒ AWSCDK::ServiceDiscovery::RoutingPolicy

The Routing Policy used by the service.

Returns:



134
135
136
 
# File 'service_discovery/service.rb', line 134

def routing_policy()
  jsii_get_property("routingPolicy")
end

#service_arn ⇒ String

The Arn of the namespace that you want to use for DNS configuration.

Returns:

  • (String) 


141
142
143
 
# File 'service_discovery/service.rb', line 141

def service_arn()
  jsii_get_property("serviceArn")
end

#service_id ⇒ String

The ID of the namespace that you want to use for DNS configuration.

Returns:

  • (String) 


148
149
150
 
# File 'service_discovery/service.rb', line 148

def service_id()
  jsii_get_property("serviceId")
end

#service_name ⇒ String

A name for the Cloudmap Service.

Returns:

  • (String) 


155
156
157
 
# File 'service_discovery/service.rb', line 155

def service_name()
  jsii_get_property("serviceName")
end

#service_ref ⇒ AWSCDK::Interfaces::AWSServicediscovery::ServiceReference

A reference to a Service resource.

Returns:



162
163
164
 
# File 'service_discovery/service.rb', line 162

def service_ref()
  jsii_get_property("serviceRef")
end

#stack ⇒ AWSCDK::Stack

The stack in which this resource is defined.

Returns:



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

def stack()
  jsii_get_property("stack")
end

#to_string ⇒ String

Returns a string representation of this construct.

Returns:

  • (String) 


169
170
171
 
# File 'service_discovery/service.rb', line 169

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


182
183
184
185
186
187
 
# File 'service_discovery/service.rb', line 182

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