`dataCloudflareFilter` Submodule

Constructs

DataCloudflareFilter

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

Initializers

using Io.Cdktn.Providers.Cloudflare;

new DataCloudflareFilter(Construct Scope, string Id, DataCloudflareFilterConfig Config = null);

Name	Type	Description
`Scope`	`Constructs.Construct`	The scope in which to define this construct.
`Id`	`string`	The scoped construct ID.
`Config`	`DataCloudflareFilterConfig`	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`^Optional

Type: DataCloudflareFilterConfig

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.
`PutFilter`	No description.
`ResetFilter`	No description.
`ResetFilterId`	No description.
`ResetZoneId`	No description.

`ToString`

private string ToString()

Returns a string representation of this construct.

`With`

private IConstruct With(params IMixin[] Mixins)

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.

`Mixins`^Required

Type: params Constructs.IMixin[]

The mixins to apply.

`AddOverride`

private void AddOverride(string Path, object Value)

`Path`^Required

Type: string

`Value`^Required

Type: object

`OverrideLogicalId`

private void OverrideLogicalId(string NewLogicalId)

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`

private void ResetOverrideLogicalId()

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

`ToHclTerraform`

private object ToHclTerraform()

Adds this resource to the terraform JSON output.

`ToMetadata`

private object ToMetadata()

`ToTerraform`

private object ToTerraform()

Adds this resource to the terraform JSON output.

`GetAnyMapAttribute`

private System.Collections.Generic.IDictionary<string, object> GetAnyMapAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`GetBooleanAttribute`

private IResolvable GetBooleanAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`GetBooleanMapAttribute`

private System.Collections.Generic.IDictionary<string, bool> GetBooleanMapAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`GetListAttribute`

private string[] GetListAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`GetNumberAttribute`

private double GetNumberAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`GetNumberListAttribute`

private double[] GetNumberListAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`GetNumberMapAttribute`

private System.Collections.Generic.IDictionary<string, double> GetNumberMapAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`GetStringAttribute`

private string GetStringAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`GetStringMapAttribute`

private System.Collections.Generic.IDictionary<string, string> GetStringMapAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`InterpolationForAttribute`

private IResolvable InterpolationForAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`PutFilter`

private void PutFilter(DataCloudflareFilterFilter Value)

`Value`^Required

Type: DataCloudflareFilterFilter

`ResetFilter`

private void ResetFilter()

`ResetFilterId`

private void ResetFilterId()

`ResetZoneId`

private void ResetZoneId()

Static Functions

Name	Description
`IsConstruct`	Checks if `x` is a construct.
`IsTerraformElement`	No description.
`IsTerraformDataSource`	No description.
`GenerateConfigForImport`	Generates CDKTN code for importing a DataCloudflareFilter resource upon running "cdktn plan ".

`IsConstruct`

using Io.Cdktn.Providers.Cloudflare;

DataCloudflareFilter.IsConstruct(object X);

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: object

Any object.

`IsTerraformElement`

using Io.Cdktn.Providers.Cloudflare;

DataCloudflareFilter.IsTerraformElement(object X);

`X`^Required

Type: object

`IsTerraformDataSource`

using Io.Cdktn.Providers.Cloudflare;

DataCloudflareFilter.IsTerraformDataSource(object X);

`X`^Required

Type: object

`GenerateConfigForImport`

using Io.Cdktn.Providers.Cloudflare;

DataCloudflareFilter.GenerateConfigForImport(Construct Scope, string ImportToId, string ImportFromId, TerraformProvider Provider = null);

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

`ImportFromId`^Required

Type: string

The id of the existing DataCloudflareFilter that should be imported.

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

`Provider`^Optional

Type: Io.Cdktn.TerraformProvider

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

Properties

Name	Type	Description
`Node`	`Constructs.Node`	The tree node.
`CdktfStack`	`Io.Cdktn.TerraformStack`	No description.
`Fqn`	`string`	No description.
`FriendlyUniqueId`	`string`	No description.
`TerraformMetaArguments`	`System.Collections.Generic.IDictionary<string, object>`	No description.
`TerraformResourceType`	`string`	No description.
`TerraformGeneratorMetadata`	`Io.Cdktn.TerraformProviderGeneratorMetadata`	No description.
`Count`	`double\|Io.Cdktn.TerraformCount`	No description.
`DependsOn`	`string[]`	No description.
`ForEach`	`Io.Cdktn.ITerraformIterator`	No description.
`Lifecycle`	`Io.Cdktn.TerraformResourceLifecycle`	No description.
`Provider`	`Io.Cdktn.TerraformProvider`	No description.
`Description`	`string`	No description.
`Expression`	`string`	No description.
`Filter`	`DataCloudflareFilterFilterOutputReference`	No description.
`Id`	`string`	No description.
`Paused`	`Io.Cdktn.IResolvable`	No description.
`Ref`	`string`	No description.
`FilterIdInput`	`string`	No description.
`FilterInput`	`Io.Cdktn.IResolvable\|DataCloudflareFilterFilter`	No description.
`ZoneIdInput`	`string`	No description.
`FilterId`	`string`	No description.
`ZoneId`	`string`	No description.

`Node`^Required

public Node Node { get; }

Type: Constructs.Node

The tree node.

`CdktfStack`^Required

public TerraformStack CdktfStack { get; }

Type: Io.Cdktn.TerraformStack

`Fqn`^Required

public string Fqn { get; }

Type: string

`FriendlyUniqueId`^Required

public string FriendlyUniqueId { get; }

Type: string

`TerraformMetaArguments`^Required

public System.Collections.Generic.IDictionary<string, object> TerraformMetaArguments { get; }

Type: System.Collections.Generic.IDictionary<string, object>

`TerraformResourceType`^Required

public string TerraformResourceType { get; }

Type: string

`TerraformGeneratorMetadata`^Optional

public TerraformProviderGeneratorMetadata TerraformGeneratorMetadata { get; }

Type: Io.Cdktn.TerraformProviderGeneratorMetadata

`Count`^Optional

public double|TerraformCount Count { get; }

Type: double|Io.Cdktn.TerraformCount

`DependsOn`^Optional

public string[] DependsOn { get; }

Type: string[]

`ForEach`^Optional

public ITerraformIterator ForEach { get; }

Type: Io.Cdktn.ITerraformIterator

`Lifecycle`^Optional

public TerraformResourceLifecycle Lifecycle { get; }

Type: Io.Cdktn.TerraformResourceLifecycle

`Provider`^Optional

public TerraformProvider Provider { get; }

Type: Io.Cdktn.TerraformProvider

`Description`^Required

public string Description { get; }

Type: string

`Expression`^Required

public string Expression { get; }

Type: string

`Filter`^Required

public DataCloudflareFilterFilterOutputReference Filter { get; }

Type: DataCloudflareFilterFilterOutputReference

`Id`^Required

public string Id { get; }

Type: string

`Paused`^Required

public IResolvable Paused { get; }

Type: Io.Cdktn.IResolvable

`Ref`^Required

public string Ref { get; }

Type: string

`FilterIdInput`^Optional

public string FilterIdInput { get; }

Type: string

`FilterInput`^Optional

public IResolvable|DataCloudflareFilterFilter FilterInput { get; }

Type: Io.Cdktn.IResolvable|DataCloudflareFilterFilter

`ZoneIdInput`^Optional

public string ZoneIdInput { get; }

Type: string

`FilterId`^Required

public string FilterId { get; }

Type: string

`ZoneId`^Required

public string ZoneId { get; }

Type: string

Constants

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

`TfResourceType`^Required

public string TfResourceType { get; }

Type: string

Structs

DataCloudflareFilterConfig

Initializer

using Io.Cdktn.Providers.Cloudflare;

new DataCloudflareFilterConfig {
    SSHProvisionerConnection|WinrmProvisionerConnection Connection = null,
    double|TerraformCount Count = null,
    ITerraformDependable[] DependsOn = null,
    ITerraformIterator ForEach = null,
    TerraformResourceLifecycle Lifecycle = null,
    TerraformProvider Provider = null,
    (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners = null,
    DataCloudflareFilterFilter Filter = null,
    string FilterId = null,
    string ZoneId = null
};

Properties

Name	Type	Description
`Connection`	`Io.Cdktn.SSHProvisionerConnection\|Io.Cdktn.WinrmProvisionerConnection`	No description.
`Count`	`double\|Io.Cdktn.TerraformCount`	No description.
`DependsOn`	`Io.Cdktn.ITerraformDependable[]`	No description.
`ForEach`	`Io.Cdktn.ITerraformIterator`	No description.
`Lifecycle`	`Io.Cdktn.TerraformResourceLifecycle`	No description.
`Provider`	`Io.Cdktn.TerraformProvider`	No description.
`Provisioners`	`Io.Cdktn.FileProvisioner\|Io.Cdktn.LocalExecProvisioner\|Io.Cdktn.RemoteExecProvisioner[]`	No description.
`Filter`	`DataCloudflareFilterFilter`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.22.0/docs/data-sources/filter#filter DataCloudflareFilter#filter}.
`FilterId`	`string`	The unique identifier of the filter.
`ZoneId`	`string`	Defines an identifier.

`Connection`^Optional

public SSHProvisionerConnection|WinrmProvisionerConnection Connection { get; set; }

Type: Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection

`Count`^Optional

public double|TerraformCount Count { get; set; }

Type: double|Io.Cdktn.TerraformCount

`DependsOn`^Optional

public ITerraformDependable[] DependsOn { get; set; }

Type: Io.Cdktn.ITerraformDependable[]

`ForEach`^Optional

public ITerraformIterator ForEach { get; set; }

Type: Io.Cdktn.ITerraformIterator

`Lifecycle`^Optional

public TerraformResourceLifecycle Lifecycle { get; set; }

Type: Io.Cdktn.TerraformResourceLifecycle

`Provider`^Optional

public TerraformProvider Provider { get; set; }

Type: Io.Cdktn.TerraformProvider

`Provisioners`^Optional

public (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners { get; set; }

Type: Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.RemoteExecProvisioner[]

`Filter`^Optional

public DataCloudflareFilterFilter Filter { get; set; }

Type: DataCloudflareFilterFilter

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

`FilterId`^Optional

public string FilterId { get; set; }

Type: string

The unique identifier of the filter.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.22.0/docs/data-sources/filter#filter_id DataCloudflareFilter#filter_id}

`ZoneId`^Optional

public string ZoneId { get; set; }

Type: string

Defines an identifier.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.22.0/docs/data-sources/filter#zone_id DataCloudflareFilter#zone_id}

DataCloudflareFilterFilter

Initializer

using Io.Cdktn.Providers.Cloudflare;

new DataCloudflareFilterFilter {
    string Description = null,
    string Expression = null,
    string Id = null,
    bool|IResolvable Paused = null,
    string Ref = null
};

Properties

Name	Type	Description
`Description`	`string`	A case-insensitive string to find in the description.
`Expression`	`string`	A case-insensitive string to find in the expression.
`Id`	`string`	The unique identifier of the filter.
`Paused`	`bool\|Io.Cdktn.IResolvable`	When true, indicates that the filter is currently paused.
`Ref`	`string`	The filter ref (a short reference tag) to search for. Must be an exact match.

`Description`^Optional

public string Description { get; set; }

Type: string

A case-insensitive string to find in the description.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.22.0/docs/data-sources/filter#description DataCloudflareFilter#description}

`Expression`^Optional

public string Expression { get; set; }

Type: string

A case-insensitive string to find in the expression.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.22.0/docs/data-sources/filter#expression DataCloudflareFilter#expression}

`Id`^Optional

public string Id { get; set; }

Type: string

The unique identifier of the filter.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.22.0/docs/data-sources/filter#id DataCloudflareFilter#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.

`Paused`^Optional

public bool|IResolvable Paused { get; set; }

Type: bool|Io.Cdktn.IResolvable

When true, indicates that the filter is currently paused.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.22.0/docs/data-sources/filter#paused DataCloudflareFilter#paused}

`Ref`^Optional

public string Ref { get; set; }

Type: string

The filter ref (a short reference tag) to search for. Must be an exact match.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.22.0/docs/data-sources/filter#ref DataCloudflareFilter#ref}

Classes

DataCloudflareFilterFilterOutputReference

Initializers

using Io.Cdktn.Providers.Cloudflare;

new DataCloudflareFilterFilterOutputReference(IInterpolatingParent TerraformResource, string TerraformAttribute);

Name	Type	Description
`TerraformResource`	`Io.Cdktn.IInterpolatingParent`	The parent resource.
`TerraformAttribute`	`string`	The attribute on the parent resource this class is referencing.

`TerraformResource`^Required

Type: Io.Cdktn.IInterpolatingParent

The parent resource.

`TerraformAttribute`^Required

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.
`ResetDescription`	No description.
`ResetExpression`	No description.
`ResetId`	No description.
`ResetPaused`	No description.
`ResetRef`	No description.

`ComputeFqn`

private string ComputeFqn()

`GetAnyMapAttribute`

private System.Collections.Generic.IDictionary<string, object> GetAnyMapAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`GetBooleanAttribute`

private IResolvable GetBooleanAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`GetBooleanMapAttribute`

private System.Collections.Generic.IDictionary<string, bool> GetBooleanMapAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`GetListAttribute`

private string[] GetListAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`GetNumberAttribute`

private double GetNumberAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`GetNumberListAttribute`

private double[] GetNumberListAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`GetNumberMapAttribute`

private System.Collections.Generic.IDictionary<string, double> GetNumberMapAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`GetStringAttribute`

private string GetStringAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`GetStringMapAttribute`

private System.Collections.Generic.IDictionary<string, string> GetStringMapAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`InterpolationForAttribute`

private IResolvable InterpolationForAttribute(string Property)

`Property`^Required

Type: string

`Resolve`

private object Resolve(IResolveContext Context)

Produce the Token's value at resolution time.

`Context`^Required

Type: Io.Cdktn.IResolveContext

`ToString`

private string ToString()

Return a string representation of this resolvable object.

Returns a reversible string representation.

`ResetDescription`

private void ResetDescription()

`ResetExpression`

private void ResetExpression()

`ResetId`

private void ResetId()

`ResetPaused`

private void ResetPaused()

`ResetRef`

private void ResetRef()

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.
`DescriptionInput`	`string`	No description.
`ExpressionInput`	`string`	No description.
`IdInput`	`string`	No description.
`PausedInput`	`bool\|Io.Cdktn.IResolvable`	No description.
`RefInput`	`string`	No description.
`Description`	`string`	No description.
`Expression`	`string`	No description.
`Id`	`string`	No description.
`Paused`	`bool\|Io.Cdktn.IResolvable`	No description.
`Ref`	`string`	No description.
`InternalValue`	`Io.Cdktn.IResolvable\|DataCloudflareFilterFilter`	No description.

`CreationStack`^Required

public string[] CreationStack { get; }

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.

`Fqn`^Required

public string Fqn { get; }

Type: string

`DescriptionInput`^Optional

public string DescriptionInput { get; }

Type: string

`ExpressionInput`^Optional

public string ExpressionInput { get; }

Type: string

`IdInput`^Optional

public string IdInput { get; }

Type: string

`PausedInput`^Optional

public bool|IResolvable PausedInput { get; }

Type: bool|Io.Cdktn.IResolvable

`RefInput`^Optional

public string RefInput { get; }

Type: string

`Description`^Required

public string Description { get; }

Type: string

`Expression`^Required

public string Expression { get; }

Type: string

`Id`^Required

public string Id { get; }

Type: string

`Paused`^Required

public bool|IResolvable Paused { get; }

Type: bool|Io.Cdktn.IResolvable

`Ref`^Required

public string Ref { get; }

Type: string

`InternalValue`^Optional

public IResolvable|DataCloudflareFilterFilter InternalValue { get; }

Type: Io.Cdktn.IResolvable|DataCloudflareFilterFilter

Uh oh!

FilesExpand file tree

dataCloudflareFilter.csharp.md

Latest commit

History

dataCloudflareFilter.csharp.md

File metadata and controls

dataCloudflareFilter Submodule

Constructs