Module: AWSCDK::ServiceDiscovery::IService

Includes:
IResource, Interfaces::AWSServicediscovery::IServiceRef
Included in:
Service
Defined in:
service_discovery/i_service.rb

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.jsii_overridable_methods ⇒ Object 



124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
 
# File 'service_discovery/i_service.rb', line 124

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 },
    :service_ref => { kind: :property, name: "serviceRef", 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 },
    :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:



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

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 the service.

Returns:



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

def discovery_type()
  jsii_get_property("discoveryType")
end

#dns_record_type ⇒ AWSCDK::ServiceDiscovery::DNSRecordType

The DnsRecordType used by the service.

Returns:



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

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:



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

def env()
  jsii_get_property("env")
end

#namespace ⇒ AWSCDK::ServiceDiscovery::INamespace

The namespace for the Cloudmap Service.

Returns:



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

def namespace()
  jsii_get_property("namespace")
end

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


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

def node()
  jsii_get_property("node")
end

#routing_policy ⇒ AWSCDK::ServiceDiscovery::RoutingPolicy

The Routing Policy used by the service.

Returns:



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

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) 


75
76
77
 
# File 'service_discovery/i_service.rb', line 75

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) 


82
83
84
 
# File 'service_discovery/i_service.rb', line 82

def service_id()
  jsii_get_property("serviceId")
end

#service_name ⇒ String

A name for the Cloudmap Service.

Returns:

  • (String) 


89
90
91
 
# File 'service_discovery/i_service.rb', line 89

def service_name()
  jsii_get_property("serviceName")
end

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

A reference to a Service resource.

Returns:



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

def service_ref()
  jsii_get_property("serviceRef")
end

#stack ⇒ AWSCDK::Stack

The stack in which this resource is defined.

Returns:



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

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



100
101
102
103
104
105
 
# File 'service_discovery/i_service.rb', line 100

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