Skip to content

Latest commit

 

History

History
1506 lines (925 loc) · 66.9 KB

dataAwsVpcEndpointService.md

File metadata and controls

1506 lines (925 loc) · 66.9 KB

dataAwsVpcEndpointService Submodule

Constructs

DataAwsVpcEndpointService

Represents a {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/data-sources/vpc_endpoint_service aws_vpc_endpoint_service}.

Initializers

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

new dataAwsVpcEndpointService.DataAwsVpcEndpointService(scope: Construct, id: string, config?: DataAwsVpcEndpointServiceConfig)
Name Type Description
scope constructs.Construct The scope in which to define this construct.
id string The scoped construct ID.
config DataAwsVpcEndpointServiceConfig 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


configOptional

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.
toHclTerraform Adds this resource to the terraform JSON output.
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.
putFilter No description.
resetFilter No description.
resetId No description.
resetService No description.
resetServiceName No description.
resetServiceType No description.
resetTags 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.

toHclTerraform
public toHclTerraform(): any

Adds this resource to the terraform JSON output.

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

putFilter
public putFilter(value: IResolvable | DataAwsVpcEndpointServiceFilter[]): void
valueRequired

resetFilter
public resetFilter(): void
resetId
public resetId(): void
resetService
public resetService(): void
resetServiceName
public resetServiceName(): void
resetServiceType
public resetServiceType(): void
resetTags
public resetTags(): void

Static Functions

Name Description
isConstruct Checks if x is a construct.
isTerraformElement No description.
isTerraformDataSource No description.
generateConfigForImport Generates CDKTF code for importing a DataAwsVpcEndpointService resource upon running "cdktf plan ".

isConstruct
import { dataAwsVpcEndpointService } from '@cdktf/aws-cdk'

dataAwsVpcEndpointService.DataAwsVpcEndpointService.isConstruct(x: any)

Checks if x is a construct.

xRequired
  • Type: any

Any object.


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

dataAwsVpcEndpointService.DataAwsVpcEndpointService.isTerraformElement(x: any)
xRequired
  • Type: any

isTerraformDataSource
import { dataAwsVpcEndpointService } from '@cdktf/aws-cdk'

dataAwsVpcEndpointService.DataAwsVpcEndpointService.isTerraformDataSource(x: any)
xRequired
  • Type: any

generateConfigForImport
import { dataAwsVpcEndpointService } from '@cdktf/aws-cdk'

dataAwsVpcEndpointService.DataAwsVpcEndpointService.generateConfigForImport(scope: Construct, importToId: string, importFromId: string, provider?: TerraformProvider)

Generates CDKTF code for importing a DataAwsVpcEndpointService resource upon running "cdktf plan ".

scopeRequired
  • Type: constructs.Construct

The scope in which to define this construct.


importToIdRequired
  • Type: string

The construct id used in the generated config for the DataAwsVpcEndpointService to import.


importFromIdRequired
  • Type: string

The id of the existing DataAwsVpcEndpointService that should be imported.

Refer to the {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/data-sources/vpc_endpoint_service#import import section} in the documentation of this resource for the id to use


providerOptional
  • Type: cdktf.TerraformProvider

? Optional instance of the provider where the DataAwsVpcEndpointService to import is found.


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.
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.
acceptanceRequired cdktf.IResolvable No description.
arn string No description.
availabilityZones string[] No description.
baseEndpointDnsNames string[] No description.
filter DataAwsVpcEndpointServiceFilterList No description.
managesVpcEndpoints cdktf.IResolvable No description.
owner string No description.
privateDnsName string No description.
serviceId string No description.
vpcEndpointPolicySupported cdktf.IResolvable No description.
filterInput cdktf.IResolvable | DataAwsVpcEndpointServiceFilter[] No description.
idInput string No description.
serviceInput string No description.
serviceNameInput string No description.
serviceTypeInput string No description.
tagsInput {[ key: string ]: string} No description.
id string No description.
service string No description.
serviceName string No description.
serviceType string No description.
tags {[ 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

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

acceptanceRequiredRequired
public readonly acceptanceRequired: IResolvable;
  • Type: cdktf.IResolvable

arnRequired
public readonly arn: string;
  • Type: string

availabilityZonesRequired
public readonly availabilityZones: string[];
  • Type: string[]

baseEndpointDnsNamesRequired
public readonly baseEndpointDnsNames: string[];
  • Type: string[]

filterRequired
public readonly filter: DataAwsVpcEndpointServiceFilterList;

managesVpcEndpointsRequired
public readonly managesVpcEndpoints: IResolvable;
  • Type: cdktf.IResolvable

ownerRequired
public readonly owner: string;
  • Type: string

privateDnsNameRequired
public readonly privateDnsName: string;
  • Type: string

serviceIdRequired
public readonly serviceId: string;
  • Type: string

vpcEndpointPolicySupportedRequired
public readonly vpcEndpointPolicySupported: IResolvable;
  • Type: cdktf.IResolvable

filterInputOptional
public readonly filterInput: IResolvable | DataAwsVpcEndpointServiceFilter[];

idInputOptional
public readonly idInput: string;
  • Type: string

serviceInputOptional
public readonly serviceInput: string;
  • Type: string

serviceNameInputOptional
public readonly serviceNameInput: string;
  • Type: string

serviceTypeInputOptional
public readonly serviceTypeInput: string;
  • Type: string

tagsInputOptional
public readonly tagsInput: {[ key: string ]: string};
  • Type: {[ key: string ]: string}

idRequired
public readonly id: string;
  • Type: string

serviceRequired
public readonly service: string;
  • Type: string

serviceNameRequired
public readonly serviceName: string;
  • Type: string

serviceTypeRequired
public readonly serviceType: string;
  • Type: string

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

Constants

Name Type Description
tfResourceType string No description.

tfResourceTypeRequired
public readonly tfResourceType: string;
  • Type: string

Structs

DataAwsVpcEndpointServiceConfig

Initializer

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

const dataAwsVpcEndpointServiceConfig: dataAwsVpcEndpointService.DataAwsVpcEndpointServiceConfig = { ... }

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.
filter cdktf.IResolvable | DataAwsVpcEndpointServiceFilter[] filter block.
id string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/data-sources/vpc_endpoint_service#id DataAwsVpcEndpointService#id}.
service string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/data-sources/vpc_endpoint_service#service DataAwsVpcEndpointService#service}.
serviceName string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/data-sources/vpc_endpoint_service#service_name DataAwsVpcEndpointService#service_name}.
serviceType string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/data-sources/vpc_endpoint_service#service_type DataAwsVpcEndpointService#service_type}.
tags {[ key: string ]: string} Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/data-sources/vpc_endpoint_service#tags DataAwsVpcEndpointService#tags}.

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[]

filterOptional
public readonly filter: IResolvable | DataAwsVpcEndpointServiceFilter[];

filter block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/data-sources/vpc_endpoint_service#filter DataAwsVpcEndpointService#filter}


idOptional
public readonly id: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/data-sources/vpc_endpoint_service#id DataAwsVpcEndpointService#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.


serviceOptional
public readonly service: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/data-sources/vpc_endpoint_service#service DataAwsVpcEndpointService#service}.


serviceNameOptional
public readonly serviceName: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/data-sources/vpc_endpoint_service#service_name DataAwsVpcEndpointService#service_name}.


serviceTypeOptional
public readonly serviceType: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/data-sources/vpc_endpoint_service#service_type DataAwsVpcEndpointService#service_type}.


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/data-sources/vpc_endpoint_service#tags DataAwsVpcEndpointService#tags}.


DataAwsVpcEndpointServiceFilter

Initializer

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

const dataAwsVpcEndpointServiceFilter: dataAwsVpcEndpointService.DataAwsVpcEndpointServiceFilter = { ... }

Properties

Name Type Description
name string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/data-sources/vpc_endpoint_service#name DataAwsVpcEndpointService#name}.
values string[] Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/data-sources/vpc_endpoint_service#values DataAwsVpcEndpointService#values}.

nameRequired
public readonly name: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/data-sources/vpc_endpoint_service#name DataAwsVpcEndpointService#name}.


valuesRequired
public readonly values: string[];
  • Type: string[]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/data-sources/vpc_endpoint_service#values DataAwsVpcEndpointService#values}.


Classes

DataAwsVpcEndpointServiceFilterList

Initializers

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

new dataAwsVpcEndpointService.DataAwsVpcEndpointServiceFilterList(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
allWithMapKey Creating an iterator for this complex list.
computeFqn No description.
resolve Produce the Token's value at resolution time.
toString Return a string representation of this resolvable object.
get No description.

allWithMapKey
public allWithMapKey(mapKeyAttributeName: string): DynamicListTerraformIterator

Creating an iterator for this complex list.

The list will be converted into a map with the mapKeyAttributeName as the key.

mapKeyAttributeNameRequired
  • Type: string

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): DataAwsVpcEndpointServiceFilterOutputReference
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 | DataAwsVpcEndpointServiceFilter[] 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 | DataAwsVpcEndpointServiceFilter[];

DataAwsVpcEndpointServiceFilterOutputReference

Initializers

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

new dataAwsVpcEndpointService.DataAwsVpcEndpointServiceFilterOutputReference(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.
nameInput string No description.
valuesInput string[] No description.
name string No description.
values string[] No description.
internalValue cdktf.IResolvable | DataAwsVpcEndpointServiceFilter 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

nameInputOptional
public readonly nameInput: string;
  • Type: string

valuesInputOptional
public readonly valuesInput: string[];
  • Type: string[]

nameRequired
public readonly name: string;
  • Type: string

valuesRequired
public readonly values: string[];
  • Type: string[]

internalValueOptional
public readonly internalValue: IResolvable | DataAwsVpcEndpointServiceFilter;