Skip to content

Latest commit

 

History

History
1159 lines (723 loc) · 47.7 KB

File metadata and controls

1159 lines (723 loc) · 47.7 KB

cloudforceOneRequest Submodule

Constructs

CloudforceOneRequest

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

Initializers

using Io.Cdktn.Providers.Cloudflare;

new CloudforceOneRequest(Construct Scope, string Id, CloudforceOneRequestConfig Config = null);
Name Type Description
Scope Constructs.Construct The scope in which to define this construct.
Id string The scoped construct ID.
Config CloudforceOneRequestConfig No description.

ScopeRequired
  • Type: Constructs.Construct

The scope in which to define this construct.


IdRequired
  • Type: string

The scoped construct ID.

Must be unique amongst siblings in the same scope


ConfigOptional

Methods

Name Description
ToString Returns a string representation of this construct.
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".
ResetAccountId No description.
ResetContent No description.
ResetPriority No description.
ResetRequestType No description.
ResetSummary No description.
ResetTlp 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.

MixinsRequired
  • Type: params Constructs.IMixin[]

The mixins to apply.


AddOverride
private void AddOverride(string Path, object Value)
PathRequired
  • Type: string

ValueRequired
  • Type: object

OverrideLogicalId
private void OverrideLogicalId(string NewLogicalId)

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

NewLogicalIdRequired
  • 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()
ToMetadata
private object ToMetadata()
ToTerraform
private object ToTerraform()

Adds this resource to the terraform JSON output.

AddMoveTarget
private void AddMoveTarget(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: string

The string move target that will correspond to this resource.


GetAnyMapAttribute
private System.Collections.Generic.IDictionary<string, object> GetAnyMapAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string

GetBooleanAttribute
private IResolvable GetBooleanAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string

GetBooleanMapAttribute
private System.Collections.Generic.IDictionary<string, bool> GetBooleanMapAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string

GetListAttribute
private string[] GetListAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string

GetNumberAttribute
private double GetNumberAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string

GetNumberListAttribute
private double[] GetNumberListAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string

GetNumberMapAttribute
private System.Collections.Generic.IDictionary<string, double> GetNumberMapAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string

GetStringAttribute
private string GetStringAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string

GetStringMapAttribute
private System.Collections.Generic.IDictionary<string, string> GetStringMapAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string

HasResourceMove
private TerraformResourceMoveByTarget|TerraformResourceMoveById HasResourceMove()
ImportFrom
private void ImportFrom(string Id, TerraformProvider Provider = null)
IdRequired
  • Type: string

ProviderOptional
  • Type: Io.Cdktn.TerraformProvider

InterpolationForAttribute
private IResolvable InterpolationForAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string

MoveFromId
private void MoveFromId(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: string

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


MoveTo
private void MoveTo(string MoveTarget, string|double Index = null)

Moves this resource to the target resource given by moveTarget.

MoveTargetRequired
  • Type: string

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


IndexOptional
  • Type: string|double

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


MoveToId
private void MoveToId(string Id)

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

IdRequired
  • Type: string

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


ResetAccountId
private void ResetAccountId()
ResetContent
private void ResetContent()
ResetPriority
private void ResetPriority()
ResetRequestType
private void ResetRequestType()
ResetSummary
private void ResetSummary()
ResetTlp
private void ResetTlp()

Static Functions

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

IsConstruct
using Io.Cdktn.Providers.Cloudflare;

CloudforceOneRequest.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.

XRequired
  • Type: object

Any object.


IsTerraformElement
using Io.Cdktn.Providers.Cloudflare;

CloudforceOneRequest.IsTerraformElement(object X);
XRequired
  • Type: object

IsTerraformResource
using Io.Cdktn.Providers.Cloudflare;

CloudforceOneRequest.IsTerraformResource(object X);
XRequired
  • Type: object

GenerateConfigForImport
using Io.Cdktn.Providers.Cloudflare;

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

Generates CDKTN code for importing a CloudforceOneRequest 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 CloudforceOneRequest to import.


ImportFromIdRequired
  • Type: string

The id of the existing CloudforceOneRequest that should be imported.

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


ProviderOptional
  • Type: Io.Cdktn.TerraformProvider

? Optional instance of the provider where the CloudforceOneRequest 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.
Connection Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection 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.
Provisioners Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.RemoteExecProvisioner[] No description.
Completed string No description.
Created string No description.
Id string No description.
MessageTokens double No description.
ReadableId string No description.
Request string No description.
Status string No description.
Tokens double No description.
Updated string No description.
AccountIdInput string No description.
ContentInput string No description.
PriorityInput string No description.
RequestTypeInput string No description.
SummaryInput string No description.
TlpInput string No description.
AccountId string No description.
Content string No description.
Priority string No description.
RequestType string No description.
Summary string No description.
Tlp string No description.

NodeRequired
public Node Node { get; }
  • Type: Constructs.Node

The tree node.


CdktfStackRequired
public TerraformStack CdktfStack { get; }
  • Type: Io.Cdktn.TerraformStack

FqnRequired
public string Fqn { get; }
  • Type: string

FriendlyUniqueIdRequired
public string FriendlyUniqueId { get; }
  • Type: string

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

TerraformResourceTypeRequired
public string TerraformResourceType { get; }
  • Type: string

TerraformGeneratorMetadataOptional
public TerraformProviderGeneratorMetadata TerraformGeneratorMetadata { get; }
  • Type: Io.Cdktn.TerraformProviderGeneratorMetadata

ConnectionOptional
public SSHProvisionerConnection|WinrmProvisionerConnection Connection { get; }
  • Type: Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection

CountOptional
public double|TerraformCount Count { get; }
  • Type: double|Io.Cdktn.TerraformCount

DependsOnOptional
public string[] DependsOn { get; }
  • Type: string[]

ForEachOptional
public ITerraformIterator ForEach { get; }
  • Type: Io.Cdktn.ITerraformIterator

LifecycleOptional
public TerraformResourceLifecycle Lifecycle { get; }
  • Type: Io.Cdktn.TerraformResourceLifecycle

ProviderOptional
public TerraformProvider Provider { get; }
  • Type: Io.Cdktn.TerraformProvider

ProvisionersOptional
public (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners { get; }
  • Type: Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.RemoteExecProvisioner[]

CompletedRequired
public string Completed { get; }
  • Type: string

CreatedRequired
public string Created { get; }
  • Type: string

IdRequired
public string Id { get; }
  • Type: string

MessageTokensRequired
public double MessageTokens { get; }
  • Type: double

ReadableIdRequired
public string ReadableId { get; }
  • Type: string

RequestRequired
public string Request { get; }
  • Type: string

StatusRequired
public string Status { get; }
  • Type: string

TokensRequired
public double Tokens { get; }
  • Type: double

UpdatedRequired
public string Updated { get; }
  • Type: string

AccountIdInputOptional
public string AccountIdInput { get; }
  • Type: string

ContentInputOptional
public string ContentInput { get; }
  • Type: string

PriorityInputOptional
public string PriorityInput { get; }
  • Type: string

RequestTypeInputOptional
public string RequestTypeInput { get; }
  • Type: string

SummaryInputOptional
public string SummaryInput { get; }
  • Type: string

TlpInputOptional
public string TlpInput { get; }
  • Type: string

AccountIdRequired
public string AccountId { get; }
  • Type: string

ContentRequired
public string Content { get; }
  • Type: string

PriorityRequired
public string Priority { get; }
  • Type: string

RequestTypeRequired
public string RequestType { get; }
  • Type: string

SummaryRequired
public string Summary { get; }
  • Type: string

TlpRequired
public string Tlp { get; }
  • Type: string

Constants

Name Type Description
TfResourceType string No description.

TfResourceTypeRequired
public string TfResourceType { get; }
  • Type: string

Structs

CloudforceOneRequestConfig

Initializer

using Io.Cdktn.Providers.Cloudflare;

new CloudforceOneRequestConfig {
    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,
    string AccountId = null,
    string Content = null,
    string Priority = null,
    string RequestType = null,
    string Summary = null,
    string Tlp = 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.
AccountId string Identifier.
Content string Request content.
Priority string Priority for analyzing the request.
RequestType string Requested information from request.
Summary string Brief description of the request.
Tlp string The CISA defined Traffic Light Protocol (TLP). Available values: "clear", "amber", "amber-strict", "green", "red".

ConnectionOptional
public SSHProvisionerConnection|WinrmProvisionerConnection Connection { get; set; }
  • Type: Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection

CountOptional
public double|TerraformCount Count { get; set; }
  • Type: double|Io.Cdktn.TerraformCount

DependsOnOptional
public ITerraformDependable[] DependsOn { get; set; }
  • Type: Io.Cdktn.ITerraformDependable[]

ForEachOptional
public ITerraformIterator ForEach { get; set; }
  • Type: Io.Cdktn.ITerraformIterator

LifecycleOptional
public TerraformResourceLifecycle Lifecycle { get; set; }
  • Type: Io.Cdktn.TerraformResourceLifecycle

ProviderOptional
public TerraformProvider Provider { get; set; }
  • Type: Io.Cdktn.TerraformProvider

ProvisionersOptional
public (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners { get; set; }
  • Type: Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.RemoteExecProvisioner[]

AccountIdOptional
public string AccountId { get; set; }
  • Type: string

Identifier.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.19.1/docs/resources/cloudforce_one_request#account_id CloudforceOneRequest#account_id}


ContentOptional
public string Content { get; set; }
  • Type: string

Request content.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.19.1/docs/resources/cloudforce_one_request#content CloudforceOneRequest#content}


PriorityOptional
public string Priority { get; set; }
  • Type: string

Priority for analyzing the request.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.19.1/docs/resources/cloudforce_one_request#priority CloudforceOneRequest#priority}


RequestTypeOptional
public string RequestType { get; set; }
  • Type: string

Requested information from request.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.19.1/docs/resources/cloudforce_one_request#request_type CloudforceOneRequest#request_type}


SummaryOptional
public string Summary { get; set; }
  • Type: string

Brief description of the request.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.19.1/docs/resources/cloudforce_one_request#summary CloudforceOneRequest#summary}


TlpOptional
public string Tlp { get; set; }
  • Type: string

The CISA defined Traffic Light Protocol (TLP). Available values: "clear", "amber", "amber-strict", "green", "red".

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.19.1/docs/resources/cloudforce_one_request#tlp CloudforceOneRequest#tlp}