Service L2 construct
Define a CloudMap Service.
Example
import * as cdk from '../../core';
import * as servicediscovery from '../lib';
const app = new cdk.App();
const stack = new cdk.Stack(app, 'aws-servicediscovery-integ');
const namespace = new servicediscovery.PublicDnsNamespace(stack, 'Namespace', {
name: 'foobar.com',
});
const service = namespace.createService('Service', {
name: 'foo',
dnsRecordType: servicediscovery.DnsRecordType.A,
dnsTtl: cdk.Duration.seconds(30),
healthCheck: {
type: servicediscovery.HealthCheckType.HTTPS,
resourcePath: '/healthcheck',
failureThreshold: 2,
},
});
service.registerIpInstance('IpInstance', {
ipv4: '54.239.25.192',
port: 443,
});
app.synth();
import aws_cdk as cdk
import aws_cdk as servicediscovery
app = cdk.App()
stack = cdk.Stack(app, "aws-servicediscovery-integ")
namespace = servicediscovery.PublicDnsNamespace(stack, "Namespace",
name="foobar.com"
)
service = namespace.create_service("Service",
name="foo",
dns_record_type=servicediscovery.DnsRecordType.A,
dns_ttl=cdk.Duration.seconds(30),
health_check=cdk.aws_servicediscovery.HealthCheckConfig(
type=servicediscovery.HealthCheckType.HTTPS,
resource_path="/healthcheck",
failure_threshold=2
)
)
service.register_ip_instance("IpInstance",
ipv4="54.239.25.192",
port=443
)
app.synth()
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();
// Install: dotnet add package Amazon.CDK.Lib
using Amazon.CDK;
using Amazon.CDK;
var app = new App();
var stack = new Stack(app, "aws-servicediscovery-integ");
var namespace = new PublicDnsNamespace(stack, "Namespace", new PublicDnsNamespaceProps {
Name = "foobar.com"
});
var service = namespace.CreateService("Service", new DnsServiceProps {
Name = "foo",
DnsRecordType = DnsRecordType.A,
DnsTtl = Duration.Seconds(30),
HealthCheck = new HealthCheckConfig {
Type = HealthCheckType.HTTPS,
ResourcePath = "/healthcheck",
FailureThreshold = 2
}
});
service.RegisterIpInstance("IpInstance", new IpInstanceBaseProps {
Ipv4 = "54.239.25.192",
Port = 443
});
app.Synth();
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
import "github.com/aws/aws-cdk-go/awscdk"
import "github.com/aws/aws-cdk-go/awscdk"
app := cdk.NewApp()
stack := cdk.NewStack(app, jsii.String("aws-servicediscovery-integ"))
namespace := servicediscovery.NewPublicDnsNamespace(stack, jsii.String("Namespace"), &PublicDnsNamespaceProps{
Name: jsii.String("foobar.com"),
})
service := namespace.CreateService(jsii.String("Service"), &DnsServiceProps{
Name: jsii.String("foo"),
DnsRecordType: servicediscovery.DnsRecordType_A,
DnsTtl: cdk.Duration_Seconds(jsii.Number(30)),
HealthCheck: &HealthCheckConfig{
Type: servicediscovery.HealthCheckType_HTTPS,
ResourcePath: jsii.String("/healthcheck"),
FailureThreshold: jsii.Number(2),
},
})
service.RegisterIpInstance(jsii.String("IpInstance"), &IpInstanceBaseProps{
Ipv4: jsii.String("54.239.25.192"),
Port: jsii.Number(443),
})
app.Synth()
Initializer
new Service(scope: Construct, id: string, props: ServiceProps)
Service(scope: Construct, id: str, props: ServiceProps)
new Service(Construct scope, String id, ServiceProps props)
new Service(Construct scope, string id, ServiceProps props)
NewService(Scope Construct, Id *string, Props ServiceProps)
Construct Props
customHealthCheckHealthCheckCustomConfigcustom_health_checkHealthCheckCustomConfigcustomHealthCheckHealthCheckCustomConfigCustomHealthCheckHealthCheckCustomConfigCustomHealthCheckHealthCheckCustomConfig= none#Only one of healthCheckConfig or healthCheckCustomConfig can be specified. See: https://docs.aws.amazon.com/cloud-map/latest/api/API_HealthCheckCustomConfig.html
discoveryTypeDiscoveryTypediscovery_typeDiscoveryTypediscoveryTypeDiscoveryTypeDiscoveryTypeDiscoveryTypeDiscoveryTypeDiscoveryType= DNS_AND_API#dnsRecordTypeDnsRecordTypedns_record_typeDnsRecordTypednsRecordTypeDnsRecordTypeDnsRecordTypeDnsRecordTypeDnsRecordTypeDnsRecordType= A#Supported record types include A, AAAA, A and AAAA (A_AAAA), CNAME, and SRV.
healthCheckHealthCheckConfighealth_checkHealthCheckConfighealthCheckHealthCheckConfigHealthCheckHealthCheckConfigHealthCheckHealthCheckConfig= none#notes
If you specify health check settings, AWS Cloud Map associates the health check with the records that you specify in DnsConfig. Only one of healthCheckConfig or healthCheckCustomConfig can be specified. Not valid for PrivateDnsNamespaces. If you use healthCheck, you can only register IP instances to this service.
Setting this to true correctly configures the routingPolicy and performs some additional validation.
namespaceINamespacenamespaceINamespacenamespaceINamespaceNamespaceINamespaceNamespaceINamespacerequired#routingPolicyRoutingPolicyrouting_policyRoutingPolicyroutingPolicyRoutingPolicyRoutingPolicyRoutingPolicyRoutingPolicyRoutingPolicy= WEIGHTED for CNAME records and w…#default
Default: WEIGHTED for CNAME records and when loadBalancer is true, MULTIVALUE otherwise
Properties
discoveryTypeDiscoveryTypediscovery_typeDiscoveryTypediscoveryTypeDiscoveryTypeDiscoveryTypeDiscoveryTypeDiscoveryTypeDiscoveryTyperequired#dnsRecordTypeDnsRecordTypedns_record_typeDnsRecordTypednsRecordTypeDnsRecordTypeDnsRecordTypeDnsRecordTypeDnsRecordTypeDnsRecordTyperequired#envResourceEnvironmentenvResourceEnvironmentenvResourceEnvironmentEnvResourceEnvironmentEnvResourceEnvironmentrequired#notes
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.
namespaceINamespacenamespaceINamespacenamespaceINamespaceNamespaceINamespaceNamespaceINamespacerequired#PROPERTY_INJECTION_IDstringproperty_injection_idstrPROPERTY_INJECTION_IDStringPROPERTY_INJECTION_IDstringPROPERTY_INJECTION_ID*stringrequiredstatic#routingPolicyRoutingPolicyrouting_policyRoutingPolicyroutingPolicyRoutingPolicyRoutingPolicyRoutingPolicyRoutingPolicyRoutingPolicyrequired#serviceRefServiceReferenceservice_refServiceReferenceserviceRefServiceReferenceServiceRefServiceReferenceServiceRefServiceReferencerequired#Methods
applyCrossStackReferenceStrength(strength: ReferenceStrength): voiddef apply_cross_stack_reference_strength(self, strength: ReferenceStrength) -> Nonepublic void applyCrossStackReferenceStrength(ReferenceStrength strength)public void ApplyCrossStackReferenceStrength(ReferenceStrength strength)func ApplyCrossStackReferenceStrength(Strength ReferenceStrength)#notes · 1 parameter
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
strengthstrengthstrengthstrengthStrength— - The reference strength to use for this resource.
applyRemovalPolicy(policy: RemovalPolicy): voiddef apply_removal_policy(self, policy: RemovalPolicy) -> Nonepublic void applyRemovalPolicy(RemovalPolicy policy)public void ApplyRemovalPolicy(RemovalPolicy policy)func ApplyRemovalPolicy(Policy RemovalPolicy)#notes
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).
fromServiceAttributes(scope: Construct, id: string, attrs: ServiceAttributes): IService@staticmethod def from_service_attributes(scope: Construct, id: str, attrs: ServiceAttributes) -> IServicepublic static IService fromServiceAttributes(Construct scope, String id, ServiceAttributes attrs)public static IService FromServiceAttributes(Construct scope, string id, ServiceAttributes attrs)func FromServiceAttributes(Scope Construct, Id *string, Attrs ServiceAttributes) IServicestatic#isConstruct(x: any): boolean@staticmethod def is_construct(x: Any) -> boolpublic static Boolean isConstruct(Object x)public static bool IsConstruct(object x)func IsConstruct(X interface{}) *boolstatic#notes · 1 parameter · returns
Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.
Parameters
xxxxX— Any object.
Returns: true if x is an object created from a class which extends Construct.
isOwnedResource(construct: IConstruct): boolean@staticmethod def is_owned_resource(construct: IConstruct) -> boolpublic static Boolean isOwnedResource(IConstruct construct)public static bool IsOwnedResource(IConstruct construct)func IsOwnedResource(Construct IConstruct) *boolstatic#isResource(construct: IConstruct): boolean@staticmethod def is_resource(construct: IConstruct) -> boolpublic static Boolean isResource(IConstruct construct)public static bool IsResource(IConstruct construct)func IsResource(Construct IConstruct) *boolstatic#registerCnameInstance(id: string, props: CnameInstanceBaseProps): IInstancedef register_cname_instance(self, id: str, props: CnameInstanceBaseProps) -> IInstancepublic IInstance registerCnameInstance(String id, CnameInstanceBaseProps props)public IInstance RegisterCnameInstance(string id, CnameInstanceBaseProps props)func RegisterCnameInstance(Id *string, Props CnameInstanceBaseProps) IInstance#registerIpInstance(id: string, props: IpInstanceBaseProps): IInstancedef register_ip_instance(self, id: str, props: IpInstanceBaseProps) -> IInstancepublic IInstance registerIpInstance(String id, IpInstanceBaseProps props)public IInstance RegisterIpInstance(string id, IpInstanceBaseProps props)func RegisterIpInstance(Id *string, Props IpInstanceBaseProps) IInstance#registerLoadBalancer(id: string, loadBalancer: ILoadBalancerV2, customAttributes?: { [key: string]: string }): IInstancedef register_load_balancer(self, id: str, load_balancer: ILoadBalancerV2, custom_attributes: typing.Optional[typing.Mapping[str, str]] = None) -> IInstancepublic IInstance registerLoadBalancer(String id, ILoadBalancerV2 loadBalancer, Map<String, String> customAttributes)public IInstance RegisterLoadBalancer(string id, ILoadBalancerV2 loadBalancer, IDictionary<string, string>? customAttributes = null)func RegisterLoadBalancer(Id *string, LoadBalancer ILoadBalancerV2, CustomAttributes *map[string]*string) IInstance#registerNonIpInstance(id: string, props: NonIpInstanceBaseProps): IInstancedef register_non_ip_instance(self, id: str, props: NonIpInstanceBaseProps) -> IInstancepublic IInstance registerNonIpInstance(String id, NonIpInstanceBaseProps props)public IInstance RegisterNonIpInstance(string id, NonIpInstanceBaseProps props)func RegisterNonIpInstance(Id *string, Props NonIpInstanceBaseProps) IInstance#toString(): stringdef to_string(self, ) -> strpublic String toString()public string ToString()func ToString() *string#with(...mixins: IMixin[]): IConstructdef with(self, mixins: IMixin) -> IConstructpublic IConstruct with(IMixin mixins)public IConstruct With(IMixin mixins)func With(Mixins IMixin) IConstruct#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.