awsservicediscovery

package
v1.111.0-devpreview Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jul 2, 2021 License: Apache-2.0 Imports: 8 Imported by: 3

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func AliasTargetInstance_IsConstruct

func AliasTargetInstance_IsConstruct(x interface{}) *bool

Return whether the given object is a Construct. Experimental.

func AliasTargetInstance_IsResource

func AliasTargetInstance_IsResource(construct awscdk.IConstruct) *bool

Check whether the given construct is a Resource. Experimental.

func CfnHttpNamespace_CFN_RESOURCE_TYPE_NAME

func CfnHttpNamespace_CFN_RESOURCE_TYPE_NAME() *string

func CfnHttpNamespace_IsCfnElement

func CfnHttpNamespace_IsCfnElement(x interface{}) *bool

Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.

Returns: The construct as a stack element or undefined if it is not a stack element. Experimental.

func CfnHttpNamespace_IsCfnResource

func CfnHttpNamespace_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource. Experimental.

func CfnHttpNamespace_IsConstruct

func CfnHttpNamespace_IsConstruct(x interface{}) *bool

Return whether the given object is a Construct. Experimental.

func CfnInstance_CFN_RESOURCE_TYPE_NAME

func CfnInstance_CFN_RESOURCE_TYPE_NAME() *string

func CfnInstance_IsCfnElement

func CfnInstance_IsCfnElement(x interface{}) *bool

Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.

Returns: The construct as a stack element or undefined if it is not a stack element. Experimental.

func CfnInstance_IsCfnResource

func CfnInstance_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource. Experimental.

func CfnInstance_IsConstruct

func CfnInstance_IsConstruct(x interface{}) *bool

Return whether the given object is a Construct. Experimental.

func CfnPrivateDnsNamespace_CFN_RESOURCE_TYPE_NAME

func CfnPrivateDnsNamespace_CFN_RESOURCE_TYPE_NAME() *string

func CfnPrivateDnsNamespace_IsCfnElement

func CfnPrivateDnsNamespace_IsCfnElement(x interface{}) *bool

Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.

Returns: The construct as a stack element or undefined if it is not a stack element. Experimental.

func CfnPrivateDnsNamespace_IsCfnResource

func CfnPrivateDnsNamespace_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource. Experimental.

func CfnPrivateDnsNamespace_IsConstruct

func CfnPrivateDnsNamespace_IsConstruct(x interface{}) *bool

Return whether the given object is a Construct. Experimental.

func CfnPublicDnsNamespace_CFN_RESOURCE_TYPE_NAME

func CfnPublicDnsNamespace_CFN_RESOURCE_TYPE_NAME() *string

func CfnPublicDnsNamespace_IsCfnElement

func CfnPublicDnsNamespace_IsCfnElement(x interface{}) *bool

Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.

Returns: The construct as a stack element or undefined if it is not a stack element. Experimental.

func CfnPublicDnsNamespace_IsCfnResource

func CfnPublicDnsNamespace_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource. Experimental.

func CfnPublicDnsNamespace_IsConstruct

func CfnPublicDnsNamespace_IsConstruct(x interface{}) *bool

Return whether the given object is a Construct. Experimental.

func CfnService_CFN_RESOURCE_TYPE_NAME

func CfnService_CFN_RESOURCE_TYPE_NAME() *string

func CfnService_IsCfnElement

func CfnService_IsCfnElement(x interface{}) *bool

Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.

Returns: The construct as a stack element or undefined if it is not a stack element. Experimental.

func CfnService_IsCfnResource

func CfnService_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource. Experimental.

func CfnService_IsConstruct

func CfnService_IsConstruct(x interface{}) *bool

Return whether the given object is a Construct. Experimental.

func CnameInstance_IsConstruct

func CnameInstance_IsConstruct(x interface{}) *bool

Return whether the given object is a Construct. Experimental.

func CnameInstance_IsResource

func CnameInstance_IsResource(construct awscdk.IConstruct) *bool

Check whether the given construct is a Resource. Experimental.

func HttpNamespace_IsConstruct

func HttpNamespace_IsConstruct(x interface{}) *bool

Return whether the given object is a Construct. Experimental.

func HttpNamespace_IsResource

func HttpNamespace_IsResource(construct awscdk.IConstruct) *bool

Check whether the given construct is a Resource. Experimental.

func InstanceBase_IsConstruct

func InstanceBase_IsConstruct(x interface{}) *bool

Return whether the given object is a Construct. Experimental.

func InstanceBase_IsResource

func InstanceBase_IsResource(construct awscdk.IConstruct) *bool

Check whether the given construct is a Resource. Experimental.

func IpInstance_IsConstruct

func IpInstance_IsConstruct(x interface{}) *bool

Return whether the given object is a Construct. Experimental.

func IpInstance_IsResource

func IpInstance_IsResource(construct awscdk.IConstruct) *bool

Check whether the given construct is a Resource. Experimental.

func NewAliasTargetInstance_Override

func NewAliasTargetInstance_Override(a AliasTargetInstance, scope constructs.Construct, id *string, props *AliasTargetInstanceProps)

Experimental.

func NewCfnHttpNamespace_Override

func NewCfnHttpNamespace_Override(c CfnHttpNamespace, scope awscdk.Construct, id *string, props *CfnHttpNamespaceProps)

Create a new `AWS::ServiceDiscovery::HttpNamespace`.

func NewCfnInstance_Override

func NewCfnInstance_Override(c CfnInstance, scope awscdk.Construct, id *string, props *CfnInstanceProps)

Create a new `AWS::ServiceDiscovery::Instance`.

func NewCfnPrivateDnsNamespace_Override

func NewCfnPrivateDnsNamespace_Override(c CfnPrivateDnsNamespace, scope awscdk.Construct, id *string, props *CfnPrivateDnsNamespaceProps)

Create a new `AWS::ServiceDiscovery::PrivateDnsNamespace`.

func NewCfnPublicDnsNamespace_Override

func NewCfnPublicDnsNamespace_Override(c CfnPublicDnsNamespace, scope awscdk.Construct, id *string, props *CfnPublicDnsNamespaceProps)

Create a new `AWS::ServiceDiscovery::PublicDnsNamespace`.

func NewCfnService_Override

func NewCfnService_Override(c CfnService, scope awscdk.Construct, id *string, props *CfnServiceProps)

Create a new `AWS::ServiceDiscovery::Service`.

func NewCnameInstance_Override

func NewCnameInstance_Override(c CnameInstance, scope constructs.Construct, id *string, props *CnameInstanceProps)

Experimental.

func NewHttpNamespace_Override

func NewHttpNamespace_Override(h HttpNamespace, scope constructs.Construct, id *string, props *HttpNamespaceProps)

Experimental.

func NewInstanceBase_Override

func NewInstanceBase_Override(i InstanceBase, scope constructs.Construct, id *string, props *awscdk.ResourceProps)

Experimental.

func NewIpInstance_Override

func NewIpInstance_Override(i IpInstance, scope constructs.Construct, id *string, props *IpInstanceProps)

Experimental.

func NewNonIpInstance_Override

func NewNonIpInstance_Override(n NonIpInstance, scope constructs.Construct, id *string, props *NonIpInstanceProps)

Experimental.

func NewPrivateDnsNamespace_Override

func NewPrivateDnsNamespace_Override(p PrivateDnsNamespace, scope constructs.Construct, id *string, props *PrivateDnsNamespaceProps)

Experimental.

func NewPublicDnsNamespace_Override

func NewPublicDnsNamespace_Override(p PublicDnsNamespace, scope constructs.Construct, id *string, props *PublicDnsNamespaceProps)

Experimental.

func NewService_Override

func NewService_Override(s Service, scope constructs.Construct, id *string, props *ServiceProps)

Experimental.

func NonIpInstance_IsConstruct

func NonIpInstance_IsConstruct(x interface{}) *bool

Return whether the given object is a Construct. Experimental.

func NonIpInstance_IsResource

func NonIpInstance_IsResource(construct awscdk.IConstruct) *bool

Check whether the given construct is a Resource. Experimental.

func PrivateDnsNamespace_IsConstruct

func PrivateDnsNamespace_IsConstruct(x interface{}) *bool

Return whether the given object is a Construct. Experimental.

func PrivateDnsNamespace_IsResource

func PrivateDnsNamespace_IsResource(construct awscdk.IConstruct) *bool

Check whether the given construct is a Resource. Experimental.

func PublicDnsNamespace_IsConstruct

func PublicDnsNamespace_IsConstruct(x interface{}) *bool

Return whether the given object is a Construct. Experimental.

func PublicDnsNamespace_IsResource

func PublicDnsNamespace_IsResource(construct awscdk.IConstruct) *bool

Check whether the given construct is a Resource. Experimental.

func Service_IsConstruct

func Service_IsConstruct(x interface{}) *bool

Return whether the given object is a Construct. Experimental.

func Service_IsResource

func Service_IsResource(construct awscdk.IConstruct) *bool

Check whether the given construct is a Resource. Experimental.

Types

type AliasTargetInstance

type AliasTargetInstance interface {
	InstanceBase
	DnsName() *string
	Env() *awscdk.ResourceEnvironment
	InstanceId() *string
	Node() awscdk.ConstructNode
	PhysicalName() *string
	Service() IService
	Stack() awscdk.Stack
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy)
	GeneratePhysicalName() *string
	GetResourceArnAttribute(arnAttr *string, arnComponents *awscdk.ArnComponents) *string
	GetResourceNameAttribute(nameAttr *string) *string
	OnPrepare()
	OnSynthesize(session constructs.ISynthesisSession)
	OnValidate() *[]*string
	Prepare()
	Synthesize(session awscdk.ISynthesisSession)
	ToString() *string
	UniqueInstanceId() *string
	Validate() *[]*string
}

Instance that uses Route 53 Alias record type.

Currently, the only resource types supported are Elastic Load Balancers. Experimental.

func NewAliasTargetInstance

func NewAliasTargetInstance(scope constructs.Construct, id *string, props *AliasTargetInstanceProps) AliasTargetInstance

Experimental.

type AliasTargetInstanceProps

type AliasTargetInstanceProps struct {
	// Custom attributes of the instance.
	// Experimental.
	CustomAttributes *map[string]*string `json:"customAttributes"`
	// The id of the instance resource.
	// Experimental.
	InstanceId *string `json:"instanceId"`
	// DNS name of the target.
	// Experimental.
	DnsName *string `json:"dnsName"`
	// The Cloudmap service this resource is registered to.
	// Experimental.
	Service IService `json:"service"`
}

Experimental.

type BaseInstanceProps

type BaseInstanceProps struct {
	// Custom attributes of the instance.
	// Experimental.
	CustomAttributes *map[string]*string `json:"customAttributes"`
	// The id of the instance resource.
	// Experimental.
	InstanceId *string `json:"instanceId"`
}

Used when the resource that's associated with the service instance is accessible using values other than an IP address or a domain name (CNAME), i.e. for non-ip-instances. Experimental.

type BaseNamespaceProps

type BaseNamespaceProps struct {
	// A name for the Namespace.
	// Experimental.
	Name *string `json:"name"`
	// A description of the Namespace.
	// Experimental.
	Description *string `json:"description"`
}

Experimental.

type BaseServiceProps

type BaseServiceProps struct {
	// Structure containing failure threshold for a custom health checker.
	//
	// Only one of healthCheckConfig or healthCheckCustomConfig can be specified.
	// See: https://docs.aws.amazon.com/cloud-map/latest/api/API_HealthCheckCustomConfig.html
	// Experimental.
	CustomHealthCheck *HealthCheckCustomConfig `json:"customHealthCheck"`
	// A description of the service.
	// Experimental.
	Description *string `json:"description"`
	// Settings for an optional health check.
	//
	// 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.
	// Experimental.
	HealthCheck *HealthCheckConfig `json:"healthCheck"`
	// A name for the Service.
	// Experimental.
	Name *string `json:"name"`
}

Basic props needed to create a service in a given namespace.

Used by HttpNamespace.createService Experimental.

type CfnHttpNamespace

type CfnHttpNamespace interface {
	awscdk.CfnResource
	awscdk.IInspectable
	AttrArn() *string
	AttrId() *string
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	CfnResourceType() *string
	CreationStack() *[]*string
	Description() *string
	SetDescription(val *string)
	LogicalId() *string
	Name() *string
	SetName(val *string)
	Node() awscdk.ConstructNode
	Ref() *string
	Stack() awscdk.Stack
	Tags() awscdk.TagManager
	UpdatedProperites() *map[string]interface{}
	AddDeletionOverride(path *string)
	AddDependsOn(target awscdk.CfnResource)
	AddMetadata(key *string, value interface{})
	AddOverride(path *string, value interface{})
	AddPropertyDeletionOverride(propertyPath *string)
	AddPropertyOverride(propertyPath *string, value interface{})
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
	GetAtt(attributeName *string) awscdk.Reference
	GetMetadata(key *string) interface{}
	Inspect(inspector awscdk.TreeInspector)
	OnPrepare()
	OnSynthesize(session constructs.ISynthesisSession)
	OnValidate() *[]*string
	OverrideLogicalId(newLogicalId *string)
	Prepare()
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	ShouldSynthesize() *bool
	Synthesize(session awscdk.ISynthesisSession)
	ToString() *string
	Validate() *[]*string
	ValidateProperties(_properties interface{})
}

A CloudFormation `AWS::ServiceDiscovery::HttpNamespace`.

func NewCfnHttpNamespace

func NewCfnHttpNamespace(scope awscdk.Construct, id *string, props *CfnHttpNamespaceProps) CfnHttpNamespace

Create a new `AWS::ServiceDiscovery::HttpNamespace`.

type CfnHttpNamespaceProps

type CfnHttpNamespaceProps struct {
	// `AWS::ServiceDiscovery::HttpNamespace.Name`.
	Name *string `json:"name"`
	// `AWS::ServiceDiscovery::HttpNamespace.Description`.
	Description *string `json:"description"`
	// `AWS::ServiceDiscovery::HttpNamespace.Tags`.
	Tags *[]*awscdk.CfnTag `json:"tags"`
}

Properties for defining a `AWS::ServiceDiscovery::HttpNamespace`.

type CfnInstance

type CfnInstance interface {
	awscdk.CfnResource
	awscdk.IInspectable
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	CfnResourceType() *string
	CreationStack() *[]*string
	InstanceAttributes() interface{}
	SetInstanceAttributes(val interface{})
	InstanceId() *string
	SetInstanceId(val *string)
	LogicalId() *string
	Node() awscdk.ConstructNode
	Ref() *string
	ServiceId() *string
	SetServiceId(val *string)
	Stack() awscdk.Stack
	UpdatedProperites() *map[string]interface{}
	AddDeletionOverride(path *string)
	AddDependsOn(target awscdk.CfnResource)
	AddMetadata(key *string, value interface{})
	AddOverride(path *string, value interface{})
	AddPropertyDeletionOverride(propertyPath *string)
	AddPropertyOverride(propertyPath *string, value interface{})
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
	GetAtt(attributeName *string) awscdk.Reference
	GetMetadata(key *string) interface{}
	Inspect(inspector awscdk.TreeInspector)
	OnPrepare()
	OnSynthesize(session constructs.ISynthesisSession)
	OnValidate() *[]*string
	OverrideLogicalId(newLogicalId *string)
	Prepare()
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	ShouldSynthesize() *bool
	Synthesize(session awscdk.ISynthesisSession)
	ToString() *string
	Validate() *[]*string
	ValidateProperties(_properties interface{})
}

A CloudFormation `AWS::ServiceDiscovery::Instance`.

func NewCfnInstance

func NewCfnInstance(scope awscdk.Construct, id *string, props *CfnInstanceProps) CfnInstance

Create a new `AWS::ServiceDiscovery::Instance`.

type CfnInstanceProps

type CfnInstanceProps struct {
	// `AWS::ServiceDiscovery::Instance.InstanceAttributes`.
	InstanceAttributes interface{} `json:"instanceAttributes"`
	// `AWS::ServiceDiscovery::Instance.ServiceId`.
	ServiceId *string `json:"serviceId"`
	// `AWS::ServiceDiscovery::Instance.InstanceId`.
	InstanceId *string `json:"instanceId"`
}

Properties for defining a `AWS::ServiceDiscovery::Instance`.

type CfnPrivateDnsNamespace

type CfnPrivateDnsNamespace interface {
	awscdk.CfnResource
	awscdk.IInspectable
	AttrArn() *string
	AttrId() *string
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	CfnResourceType() *string
	CreationStack() *[]*string
	Description() *string
	SetDescription(val *string)
	LogicalId() *string
	Name() *string
	SetName(val *string)
	Node() awscdk.ConstructNode
	Ref() *string
	Stack() awscdk.Stack
	Tags() awscdk.TagManager
	UpdatedProperites() *map[string]interface{}
	Vpc() *string
	SetVpc(val *string)
	AddDeletionOverride(path *string)
	AddDependsOn(target awscdk.CfnResource)
	AddMetadata(key *string, value interface{})
	AddOverride(path *string, value interface{})
	AddPropertyDeletionOverride(propertyPath *string)
	AddPropertyOverride(propertyPath *string, value interface{})
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
	GetAtt(attributeName *string) awscdk.Reference
	GetMetadata(key *string) interface{}
	Inspect(inspector awscdk.TreeInspector)
	OnPrepare()
	OnSynthesize(session constructs.ISynthesisSession)
	OnValidate() *[]*string
	OverrideLogicalId(newLogicalId *string)
	Prepare()
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	ShouldSynthesize() *bool
	Synthesize(session awscdk.ISynthesisSession)
	ToString() *string
	Validate() *[]*string
	ValidateProperties(_properties interface{})
}

A CloudFormation `AWS::ServiceDiscovery::PrivateDnsNamespace`.

func NewCfnPrivateDnsNamespace

func NewCfnPrivateDnsNamespace(scope awscdk.Construct, id *string, props *CfnPrivateDnsNamespaceProps) CfnPrivateDnsNamespace

Create a new `AWS::ServiceDiscovery::PrivateDnsNamespace`.

type CfnPrivateDnsNamespaceProps

type CfnPrivateDnsNamespaceProps struct {
	// `AWS::ServiceDiscovery::PrivateDnsNamespace.Name`.
	Name *string `json:"name"`
	// `AWS::ServiceDiscovery::PrivateDnsNamespace.Vpc`.
	Vpc *string `json:"vpc"`
	// `AWS::ServiceDiscovery::PrivateDnsNamespace.Description`.
	Description *string `json:"description"`
	// `AWS::ServiceDiscovery::PrivateDnsNamespace.Tags`.
	Tags *[]*awscdk.CfnTag `json:"tags"`
}

Properties for defining a `AWS::ServiceDiscovery::PrivateDnsNamespace`.

type CfnPublicDnsNamespace

type CfnPublicDnsNamespace interface {
	awscdk.CfnResource
	awscdk.IInspectable
	AttrArn() *string
	AttrId() *string
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	CfnResourceType() *string
	CreationStack() *[]*string
	Description() *string
	SetDescription(val *string)
	LogicalId() *string
	Name() *string
	SetName(val *string)
	Node() awscdk.ConstructNode
	Ref() *string
	Stack() awscdk.Stack
	Tags() awscdk.TagManager
	UpdatedProperites() *map[string]interface{}
	AddDeletionOverride(path *string)
	AddDependsOn(target awscdk.CfnResource)
	AddMetadata(key *string, value interface{})
	AddOverride(path *string, value interface{})
	AddPropertyDeletionOverride(propertyPath *string)
	AddPropertyOverride(propertyPath *string, value interface{})
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
	GetAtt(attributeName *string) awscdk.Reference
	GetMetadata(key *string) interface{}
	Inspect(inspector awscdk.TreeInspector)
	OnPrepare()
	OnSynthesize(session constructs.ISynthesisSession)
	OnValidate() *[]*string
	OverrideLogicalId(newLogicalId *string)
	Prepare()
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	ShouldSynthesize() *bool
	Synthesize(session awscdk.ISynthesisSession)
	ToString() *string
	Validate() *[]*string
	ValidateProperties(_properties interface{})
}

A CloudFormation `AWS::ServiceDiscovery::PublicDnsNamespace`.

func NewCfnPublicDnsNamespace

func NewCfnPublicDnsNamespace(scope awscdk.Construct, id *string, props *CfnPublicDnsNamespaceProps) CfnPublicDnsNamespace

Create a new `AWS::ServiceDiscovery::PublicDnsNamespace`.

type CfnPublicDnsNamespaceProps

type CfnPublicDnsNamespaceProps struct {
	// `AWS::ServiceDiscovery::PublicDnsNamespace.Name`.
	Name *string `json:"name"`
	// `AWS::ServiceDiscovery::PublicDnsNamespace.Description`.
	Description *string `json:"description"`
	// `AWS::ServiceDiscovery::PublicDnsNamespace.Tags`.
	Tags *[]*awscdk.CfnTag `json:"tags"`
}

Properties for defining a `AWS::ServiceDiscovery::PublicDnsNamespace`.

type CfnService

type CfnService interface {
	awscdk.CfnResource
	awscdk.IInspectable
	AttrArn() *string
	AttrId() *string
	AttrName() *string
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	CfnResourceType() *string
	CreationStack() *[]*string
	Description() *string
	SetDescription(val *string)
	DnsConfig() interface{}
	SetDnsConfig(val interface{})
	HealthCheckConfig() interface{}
	SetHealthCheckConfig(val interface{})
	HealthCheckCustomConfig() interface{}
	SetHealthCheckCustomConfig(val interface{})
	LogicalId() *string
	Name() *string
	SetName(val *string)
	NamespaceId() *string
	SetNamespaceId(val *string)
	Node() awscdk.ConstructNode
	Ref() *string
	Stack() awscdk.Stack
	Tags() awscdk.TagManager
	Type() *string
	SetType(val *string)
	UpdatedProperites() *map[string]interface{}
	AddDeletionOverride(path *string)
	AddDependsOn(target awscdk.CfnResource)
	AddMetadata(key *string, value interface{})
	AddOverride(path *string, value interface{})
	AddPropertyDeletionOverride(propertyPath *string)
	AddPropertyOverride(propertyPath *string, value interface{})
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
	GetAtt(attributeName *string) awscdk.Reference
	GetMetadata(key *string) interface{}
	Inspect(inspector awscdk.TreeInspector)
	OnPrepare()
	OnSynthesize(session constructs.ISynthesisSession)
	OnValidate() *[]*string
	OverrideLogicalId(newLogicalId *string)
	Prepare()
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	ShouldSynthesize() *bool
	Synthesize(session awscdk.ISynthesisSession)
	ToString() *string
	Validate() *[]*string
	ValidateProperties(_properties interface{})
}

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

func NewCfnService

func NewCfnService(scope awscdk.Construct, id *string, props *CfnServiceProps) CfnService

Create a new `AWS::ServiceDiscovery::Service`.

type CfnServiceProps

type CfnServiceProps struct {
	// `AWS::ServiceDiscovery::Service.Description`.
	Description *string `json:"description"`
	// `AWS::ServiceDiscovery::Service.DnsConfig`.
	DnsConfig interface{} `json:"dnsConfig"`
	// `AWS::ServiceDiscovery::Service.HealthCheckConfig`.
	HealthCheckConfig interface{} `json:"healthCheckConfig"`
	// `AWS::ServiceDiscovery::Service.HealthCheckCustomConfig`.
	HealthCheckCustomConfig interface{} `json:"healthCheckCustomConfig"`
	// `AWS::ServiceDiscovery::Service.Name`.
	Name *string `json:"name"`
	// `AWS::ServiceDiscovery::Service.NamespaceId`.
	NamespaceId *string `json:"namespaceId"`
	// `AWS::ServiceDiscovery::Service.Tags`.
	Tags *[]*awscdk.CfnTag `json:"tags"`
	// `AWS::ServiceDiscovery::Service.Type`.
	Type *string `json:"type"`
}

Properties for defining a `AWS::ServiceDiscovery::Service`.

type CfnService_DnsConfigProperty

type CfnService_DnsConfigProperty struct {
	// `CfnService.DnsConfigProperty.DnsRecords`.
	DnsRecords interface{} `json:"dnsRecords"`
	// `CfnService.DnsConfigProperty.NamespaceId`.
	NamespaceId *string `json:"namespaceId"`
	// `CfnService.DnsConfigProperty.RoutingPolicy`.
	RoutingPolicy *string `json:"routingPolicy"`
}

type CfnService_DnsRecordProperty

type CfnService_DnsRecordProperty struct {
	// `CfnService.DnsRecordProperty.TTL`.
	Ttl *float64 `json:"ttl"`
	// `CfnService.DnsRecordProperty.Type`.
	Type *string `json:"type"`
}

type CfnService_HealthCheckConfigProperty

type CfnService_HealthCheckConfigProperty struct {
	// `CfnService.HealthCheckConfigProperty.Type`.
	Type *string `json:"type"`
	// `CfnService.HealthCheckConfigProperty.FailureThreshold`.
	FailureThreshold *float64 `json:"failureThreshold"`
	// `CfnService.HealthCheckConfigProperty.ResourcePath`.
	ResourcePath *string `json:"resourcePath"`
}

type CfnService_HealthCheckCustomConfigProperty

type CfnService_HealthCheckCustomConfigProperty struct {
	// `CfnService.HealthCheckCustomConfigProperty.FailureThreshold`.
	FailureThreshold *float64 `json:"failureThreshold"`
}

type CnameInstance

type CnameInstance interface {
	InstanceBase
	Cname() *string
	Env() *awscdk.ResourceEnvironment
	InstanceId() *string
	Node() awscdk.ConstructNode
	PhysicalName() *string
	Service() IService
	Stack() awscdk.Stack
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy)
	GeneratePhysicalName() *string
	GetResourceArnAttribute(arnAttr *string, arnComponents *awscdk.ArnComponents) *string
	GetResourceNameAttribute(nameAttr *string) *string
	OnPrepare()
	OnSynthesize(session constructs.ISynthesisSession)
	OnValidate() *[]*string
	Prepare()
	Synthesize(session awscdk.ISynthesisSession)
	ToString() *string
	UniqueInstanceId() *string
	Validate() *[]*string
}

Instance that is accessible using a domain name (CNAME). Experimental.

func NewCnameInstance

func NewCnameInstance(scope constructs.Construct, id *string, props *CnameInstanceProps) CnameInstance

Experimental.

type CnameInstanceBaseProps

type CnameInstanceBaseProps struct {
	// Custom attributes of the instance.
	// Experimental.
	CustomAttributes *map[string]*string `json:"customAttributes"`
	// The id of the instance resource.
	// Experimental.
	InstanceId *string `json:"instanceId"`
	// If the service configuration includes a CNAME record, the domain name that you want Route 53 to return in response to DNS queries, for example, example.com. This value is required if the service specified by ServiceId includes settings for an CNAME record.
	// Experimental.
	InstanceCname *string `json:"instanceCname"`
}

Experimental.

type CnameInstanceProps

type CnameInstanceProps struct {
	// Custom attributes of the instance.
	// Experimental.
	CustomAttributes *map[string]*string `json:"customAttributes"`
	// The id of the instance resource.
	// Experimental.
	InstanceId *string `json:"instanceId"`
	// If the service configuration includes a CNAME record, the domain name that you want Route 53 to return in response to DNS queries, for example, example.com. This value is required if the service specified by ServiceId includes settings for an CNAME record.
	// Experimental.
	InstanceCname *string `json:"instanceCname"`
	// The Cloudmap service this resource is registered to.
	// Experimental.
	Service IService `json:"service"`
}

Experimental.

type DnsRecordType

type DnsRecordType string

Experimental.

const (
	DnsRecordType_A      DnsRecordType = "A"
	DnsRecordType_AAAA   DnsRecordType = "AAAA"
	DnsRecordType_A_AAAA DnsRecordType = "A_AAAA"
	DnsRecordType_SRV    DnsRecordType = "SRV"
	DnsRecordType_CNAME  DnsRecordType = "CNAME"
)

type DnsServiceProps

type DnsServiceProps struct {
	// Structure containing failure threshold for a custom health checker.
	//
	// Only one of healthCheckConfig or healthCheckCustomConfig can be specified.
	// See: https://docs.aws.amazon.com/cloud-map/latest/api/API_HealthCheckCustomConfig.html
	// Experimental.
	CustomHealthCheck *HealthCheckCustomConfig `json:"customHealthCheck"`
	// A description of the service.
	// Experimental.
	Description *string `json:"description"`
	// Settings for an optional health check.
	//
	// 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.
	// Experimental.
	HealthCheck *HealthCheckConfig `json:"healthCheck"`
	// A name for the Service.
	// Experimental.
	Name *string `json:"name"`
	// The DNS type of the record that you want AWS Cloud Map to create.
	//
	// Supported record types
	// include A, AAAA, A and AAAA (A_AAAA), CNAME, and SRV.
	// Experimental.
	DnsRecordType DnsRecordType `json:"dnsRecordType"`
	// The amount of time, in seconds, that you want DNS resolvers to cache the settings for this record.
	// Experimental.
	DnsTtl awscdk.Duration `json:"dnsTtl"`
	// Whether or not this service will have an Elastic LoadBalancer registered to it as an AliasTargetInstance.
	//
	// Setting this to `true` correctly configures the `routingPolicy`
	// and performs some additional validation.
	// Experimental.
	LoadBalancer *bool `json:"loadBalancer"`
	// The routing policy that you want to apply to all DNS records that AWS Cloud Map creates when you register an instance and specify this service.
	// Experimental.
	RoutingPolicy RoutingPolicy `json:"routingPolicy"`
}

Service props needed to create a service in a given namespace.

Used by createService() for PrivateDnsNamespace and PublicDnsNamespace Experimental.

type HealthCheckConfig

type HealthCheckConfig struct {
	// The number of consecutive health checks that an endpoint must pass or fail for Route 53 to change the current status of the endpoint from unhealthy to healthy or vice versa.
	// Experimental.
	FailureThreshold *float64 `json:"failureThreshold"`
	// The path that you want Route 53 to request when performing health checks.
	//
	// Do not use when health check type is TCP.
	// Experimental.
	ResourcePath *string `json:"resourcePath"`
	// The type of health check that you want to create, which indicates how Route 53 determines whether an endpoint is healthy.
	//
	// Cannot be modified once created. Supported values are HTTP, HTTPS, and TCP.
	// Experimental.
	Type HealthCheckType `json:"type"`
}

Settings for an optional Amazon Route 53 health check.

If you specify settings for a health check, AWS Cloud Map associates the health check with all the records that you specify in DnsConfig. Only valid with a PublicDnsNamespace. Experimental.

type HealthCheckCustomConfig

type HealthCheckCustomConfig struct {
	// 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.
	// Experimental.
	FailureThreshold *float64 `json:"failureThreshold"`
}

Specifies information about an optional custom health check. Experimental.

type HealthCheckType

type HealthCheckType string

Experimental.

const (
	HealthCheckType_HTTP  HealthCheckType = "HTTP"
	HealthCheckType_HTTPS HealthCheckType = "HTTPS"
	HealthCheckType_TCP   HealthCheckType = "TCP"
)

type HttpNamespace

type HttpNamespace interface {
	awscdk.Resource
	IHttpNamespace
	Env() *awscdk.ResourceEnvironment
	HttpNamespaceArn() *string
	HttpNamespaceId() *string
	HttpNamespaceName() *string
	NamespaceArn() *string
	NamespaceId() *string
	NamespaceName() *string
	Node() awscdk.ConstructNode
	PhysicalName() *string
	Stack() awscdk.Stack
	Type() NamespaceType
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy)
	CreateService(id *string, props *BaseServiceProps) Service
	GeneratePhysicalName() *string
	GetResourceArnAttribute(arnAttr *string, arnComponents *awscdk.ArnComponents) *string
	GetResourceNameAttribute(nameAttr *string) *string
	OnPrepare()
	OnSynthesize(session constructs.ISynthesisSession)
	OnValidate() *[]*string
	Prepare()
	Synthesize(session awscdk.ISynthesisSession)
	ToString() *string
	Validate() *[]*string
}

Define an HTTP Namespace. Experimental.

func NewHttpNamespace

func NewHttpNamespace(scope constructs.Construct, id *string, props *HttpNamespaceProps) HttpNamespace

Experimental.

type HttpNamespaceAttributes

type HttpNamespaceAttributes struct {
	// Namespace ARN for the Namespace.
	// Experimental.
	NamespaceArn *string `json:"namespaceArn"`
	// Namespace Id for the Namespace.
	// Experimental.
	NamespaceId *string `json:"namespaceId"`
	// A name for the Namespace.
	// Experimental.
	NamespaceName *string `json:"namespaceName"`
}

Experimental.

type HttpNamespaceProps

type HttpNamespaceProps struct {
	// A name for the Namespace.
	// Experimental.
	Name *string `json:"name"`
	// A description of the Namespace.
	// Experimental.
	Description *string `json:"description"`
}

Experimental.

type IHttpNamespace

type IHttpNamespace interface {
	INamespace
}

Experimental.

func HttpNamespace_FromHttpNamespaceAttributes

func HttpNamespace_FromHttpNamespaceAttributes(scope constructs.Construct, id *string, attrs *HttpNamespaceAttributes) IHttpNamespace

Experimental.

type IInstance

type IInstance interface {
	awscdk.IResource
	// The id of the instance resource.
	// Experimental.
	InstanceId() *string
	// The Cloudmap service this resource is registered to.
	// Experimental.
	Service() IService
}

Experimental.

type INamespace

type INamespace interface {
	awscdk.IResource
	// Namespace ARN for the Namespace.
	// Experimental.
	NamespaceArn() *string
	// Namespace Id for the Namespace.
	// Experimental.
	NamespaceId() *string
	// A name for the Namespace.
	// Experimental.
	NamespaceName() *string
	// Type of Namespace.
	// Experimental.
	Type() NamespaceType
}

Experimental.

type IPrivateDnsNamespace

type IPrivateDnsNamespace interface {
	INamespace
}

Experimental.

func PrivateDnsNamespace_FromPrivateDnsNamespaceAttributes

func PrivateDnsNamespace_FromPrivateDnsNamespaceAttributes(scope constructs.Construct, id *string, attrs *PrivateDnsNamespaceAttributes) IPrivateDnsNamespace

Experimental.

type IPublicDnsNamespace

type IPublicDnsNamespace interface {
	INamespace
}

Experimental.

func PublicDnsNamespace_FromPublicDnsNamespaceAttributes

func PublicDnsNamespace_FromPublicDnsNamespaceAttributes(scope constructs.Construct, id *string, attrs *PublicDnsNamespaceAttributes) IPublicDnsNamespace

Experimental.

type IService

type IService interface {
	awscdk.IResource
	// The DnsRecordType used by the service.
	// Experimental.
	DnsRecordType() DnsRecordType
	// The namespace for the Cloudmap Service.
	// Experimental.
	Namespace() INamespace
	// The Routing Policy used by the service.
	// Experimental.
	RoutingPolicy() RoutingPolicy
	// The Arn of the namespace that you want to use for DNS configuration.
	// Experimental.
	ServiceArn() *string
	// The ID of the namespace that you want to use for DNS configuration.
	// Experimental.
	ServiceId() *string
	// A name for the Cloudmap Service.
	// Experimental.
	ServiceName() *string
}

Experimental.

func Service_FromServiceAttributes

func Service_FromServiceAttributes(scope constructs.Construct, id *string, attrs *ServiceAttributes) IService

Experimental.

type InstanceBase

type InstanceBase interface {
	awscdk.Resource
	IInstance
	Env() *awscdk.ResourceEnvironment
	InstanceId() *string
	Node() awscdk.ConstructNode
	PhysicalName() *string
	Service() IService
	Stack() awscdk.Stack
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy)
	GeneratePhysicalName() *string
	GetResourceArnAttribute(arnAttr *string, arnComponents *awscdk.ArnComponents) *string
	GetResourceNameAttribute(nameAttr *string) *string
	OnPrepare()
	OnSynthesize(session constructs.ISynthesisSession)
	OnValidate() *[]*string
	Prepare()
	Synthesize(session awscdk.ISynthesisSession)
	ToString() *string
	UniqueInstanceId() *string
	Validate() *[]*string
}

Experimental.

type IpInstance

type IpInstance interface {
	InstanceBase
	Env() *awscdk.ResourceEnvironment
	InstanceId() *string
	Ipv4() *string
	Ipv6() *string
	Node() awscdk.ConstructNode
	PhysicalName() *string
	Port() *float64
	Service() IService
	Stack() awscdk.Stack
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy)
	GeneratePhysicalName() *string
	GetResourceArnAttribute(arnAttr *string, arnComponents *awscdk.ArnComponents) *string
	GetResourceNameAttribute(nameAttr *string) *string
	OnPrepare()
	OnSynthesize(session constructs.ISynthesisSession)
	OnValidate() *[]*string
	Prepare()
	Synthesize(session awscdk.ISynthesisSession)
	ToString() *string
	UniqueInstanceId() *string
	Validate() *[]*string
}

Instance that is accessible using an IP address. Experimental.

func NewIpInstance

func NewIpInstance(scope constructs.Construct, id *string, props *IpInstanceProps) IpInstance

Experimental.

type IpInstanceBaseProps

type IpInstanceBaseProps struct {
	// Custom attributes of the instance.
	// Experimental.
	CustomAttributes *map[string]*string `json:"customAttributes"`
	// The id of the instance resource.
	// Experimental.
	InstanceId *string `json:"instanceId"`
	// If the service that you specify contains a template for an A record, the IPv4 address that you want AWS Cloud Map to use for the value of the A record.
	// Experimental.
	Ipv4 *string `json:"ipv4"`
	// If the service that you specify contains a template for an AAAA record, the IPv6 address that you want AWS Cloud Map to use for the value of the AAAA record.
	// Experimental.
	Ipv6 *string `json:"ipv6"`
	// The port on the endpoint that you want AWS Cloud Map to perform health checks on.
	//
	// This value is also used for
	// the port value in an SRV record if the service that you specify includes an SRV record. You can also specify a
	// default port that is applied to all instances in the Service configuration.
	// Experimental.
	Port *float64 `json:"port"`
}

Experimental.

type IpInstanceProps

type IpInstanceProps struct {
	// Custom attributes of the instance.
	// Experimental.
	CustomAttributes *map[string]*string `json:"customAttributes"`
	// The id of the instance resource.
	// Experimental.
	InstanceId *string `json:"instanceId"`
	// If the service that you specify contains a template for an A record, the IPv4 address that you want AWS Cloud Map to use for the value of the A record.
	// Experimental.
	Ipv4 *string `json:"ipv4"`
	// If the service that you specify contains a template for an AAAA record, the IPv6 address that you want AWS Cloud Map to use for the value of the AAAA record.
	// Experimental.
	Ipv6 *string `json:"ipv6"`
	// The port on the endpoint that you want AWS Cloud Map to perform health checks on.
	//
	// This value is also used for
	// the port value in an SRV record if the service that you specify includes an SRV record. You can also specify a
	// default port that is applied to all instances in the Service configuration.
	// Experimental.
	Port *float64 `json:"port"`
	// The Cloudmap service this resource is registered to.
	// Experimental.
	Service IService `json:"service"`
}

Experimental.

type NamespaceType

type NamespaceType string

Experimental.

const (
	NamespaceType_HTTP        NamespaceType = "HTTP"
	NamespaceType_DNS_PRIVATE NamespaceType = "DNS_PRIVATE"
	NamespaceType_DNS_PUBLIC  NamespaceType = "DNS_PUBLIC"
)

type NonIpInstance

type NonIpInstance interface {
	InstanceBase
	Env() *awscdk.ResourceEnvironment
	InstanceId() *string
	Node() awscdk.ConstructNode
	PhysicalName() *string
	Service() IService
	Stack() awscdk.Stack
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy)
	GeneratePhysicalName() *string
	GetResourceArnAttribute(arnAttr *string, arnComponents *awscdk.ArnComponents) *string
	GetResourceNameAttribute(nameAttr *string) *string
	OnPrepare()
	OnSynthesize(session constructs.ISynthesisSession)
	OnValidate() *[]*string
	Prepare()
	Synthesize(session awscdk.ISynthesisSession)
	ToString() *string
	UniqueInstanceId() *string
	Validate() *[]*string
}

Instance accessible using values other than an IP address or a domain name (CNAME).

Specify the other values in Custom attributes. Experimental.

func NewNonIpInstance

func NewNonIpInstance(scope constructs.Construct, id *string, props *NonIpInstanceProps) NonIpInstance

Experimental.

type NonIpInstanceBaseProps

type NonIpInstanceBaseProps struct {
	// Custom attributes of the instance.
	// Experimental.
	CustomAttributes *map[string]*string `json:"customAttributes"`
	// The id of the instance resource.
	// Experimental.
	InstanceId *string `json:"instanceId"`
}

Experimental.

type NonIpInstanceProps

type NonIpInstanceProps struct {
	// Custom attributes of the instance.
	// Experimental.
	CustomAttributes *map[string]*string `json:"customAttributes"`
	// The id of the instance resource.
	// Experimental.
	InstanceId *string `json:"instanceId"`
	// The Cloudmap service this resource is registered to.
	// Experimental.
	Service IService `json:"service"`
}

Experimental.

type PrivateDnsNamespace

type PrivateDnsNamespace interface {
	awscdk.Resource
	IPrivateDnsNamespace
	Env() *awscdk.ResourceEnvironment
	NamespaceArn() *string
	NamespaceId() *string
	NamespaceName() *string
	Node() awscdk.ConstructNode
	PhysicalName() *string
	PrivateDnsNamespaceArn() *string
	PrivateDnsNamespaceId() *string
	PrivateDnsNamespaceName() *string
	Stack() awscdk.Stack
	Type() NamespaceType
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy)
	CreateService(id *string, props *DnsServiceProps) Service
	GeneratePhysicalName() *string
	GetResourceArnAttribute(arnAttr *string, arnComponents *awscdk.ArnComponents) *string
	GetResourceNameAttribute(nameAttr *string) *string
	OnPrepare()
	OnSynthesize(session constructs.ISynthesisSession)
	OnValidate() *[]*string
	Prepare()
	Synthesize(session awscdk.ISynthesisSession)
	ToString() *string
	Validate() *[]*string
}

Define a Service Discovery HTTP Namespace. Experimental.

func NewPrivateDnsNamespace

func NewPrivateDnsNamespace(scope constructs.Construct, id *string, props *PrivateDnsNamespaceProps) PrivateDnsNamespace

Experimental.

type PrivateDnsNamespaceAttributes

type PrivateDnsNamespaceAttributes struct {
	// Namespace ARN for the Namespace.
	// Experimental.
	NamespaceArn *string `json:"namespaceArn"`
	// Namespace Id for the Namespace.
	// Experimental.
	NamespaceId *string `json:"namespaceId"`
	// A name for the Namespace.
	// Experimental.
	NamespaceName *string `json:"namespaceName"`
}

Experimental.

type PrivateDnsNamespaceProps

type PrivateDnsNamespaceProps struct {
	// A name for the Namespace.
	// Experimental.
	Name *string `json:"name"`
	// A description of the Namespace.
	// Experimental.
	Description *string `json:"description"`
	// The Amazon VPC that you want to associate the namespace with.
	// Experimental.
	Vpc awsec2.IVpc `json:"vpc"`
}

Experimental.

type PublicDnsNamespace

type PublicDnsNamespace interface {
	awscdk.Resource
	IPublicDnsNamespace
	Env() *awscdk.ResourceEnvironment
	NamespaceArn() *string
	NamespaceId() *string
	NamespaceName() *string
	Node() awscdk.ConstructNode
	PhysicalName() *string
	PublicDnsNamespaceArn() *string
	PublicDnsNamespaceId() *string
	PublicDnsNamespaceName() *string
	Stack() awscdk.Stack
	Type() NamespaceType
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy)
	CreateService(id *string, props *DnsServiceProps) Service
	GeneratePhysicalName() *string
	GetResourceArnAttribute(arnAttr *string, arnComponents *awscdk.ArnComponents) *string
	GetResourceNameAttribute(nameAttr *string) *string
	OnPrepare()
	OnSynthesize(session constructs.ISynthesisSession)
	OnValidate() *[]*string
	Prepare()
	Synthesize(session awscdk.ISynthesisSession)
	ToString() *string
	Validate() *[]*string
}

Define a Public DNS Namespace. Experimental.

func NewPublicDnsNamespace

func NewPublicDnsNamespace(scope constructs.Construct, id *string, props *PublicDnsNamespaceProps) PublicDnsNamespace

Experimental.

type PublicDnsNamespaceAttributes

type PublicDnsNamespaceAttributes struct {
	// Namespace ARN for the Namespace.
	// Experimental.
	NamespaceArn *string `json:"namespaceArn"`
	// Namespace Id for the Namespace.
	// Experimental.
	NamespaceId *string `json:"namespaceId"`
	// A name for the Namespace.
	// Experimental.
	NamespaceName *string `json:"namespaceName"`
}

Experimental.

type PublicDnsNamespaceProps

type PublicDnsNamespaceProps struct {
	// A name for the Namespace.
	// Experimental.
	Name *string `json:"name"`
	// A description of the Namespace.
	// Experimental.
	Description *string `json:"description"`
}

Experimental.

type RoutingPolicy

type RoutingPolicy string

Experimental.

const (
	RoutingPolicy_WEIGHTED   RoutingPolicy = "WEIGHTED"
	RoutingPolicy_MULTIVALUE RoutingPolicy = "MULTIVALUE"
)

type Service

type Service interface {
	awscdk.Resource
	IService
	DnsRecordType() DnsRecordType
	Env() *awscdk.ResourceEnvironment
	Namespace() INamespace
	Node() awscdk.ConstructNode
	PhysicalName() *string
	RoutingPolicy() RoutingPolicy
	ServiceArn() *string
	ServiceId() *string
	ServiceName() *string
	Stack() awscdk.Stack
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy)
	GeneratePhysicalName() *string
	GetResourceArnAttribute(arnAttr *string, arnComponents *awscdk.ArnComponents) *string
	GetResourceNameAttribute(nameAttr *string) *string
	OnPrepare()
	OnSynthesize(session constructs.ISynthesisSession)
	OnValidate() *[]*string
	Prepare()
	RegisterCnameInstance(id *string, props *CnameInstanceBaseProps) IInstance
	RegisterIpInstance(id *string, props *IpInstanceBaseProps) IInstance
	RegisterLoadBalancer(id *string, loadBalancer awselasticloadbalancingv2.ILoadBalancerV2, customAttributes *map[string]*string) IInstance
	RegisterNonIpInstance(id *string, props *NonIpInstanceBaseProps) IInstance
	Synthesize(session awscdk.ISynthesisSession)
	ToString() *string
	Validate() *[]*string
}

Define a CloudMap Service. Experimental.

func NewService

func NewService(scope constructs.Construct, id *string, props *ServiceProps) Service

Experimental.

type ServiceAttributes

type ServiceAttributes struct {
	// Experimental.
	DnsRecordType DnsRecordType `json:"dnsRecordType"`
	// Experimental.
	Namespace INamespace `json:"namespace"`
	// Experimental.
	RoutingPolicy RoutingPolicy `json:"routingPolicy"`
	// Experimental.
	ServiceArn *string `json:"serviceArn"`
	// Experimental.
	ServiceId *string `json:"serviceId"`
	// Experimental.
	ServiceName *string `json:"serviceName"`
}

Experimental.

type ServiceProps

type ServiceProps struct {
	// Structure containing failure threshold for a custom health checker.
	//
	// Only one of healthCheckConfig or healthCheckCustomConfig can be specified.
	// See: https://docs.aws.amazon.com/cloud-map/latest/api/API_HealthCheckCustomConfig.html
	// Experimental.
	CustomHealthCheck *HealthCheckCustomConfig `json:"customHealthCheck"`
	// A description of the service.
	// Experimental.
	Description *string `json:"description"`
	// Settings for an optional health check.
	//
	// 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.
	// Experimental.
	HealthCheck *HealthCheckConfig `json:"healthCheck"`
	// A name for the Service.
	// Experimental.
	Name *string `json:"name"`
	// The DNS type of the record that you want AWS Cloud Map to create.
	//
	// Supported record types
	// include A, AAAA, A and AAAA (A_AAAA), CNAME, and SRV.
	// Experimental.
	DnsRecordType DnsRecordType `json:"dnsRecordType"`
	// The amount of time, in seconds, that you want DNS resolvers to cache the settings for this record.
	// Experimental.
	DnsTtl awscdk.Duration `json:"dnsTtl"`
	// Whether or not this service will have an Elastic LoadBalancer registered to it as an AliasTargetInstance.
	//
	// Setting this to `true` correctly configures the `routingPolicy`
	// and performs some additional validation.
	// Experimental.
	LoadBalancer *bool `json:"loadBalancer"`
	// The routing policy that you want to apply to all DNS records that AWS Cloud Map creates when you register an instance and specify this service.
	// Experimental.
	RoutingPolicy RoutingPolicy `json:"routingPolicy"`
	// The namespace that you want to use for DNS configuration.
	// Experimental.
	Namespace INamespace `json:"namespace"`
}

Experimental.

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL