software.amazon.awscdk.services.servicediscovery

Class Service

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.Resource

software.amazon.awscdk.services.servicediscovery.Service

All Implemented Interfaces:

IResource, IService, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:42.172Z")
 @Stability(value=Stable)
public class Service
extends Resource
implements IService

Define a CloudMap Service.

Example:

 import software.amazon.awscdk.*;
 import software.amazon.awscdk.*;
 App app = new App();
 Stack stack = new Stack(app, "aws-servicediscovery-integ");
 PublicDnsNamespace namespace = PublicDnsNamespace.Builder.create(stack, "Namespace")
         .name("foobar.com")
         .build();
 Service service = namespace.createService("Service", DnsServiceProps.builder()
         .name("foo")
         .dnsRecordType(DnsRecordType.A)
         .dnsTtl(Duration.seconds(30))
         .healthCheck(HealthCheckConfig.builder()
                 .type(HealthCheckType.HTTPS)
                 .resourcePath("/healthcheck")
                 .failureThreshold(2)
                 .build())
         .build());
 service.registerIpInstance("IpInstance", IpInstanceBaseProps.builder()
         .ipv4("54.239.25.192")
         .port(443)
         .build());
 app.synth();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Service.Builder A fluent builder for Service.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.servicediscovery.IService

IService.Jsii$Default, IService.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor and Description
	Service(software.constructs.Construct scope, String id, ServiceProps props)
protected	Service(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	Service(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
static IService	fromServiceAttributes(software.constructs.Construct scope, String id, ServiceAttributes attrs)
DiscoveryType	getDiscoveryType() The discovery type used by this service.
DnsRecordType	getDnsRecordType() The DnsRecordType used by the service.
INamespace	getNamespace() The namespace for the Cloudmap Service.
RoutingPolicy	getRoutingPolicy() The Routing Policy used by the service.
String	getServiceArn() The Arn of the namespace that you want to use for DNS configuration.
String	getServiceId() The ID of the namespace that you want to use for DNS configuration.
String	getServiceName() A name for the Cloudmap Service.
IInstance	registerCnameInstance(String id, CnameInstanceBaseProps props) Registers a resource that is accessible using a CNAME.
IInstance	registerIpInstance(String id, IpInstanceBaseProps props) Registers a resource that is accessible using an IP address.
IInstance	registerLoadBalancer(String id, ILoadBalancerV2 loadBalancer) Registers an ELB as a new instance with unique name instanceId in this service.
IInstance	registerLoadBalancer(String id, ILoadBalancerV2 loadBalancer, Map<String,String> customAttributes) Registers an ELB as a new instance with unique name instanceId in this service.
IInstance	registerNonIpInstance(String id, NonIpInstanceBaseProps props) Registers a resource that is accessible using values other than an IP address or a domain name (CNAME).

Methods inherited from class software.amazon.awscdk.Resource

applyRemovalPolicy, generatePhysicalName, getEnv, getPhysicalName, getResourceArnAttribute, getResourceNameAttribute, getStack, isOwnedResource, isResource

Methods inherited from class software.constructs.Construct

getNode, isConstruct, toString

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awscdk.IResource

applyRemovalPolicy, getEnv, getStack

Methods inherited from interface software.constructs.IConstruct

getNode

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Detail

Service

protected Service(software.amazon.jsii.JsiiObjectRef objRef)

Service

protected Service(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

Service

@Stability(value=Stable)
public Service(@NotNull
                                        software.constructs.Construct scope,
                                        @NotNull
                                        String id,
                                        @NotNull
                                        ServiceProps props)

Parameters:

scope - This parameter is required.

id - This parameter is required.

props - This parameter is required.

Method Detail

fromServiceAttributes

@Stability(value=Stable)
 @NotNull
public static IService fromServiceAttributes(@NotNull
                                                                                software.constructs.Construct scope,
                                                                                @NotNull
                                                                                String id,
                                                                                @NotNull
                                                                                ServiceAttributes attrs)

Parameters:

scope - This parameter is required.

id - This parameter is required.

attrs - This parameter is required.

registerCnameInstance

@Stability(value=Stable)
 @NotNull
public IInstance registerCnameInstance(@NotNull
                                                                          String id,
                                                                          @NotNull
                                                                          CnameInstanceBaseProps props)

Registers a resource that is accessible using a CNAME.

Parameters:

id - This parameter is required.

props - This parameter is required.

registerIpInstance

@Stability(value=Stable)
 @NotNull
public IInstance registerIpInstance(@NotNull
                                                                       String id,
                                                                       @NotNull
                                                                       IpInstanceBaseProps props)

Registers a resource that is accessible using an IP address.

Parameters:

id - This parameter is required.

props - This parameter is required.

registerLoadBalancer

@Stability(value=Stable)
 @NotNull
public IInstance registerLoadBalancer(@NotNull
                                                                         String id,
                                                                         @NotNull
                                                                         ILoadBalancerV2 loadBalancer,
                                                                         @Nullable
                                                                         Map<String,String> customAttributes)

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

Parameters:

id - This parameter is required.

loadBalancer - This parameter is required.

customAttributes -

registerLoadBalancer

@Stability(value=Stable)
 @NotNull
public IInstance registerLoadBalancer(@NotNull
                                                                         String id,
                                                                         @NotNull
                                                                         ILoadBalancerV2 loadBalancer)

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

Parameters:

id - This parameter is required.

loadBalancer - This parameter is required.

registerNonIpInstance

@Stability(value=Stable)
 @NotNull
public IInstance registerNonIpInstance(@NotNull
                                                                          String id,
                                                                          @NotNull
                                                                          NonIpInstanceBaseProps props)

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

Parameters:

id - This parameter is required.

props - This parameter is required.

getDiscoveryType

@Stability(value=Stable)
 @NotNull
public DiscoveryType getDiscoveryType()

The discovery type used by this service.

Specified by:

getDiscoveryType in interface IService

getDnsRecordType

@Stability(value=Stable)
 @NotNull
public DnsRecordType getDnsRecordType()

The DnsRecordType used by the service.

Specified by:

getDnsRecordType in interface IService

getNamespace

@Stability(value=Stable)
 @NotNull
public INamespace getNamespace()

The namespace for the Cloudmap Service.

Specified by:

getNamespace in interface IService

getRoutingPolicy

@Stability(value=Stable)
 @NotNull
public RoutingPolicy getRoutingPolicy()

The Routing Policy used by the service.

Specified by:

getRoutingPolicy in interface IService

getServiceArn

@Stability(value=Stable)
 @NotNull
public String getServiceArn()

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

Specified by:

getServiceArn in interface IService

getServiceId

@Stability(value=Stable)
 @NotNull
public String getServiceId()

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

Specified by:

getServiceId in interface IService

getServiceName

@Stability(value=Stable)
 @NotNull
public String getServiceName()

A name for the Cloudmap Service.

Specified by:

getServiceName in interface IService