CloudMapOptions

All Known Implementing Classes:: CloudMapOptions.Jsii$Proxy

@Generated(value="jsii-pacmak/1.58.0 (build f8ba112)",
           date="2022-05-27T16:28:06.021Z")
public interface CloudMapOptions

The options to enabling AWS Cloud Map for an Amazon ECS service.

Example:

 TaskDefinition taskDefinition;
 Cluster cluster;
 Ec2Service service = Ec2Service.Builder.create(this, "Service")
         .cluster(cluster)
         .taskDefinition(taskDefinition)
         .cloudMapOptions(CloudMapOptions.builder()
                 // Create A records - useful for AWSVPC network mode.
                 .dnsRecordType(DnsRecordType.A)
                 .build())
         .build();

Nested Class Summary

Nested Classes
Modifier and Type	Interface and Description
`static class`	`CloudMapOptions.Builder` A builder for `CloudMapOptions`
`static class`	`CloudMapOptions.Jsii$Proxy` An implementation for `CloudMapOptions`

Method Summary

All Methods Static Methods Instance Methods Default Methods
Modifier and Type	Method and Description
`static CloudMapOptions.Builder`	`builder()`
`default INamespace`	`getCloudMapNamespace()` The service discovery namespace for the Cloud Map service to attach to the ECS service.
`default ContainerDefinition`	`getContainer()` The container to point to for a SRV record.
`default java.lang.Number`	`getContainerPort()` The port to point to for a SRV record.
`default DnsRecordType`	`getDnsRecordType()` The DNS record type that you want AWS Cloud Map to create.
`default Duration`	`getDnsTtl()` The amount of time that you want DNS resolvers to cache the settings for this record.
`default java.lang.Number`	`getFailureThreshold()` The number of 30-second intervals that you want Cloud Map to wait after receiving an UpdateInstanceCustomHealthStatus request before it changes the health status of a service instance.
`default java.lang.String`	`getName()` The name of the Cloud Map service to attach to the ECS service.

- Method Detail
  - getCloudMapNamespace
```
default INamespace getCloudMapNamespace()
```
    The service discovery namespace for the Cloud Map service to attach to the ECS service.
    Default: - the defaultCloudMapNamespace associated to the cluster
  - getContainer
```
default ContainerDefinition getContainer()
```
    The container to point to for a SRV record.
    Default: - the task definition's default container
  - getContainerPort
```
default java.lang.Number getContainerPort()
```
    The port to point to for a SRV record.
    Default: - the default port of the task definition's default container
  - getDnsRecordType
```
default DnsRecordType getDnsRecordType()
```
    The DNS record type that you want AWS Cloud Map to create.
    The supported record types are A or SRV.
    Default: - DnsRecordType.A if TaskDefinition.networkMode = AWS_VPC, otherwise DnsRecordType.SRV
  - getDnsTtl
```
default Duration getDnsTtl()
```
    The amount of time that you want DNS resolvers to cache the settings for this record.
    Default: Duration.minutes(1)
  - getFailureThreshold
```
default java.lang.Number getFailureThreshold()
```
    The number of 30-second intervals that you want Cloud Map to wait after receiving an UpdateInstanceCustomHealthStatus request before it changes the health status of a service instance.
    NOTE: This is used for HealthCheckCustomConfig
  - getName
```
default java.lang.String getName()
```
    The name of the Cloud Map service to attach to the ECS service.
    Default: CloudFormation-generated name
  - builder
```
static CloudMapOptions.Builder builder()
```
    Returns:
    
    a CloudMapOptions.Builder of CloudMapOptions

Interface CloudMapOptions

Nested Class Summary

Method Summary

Method Detail

getCloudMapNamespace

getContainer

getContainerPort

getDnsRecordType

getDnsTtl

getFailureThreshold

getName

builder