`dataCloudflareCloudforceOneRequestMessage` Submodule

Constructs

DataCloudflareCloudforceOneRequestMessage

Represents a {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.14.0/docs/data-sources/cloudforce_one_request_message cloudflare_cloudforce_one_request_message}.

Initializers

import { dataCloudflareCloudforceOneRequestMessage } from '@cdktf/provider-cloudflare'

new dataCloudflareCloudforceOneRequestMessage.DataCloudflareCloudforceOneRequestMessage(scope: Construct, id: string, config: DataCloudflareCloudforceOneRequestMessageConfig)

Name	Type	Description
`scope`	`constructs.Construct`	The scope in which to define this construct.
`id`	`string`	The scoped construct ID.
`config`	`DataCloudflareCloudforceOneRequestMessageConfig`	No description.

`scope`^Required

Type: constructs.Construct

The scope in which to define this construct.

`id`^Required

Type: string

The scoped construct ID.

Must be unique amongst siblings in the same scope

`config`^Required

Type: DataCloudflareCloudforceOneRequestMessageConfig

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.
`resetAfter`	No description.
`resetBefore`	No description.
`resetSortBy`	No description.
`resetSortOrder`	No description.

`toString`

public toString(): string

Returns a string representation of this construct.

`addOverride`

public addOverride(path: string, value: any): void

`path`^Required

Type: string

`value`^Required

Type: any

`overrideLogicalId`

public overrideLogicalId(newLogicalId: string): void

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

`newLogicalId`^Required

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}

`terraformAttribute`^Required

Type: string

`getBooleanAttribute`

public getBooleanAttribute(terraformAttribute: string): IResolvable

`terraformAttribute`^Required

Type: string

`getBooleanMapAttribute`

public getBooleanMapAttribute(terraformAttribute: string): {[ key: string ]: boolean}

`terraformAttribute`^Required

Type: string

`getListAttribute`

public getListAttribute(terraformAttribute: string): string[]

`terraformAttribute`^Required

Type: string

`getNumberAttribute`

public getNumberAttribute(terraformAttribute: string): number

`terraformAttribute`^Required

Type: string

`getNumberListAttribute`

public getNumberListAttribute(terraformAttribute: string): number[]

`terraformAttribute`^Required

Type: string

`getNumberMapAttribute`

public getNumberMapAttribute(terraformAttribute: string): {[ key: string ]: number}

`terraformAttribute`^Required

Type: string

`getStringAttribute`

public getStringAttribute(terraformAttribute: string): string

`terraformAttribute`^Required

Type: string

`getStringMapAttribute`

public getStringMapAttribute(terraformAttribute: string): {[ key: string ]: string}

`terraformAttribute`^Required

Type: string

`interpolationForAttribute`

public interpolationForAttribute(terraformAttribute: string): IResolvable

`terraformAttribute`^Required

Type: string

`resetAfter`

public resetAfter(): void

`resetBefore`

public resetBefore(): void

`resetSortBy`

public resetSortBy(): void

`resetSortOrder`

public resetSortOrder(): 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 DataCloudflareCloudforceOneRequestMessage resource upon running "cdktf plan ".

`isConstruct`

import { dataCloudflareCloudforceOneRequestMessage } from '@cdktf/provider-cloudflare'

dataCloudflareCloudforceOneRequestMessage.DataCloudflareCloudforceOneRequestMessage.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.

`x`^Required

Type: any

Any object.

`isTerraformElement`

import { dataCloudflareCloudforceOneRequestMessage } from '@cdktf/provider-cloudflare'

dataCloudflareCloudforceOneRequestMessage.DataCloudflareCloudforceOneRequestMessage.isTerraformElement(x: any)

`x`^Required

Type: any

`isTerraformDataSource`

import { dataCloudflareCloudforceOneRequestMessage } from '@cdktf/provider-cloudflare'

dataCloudflareCloudforceOneRequestMessage.DataCloudflareCloudforceOneRequestMessage.isTerraformDataSource(x: any)

`x`^Required

Type: any

`generateConfigForImport`

import { dataCloudflareCloudforceOneRequestMessage } from '@cdktf/provider-cloudflare'

dataCloudflareCloudforceOneRequestMessage.DataCloudflareCloudforceOneRequestMessage.generateConfigForImport(scope: Construct, importToId: string, importFromId: string, provider?: TerraformProvider)

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

`scope`^Required

Type: constructs.Construct

The scope in which to define this construct.

`importToId`^Required

Type: string

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

`importFromId`^Required

Type: string

The id of the existing DataCloudflareCloudforceOneRequestMessage that should be imported.

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

`provider`^Optional

Type: cdktf.TerraformProvider

? Optional instance of the provider where the DataCloudflareCloudforceOneRequestMessage 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.
`author`	`string`	No description.
`content`	`string`	No description.
`created`	`string`	No description.
`id`	`string`	No description.
`isFollowOnRequest`	`cdktf.IResolvable`	No description.
`updated`	`string`	No description.
`accountIdInput`	`string`	No description.
`afterInput`	`string`	No description.
`beforeInput`	`string`	No description.
`pageInput`	`number`	No description.
`perPageInput`	`number`	No description.
`requestIdInput`	`string`	No description.
`sortByInput`	`string`	No description.
`sortOrderInput`	`string`	No description.
`accountId`	`string`	No description.
`after`	`string`	No description.
`before`	`string`	No description.
`page`	`number`	No description.
`perPage`	`number`	No description.
`requestId`	`string`	No description.
`sortBy`	`string`	No description.
`sortOrder`	`string`	No description.

`node`^Required

public readonly node: Node;

Type: constructs.Node

The tree node.

`cdktfStack`^Required

public readonly cdktfStack: TerraformStack;

Type: cdktf.TerraformStack

`fqn`^Required

public readonly fqn: string;

Type: string

`friendlyUniqueId`^Required

public readonly friendlyUniqueId: string;

Type: string

`terraformMetaArguments`^Required

public readonly terraformMetaArguments: {[ key: string ]: any};

Type: {[ key: string ]: any}

`terraformResourceType`^Required

public readonly terraformResourceType: string;

Type: string

`terraformGeneratorMetadata`^Optional

public readonly terraformGeneratorMetadata: TerraformProviderGeneratorMetadata;

Type: cdktf.TerraformProviderGeneratorMetadata

`count`^Optional

public readonly count: number | TerraformCount;

Type: number | cdktf.TerraformCount

`dependsOn`^Optional

public readonly dependsOn: string[];

Type: string[]

`forEach`^Optional

public readonly forEach: ITerraformIterator;

Type: cdktf.ITerraformIterator

`lifecycle`^Optional

public readonly lifecycle: TerraformResourceLifecycle;

Type: cdktf.TerraformResourceLifecycle

`provider`^Optional

public readonly provider: TerraformProvider;

Type: cdktf.TerraformProvider

`author`^Required

public readonly author: string;

Type: string

`content`^Required

public readonly content: string;

Type: string

`created`^Required

public readonly created: string;

Type: string

`id`^Required

public readonly id: string;

Type: string

`isFollowOnRequest`^Required

public readonly isFollowOnRequest: IResolvable;

Type: cdktf.IResolvable

`updated`^Required

public readonly updated: string;

Type: string

`accountIdInput`^Optional

public readonly accountIdInput: string;

Type: string

`afterInput`^Optional

public readonly afterInput: string;

Type: string

`beforeInput`^Optional

public readonly beforeInput: string;

Type: string

`pageInput`^Optional

public readonly pageInput: number;

Type: number

`perPageInput`^Optional

public readonly perPageInput: number;

Type: number

`requestIdInput`^Optional

public readonly requestIdInput: string;

Type: string

`sortByInput`^Optional

public readonly sortByInput: string;

Type: string

`sortOrderInput`^Optional

public readonly sortOrderInput: string;

Type: string

`accountId`^Required

public readonly accountId: string;

Type: string

`after`^Required

public readonly after: string;

Type: string

`before`^Required

public readonly before: string;

Type: string

`page`^Required

public readonly page: number;

Type: number

`perPage`^Required

public readonly perPage: number;

Type: number

`requestId`^Required

public readonly requestId: string;

Type: string

`sortBy`^Required

public readonly sortBy: string;

Type: string

`sortOrder`^Required

public readonly sortOrder: string;

Type: string

Constants

Name	Type	Description
`tfResourceType`	`string`	No description.

`tfResourceType`^Required

public readonly tfResourceType: string;

Type: string

Structs

DataCloudflareCloudforceOneRequestMessageConfig

Initializer

import { dataCloudflareCloudforceOneRequestMessage } from '@cdktf/provider-cloudflare'

const dataCloudflareCloudforceOneRequestMessageConfig: dataCloudflareCloudforceOneRequestMessage.DataCloudflareCloudforceOneRequestMessageConfig = { ... }

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.
`accountId`	`string`	Identifier.
`page`	`number`	Page number of results.
`perPage`	`number`	Number of results per page.
`requestId`	`string`	UUID.
`after`	`string`	Retrieve mes ges created after this time.
`before`	`string`	Retrieve messages created before this time.
`sortBy`	`string`	Field to sort results by.
`sortOrder`	`string`	Sort order (asc or desc). Available values: "asc", "desc".

`connection`^Optional

public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnection;

Type: cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection

`count`^Optional

public readonly count: number | TerraformCount;

Type: number | cdktf.TerraformCount

`dependsOn`^Optional

public readonly dependsOn: ITerraformDependable[];

Type: cdktf.ITerraformDependable[]

`forEach`^Optional

public readonly forEach: ITerraformIterator;

Type: cdktf.ITerraformIterator

`lifecycle`^Optional

public readonly lifecycle: TerraformResourceLifecycle;

Type: cdktf.TerraformResourceLifecycle

`provider`^Optional

public readonly provider: TerraformProvider;

Type: cdktf.TerraformProvider

`provisioners`^Optional

public readonly provisioners: (FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner)[];

Type: cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[]

`accountId`^Required

public readonly accountId: string;

Type: string

Identifier.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.14.0/docs/data-sources/cloudforce_one_request_message#account_id DataCloudflareCloudforceOneRequestMessage#account_id}

`page`^Required

public readonly page: number;

Type: number

Page number of results.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.14.0/docs/data-sources/cloudforce_one_request_message#page DataCloudflareCloudforceOneRequestMessage#page}

`perPage`^Required

public readonly perPage: number;

Type: number

Number of results per page.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.14.0/docs/data-sources/cloudforce_one_request_message#per_page DataCloudflareCloudforceOneRequestMessage#per_page}

`requestId`^Required

public readonly requestId: string;

Type: string

UUID.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.14.0/docs/data-sources/cloudforce_one_request_message#request_id DataCloudflareCloudforceOneRequestMessage#request_id}

`after`^Optional

public readonly after: string;

Type: string

Retrieve mes ges created after this time.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.14.0/docs/data-sources/cloudforce_one_request_message#after DataCloudflareCloudforceOneRequestMessage#after}

`before`^Optional

public readonly before: string;

Type: string

Retrieve messages created before this time.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.14.0/docs/data-sources/cloudforce_one_request_message#before DataCloudflareCloudforceOneRequestMessage#before}

`sortBy`^Optional

public readonly sortBy: string;

Type: string

Field to sort results by.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.14.0/docs/data-sources/cloudforce_one_request_message#sort_by DataCloudflareCloudforceOneRequestMessage#sort_by}

`sortOrder`^Optional

public readonly sortOrder: string;

Type: string

Sort order (asc or desc). Available values: "asc", "desc".

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.14.0/docs/data-sources/cloudforce_one_request_message#sort_order DataCloudflareCloudforceOneRequestMessage#sort_order}

FilesExpand file tree

dataCloudflareCloudforceOneRequestMessage.typescript.md

Latest commit

History

dataCloudflareCloudforceOneRequestMessage.typescript.md

File metadata and controls

dataCloudflareCloudforceOneRequestMessage Submodule

Constructs