CfnService (software.amazon.awscdk:aws-cdk-lib 2.42.1 API)

java.lang.Object
- software.amazon.jsii.JsiiObject
- - software.constructs.Construct
  - - software.amazon.awscdk.CfnElement
    - - software.amazon.awscdk.CfnRefElement
      - software.amazon.awscdk.CfnResource
        
        software.amazon.awscdk.services.servicediscovery.CfnService

All Implemented Interfaces:: IInspectable, 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.138Z")
 @Stability(value=Stable)
public class CfnService
extends CfnResource
implements IInspectable

A CloudFormation `AWS::ServiceDiscovery::Service`.

A complex type that contains information about a service, which defines the configuration of the following entities:

For public and private DNS namespaces, one of the following combinations of DNS records in Amazon Route 53:
A
AAAA
A and AAAA
SRV
CNAME
Optionally, a health check

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.servicediscovery.*;
 CfnService cfnService = CfnService.Builder.create(this, "MyCfnService")
         .description("description")
         .dnsConfig(DnsConfigProperty.builder()
                 .dnsRecords(List.of(DnsRecordProperty.builder()
                         .ttl(123)
                         .type("type")
                         .build()))
                 // the properties below are optional
                 .namespaceId("namespaceId")
                 .routingPolicy("routingPolicy")
                 .build())
         .healthCheckConfig(HealthCheckConfigProperty.builder()
                 .type("type")
                 // the properties below are optional
                 .failureThreshold(123)
                 .resourcePath("resourcePath")
                 .build())
         .healthCheckCustomConfig(HealthCheckCustomConfigProperty.builder()
                 .failureThreshold(123)
                 .build())
         .name("name")
         .namespaceId("namespaceId")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .type("type")
         .build();

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`CfnService.Builder` A fluent builder for `CfnService`.
`static interface`	`CfnService.DnsConfigProperty` A complex type that contains information about the Amazon Route 53 DNS records that you want AWS Cloud Map to create when you register an instance.
`static interface`	`CfnService.DnsRecordProperty` A complex type that contains information about the Route 53 DNS records that you want AWS Cloud Map to create when you register an instance.
`static interface`	`CfnService.HealthCheckConfigProperty` Public DNS and HTTP namespaces only. A complex type that contains settings for an optional health check.
`static interface`	`CfnService.HealthCheckCustomConfigProperty` A complex type that contains information about an optional custom health check.

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

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct
software.constructs.IConstruct.Jsii$Default

Field Summary

Fields
Modifier and Type Field and Description

static String CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.

Fields
Modifier and Type	Field and Description
`static String`	`CFN_RESOURCE_TYPE_NAME` The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors
Modifier	Constructor and Description
	`CfnService(software.constructs.Construct scope, String id)` Create a new `AWS::ServiceDiscovery::Service`.
	`CfnService(software.constructs.Construct scope, String id, CfnServiceProps props)` Create a new `AWS::ServiceDiscovery::Service`.
`protected`	`CfnService(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)`
`protected`	`CfnService(software.amazon.jsii.JsiiObjectRef objRef)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`getAttrArn()` The Amazon Resource Name (ARN) of the service.
`String`	`getAttrId()` The ID of the service.
`String`	`getAttrName()` The name that you assigned to the service.
`protected Map<String,Object>`	`getCfnProperties()`
`String`	`getDescription()` The description of the service.
`Object`	`getDnsConfig()` A complex type that contains information about the Route 53 DNS records that you want AWS Cloud Map to create when you register an instance.
`Object`	`getHealthCheckConfig()` Public DNS and HTTP namespaces only. A complex type that contains settings for an optional health check.
`Object`	`getHealthCheckCustomConfig()` A complex type that contains information about an optional custom health check.
`String`	`getName()` The name of the service.
`String`	`getNamespaceId()` The ID of the namespace that was used to create the service.
`TagManager`	`getTags()` The tags for the service.
`String`	`getType()` If present, specifies that the service instances are only discoverable using the `DiscoverInstances` API operation.
`void`	`inspect(TreeInspector inspector)` Examines the CloudFormation resource and discloses attributes.
`protected Map<String,Object>`	`renderProperties(Map<String,Object> props)`
`void`	`setDescription(String value)` The description of the service.
`void`	`setDnsConfig(CfnService.DnsConfigProperty value)` A complex type that contains information about the Route 53 DNS records that you want AWS Cloud Map to create when you register an instance.
`void`	`setDnsConfig(IResolvable value)` A complex type that contains information about the Route 53 DNS records that you want AWS Cloud Map to create when you register an instance.
`void`	`setHealthCheckConfig(CfnService.HealthCheckConfigProperty value)` Public DNS and HTTP namespaces only. A complex type that contains settings for an optional health check.
`void`	`setHealthCheckConfig(IResolvable value)` Public DNS and HTTP namespaces only. A complex type that contains settings for an optional health check.
`void`	`setHealthCheckCustomConfig(CfnService.HealthCheckCustomConfigProperty value)` A complex type that contains information about an optional custom health check.
`void`	`setHealthCheckCustomConfig(IResolvable value)` A complex type that contains information about an optional custom health check.
`void`	`setName(String value)` The name of the service.
`void`	`setNamespaceId(String value)` The ID of the namespace that was used to create the service.
`void`	`setType(String value)` If present, specifies that the service instances are only discoverable using the `DiscoverInstances` API operation.

Methods inherited from class software.amazon.awscdk.CfnResource
addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement
getRef

Methods inherited from class software.amazon.awscdk.CfnElement
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct
getNode, isConstruct

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.jsii.JsiiSerializable
$jsii$toJson

- Field Detail
  - CFN_RESOURCE_TYPE_NAME
```
@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME
```
    The CloudFormation resource type name for this resource class.
- Constructor Detail
  - CfnService
```
protected CfnService(software.amazon.jsii.JsiiObjectRef objRef)
```
  - CfnService
```
protected CfnService(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
```
  - CfnService
```
@Stability(value=Stable)
public CfnService(@NotNull
                                           software.constructs.Construct scope,
                                           @NotNull
                                           String id,
                                           @Nullable
                                           CfnServiceProps props)
```
    Create a new `AWS::ServiceDiscovery::Service`.
    
    Parameters:
    
    scope - - scope in which this resource is defined. This parameter is required.
    
    id - - scoped id of the resource. This parameter is required.
    
    props - - resource properties.
  - CfnService
```
@Stability(value=Stable)
public CfnService(@NotNull
                                           software.constructs.Construct scope,
                                           @NotNull
                                           String id)
```
    Create a new `AWS::ServiceDiscovery::Service`.
    
    Parameters:
    
    scope - - scope in which this resource is defined. This parameter is required.
    
    id - - scoped id of the resource. This parameter is required.
- Method Detail
  - inspect
```
@Stability(value=Stable)
public void inspect(@NotNull
                                             TreeInspector inspector)
```
    Examines the CloudFormation resource and discloses attributes.
    
    Specified by:
    
    inspect in interface IInspectable
    
    Parameters:
    
    inspector - - tree inspector to collect and process attributes. This parameter is required.
  - renderProperties
```
@Stability(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)
```
    Overrides:
    
    renderProperties in class CfnResource
    
    Parameters:
    
    props - This parameter is required.
  - getAttrArn
```
@Stability(value=Stable)
 @NotNull
public String getAttrArn()
```
    The Amazon Resource Name (ARN) of the service.
  - getAttrId
```
@Stability(value=Stable)
 @NotNull
public String getAttrId()
```
    The ID of the service.
  - getAttrName
```
@Stability(value=Stable)
 @NotNull
public String getAttrName()
```
    The name that you assigned to the service.
  - getCfnProperties
```
@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()
```
    Overrides:
    
    getCfnProperties in class CfnResource
  - getTags
```
@Stability(value=Stable)
 @NotNull
public TagManager getTags()
```
    The tags for the service.
    Each tag consists of a key and an optional value, both of which you define. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.
  - getDescription
```
@Stability(value=Stable)
 @Nullable
public String getDescription()
```
    The description of the service.
  - setDescription
```
@Stability(value=Stable)
public void setDescription(@Nullable
                                                    String value)
```
    The description of the service.
  - getDnsConfig
```
@Stability(value=Stable)
 @Nullable
public Object getDnsConfig()
```
    A complex type that contains information about the Route 53 DNS records that you want AWS Cloud Map to create when you register an instance.
  - setDnsConfig
```
@Stability(value=Stable)
public void setDnsConfig(@Nullable
                                                  CfnService.DnsConfigProperty value)
```
    A complex type that contains information about the Route 53 DNS records that you want AWS Cloud Map to create when you register an instance.
  - setDnsConfig
```
@Stability(value=Stable)
public void setDnsConfig(@Nullable
                                                  IResolvable value)
```
    A complex type that contains information about the Route 53 DNS records that you want AWS Cloud Map to create when you register an instance.
  - getHealthCheckConfig
```
@Stability(value=Stable)
 @Nullable
public Object getHealthCheckConfig()
```
    *Public DNS and HTTP namespaces only.* A complex type that contains settings for an optional health check. If you specify settings for a health check, AWS Cloud Map associates the health check with the records that you specify in `DnsConfig` .
    For information about the charges for health checks, see Amazon Route 53 Pricing .
  - setHealthCheckConfig
```
@Stability(value=Stable)
public void setHealthCheckConfig(@Nullable
                                                          CfnService.HealthCheckConfigProperty value)
```
    *Public DNS and HTTP namespaces only.* A complex type that contains settings for an optional health check. If you specify settings for a health check, AWS Cloud Map associates the health check with the records that you specify in `DnsConfig` .
    For information about the charges for health checks, see Amazon Route 53 Pricing .
  - setHealthCheckConfig
```
@Stability(value=Stable)
public void setHealthCheckConfig(@Nullable
                                                          IResolvable value)
```
    *Public DNS and HTTP namespaces only.* A complex type that contains settings for an optional health check. If you specify settings for a health check, AWS Cloud Map associates the health check with the records that you specify in `DnsConfig` .
    For information about the charges for health checks, see Amazon Route 53 Pricing .
  - getHealthCheckCustomConfig
```
@Stability(value=Stable)
 @Nullable
public Object getHealthCheckCustomConfig()
```
    A complex type that contains information about an optional custom health check.
    
    If you specify a health check configuration, you can specify either HealthCheckCustomConfig or HealthCheckConfig but not both.
  - setHealthCheckCustomConfig
```
@Stability(value=Stable)
public void setHealthCheckCustomConfig(@Nullable
                                                                CfnService.HealthCheckCustomConfigProperty value)
```
    A complex type that contains information about an optional custom health check.
    
    If you specify a health check configuration, you can specify either HealthCheckCustomConfig or HealthCheckConfig but not both.
  - setHealthCheckCustomConfig
```
@Stability(value=Stable)
public void setHealthCheckCustomConfig(@Nullable
                                                                IResolvable value)
```
    A complex type that contains information about an optional custom health check.
    
    If you specify a health check configuration, you can specify either HealthCheckCustomConfig or HealthCheckConfig but not both.
  - getName
```
@Stability(value=Stable)
 @Nullable
public String getName()
```
    The name of the service.
  - setName
```
@Stability(value=Stable)
public void setName(@Nullable
                                             String value)
```
    The name of the service.
  - getNamespaceId
```
@Stability(value=Stable)
 @Nullable
public String getNamespaceId()
```
    The ID of the namespace that was used to create the service.
    
    You must specify a value for NamespaceId either for the service properties or for DnsConfig . Don't specify a value in both places.
  - setNamespaceId
```
@Stability(value=Stable)
public void setNamespaceId(@Nullable
                                                    String value)
```
    The ID of the namespace that was used to create the service.
    
    You must specify a value for NamespaceId either for the service properties or for DnsConfig . Don't specify a value in both places.
  - getType
```
@Stability(value=Stable)
 @Nullable
public String getType()
```
    If present, specifies that the service instances are only discoverable using the `DiscoverInstances` API operation.
    No DNS records is registered for the service instances. The only valid value is HTTP .
  - setType
```
@Stability(value=Stable)
public void setType(@Nullable
                                             String value)
```
    If present, specifies that the service instances are only discoverable using the `DiscoverInstances` API operation.
    No DNS records is registered for the service instances. The only valid value is HTTP .

Class CfnService

Nested Class Summary

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

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

Nested classes/interfaces inherited from interface software.constructs.IConstruct

Field Summary

Constructor Summary

Method Summary

Methods inherited from class software.amazon.awscdk.CfnResource

Methods inherited from class software.amazon.awscdk.CfnRefElement

Methods inherited from class software.amazon.awscdk.CfnElement

Methods inherited from class software.constructs.Construct

Methods inherited from class software.amazon.jsii.JsiiObject

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.jsii.JsiiSerializable

Field Detail

CFN_RESOURCE_TYPE_NAME

Constructor Detail

CfnService

CfnService

CfnService

CfnService

Method Detail

inspect

renderProperties

getAttrArn

getAttrId

getAttrName

getCfnProperties

getTags

getDescription

setDescription

getDnsConfig

setDnsConfig

setDnsConfig

getHealthCheckConfig

setHealthCheckConfig

setHealthCheckConfig

getHealthCheckCustomConfig

setHealthCheckCustomConfig

setHealthCheckCustomConfig

getName

setName

getNamespaceId

setNamespaceId

getType

setType