Skip to content

Latest commit

 

History

History
1275 lines (780 loc) · 69.1 KB

File metadata and controls

1275 lines (780 loc) · 69.1 KB

dataCloudflareVulnerabilityScannerCredentials Submodule

Constructs

DataCloudflareVulnerabilityScannerCredentials

Represents a {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.22.0/docs/data-sources/vulnerability_scanner_credentials cloudflare_vulnerability_scanner_credentials}.

Initializers

import { dataCloudflareVulnerabilityScannerCredentials } from '@cdktn/provider-cloudflare'

new dataCloudflareVulnerabilityScannerCredentials.DataCloudflareVulnerabilityScannerCredentials(scope: Construct, id: string, config: DataCloudflareVulnerabilityScannerCredentialsConfig)
Name Type Description
scope constructs.Construct The scope in which to define this construct.
id string The scoped construct ID.
config DataCloudflareVulnerabilityScannerCredentialsConfig 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.
with Applies one or more mixins to 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.
resetAccountId No description.
resetMaxItems No description.

toString
public toString(): string

Returns a string representation of this construct.

with
public with(mixins: ...IMixin[]): IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

mixinsRequired
  • Type: ...constructs.IMixin[]

The mixins to apply.


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

resetAccountId
public resetAccountId(): void
resetMaxItems
public resetMaxItems(): void

Static Functions

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

isConstruct
import { dataCloudflareVulnerabilityScannerCredentials } from '@cdktn/provider-cloudflare'

dataCloudflareVulnerabilityScannerCredentials.DataCloudflareVulnerabilityScannerCredentials.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 { dataCloudflareVulnerabilityScannerCredentials } from '@cdktn/provider-cloudflare'

dataCloudflareVulnerabilityScannerCredentials.DataCloudflareVulnerabilityScannerCredentials.isTerraformElement(x: any)
xRequired
  • Type: any

isTerraformDataSource
import { dataCloudflareVulnerabilityScannerCredentials } from '@cdktn/provider-cloudflare'

dataCloudflareVulnerabilityScannerCredentials.DataCloudflareVulnerabilityScannerCredentials.isTerraformDataSource(x: any)
xRequired
  • Type: any

generateConfigForImport
import { dataCloudflareVulnerabilityScannerCredentials } from '@cdktn/provider-cloudflare'

dataCloudflareVulnerabilityScannerCredentials.DataCloudflareVulnerabilityScannerCredentials.generateConfigForImport(scope: Construct, importToId: string, importFromId: string, provider?: TerraformProvider)

Generates CDKTN code for importing a DataCloudflareVulnerabilityScannerCredentials resource upon running "cdktn 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 DataCloudflareVulnerabilityScannerCredentials to import.


importFromIdRequired
  • Type: string

The id of the existing DataCloudflareVulnerabilityScannerCredentials that should be imported.

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


providerOptional
  • Type: cdktn.TerraformProvider

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


Properties

Name Type Description
node constructs.Node The tree node.
cdktfStack cdktn.TerraformStack No description.
fqn string No description.
friendlyUniqueId string No description.
terraformMetaArguments {[ key: string ]: any} No description.
terraformResourceType string No description.
terraformGeneratorMetadata cdktn.TerraformProviderGeneratorMetadata No description.
count number | cdktn.TerraformCount No description.
dependsOn string[] No description.
forEach cdktn.ITerraformIterator No description.
lifecycle cdktn.TerraformResourceLifecycle No description.
provider cdktn.TerraformProvider No description.
result DataCloudflareVulnerabilityScannerCredentialsResultList No description.
accountIdInput string No description.
credentialSetIdInput string No description.
maxItemsInput number No description.
accountId string No description.
credentialSetId string No description.
maxItems number No description.

nodeRequired
public readonly node: Node;
  • Type: constructs.Node

The tree node.


cdktfStackRequired
public readonly cdktfStack: TerraformStack;
  • Type: cdktn.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: cdktn.TerraformProviderGeneratorMetadata

countOptional
public readonly count: number | TerraformCount;
  • Type: number | cdktn.TerraformCount

dependsOnOptional
public readonly dependsOn: string[];
  • Type: string[]

forEachOptional
public readonly forEach: ITerraformIterator;
  • Type: cdktn.ITerraformIterator

lifecycleOptional
public readonly lifecycle: TerraformResourceLifecycle;
  • Type: cdktn.TerraformResourceLifecycle

providerOptional
public readonly provider: TerraformProvider;
  • Type: cdktn.TerraformProvider

resultRequired
public readonly result: DataCloudflareVulnerabilityScannerCredentialsResultList;

accountIdInputOptional
public readonly accountIdInput: string;
  • Type: string

credentialSetIdInputOptional
public readonly credentialSetIdInput: string;
  • Type: string

maxItemsInputOptional
public readonly maxItemsInput: number;
  • Type: number

accountIdRequired
public readonly accountId: string;
  • Type: string

credentialSetIdRequired
public readonly credentialSetId: string;
  • Type: string

maxItemsRequired
public readonly maxItems: number;
  • Type: number

Constants

Name Type Description
tfResourceType string No description.

tfResourceTypeRequired
public readonly tfResourceType: string;
  • Type: string

Structs

DataCloudflareVulnerabilityScannerCredentialsConfig

Initializer

import { dataCloudflareVulnerabilityScannerCredentials } from '@cdktn/provider-cloudflare'

const dataCloudflareVulnerabilityScannerCredentialsConfig: dataCloudflareVulnerabilityScannerCredentials.DataCloudflareVulnerabilityScannerCredentialsConfig = { ... }

Properties

Name Type Description
connection cdktn.SSHProvisionerConnection | cdktn.WinrmProvisionerConnection No description.
count number | cdktn.TerraformCount No description.
dependsOn cdktn.ITerraformDependable[] No description.
forEach cdktn.ITerraformIterator No description.
lifecycle cdktn.TerraformResourceLifecycle No description.
provider cdktn.TerraformProvider No description.
provisioners cdktn.FileProvisioner | cdktn.LocalExecProvisioner | cdktn.RemoteExecProvisioner[] No description.
credentialSetId string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.22.0/docs/data-sources/vulnerability_scanner_credentials#credential_set_id DataCloudflareVulnerabilityScannerCredentials#credential_set_id}.
accountId string Identifier.
maxItems number Max items to fetch, default: 1000.

connectionOptional
public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnection;
  • Type: cdktn.SSHProvisionerConnection | cdktn.WinrmProvisionerConnection

countOptional
public readonly count: number | TerraformCount;
  • Type: number | cdktn.TerraformCount

dependsOnOptional
public readonly dependsOn: ITerraformDependable[];
  • Type: cdktn.ITerraformDependable[]

forEachOptional
public readonly forEach: ITerraformIterator;
  • Type: cdktn.ITerraformIterator

lifecycleOptional
public readonly lifecycle: TerraformResourceLifecycle;
  • Type: cdktn.TerraformResourceLifecycle

providerOptional
public readonly provider: TerraformProvider;
  • Type: cdktn.TerraformProvider

provisionersOptional
public readonly provisioners: (FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner)[];
  • Type: cdktn.FileProvisioner | cdktn.LocalExecProvisioner | cdktn.RemoteExecProvisioner[]

credentialSetIdRequired
public readonly credentialSetId: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.22.0/docs/data-sources/vulnerability_scanner_credentials#credential_set_id DataCloudflareVulnerabilityScannerCredentials#credential_set_id}.


accountIdOptional
public readonly accountId: string;
  • Type: string

Identifier.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.22.0/docs/data-sources/vulnerability_scanner_credentials#account_id DataCloudflareVulnerabilityScannerCredentials#account_id}


maxItemsOptional
public readonly maxItems: number;
  • Type: number

Max items to fetch, default: 1000.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.22.0/docs/data-sources/vulnerability_scanner_credentials#max_items DataCloudflareVulnerabilityScannerCredentials#max_items}


DataCloudflareVulnerabilityScannerCredentialsResult

Initializer

import { dataCloudflareVulnerabilityScannerCredentials } from '@cdktn/provider-cloudflare'

const dataCloudflareVulnerabilityScannerCredentialsResult: dataCloudflareVulnerabilityScannerCredentials.DataCloudflareVulnerabilityScannerCredentialsResult = { ... }

Classes

DataCloudflareVulnerabilityScannerCredentialsResultList

Initializers

import { dataCloudflareVulnerabilityScannerCredentials } from '@cdktn/provider-cloudflare'

new dataCloudflareVulnerabilityScannerCredentials.DataCloudflareVulnerabilityScannerCredentialsResultList(terraformResource: IInterpolatingParent, terraformAttribute: string, wrapsSet: boolean)
Name Type Description
terraformResource cdktn.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: cdktn.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: cdktn.IResolveContext

toString
public toString(): string

Return a string representation of this resolvable object.

Returns a reversible string representation.

get
public get(index: number): DataCloudflareVulnerabilityScannerCredentialsResultOutputReference
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.

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

DataCloudflareVulnerabilityScannerCredentialsResultOutputReference

Initializers

import { dataCloudflareVulnerabilityScannerCredentials } from '@cdktn/provider-cloudflare'

new dataCloudflareVulnerabilityScannerCredentials.DataCloudflareVulnerabilityScannerCredentialsResultOutputReference(terraformResource: IInterpolatingParent, terraformAttribute: string, complexObjectIndex: number, complexObjectIsFromSet: boolean)
Name Type Description
terraformResource cdktn.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: cdktn.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: cdktn.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.
credentialSetId string No description.
id string No description.
location string No description.
locationName string No description.
name string No description.
internalValue DataCloudflareVulnerabilityScannerCredentialsResult 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

credentialSetIdRequired
public readonly credentialSetId: string;
  • Type: string

idRequired
public readonly id: string;
  • Type: string

locationRequired
public readonly location: string;
  • Type: string

locationNameRequired
public readonly locationName: string;
  • Type: string

nameRequired
public readonly name: string;
  • Type: string

internalValueOptional
public readonly internalValue: DataCloudflareVulnerabilityScannerCredentialsResult;