Skip to content

Latest commit

 

History

History
2671 lines (1649 loc) · 128 KB

serviceDiscoveryService.md

File metadata and controls

2671 lines (1649 loc) · 128 KB

aws_service_discovery_service

Refer to the Terraform Registory for docs: aws_service_discovery_service.

serviceDiscoveryService Submodule

Constructs

ServiceDiscoveryService

Represents a {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/service_discovery_service aws_service_discovery_service}.

Initializers 

import { serviceDiscoveryService } from '@cdktf/aws-cdk'

new serviceDiscoveryService.ServiceDiscoveryService(scope: Construct, id: string, config: ServiceDiscoveryServiceConfig)
Name Type Description
scope constructs.Construct The scope in which to define this construct.
id string The scoped construct ID.
config ServiceDiscoveryServiceConfig No description.
scopeRequired
  • Type: constructs.Construct

The scope in which to define this construct.

idRequired
  • Type: string

The scoped construct ID.

Must be unique amongst siblings in the same scope

configRequired

Methods

Name Description
toString Returns a string representation of this construct.
addOverride No description.
overrideLogicalId Overrides the auto-generated logical ID with a specific ID.
resetOverrideLogicalId Resets a previously passed logical Id to use the auto-generated logical id again.
toMetadata No description.
toTerraform Adds this resource to the terraform JSON output.
getAnyMapAttribute No description.
getBooleanAttribute No description.
getBooleanMapAttribute No description.
getListAttribute No description.
getNumberAttribute No description.
getNumberListAttribute No description.
getNumberMapAttribute No description.
getStringAttribute No description.
getStringMapAttribute No description.
interpolationForAttribute No description.
putDnsConfig No description.
putHealthCheckConfig No description.
putHealthCheckCustomConfig No description.
resetDescription No description.
resetDnsConfig No description.
resetForceDestroy No description.
resetHealthCheckConfig No description.
resetHealthCheckCustomConfig No description.
resetId No description.
resetNamespaceId No description.
resetTags No description.
resetTagsAll No description.
toString 
public toString(): string

Returns a string representation of this construct.

addOverride 
public addOverride(path: string, value: any): void
pathRequired
  • Type: string
valueRequired
  • Type: any
overrideLogicalId 
public overrideLogicalId(newLogicalId: string): void

Overrides the auto-generated logical ID with a specific ID.

newLogicalIdRequired
  • Type: string

The new logical ID to use for this stack element.

resetOverrideLogicalId 
public resetOverrideLogicalId(): void

Resets a previously passed logical Id to use the auto-generated logical id again.

toMetadata 
public toMetadata(): any
toTerraform 
public toTerraform(): any

Adds this resource to the terraform JSON output.

getAnyMapAttribute 
public getAnyMapAttribute(terraformAttribute: string): {[ key: string ]: any}
terraformAttributeRequired
  • Type: string
getBooleanAttribute 
public getBooleanAttribute(terraformAttribute: string): IResolvable
terraformAttributeRequired
  • Type: string
getBooleanMapAttribute 
public getBooleanMapAttribute(terraformAttribute: string): {[ key: string ]: boolean}
terraformAttributeRequired
  • Type: string
getListAttribute 
public getListAttribute(terraformAttribute: string): string[]
terraformAttributeRequired
  • Type: string
getNumberAttribute 
public getNumberAttribute(terraformAttribute: string): number
terraformAttributeRequired
  • Type: string
getNumberListAttribute 
public getNumberListAttribute(terraformAttribute: string): number[]
terraformAttributeRequired
  • Type: string
getNumberMapAttribute 
public getNumberMapAttribute(terraformAttribute: string): {[ key: string ]: number}
terraformAttributeRequired
  • Type: string
getStringAttribute 
public getStringAttribute(terraformAttribute: string): string
terraformAttributeRequired
  • Type: string
getStringMapAttribute 
public getStringMapAttribute(terraformAttribute: string): {[ key: string ]: string}
terraformAttributeRequired
  • Type: string
interpolationForAttribute 
public interpolationForAttribute(terraformAttribute: string): IResolvable
terraformAttributeRequired
  • Type: string
putDnsConfig 
public putDnsConfig(value: ServiceDiscoveryServiceDnsConfig): void
valueRequired
putHealthCheckConfig 
public putHealthCheckConfig(value: ServiceDiscoveryServiceHealthCheckConfig): void
valueRequired
putHealthCheckCustomConfig 
public putHealthCheckCustomConfig(value: ServiceDiscoveryServiceHealthCheckCustomConfig): void
valueRequired
resetDescription 
public resetDescription(): void
resetDnsConfig 
public resetDnsConfig(): void
resetForceDestroy 
public resetForceDestroy(): void
resetHealthCheckConfig 
public resetHealthCheckConfig(): void
resetHealthCheckCustomConfig 
public resetHealthCheckCustomConfig(): void
resetId 
public resetId(): void
resetNamespaceId 
public resetNamespaceId(): void
resetTags 
public resetTags(): void
resetTagsAll 
public resetTagsAll(): void

Static Functions

Name Description
isConstruct Checks if x is a construct.
isTerraformElement No description.
isTerraformResource No description.
isConstruct 
import { serviceDiscoveryService } from '@cdktf/aws-cdk'

serviceDiscoveryService.ServiceDiscoveryService.isConstruct(x: any)

Checks if x is a construct.

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.

xRequired
  • Type: any

Any object.

isTerraformElement 
import { serviceDiscoveryService } from '@cdktf/aws-cdk'

serviceDiscoveryService.ServiceDiscoveryService.isTerraformElement(x: any)
xRequired
  • Type: any
isTerraformResource 
import { serviceDiscoveryService } from '@cdktf/aws-cdk'

serviceDiscoveryService.ServiceDiscoveryService.isTerraformResource(x: any)
xRequired
  • Type: any

Properties

Name Type Description
node constructs.Node The tree node.
cdktfStack cdktf.TerraformStack No description.
fqn string No description.
friendlyUniqueId string No description.
terraformMetaArguments {[ key: string ]: any} No description.
terraformResourceType string No description.
terraformGeneratorMetadata cdktf.TerraformProviderGeneratorMetadata No description.
connection cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection No description.
count number | cdktf.TerraformCount No description.
dependsOn string[] No description.
forEach cdktf.ITerraformIterator No description.
lifecycle cdktf.TerraformResourceLifecycle No description.
provider cdktf.TerraformProvider No description.
provisioners cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[] No description.
arn string No description.
dnsConfig ServiceDiscoveryServiceDnsConfigOutputReference No description.
healthCheckConfig ServiceDiscoveryServiceHealthCheckConfigOutputReference No description.
healthCheckCustomConfig ServiceDiscoveryServiceHealthCheckCustomConfigOutputReference No description.
descriptionInput string No description.
dnsConfigInput ServiceDiscoveryServiceDnsConfig No description.
forceDestroyInput boolean | cdktf.IResolvable No description.
healthCheckConfigInput ServiceDiscoveryServiceHealthCheckConfig No description.
healthCheckCustomConfigInput ServiceDiscoveryServiceHealthCheckCustomConfig No description.
idInput string No description.
nameInput string No description.
namespaceIdInput string No description.
tagsAllInput {[ key: string ]: string} No description.
tagsInput {[ key: string ]: string} No description.
description string No description.
forceDestroy boolean | cdktf.IResolvable No description.
id string No description.
name string No description.
namespaceId string No description.
tags {[ key: string ]: string} No description.
tagsAll {[ key: string ]: string} No description.
nodeRequired 
public readonly node: Node;
  • Type: constructs.Node

The tree node.

cdktfStackRequired 
public readonly cdktfStack: TerraformStack;
  • Type: cdktf.TerraformStack
fqnRequired 
public readonly fqn: string;
  • Type: string
friendlyUniqueIdRequired 
public readonly friendlyUniqueId: string;
  • Type: string
terraformMetaArgumentsRequired 
public readonly terraformMetaArguments: {[ key: string ]: any};
  • Type: {[ key: string ]: any}
terraformResourceTypeRequired 
public readonly terraformResourceType: string;
  • Type: string
terraformGeneratorMetadataOptional 
public readonly terraformGeneratorMetadata: TerraformProviderGeneratorMetadata;
  • Type: cdktf.TerraformProviderGeneratorMetadata
connectionOptional 
public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnection;
  • Type: cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection
countOptional 
public readonly count: number | TerraformCount;
  • Type: number | cdktf.TerraformCount
dependsOnOptional 
public readonly dependsOn: string[];
  • Type: string[]
forEachOptional 
public readonly forEach: ITerraformIterator;
  • Type: cdktf.ITerraformIterator
lifecycleOptional 
public readonly lifecycle: TerraformResourceLifecycle;
  • Type: cdktf.TerraformResourceLifecycle
providerOptional 
public readonly provider: TerraformProvider;
  • Type: cdktf.TerraformProvider
provisionersOptional 
public readonly provisioners: FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner[];
  • Type: cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[]
arnRequired 
public readonly arn: string;
  • Type: string
dnsConfigRequired 
public readonly dnsConfig: ServiceDiscoveryServiceDnsConfigOutputReference;
healthCheckConfigRequired 
public readonly healthCheckConfig: ServiceDiscoveryServiceHealthCheckConfigOutputReference;
healthCheckCustomConfigRequired 
public readonly healthCheckCustomConfig: ServiceDiscoveryServiceHealthCheckCustomConfigOutputReference;
descriptionInputOptional 
public readonly descriptionInput: string;
  • Type: string
dnsConfigInputOptional 
public readonly dnsConfigInput: ServiceDiscoveryServiceDnsConfig;
forceDestroyInputOptional 
public readonly forceDestroyInput: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable
healthCheckConfigInputOptional 
public readonly healthCheckConfigInput: ServiceDiscoveryServiceHealthCheckConfig;
healthCheckCustomConfigInputOptional 
public readonly healthCheckCustomConfigInput: ServiceDiscoveryServiceHealthCheckCustomConfig;
idInputOptional 
public readonly idInput: string;
  • Type: string
nameInputOptional 
public readonly nameInput: string;
  • Type: string
namespaceIdInputOptional 
public readonly namespaceIdInput: string;
  • Type: string
tagsAllInputOptional 
public readonly tagsAllInput: {[ key: string ]: string};
  • Type: {[ key: string ]: string}
tagsInputOptional 
public readonly tagsInput: {[ key: string ]: string};
  • Type: {[ key: string ]: string}
descriptionRequired 
public readonly description: string;
  • Type: string
forceDestroyRequired 
public readonly forceDestroy: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable
idRequired 
public readonly id: string;
  • Type: string
nameRequired 
public readonly name: string;
  • Type: string
namespaceIdRequired 
public readonly namespaceId: string;
  • Type: string
tagsRequired 
public readonly tags: {[ key: string ]: string};
  • Type: {[ key: string ]: string}
tagsAllRequired 
public readonly tagsAll: {[ key: string ]: string};
  • Type: {[ key: string ]: string}

Constants

Name Type Description
tfResourceType string No description.
tfResourceTypeRequired 
public readonly tfResourceType: string;
  • Type: string

Structs

ServiceDiscoveryServiceConfig

Initializer 

import { serviceDiscoveryService } from '@cdktf/aws-cdk'

const serviceDiscoveryServiceConfig: serviceDiscoveryService.ServiceDiscoveryServiceConfig = { ... }

Properties

Name Type Description
connection cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection No description.
count number | cdktf.TerraformCount No description.
dependsOn cdktf.ITerraformDependable[] No description.
forEach cdktf.ITerraformIterator No description.
lifecycle cdktf.TerraformResourceLifecycle No description.
provider cdktf.TerraformProvider No description.
provisioners cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[] No description.
name string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/service_discovery_service#name ServiceDiscoveryService#name}.
description string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/service_discovery_service#description ServiceDiscoveryService#description}.
dnsConfig ServiceDiscoveryServiceDnsConfig dns_config block.
forceDestroy boolean | cdktf.IResolvable Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/service_discovery_service#force_destroy ServiceDiscoveryService#force_destroy}.
healthCheckConfig ServiceDiscoveryServiceHealthCheckConfig health_check_config block.
healthCheckCustomConfig ServiceDiscoveryServiceHealthCheckCustomConfig health_check_custom_config block.
id string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/service_discovery_service#id ServiceDiscoveryService#id}.
namespaceId string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/service_discovery_service#namespace_id ServiceDiscoveryService#namespace_id}.
tags {[ key: string ]: string} Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/service_discovery_service#tags ServiceDiscoveryService#tags}.
tagsAll {[ key: string ]: string} Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/service_discovery_service#tags_all ServiceDiscoveryService#tags_all}.
connectionOptional 
public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnection;
  • Type: cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection
countOptional 
public readonly count: number | TerraformCount;
  • Type: number | cdktf.TerraformCount
dependsOnOptional 
public readonly dependsOn: ITerraformDependable[];
  • Type: cdktf.ITerraformDependable[]
forEachOptional 
public readonly forEach: ITerraformIterator;
  • Type: cdktf.ITerraformIterator
lifecycleOptional 
public readonly lifecycle: TerraformResourceLifecycle;
  • Type: cdktf.TerraformResourceLifecycle
providerOptional 
public readonly provider: TerraformProvider;
  • Type: cdktf.TerraformProvider
provisionersOptional 
public readonly provisioners: FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner[];
  • Type: cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[]
nameRequired 
public readonly name: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/service_discovery_service#name ServiceDiscoveryService#name}.

descriptionOptional 
public readonly description: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/service_discovery_service#description ServiceDiscoveryService#description}.

dnsConfigOptional 
public readonly dnsConfig: ServiceDiscoveryServiceDnsConfig;

dns_config block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/service_discovery_service#dns_config ServiceDiscoveryService#dns_config}

forceDestroyOptional 
public readonly forceDestroy: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/service_discovery_service#force_destroy ServiceDiscoveryService#force_destroy}.

healthCheckConfigOptional 
public readonly healthCheckConfig: ServiceDiscoveryServiceHealthCheckConfig;

health_check_config block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/service_discovery_service#health_check_config ServiceDiscoveryService#health_check_config}

healthCheckCustomConfigOptional 
public readonly healthCheckCustomConfig: ServiceDiscoveryServiceHealthCheckCustomConfig;

health_check_custom_config block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/service_discovery_service#health_check_custom_config ServiceDiscoveryService#health_check_custom_config}

idOptional 
public readonly id: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/service_discovery_service#id ServiceDiscoveryService#id}.

Please be aware that the id field is automatically added to all resources in Terraform providers using a Terraform provider SDK version below 2. If you experience problems setting this value it might not be settable. Please take a look at the provider documentation to ensure it should be settable.

namespaceIdOptional 
public readonly namespaceId: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/service_discovery_service#namespace_id ServiceDiscoveryService#namespace_id}.

tagsOptional 
public readonly tags: {[ key: string ]: string};
  • Type: {[ key: string ]: string}

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/service_discovery_service#tags ServiceDiscoveryService#tags}.

tagsAllOptional 
public readonly tagsAll: {[ key: string ]: string};
  • Type: {[ key: string ]: string}

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/service_discovery_service#tags_all ServiceDiscoveryService#tags_all}.

ServiceDiscoveryServiceDnsConfig

Initializer 

import { serviceDiscoveryService } from '@cdktf/aws-cdk'

const serviceDiscoveryServiceDnsConfig: serviceDiscoveryService.ServiceDiscoveryServiceDnsConfig = { ... }

Properties

Name Type Description
dnsRecords cdktf.IResolvable | ServiceDiscoveryServiceDnsConfigDnsRecords[] dns_records block.
namespaceId string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/service_discovery_service#namespace_id ServiceDiscoveryService#namespace_id}.
routingPolicy string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/service_discovery_service#routing_policy ServiceDiscoveryService#routing_policy}.
dnsRecordsRequired 
public readonly dnsRecords: IResolvable | ServiceDiscoveryServiceDnsConfigDnsRecords[];

dns_records block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/service_discovery_service#dns_records ServiceDiscoveryService#dns_records}

namespaceIdRequired 
public readonly namespaceId: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/service_discovery_service#namespace_id ServiceDiscoveryService#namespace_id}.

routingPolicyOptional 
public readonly routingPolicy: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/service_discovery_service#routing_policy ServiceDiscoveryService#routing_policy}.

ServiceDiscoveryServiceDnsConfigDnsRecords

Initializer 

import { serviceDiscoveryService } from '@cdktf/aws-cdk'

const serviceDiscoveryServiceDnsConfigDnsRecords: serviceDiscoveryService.ServiceDiscoveryServiceDnsConfigDnsRecords = { ... }

Properties

Name Type Description
ttl number Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/service_discovery_service#ttl ServiceDiscoveryService#ttl}.
type string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/service_discovery_service#type ServiceDiscoveryService#type}.
ttlRequired 
public readonly ttl: number;
  • Type: number

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/service_discovery_service#ttl ServiceDiscoveryService#ttl}.

typeRequired 
public readonly type: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/service_discovery_service#type ServiceDiscoveryService#type}.

ServiceDiscoveryServiceHealthCheckConfig

Initializer 

import { serviceDiscoveryService } from '@cdktf/aws-cdk'

const serviceDiscoveryServiceHealthCheckConfig: serviceDiscoveryService.ServiceDiscoveryServiceHealthCheckConfig = { ... }

Properties

Name Type Description
failureThreshold number Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/service_discovery_service#failure_threshold ServiceDiscoveryService#failure_threshold}.
resourcePath string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/service_discovery_service#resource_path ServiceDiscoveryService#resource_path}.
type string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/service_discovery_service#type ServiceDiscoveryService#type}.
failureThresholdOptional 
public readonly failureThreshold: number;
  • Type: number

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/service_discovery_service#failure_threshold ServiceDiscoveryService#failure_threshold}.

resourcePathOptional 
public readonly resourcePath: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/service_discovery_service#resource_path ServiceDiscoveryService#resource_path}.

typeOptional 
public readonly type: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/service_discovery_service#type ServiceDiscoveryService#type}.

ServiceDiscoveryServiceHealthCheckCustomConfig

Initializer 

import { serviceDiscoveryService } from '@cdktf/aws-cdk'

const serviceDiscoveryServiceHealthCheckCustomConfig: serviceDiscoveryService.ServiceDiscoveryServiceHealthCheckCustomConfig = { ... }

Properties

Name Type Description
failureThreshold number Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/service_discovery_service#failure_threshold ServiceDiscoveryService#failure_threshold}.
failureThresholdOptional 
public readonly failureThreshold: number;
  • Type: number

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/service_discovery_service#failure_threshold ServiceDiscoveryService#failure_threshold}.

Classes

ServiceDiscoveryServiceDnsConfigDnsRecordsList

Initializers 

import { serviceDiscoveryService } from '@cdktf/aws-cdk'

new serviceDiscoveryService.ServiceDiscoveryServiceDnsConfigDnsRecordsList(terraformResource: IInterpolatingParent, terraformAttribute: string, wrapsSet: boolean)
Name Type Description
terraformResource cdktf.IInterpolatingParent The parent resource.
terraformAttribute string The attribute on the parent resource this class is referencing.
wrapsSet boolean whether the list is wrapping a set (will add tolist() to be able to access an item via an index).
terraformResourceRequired
  • Type: cdktf.IInterpolatingParent

The parent resource.

terraformAttributeRequired
  • Type: string

The attribute on the parent resource this class is referencing.

wrapsSetRequired
  • Type: boolean

whether the list is wrapping a set (will add tolist() to be able to access an item via an index).

Methods

Name Description
computeFqn No description.
resolve Produce the Token's value at resolution time.
toString Return a string representation of this resolvable object.
get No description.
computeFqn 
public computeFqn(): string
resolve 
public resolve(_context: IResolveContext): any

Produce the Token's value at resolution time.

_contextRequired
  • Type: cdktf.IResolveContext
toString 
public toString(): string

Return a string representation of this resolvable object.

Returns a reversible string representation.

get 
public get(index: number): ServiceDiscoveryServiceDnsConfigDnsRecordsOutputReference
indexRequired
  • Type: number

the index of the item to return.

Properties

Name Type Description
creationStack string[] The creation stack of this resolvable which will be appended to errors thrown during resolution.
fqn string No description.
internalValue cdktf.IResolvable | ServiceDiscoveryServiceDnsConfigDnsRecords[] No description.
creationStackRequired 
public readonly creationStack: string[];
  • Type: string[]

The creation stack of this resolvable which will be appended to errors thrown during resolution.

If this returns an empty array the stack will not be attached.

fqnRequired 
public readonly fqn: string;
  • Type: string
internalValueOptional 
public readonly internalValue: IResolvable | ServiceDiscoveryServiceDnsConfigDnsRecords[];

ServiceDiscoveryServiceDnsConfigDnsRecordsOutputReference

Initializers 

import { serviceDiscoveryService } from '@cdktf/aws-cdk'

new serviceDiscoveryService.ServiceDiscoveryServiceDnsConfigDnsRecordsOutputReference(terraformResource: IInterpolatingParent, terraformAttribute: string, complexObjectIndex: number, complexObjectIsFromSet: boolean)
Name Type Description
terraformResource cdktf.IInterpolatingParent The parent resource.
terraformAttribute string The attribute on the parent resource this class is referencing.
complexObjectIndex number the index of this item in the list.
complexObjectIsFromSet boolean whether the list is wrapping a set (will add tolist() to be able to access an item via an index).
terraformResourceRequired
  • Type: cdktf.IInterpolatingParent

The parent resource.

terraformAttributeRequired
  • Type: string

The attribute on the parent resource this class is referencing.

complexObjectIndexRequired
  • Type: number

the index of this item in the list.

complexObjectIsFromSetRequired
  • Type: boolean

whether the list is wrapping a set (will add tolist() to be able to access an item via an index).

Methods

Name Description
computeFqn No description.
getAnyMapAttribute No description.
getBooleanAttribute No description.
getBooleanMapAttribute No description.
getListAttribute No description.
getNumberAttribute No description.
getNumberListAttribute No description.
getNumberMapAttribute No description.
getStringAttribute No description.
getStringMapAttribute No description.
interpolationForAttribute No description.
resolve Produce the Token's value at resolution time.
toString Return a string representation of this resolvable object.
computeFqn 
public computeFqn(): string
getAnyMapAttribute 
public getAnyMapAttribute(terraformAttribute: string): {[ key: string ]: any}
terraformAttributeRequired
  • Type: string
getBooleanAttribute 
public getBooleanAttribute(terraformAttribute: string): IResolvable
terraformAttributeRequired
  • Type: string
getBooleanMapAttribute 
public getBooleanMapAttribute(terraformAttribute: string): {[ key: string ]: boolean}
terraformAttributeRequired
  • Type: string
getListAttribute 
public getListAttribute(terraformAttribute: string): string[]
terraformAttributeRequired
  • Type: string
getNumberAttribute 
public getNumberAttribute(terraformAttribute: string): number
terraformAttributeRequired
  • Type: string
getNumberListAttribute 
public getNumberListAttribute(terraformAttribute: string): number[]
terraformAttributeRequired
  • Type: string
getNumberMapAttribute 
public getNumberMapAttribute(terraformAttribute: string): {[ key: string ]: number}
terraformAttributeRequired
  • Type: string
getStringAttribute 
public getStringAttribute(terraformAttribute: string): string
terraformAttributeRequired
  • Type: string
getStringMapAttribute 
public getStringMapAttribute(terraformAttribute: string): {[ key: string ]: string}
terraformAttributeRequired
  • Type: string
interpolationForAttribute 
public interpolationForAttribute(property: string): IResolvable
propertyRequired
  • Type: string
resolve 
public resolve(_context: IResolveContext): any

Produce the Token's value at resolution time.

_contextRequired
  • Type: cdktf.IResolveContext
toString 
public toString(): string

Return a string representation of this resolvable object.

Returns a reversible string representation.

Properties

Name Type Description
creationStack string[] The creation stack of this resolvable which will be appended to errors thrown during resolution.
fqn string No description.
ttlInput number No description.
typeInput string No description.
ttl number No description.
type string No description.
internalValue cdktf.IResolvable | ServiceDiscoveryServiceDnsConfigDnsRecords No description.
creationStackRequired 
public readonly creationStack: string[];
  • Type: string[]

The creation stack of this resolvable which will be appended to errors thrown during resolution.

If this returns an empty array the stack will not be attached.

fqnRequired 
public readonly fqn: string;
  • Type: string
ttlInputOptional 
public readonly ttlInput: number;
  • Type: number
typeInputOptional 
public readonly typeInput: string;
  • Type: string
ttlRequired 
public readonly ttl: number;
  • Type: number
typeRequired 
public readonly type: string;
  • Type: string
internalValueOptional 
public readonly internalValue: IResolvable | ServiceDiscoveryServiceDnsConfigDnsRecords;

ServiceDiscoveryServiceDnsConfigOutputReference

Initializers 

import { serviceDiscoveryService } from '@cdktf/aws-cdk'

new serviceDiscoveryService.ServiceDiscoveryServiceDnsConfigOutputReference(terraformResource: IInterpolatingParent, terraformAttribute: string)
Name Type Description
terraformResource cdktf.IInterpolatingParent The parent resource.
terraformAttribute string The attribute on the parent resource this class is referencing.
terraformResourceRequired
  • Type: cdktf.IInterpolatingParent

The parent resource.

terraformAttributeRequired
  • Type: string

The attribute on the parent resource this class is referencing.

Methods

Name Description
computeFqn No description.
getAnyMapAttribute No description.
getBooleanAttribute No description.
getBooleanMapAttribute No description.
getListAttribute No description.
getNumberAttribute No description.
getNumberListAttribute No description.
getNumberMapAttribute No description.
getStringAttribute No description.
getStringMapAttribute No description.
interpolationForAttribute No description.
resolve Produce the Token's value at resolution time.
toString Return a string representation of this resolvable object.
putDnsRecords No description.
resetRoutingPolicy No description.
computeFqn 
public computeFqn(): string
getAnyMapAttribute 
public getAnyMapAttribute(terraformAttribute: string): {[ key: string ]: any}
terraformAttributeRequired
  • Type: string
getBooleanAttribute 
public getBooleanAttribute(terraformAttribute: string): IResolvable
terraformAttributeRequired
  • Type: string
getBooleanMapAttribute 
public getBooleanMapAttribute(terraformAttribute: string): {[ key: string ]: boolean}
terraformAttributeRequired
  • Type: string
getListAttribute 
public getListAttribute(terraformAttribute: string): string[]
terraformAttributeRequired
  • Type: string
getNumberAttribute 
public getNumberAttribute(terraformAttribute: string): number
terraformAttributeRequired
  • Type: string
getNumberListAttribute 
public getNumberListAttribute(terraformAttribute: string): number[]
terraformAttributeRequired
  • Type: string
getNumberMapAttribute 
public getNumberMapAttribute(terraformAttribute: string): {[ key: string ]: number}
terraformAttributeRequired
  • Type: string
getStringAttribute 
public getStringAttribute(terraformAttribute: string): string
terraformAttributeRequired
  • Type: string
getStringMapAttribute 
public getStringMapAttribute(terraformAttribute: string): {[ key: string ]: string}
terraformAttributeRequired
  • Type: string
interpolationForAttribute 
public interpolationForAttribute(property: string): IResolvable
propertyRequired
  • Type: string
resolve 
public resolve(_context: IResolveContext): any

Produce the Token's value at resolution time.

_contextRequired
  • Type: cdktf.IResolveContext
toString 
public toString(): string

Return a string representation of this resolvable object.

Returns a reversible string representation.

putDnsRecords 
public putDnsRecords(value: IResolvable | ServiceDiscoveryServiceDnsConfigDnsRecords[]): void
valueRequired
resetRoutingPolicy 
public resetRoutingPolicy(): void

Properties

Name Type Description
creationStack string[] The creation stack of this resolvable which will be appended to errors thrown during resolution.
fqn string No description.
dnsRecords ServiceDiscoveryServiceDnsConfigDnsRecordsList No description.
dnsRecordsInput cdktf.IResolvable | ServiceDiscoveryServiceDnsConfigDnsRecords[] No description.
namespaceIdInput string No description.
routingPolicyInput string No description.
namespaceId string No description.
routingPolicy string No description.
internalValue ServiceDiscoveryServiceDnsConfig No description.
creationStackRequired 
public readonly creationStack: string[];
  • Type: string[]

The creation stack of this resolvable which will be appended to errors thrown during resolution.

If this returns an empty array the stack will not be attached.

fqnRequired 
public readonly fqn: string;
  • Type: string
dnsRecordsRequired 
public readonly dnsRecords: ServiceDiscoveryServiceDnsConfigDnsRecordsList;
dnsRecordsInputOptional 
public readonly dnsRecordsInput: IResolvable | ServiceDiscoveryServiceDnsConfigDnsRecords[];
namespaceIdInputOptional 
public readonly namespaceIdInput: string;
  • Type: string
routingPolicyInputOptional 
public readonly routingPolicyInput: string;
  • Type: string
namespaceIdRequired 
public readonly namespaceId: string;
  • Type: string
routingPolicyRequired 
public readonly routingPolicy: string;
  • Type: string
internalValueOptional 
public readonly internalValue: ServiceDiscoveryServiceDnsConfig;

ServiceDiscoveryServiceHealthCheckConfigOutputReference

Initializers 

import { serviceDiscoveryService } from '@cdktf/aws-cdk'

new serviceDiscoveryService.ServiceDiscoveryServiceHealthCheckConfigOutputReference(terraformResource: IInterpolatingParent, terraformAttribute: string)
Name Type Description
terraformResource cdktf.IInterpolatingParent The parent resource.
terraformAttribute string The attribute on the parent resource this class is referencing.
terraformResourceRequired
  • Type: cdktf.IInterpolatingParent

The parent resource.

terraformAttributeRequired
  • Type: string

The attribute on the parent resource this class is referencing.

Methods

Name Description
computeFqn No description.
getAnyMapAttribute No description.
getBooleanAttribute No description.
getBooleanMapAttribute No description.
getListAttribute No description.
getNumberAttribute No description.
getNumberListAttribute No description.
getNumberMapAttribute No description.
getStringAttribute No description.
getStringMapAttribute No description.
interpolationForAttribute No description.
resolve Produce the Token's value at resolution time.
toString Return a string representation of this resolvable object.
resetFailureThreshold No description.
resetResourcePath No description.
resetType No description.
computeFqn 
public computeFqn(): string
getAnyMapAttribute 
public getAnyMapAttribute(terraformAttribute: string): {[ key: string ]: any}
terraformAttributeRequired
  • Type: string
getBooleanAttribute 
public getBooleanAttribute(terraformAttribute: string): IResolvable
terraformAttributeRequired
  • Type: string
getBooleanMapAttribute 
public getBooleanMapAttribute(terraformAttribute: string): {[ key: string ]: boolean}
terraformAttributeRequired
  • Type: string
getListAttribute 
public getListAttribute(terraformAttribute: string): string[]
terraformAttributeRequired
  • Type: string
getNumberAttribute 
public getNumberAttribute(terraformAttribute: string): number
terraformAttributeRequired
  • Type: string
getNumberListAttribute 
public getNumberListAttribute(terraformAttribute: string): number[]
terraformAttributeRequired
  • Type: string
getNumberMapAttribute 
public getNumberMapAttribute(terraformAttribute: string): {[ key: string ]: number}
terraformAttributeRequired
  • Type: string
getStringAttribute 
public getStringAttribute(terraformAttribute: string): string
terraformAttributeRequired
  • Type: string
getStringMapAttribute 
public getStringMapAttribute(terraformAttribute: string): {[ key: string ]: string}
terraformAttributeRequired
  • Type: string
interpolationForAttribute 
public interpolationForAttribute(property: string): IResolvable
propertyRequired
  • Type: string
resolve 
public resolve(_context: IResolveContext): any

Produce the Token's value at resolution time.

_contextRequired
  • Type: cdktf.IResolveContext
toString 
public toString(): string

Return a string representation of this resolvable object.

Returns a reversible string representation.

resetFailureThreshold 
public resetFailureThreshold(): void
resetResourcePath 
public resetResourcePath(): void
resetType 
public resetType(): void

Properties

Name Type Description
creationStack string[] The creation stack of this resolvable which will be appended to errors thrown during resolution.
fqn string No description.
failureThresholdInput number No description.
resourcePathInput string No description.
typeInput string No description.
failureThreshold number No description.
resourcePath string No description.
type string No description.
internalValue ServiceDiscoveryServiceHealthCheckConfig No description.
creationStackRequired 
public readonly creationStack: string[];
  • Type: string[]

The creation stack of this resolvable which will be appended to errors thrown during resolution.

If this returns an empty array the stack will not be attached.

fqnRequired 
public readonly fqn: string;
  • Type: string
failureThresholdInputOptional 
public readonly failureThresholdInput: number;
  • Type: number
resourcePathInputOptional 
public readonly resourcePathInput: string;
  • Type: string
typeInputOptional 
public readonly typeInput: string;
  • Type: string
failureThresholdRequired 
public readonly failureThreshold: number;
  • Type: number
resourcePathRequired 
public readonly resourcePath: string;
  • Type: string
typeRequired 
public readonly type: string;
  • Type: string
internalValueOptional 
public readonly internalValue: ServiceDiscoveryServiceHealthCheckConfig;

ServiceDiscoveryServiceHealthCheckCustomConfigOutputReference

Initializers 

import { serviceDiscoveryService } from '@cdktf/aws-cdk'

new serviceDiscoveryService.ServiceDiscoveryServiceHealthCheckCustomConfigOutputReference(terraformResource: IInterpolatingParent, terraformAttribute: string)
Name Type Description
terraformResource cdktf.IInterpolatingParent The parent resource.
terraformAttribute string The attribute on the parent resource this class is referencing.
terraformResourceRequired
  • Type: cdktf.IInterpolatingParent

The parent resource.

terraformAttributeRequired
  • Type: string

The attribute on the parent resource this class is referencing.

Methods

Name Description
computeFqn No description.
getAnyMapAttribute No description.
getBooleanAttribute No description.
getBooleanMapAttribute No description.
getListAttribute No description.
getNumberAttribute No description.
getNumberListAttribute No description.
getNumberMapAttribute No description.
getStringAttribute No description.
getStringMapAttribute No description.
interpolationForAttribute No description.
resolve Produce the Token's value at resolution time.
toString Return a string representation of this resolvable object.
resetFailureThreshold No description.
computeFqn 
public computeFqn(): string
getAnyMapAttribute 
public getAnyMapAttribute(terraformAttribute: string): {[ key: string ]: any}
terraformAttributeRequired
  • Type: string
getBooleanAttribute 
public getBooleanAttribute(terraformAttribute: string): IResolvable
terraformAttributeRequired
  • Type: string
getBooleanMapAttribute 
public getBooleanMapAttribute(terraformAttribute: string): {[ key: string ]: boolean}
terraformAttributeRequired
  • Type: string
getListAttribute 
public getListAttribute(terraformAttribute: string): string[]
terraformAttributeRequired
  • Type: string
getNumberAttribute 
public getNumberAttribute(terraformAttribute: string): number
terraformAttributeRequired
  • Type: string
getNumberListAttribute 
public getNumberListAttribute(terraformAttribute: string): number[]
terraformAttributeRequired
  • Type: string
getNumberMapAttribute 
public getNumberMapAttribute(terraformAttribute: string): {[ key: string ]: number}
terraformAttributeRequired
  • Type: string
getStringAttribute 
public getStringAttribute(terraformAttribute: string): string
terraformAttributeRequired
  • Type: string
getStringMapAttribute 
public getStringMapAttribute(terraformAttribute: string): {[ key: string ]: string}
terraformAttributeRequired
  • Type: string
interpolationForAttribute 
public interpolationForAttribute(property: string): IResolvable
propertyRequired
  • Type: string
resolve 
public resolve(_context: IResolveContext): any

Produce the Token's value at resolution time.

_contextRequired
  • Type: cdktf.IResolveContext
toString 
public toString(): string

Return a string representation of this resolvable object.

Returns a reversible string representation.

resetFailureThreshold 
public resetFailureThreshold(): void

Properties

Name Type Description
creationStack string[] The creation stack of this resolvable which will be appended to errors thrown during resolution.
fqn string No description.
failureThresholdInput number No description.
failureThreshold number No description.
internalValue ServiceDiscoveryServiceHealthCheckCustomConfig No description.
creationStackRequired 
public readonly creationStack: string[];
  • Type: string[]

The creation stack of this resolvable which will be appended to errors thrown during resolution.

If this returns an empty array the stack will not be attached.

fqnRequired 
public readonly fqn: string;
  • Type: string
failureThresholdInputOptional 
public readonly failureThresholdInput: number;
  • Type: number
failureThresholdRequired 
public readonly failureThreshold: number;
  • Type: number
internalValueOptional 
public readonly internalValue: ServiceDiscoveryServiceHealthCheckCustomConfig;