Skip to content

firewallRule.java.md

Latest commit

 

History

History
2324 lines (1441 loc) · 104 KB

firewallRule.java.md

File metadata and controls

2324 lines (1441 loc) · 104 KB

firewallRule Submodule

Constructs

FirewallRule

Represents a {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.19.1/docs/resources/firewall_rule cloudflare_firewall_rule}.

Initializers 

import io.cdktn.providers.cloudflare.firewall_rule.FirewallRule;

FirewallRule.Builder.create(Construct scope, java.lang.String id)
//  .connection(SSHProvisionerConnection|WinrmProvisionerConnection)
//  .count(java.lang.Number|TerraformCount)
//  .dependsOn(java.util.List<ITerraformDependable>)
//  .forEach(ITerraformIterator)
//  .lifecycle(TerraformResourceLifecycle)
//  .provider(TerraformProvider)
//  .provisioners(java.util.List<FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner>)
    .action(FirewallRuleAction)
    .filter(FirewallRuleFilter)
//  .zoneId(java.lang.String)
    .build();
Name Type Description
scope software.constructs.Construct The scope in which to define this construct.
id java.lang.String The scoped construct ID.
connection io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection No description.
count java.lang.Number|io.cdktn.cdktn.TerraformCount No description.
dependsOn java.util.List<io.cdktn.cdktn.ITerraformDependable> No description.
forEach io.cdktn.cdktn.ITerraformIterator No description.
lifecycle io.cdktn.cdktn.TerraformResourceLifecycle No description.
provider io.cdktn.cdktn.TerraformProvider No description.
provisioners java.util.List<io.cdktn.cdktn.FileProvisioner|io.cdktn.cdktn.LocalExecProvisioner|io.cdktn.cdktn.RemoteExecProvisioner> No description.
action FirewallRuleAction The action to perform when the threshold of matched traffic within the configured period is exceeded.
filter FirewallRuleFilter Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.19.1/docs/resources/firewall_rule#filter FirewallRule#filter}.
zoneId java.lang.String Defines an identifier.
scopeRequired
  • Type: software.constructs.Construct

The scope in which to define this construct.

idRequired
  • Type: java.lang.String

The scoped construct ID.

Must be unique amongst siblings in the same scope

connectionOptional
  • Type: io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection
countOptional
  • Type: java.lang.Number|io.cdktn.cdktn.TerraformCount
dependsOnOptional
  • Type: java.util.List<io.cdktn.cdktn.ITerraformDependable>
forEachOptional
  • Type: io.cdktn.cdktn.ITerraformIterator
lifecycleOptional
  • Type: io.cdktn.cdktn.TerraformResourceLifecycle
providerOptional
  • Type: io.cdktn.cdktn.TerraformProvider
provisionersOptional
  • Type: java.util.List<io.cdktn.cdktn.FileProvisioner|io.cdktn.cdktn.LocalExecProvisioner|io.cdktn.cdktn.RemoteExecProvisioner>
actionRequired

The action to perform when the threshold of matched traffic within the configured period is exceeded.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.19.1/docs/resources/firewall_rule#action FirewallRule#action}

filterRequired

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.19.1/docs/resources/firewall_rule#filter FirewallRule#filter}.

zoneIdOptional
  • Type: java.lang.String

Defines an identifier.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.19.1/docs/resources/firewall_rule#zone_id FirewallRule#zone_id}

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 No description.
toMetadata No description.
toTerraform Adds this resource to the terraform JSON output.
addMoveTarget Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.
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.
hasResourceMove No description.
importFrom No description.
interpolationForAttribute No description.
moveFromId Move the resource corresponding to "id" to this resource.
moveTo Moves this resource to the target resource given by moveTarget.
moveToId Moves this resource to the resource corresponding to "id".
putAction No description.
putFilter No description.
resetZoneId No description.
toString 
public java.lang.String toString()

Returns a string representation of this construct.

with 
public IConstruct with(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.

mixinsRequired
  • Type: software.constructs.IMixin...

The mixins to apply.

addOverride 
public void addOverride(java.lang.String path, java.lang.Object value)
pathRequired
  • Type: java.lang.String
valueRequired
  • Type: java.lang.Object
overrideLogicalId 
public void overrideLogicalId(java.lang.String newLogicalId)

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

newLogicalIdRequired
  • Type: java.lang.String

The new logical ID to use for this stack element.

resetOverrideLogicalId 
public void resetOverrideLogicalId()

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

toHclTerraform 
public java.lang.Object toHclTerraform()
toMetadata 
public java.lang.Object toMetadata()
toTerraform 
public java.lang.Object toTerraform()

Adds this resource to the terraform JSON output.

addMoveTarget 
public void addMoveTarget(java.lang.String moveTarget)

Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.

moveTargetRequired
  • Type: java.lang.String

The string move target that will correspond to this resource.

getAnyMapAttribute 
public java.util.Map<java.lang.String, java.lang.Object> getAnyMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getBooleanAttribute 
public IResolvable getBooleanAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getBooleanMapAttribute 
public java.util.Map<java.lang.String, java.lang.Boolean> getBooleanMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getListAttribute 
public java.util.List<java.lang.String> getListAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getNumberAttribute 
public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getNumberListAttribute 
public java.util.List<java.lang.Number> getNumberListAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getNumberMapAttribute 
public java.util.Map<java.lang.String, java.lang.Number> getNumberMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getStringAttribute 
public java.lang.String getStringAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getStringMapAttribute 
public java.util.Map<java.lang.String, java.lang.String> getStringMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
hasResourceMove 
public TerraformResourceMoveByTarget|TerraformResourceMoveById hasResourceMove()
importFrom 
public void importFrom(java.lang.String id)
public void importFrom(java.lang.String id, TerraformProvider provider)
idRequired
  • Type: java.lang.String
providerOptional
  • Type: io.cdktn.cdktn.TerraformProvider
interpolationForAttribute 
public IResolvable interpolationForAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
moveFromId 
public void moveFromId(java.lang.String id)

Move the resource corresponding to "id" to this resource.

Note that the resource being moved from must be marked as moved using it's instance function.

idRequired
  • Type: java.lang.String

Full id of resource being moved from, e.g. "aws_s3_bucket.example".

moveTo 
public void moveTo(java.lang.String moveTarget)
public void moveTo(java.lang.String moveTarget, java.lang.String|java.lang.Number index)

Moves this resource to the target resource given by moveTarget.

moveTargetRequired
  • Type: java.lang.String

The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to.

indexOptional
  • Type: java.lang.String|java.lang.Number

Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to.

moveToId 
public void moveToId(java.lang.String id)

Moves this resource to the resource corresponding to "id".

idRequired
  • Type: java.lang.String

Full id of resource to move to, e.g. "aws_s3_bucket.example".

putAction 
public void putAction(FirewallRuleAction value)
valueRequired
putFilter 
public void putFilter(FirewallRuleFilter value)
valueRequired
resetZoneId 
public void resetZoneId()

Static Functions

Name Description
isConstruct Checks if x is a construct.
isTerraformElement No description.
isTerraformResource No description.
generateConfigForImport Generates CDKTN code for importing a FirewallRule resource upon running "cdktn plan ".
isConstruct 
import io.cdktn.providers.cloudflare.firewall_rule.FirewallRule;

FirewallRule.isConstruct(java.lang.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.

xRequired
  • Type: java.lang.Object

Any object.

isTerraformElement 
import io.cdktn.providers.cloudflare.firewall_rule.FirewallRule;

FirewallRule.isTerraformElement(java.lang.Object x)
xRequired
  • Type: java.lang.Object
isTerraformResource 
import io.cdktn.providers.cloudflare.firewall_rule.FirewallRule;

FirewallRule.isTerraformResource(java.lang.Object x)
xRequired
  • Type: java.lang.Object
generateConfigForImport 
import io.cdktn.providers.cloudflare.firewall_rule.FirewallRule;

FirewallRule.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId),FirewallRule.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId, TerraformProvider provider)

Generates CDKTN code for importing a FirewallRule resource upon running "cdktn plan ".

scopeRequired
  • Type: software.constructs.Construct

The scope in which to define this construct.

importToIdRequired
  • Type: java.lang.String

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

importFromIdRequired
  • Type: java.lang.String

The id of the existing FirewallRule that should be imported.

Refer to the {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.19.1/docs/resources/firewall_rule#import import section} in the documentation of this resource for the id to use

providerOptional
  • Type: io.cdktn.cdktn.TerraformProvider

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

Properties

Name Type Description
node software.constructs.Node The tree node.
cdktfStack io.cdktn.cdktn.TerraformStack No description.
fqn java.lang.String No description.
friendlyUniqueId java.lang.String No description.
terraformMetaArguments java.util.Map<java.lang.String, java.lang.Object> No description.
terraformResourceType java.lang.String No description.
terraformGeneratorMetadata io.cdktn.cdktn.TerraformProviderGeneratorMetadata No description.
connection io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection No description.
count java.lang.Number|io.cdktn.cdktn.TerraformCount No description.
dependsOn java.util.List<java.lang.String> No description.
forEach io.cdktn.cdktn.ITerraformIterator No description.
lifecycle io.cdktn.cdktn.TerraformResourceLifecycle No description.
provider io.cdktn.cdktn.TerraformProvider No description.
provisioners java.util.List<io.cdktn.cdktn.FileProvisioner|io.cdktn.cdktn.LocalExecProvisioner|io.cdktn.cdktn.RemoteExecProvisioner> No description.
action FirewallRuleActionOutputReference No description.
description java.lang.String No description.
filter FirewallRuleFilterOutputReference No description.
id java.lang.String No description.
paused io.cdktn.cdktn.IResolvable No description.
priority java.lang.Number No description.
products java.util.List<java.lang.String> No description.
ref java.lang.String No description.
actionInput io.cdktn.cdktn.IResolvable|FirewallRuleAction No description.
filterInput io.cdktn.cdktn.IResolvable|FirewallRuleFilter No description.
zoneIdInput java.lang.String No description.
zoneId java.lang.String No description.
nodeRequired 
public Node getNode();
  • Type: software.constructs.Node

The tree node.

cdktfStackRequired 
public TerraformStack getCdktfStack();
  • Type: io.cdktn.cdktn.TerraformStack
fqnRequired 
public java.lang.String getFqn();
  • Type: java.lang.String
friendlyUniqueIdRequired 
public java.lang.String getFriendlyUniqueId();
  • Type: java.lang.String
terraformMetaArgumentsRequired 
public java.util.Map<java.lang.String, java.lang.Object> getTerraformMetaArguments();
  • Type: java.util.Map<java.lang.String, java.lang.Object>
terraformResourceTypeRequired 
public java.lang.String getTerraformResourceType();
  • Type: java.lang.String
terraformGeneratorMetadataOptional 
public TerraformProviderGeneratorMetadata getTerraformGeneratorMetadata();
  • Type: io.cdktn.cdktn.TerraformProviderGeneratorMetadata
connectionOptional 
public SSHProvisionerConnection|WinrmProvisionerConnection getConnection();
  • Type: io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection
countOptional 
public java.lang.Number|TerraformCount getCount();
  • Type: java.lang.Number|io.cdktn.cdktn.TerraformCount
dependsOnOptional 
public java.util.List<java.lang.String> getDependsOn();
  • Type: java.util.List<java.lang.String>
forEachOptional 
public ITerraformIterator getForEach();
  • Type: io.cdktn.cdktn.ITerraformIterator
lifecycleOptional 
public TerraformResourceLifecycle getLifecycle();
  • Type: io.cdktn.cdktn.TerraformResourceLifecycle
providerOptional 
public TerraformProvider getProvider();
  • Type: io.cdktn.cdktn.TerraformProvider
provisionersOptional 
public java.util.List<FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner> getProvisioners();
  • Type: java.util.List<io.cdktn.cdktn.FileProvisioner|io.cdktn.cdktn.LocalExecProvisioner|io.cdktn.cdktn.RemoteExecProvisioner>
actionRequired 
public FirewallRuleActionOutputReference getAction();
descriptionRequired 
public java.lang.String getDescription();
  • Type: java.lang.String
filterRequired 
public FirewallRuleFilterOutputReference getFilter();
idRequired 
public java.lang.String getId();
  • Type: java.lang.String
pausedRequired 
public IResolvable getPaused();
  • Type: io.cdktn.cdktn.IResolvable
priorityRequired 
public java.lang.Number getPriority();
  • Type: java.lang.Number
productsRequired 
public java.util.List<java.lang.String> getProducts();
  • Type: java.util.List<java.lang.String>
refRequired 
public java.lang.String getRef();
  • Type: java.lang.String
actionInputOptional 
public IResolvable|FirewallRuleAction getActionInput();
filterInputOptional 
public IResolvable|FirewallRuleFilter getFilterInput();
zoneIdInputOptional 
public java.lang.String getZoneIdInput();
  • Type: java.lang.String
zoneIdRequired 
public java.lang.String getZoneId();
  • Type: java.lang.String

Constants

Name Type Description
tfResourceType java.lang.String No description.
tfResourceTypeRequired 
public java.lang.String getTfResourceType();
  • Type: java.lang.String

Structs

FirewallRuleAction

Initializer 

import io.cdktn.providers.cloudflare.firewall_rule.FirewallRuleAction;

FirewallRuleAction.builder()
//  .mode(java.lang.String)
//  .response(FirewallRuleActionResponse)
//  .timeout(java.lang.Number)
    .build();

Properties

Name Type Description
mode java.lang.String The action to perform. Available values: "simulate", "ban", "challenge", "js_challenge", "managed_challenge".
response FirewallRuleActionResponse A custom content type and reponse to return when the threshold is exceeded.
timeout java.lang.Number The time in seconds during which Cloudflare will perform the mitigation action.
modeOptional 
public java.lang.String getMode();
  • Type: java.lang.String

The action to perform. Available values: "simulate", "ban", "challenge", "js_challenge", "managed_challenge".

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.19.1/docs/resources/firewall_rule#mode FirewallRule#mode}

responseOptional 
public FirewallRuleActionResponse getResponse();

A custom content type and reponse to return when the threshold is exceeded.

The custom response configured in this object will override the custom error for the zone. This object is optional. Notes: If you omit this object, Cloudflare will use the default HTML error page. If "mode" is "challenge", "managed_challenge", or "js_challenge", Cloudflare will use the zone challenge pages and you should not provide the "response" object.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.19.1/docs/resources/firewall_rule#response FirewallRule#response}

timeoutOptional 
public java.lang.Number getTimeout();
  • Type: java.lang.Number

The time in seconds during which Cloudflare will perform the mitigation action.

Must be an integer value greater than or equal to the period. Notes: If "mode" is "challenge", "managed_challenge", or "js_challenge", Cloudflare will use the zone's Challenge Passage time and you should not provide this value.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.19.1/docs/resources/firewall_rule#timeout FirewallRule#timeout}

FirewallRuleActionResponse

Initializer 

import io.cdktn.providers.cloudflare.firewall_rule.FirewallRuleActionResponse;

FirewallRuleActionResponse.builder()
//  .body(java.lang.String)
//  .contentType(java.lang.String)
    .build();

Properties

Name Type Description
body java.lang.String The response body to return. The value must conform to the configured content type.
contentType java.lang.String The content type of the body. Must be one of the following: text/plain, text/xml, or application/json.
bodyOptional 
public java.lang.String getBody();
  • Type: java.lang.String

The response body to return. The value must conform to the configured content type.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.19.1/docs/resources/firewall_rule#body FirewallRule#body}

contentTypeOptional 
public java.lang.String getContentType();
  • Type: java.lang.String

The content type of the body. Must be one of the following: text/plain, text/xml, or application/json.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.19.1/docs/resources/firewall_rule#content_type FirewallRule#content_type}

FirewallRuleConfig

Initializer 

import io.cdktn.providers.cloudflare.firewall_rule.FirewallRuleConfig;

FirewallRuleConfig.builder()
//  .connection(SSHProvisionerConnection|WinrmProvisionerConnection)
//  .count(java.lang.Number|TerraformCount)
//  .dependsOn(java.util.List<ITerraformDependable>)
//  .forEach(ITerraformIterator)
//  .lifecycle(TerraformResourceLifecycle)
//  .provider(TerraformProvider)
//  .provisioners(java.util.List<FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner>)
    .action(FirewallRuleAction)
    .filter(FirewallRuleFilter)
//  .zoneId(java.lang.String)
    .build();

Properties

Name Type Description
connection io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection No description.
count java.lang.Number|io.cdktn.cdktn.TerraformCount No description.
dependsOn java.util.List<io.cdktn.cdktn.ITerraformDependable> No description.
forEach io.cdktn.cdktn.ITerraformIterator No description.
lifecycle io.cdktn.cdktn.TerraformResourceLifecycle No description.
provider io.cdktn.cdktn.TerraformProvider No description.
provisioners java.util.List<io.cdktn.cdktn.FileProvisioner|io.cdktn.cdktn.LocalExecProvisioner|io.cdktn.cdktn.RemoteExecProvisioner> No description.
action FirewallRuleAction The action to perform when the threshold of matched traffic within the configured period is exceeded.
filter FirewallRuleFilter Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.19.1/docs/resources/firewall_rule#filter FirewallRule#filter}.
zoneId java.lang.String Defines an identifier.
connectionOptional 
public SSHProvisionerConnection|WinrmProvisionerConnection getConnection();
  • Type: io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection
countOptional 
public java.lang.Number|TerraformCount getCount();
  • Type: java.lang.Number|io.cdktn.cdktn.TerraformCount
dependsOnOptional 
public java.util.List<ITerraformDependable> getDependsOn();
  • Type: java.util.List<io.cdktn.cdktn.ITerraformDependable>
forEachOptional 
public ITerraformIterator getForEach();
  • Type: io.cdktn.cdktn.ITerraformIterator
lifecycleOptional 
public TerraformResourceLifecycle getLifecycle();
  • Type: io.cdktn.cdktn.TerraformResourceLifecycle
providerOptional 
public TerraformProvider getProvider();
  • Type: io.cdktn.cdktn.TerraformProvider
provisionersOptional 
public java.util.List<FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner> getProvisioners();
  • Type: java.util.List<io.cdktn.cdktn.FileProvisioner|io.cdktn.cdktn.LocalExecProvisioner|io.cdktn.cdktn.RemoteExecProvisioner>
actionRequired 
public FirewallRuleAction getAction();

The action to perform when the threshold of matched traffic within the configured period is exceeded.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.19.1/docs/resources/firewall_rule#action FirewallRule#action}

filterRequired 
public FirewallRuleFilter getFilter();

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.19.1/docs/resources/firewall_rule#filter FirewallRule#filter}.

zoneIdOptional 
public java.lang.String getZoneId();
  • Type: java.lang.String

Defines an identifier.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.19.1/docs/resources/firewall_rule#zone_id FirewallRule#zone_id}

FirewallRuleFilter

Initializer 

import io.cdktn.providers.cloudflare.firewall_rule.FirewallRuleFilter;

FirewallRuleFilter.builder()
//  .description(java.lang.String)
//  .expression(java.lang.String)
//  .paused(java.lang.Boolean|IResolvable)
//  .ref(java.lang.String)
    .build();

Properties

Name Type Description
description java.lang.String An informative summary of the filter.
expression java.lang.String The filter expression. For more information, refer to Expressions.
paused java.lang.Boolean|io.cdktn.cdktn.IResolvable When true, indicates that the filter is currently paused.
ref java.lang.String A short reference tag. Allows you to select related filters.
descriptionOptional 
public java.lang.String getDescription();
  • Type: java.lang.String

An informative summary of the filter.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.19.1/docs/resources/firewall_rule#description FirewallRule#description}

expressionOptional 
public java.lang.String getExpression();
  • Type: java.lang.String

The filter expression. For more information, refer to Expressions.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.19.1/docs/resources/firewall_rule#expression FirewallRule#expression}

pausedOptional 
public java.lang.Boolean|IResolvable getPaused();
  • Type: java.lang.Boolean|io.cdktn.cdktn.IResolvable

When true, indicates that the filter is currently paused.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.19.1/docs/resources/firewall_rule#paused FirewallRule#paused}

refOptional 
public java.lang.String getRef();
  • Type: java.lang.String

A short reference tag. Allows you to select related filters.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.19.1/docs/resources/firewall_rule#ref FirewallRule#ref}

Classes

FirewallRuleActionOutputReference

Initializers 

import io.cdktn.providers.cloudflare.firewall_rule.FirewallRuleActionOutputReference;

new FirewallRuleActionOutputReference(IInterpolatingParent terraformResource, java.lang.String terraformAttribute);
Name Type Description
terraformResource io.cdktn.cdktn.IInterpolatingParent The parent resource.
terraformAttribute java.lang.String The attribute on the parent resource this class is referencing.
terraformResourceRequired
  • Type: io.cdktn.cdktn.IInterpolatingParent

The parent resource.

terraformAttributeRequired
  • Type: java.lang.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.
putResponse No description.
resetMode No description.
resetResponse No description.
resetTimeout No description.
computeFqn 
public java.lang.String computeFqn()
getAnyMapAttribute 
public java.util.Map<java.lang.String, java.lang.Object> getAnyMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getBooleanAttribute 
public IResolvable getBooleanAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getBooleanMapAttribute 
public java.util.Map<java.lang.String, java.lang.Boolean> getBooleanMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getListAttribute 
public java.util.List<java.lang.String> getListAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getNumberAttribute 
public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getNumberListAttribute 
public java.util.List<java.lang.Number> getNumberListAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getNumberMapAttribute 
public java.util.Map<java.lang.String, java.lang.Number> getNumberMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getStringAttribute 
public java.lang.String getStringAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getStringMapAttribute 
public java.util.Map<java.lang.String, java.lang.String> getStringMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
interpolationForAttribute 
public IResolvable interpolationForAttribute(java.lang.String property)
propertyRequired
  • Type: java.lang.String
resolve 
public java.lang.Object resolve(IResolveContext _context)

Produce the Token's value at resolution time.

_contextRequired
  • Type: io.cdktn.cdktn.IResolveContext
toString 
public java.lang.String toString()

Return a string representation of this resolvable object.

Returns a reversible string representation.

putResponse 
public void putResponse(FirewallRuleActionResponse value)
valueRequired
resetMode 
public void resetMode()
resetResponse 
public void resetResponse()
resetTimeout 
public void resetTimeout()

Properties

Name Type Description
creationStack java.util.List<java.lang.String> The creation stack of this resolvable which will be appended to errors thrown during resolution.
fqn java.lang.String No description.
response FirewallRuleActionResponseOutputReference No description.
modeInput java.lang.String No description.
responseInput io.cdktn.cdktn.IResolvable|FirewallRuleActionResponse No description.
timeoutInput java.lang.Number No description.
mode java.lang.String No description.
timeout java.lang.Number No description.
internalValue io.cdktn.cdktn.IResolvable|FirewallRuleAction No description.
creationStackRequired 
public java.util.List<java.lang.String> getCreationStack();
  • Type: java.util.List<java.lang.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 java.lang.String getFqn();
  • Type: java.lang.String
responseRequired 
public FirewallRuleActionResponseOutputReference getResponse();
modeInputOptional 
public java.lang.String getModeInput();
  • Type: java.lang.String
responseInputOptional 
public IResolvable|FirewallRuleActionResponse getResponseInput();
timeoutInputOptional 
public java.lang.Number getTimeoutInput();
  • Type: java.lang.Number
modeRequired 
public java.lang.String getMode();
  • Type: java.lang.String
timeoutRequired 
public java.lang.Number getTimeout();
  • Type: java.lang.Number
internalValueOptional 
public IResolvable|FirewallRuleAction getInternalValue();

FirewallRuleActionResponseOutputReference

Initializers 

import io.cdktn.providers.cloudflare.firewall_rule.FirewallRuleActionResponseOutputReference;

new FirewallRuleActionResponseOutputReference(IInterpolatingParent terraformResource, java.lang.String terraformAttribute);
Name Type Description
terraformResource io.cdktn.cdktn.IInterpolatingParent The parent resource.
terraformAttribute java.lang.String The attribute on the parent resource this class is referencing.
terraformResourceRequired
  • Type: io.cdktn.cdktn.IInterpolatingParent

The parent resource.

terraformAttributeRequired
  • Type: java.lang.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.
resetBody No description.
resetContentType No description.
computeFqn 
public java.lang.String computeFqn()
getAnyMapAttribute 
public java.util.Map<java.lang.String, java.lang.Object> getAnyMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getBooleanAttribute 
public IResolvable getBooleanAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getBooleanMapAttribute 
public java.util.Map<java.lang.String, java.lang.Boolean> getBooleanMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getListAttribute 
public java.util.List<java.lang.String> getListAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getNumberAttribute 
public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getNumberListAttribute 
public java.util.List<java.lang.Number> getNumberListAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getNumberMapAttribute 
public java.util.Map<java.lang.String, java.lang.Number> getNumberMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getStringAttribute 
public java.lang.String getStringAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getStringMapAttribute 
public java.util.Map<java.lang.String, java.lang.String> getStringMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
interpolationForAttribute 
public IResolvable interpolationForAttribute(java.lang.String property)
propertyRequired
  • Type: java.lang.String
resolve 
public java.lang.Object resolve(IResolveContext _context)

Produce the Token's value at resolution time.

_contextRequired
  • Type: io.cdktn.cdktn.IResolveContext
toString 
public java.lang.String toString()

Return a string representation of this resolvable object.

Returns a reversible string representation.

resetBody 
public void resetBody()
resetContentType 
public void resetContentType()

Properties

Name Type Description
creationStack java.util.List<java.lang.String> The creation stack of this resolvable which will be appended to errors thrown during resolution.
fqn java.lang.String No description.
bodyInput java.lang.String No description.
contentTypeInput java.lang.String No description.
body java.lang.String No description.
contentType java.lang.String No description.
internalValue io.cdktn.cdktn.IResolvable|FirewallRuleActionResponse No description.
creationStackRequired 
public java.util.List<java.lang.String> getCreationStack();
  • Type: java.util.List<java.lang.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 java.lang.String getFqn();
  • Type: java.lang.String
bodyInputOptional 
public java.lang.String getBodyInput();
  • Type: java.lang.String
contentTypeInputOptional 
public java.lang.String getContentTypeInput();
  • Type: java.lang.String
bodyRequired 
public java.lang.String getBody();
  • Type: java.lang.String
contentTypeRequired 
public java.lang.String getContentType();
  • Type: java.lang.String
internalValueOptional 
public IResolvable|FirewallRuleActionResponse getInternalValue();

FirewallRuleFilterOutputReference

Initializers 

import io.cdktn.providers.cloudflare.firewall_rule.FirewallRuleFilterOutputReference;

new FirewallRuleFilterOutputReference(IInterpolatingParent terraformResource, java.lang.String terraformAttribute);
Name Type Description
terraformResource io.cdktn.cdktn.IInterpolatingParent The parent resource.
terraformAttribute java.lang.String The attribute on the parent resource this class is referencing.
terraformResourceRequired
  • Type: io.cdktn.cdktn.IInterpolatingParent

The parent resource.

terraformAttributeRequired
  • Type: java.lang.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.
resetPaused No description.
resetRef No description.
computeFqn 
public java.lang.String computeFqn()
getAnyMapAttribute 
public java.util.Map<java.lang.String, java.lang.Object> getAnyMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getBooleanAttribute 
public IResolvable getBooleanAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getBooleanMapAttribute 
public java.util.Map<java.lang.String, java.lang.Boolean> getBooleanMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getListAttribute 
public java.util.List<java.lang.String> getListAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getNumberAttribute 
public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getNumberListAttribute 
public java.util.List<java.lang.Number> getNumberListAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getNumberMapAttribute 
public java.util.Map<java.lang.String, java.lang.Number> getNumberMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getStringAttribute 
public java.lang.String getStringAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getStringMapAttribute 
public java.util.Map<java.lang.String, java.lang.String> getStringMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
interpolationForAttribute 
public IResolvable interpolationForAttribute(java.lang.String property)
propertyRequired
  • Type: java.lang.String
resolve 
public java.lang.Object resolve(IResolveContext _context)

Produce the Token's value at resolution time.

_contextRequired
  • Type: io.cdktn.cdktn.IResolveContext
toString 
public java.lang.String toString()

Return a string representation of this resolvable object.

Returns a reversible string representation.

resetDescription 
public void resetDescription()
resetExpression 
public void resetExpression()
resetPaused 
public void resetPaused()
resetRef 
public void resetRef()

Properties

Name Type Description
creationStack java.util.List<java.lang.String> The creation stack of this resolvable which will be appended to errors thrown during resolution.
fqn java.lang.String No description.
id java.lang.String No description.
descriptionInput java.lang.String No description.
expressionInput java.lang.String No description.
pausedInput java.lang.Boolean|io.cdktn.cdktn.IResolvable No description.
refInput java.lang.String No description.
description java.lang.String No description.
expression java.lang.String No description.
paused java.lang.Boolean|io.cdktn.cdktn.IResolvable No description.
ref java.lang.String No description.
internalValue io.cdktn.cdktn.IResolvable|FirewallRuleFilter No description.
creationStackRequired 
public java.util.List<java.lang.String> getCreationStack();
  • Type: java.util.List<java.lang.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 java.lang.String getFqn();
  • Type: java.lang.String
idRequired 
public java.lang.String getId();
  • Type: java.lang.String
descriptionInputOptional 
public java.lang.String getDescriptionInput();
  • Type: java.lang.String
expressionInputOptional 
public java.lang.String getExpressionInput();
  • Type: java.lang.String
pausedInputOptional 
public java.lang.Boolean|IResolvable getPausedInput();
  • Type: java.lang.Boolean|io.cdktn.cdktn.IResolvable
refInputOptional 
public java.lang.String getRefInput();
  • Type: java.lang.String
descriptionRequired 
public java.lang.String getDescription();
  • Type: java.lang.String
expressionRequired 
public java.lang.String getExpression();
  • Type: java.lang.String
pausedRequired 
public java.lang.Boolean|IResolvable getPaused();
  • Type: java.lang.Boolean|io.cdktn.cdktn.IResolvable
refRequired 
public java.lang.String getRef();
  • Type: java.lang.String
internalValueOptional 
public IResolvable|FirewallRuleFilter getInternalValue();