Skip to content

Latest commit

 

History

History
1266 lines (795 loc) · 51.2 KB

lambdaPermission.csharp.md

File metadata and controls

1266 lines (795 loc) · 51.2 KB

lambdaPermission Submodule

Constructs

LambdaPermission

Represents a {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/lambda_permission aws_lambda_permission}.

Initializers

using HashiCorp.Cdktf.Providers.Aws;

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

ScopeRequired
  • Type: Constructs.Construct

The scope in which to define this construct.


IdRequired
  • Type: string

The scoped construct ID.

Must be unique amongst siblings in the same scope


ConfigRequired

Methods

Name Description
ToString Returns a string representation of this construct.
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".
ResetEventSourceToken No description.
ResetFunctionUrlAuthType No description.
ResetId No description.
ResetPrincipalOrgId No description.
ResetQualifier No description.
ResetSourceAccount No description.
ResetSourceArn No description.
ResetStatementId No description.
ResetStatementIdPrefix No description.

ToString
private string ToString()

Returns a string representation of this construct.

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 object HasResourceMove()
ImportFrom
private void ImportFrom(string Id, TerraformProvider Provider = null)
IdRequired
  • Type: string

ProviderOptional
  • Type: HashiCorp.Cdktf.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, object 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: object

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


ResetEventSourceToken
private void ResetEventSourceToken()
ResetFunctionUrlAuthType
private void ResetFunctionUrlAuthType()
ResetId
private void ResetId()
ResetPrincipalOrgId
private void ResetPrincipalOrgId()
ResetQualifier
private void ResetQualifier()
ResetSourceAccount
private void ResetSourceAccount()
ResetSourceArn
private void ResetSourceArn()
ResetStatementId
private void ResetStatementId()
ResetStatementIdPrefix
private void ResetStatementIdPrefix()

Static Functions

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

IsConstruct
using HashiCorp.Cdktf.Providers.Aws;

LambdaPermission.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 HashiCorp.Cdktf.Providers.Aws;

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

IsTerraformResource
using HashiCorp.Cdktf.Providers.Aws;

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

GenerateConfigForImport
using HashiCorp.Cdktf.Providers.Aws;

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

Generates CDKTF code for importing a LambdaPermission resource upon running "cdktf 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 LambdaPermission to import.


ImportFromIdRequired
  • Type: string

The id of the existing LambdaPermission that should be imported.

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


ProviderOptional
  • Type: HashiCorp.Cdktf.TerraformProvider

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


Properties

Name Type Description
Node Constructs.Node The tree node.
CdktfStack HashiCorp.Cdktf.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 HashiCorp.Cdktf.TerraformProviderGeneratorMetadata No description.
Connection object No description.
Count object No description.
DependsOn string[] No description.
ForEach HashiCorp.Cdktf.ITerraformIterator No description.
Lifecycle HashiCorp.Cdktf.TerraformResourceLifecycle No description.
Provider HashiCorp.Cdktf.TerraformProvider No description.
Provisioners object[] No description.
ActionInput string No description.
EventSourceTokenInput string No description.
FunctionNameInput string No description.
FunctionUrlAuthTypeInput string No description.
IdInput string No description.
PrincipalInput string No description.
PrincipalOrgIdInput string No description.
QualifierInput string No description.
SourceAccountInput string No description.
SourceArnInput string No description.
StatementIdInput string No description.
StatementIdPrefixInput string No description.
Action string No description.
EventSourceToken string No description.
FunctionName string No description.
FunctionUrlAuthType string No description.
Id string No description.
Principal string No description.
PrincipalOrgId string No description.
Qualifier string No description.
SourceAccount string No description.
SourceArn string No description.
StatementId string No description.
StatementIdPrefix string No description.

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

The tree node.


CdktfStackRequired
public TerraformStack CdktfStack { get; }
  • Type: HashiCorp.Cdktf.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: HashiCorp.Cdktf.TerraformProviderGeneratorMetadata

ConnectionOptional
public object Connection { get; }
  • Type: object

CountOptional
public object Count { get; }
  • Type: object

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

ForEachOptional
public ITerraformIterator ForEach { get; }
  • Type: HashiCorp.Cdktf.ITerraformIterator

LifecycleOptional
public TerraformResourceLifecycle Lifecycle { get; }
  • Type: HashiCorp.Cdktf.TerraformResourceLifecycle

ProviderOptional
public TerraformProvider Provider { get; }
  • Type: HashiCorp.Cdktf.TerraformProvider

ProvisionersOptional
public object[] Provisioners { get; }
  • Type: object[]

ActionInputOptional
public string ActionInput { get; }
  • Type: string

EventSourceTokenInputOptional
public string EventSourceTokenInput { get; }
  • Type: string

FunctionNameInputOptional
public string FunctionNameInput { get; }
  • Type: string

FunctionUrlAuthTypeInputOptional
public string FunctionUrlAuthTypeInput { get; }
  • Type: string

IdInputOptional
public string IdInput { get; }
  • Type: string

PrincipalInputOptional
public string PrincipalInput { get; }
  • Type: string

PrincipalOrgIdInputOptional
public string PrincipalOrgIdInput { get; }
  • Type: string

QualifierInputOptional
public string QualifierInput { get; }
  • Type: string

SourceAccountInputOptional
public string SourceAccountInput { get; }
  • Type: string

SourceArnInputOptional
public string SourceArnInput { get; }
  • Type: string

StatementIdInputOptional
public string StatementIdInput { get; }
  • Type: string

StatementIdPrefixInputOptional
public string StatementIdPrefixInput { get; }
  • Type: string

ActionRequired
public string Action { get; }
  • Type: string

EventSourceTokenRequired
public string EventSourceToken { get; }
  • Type: string

FunctionNameRequired
public string FunctionName { get; }
  • Type: string

FunctionUrlAuthTypeRequired
public string FunctionUrlAuthType { get; }
  • Type: string

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

PrincipalRequired
public string Principal { get; }
  • Type: string

PrincipalOrgIdRequired
public string PrincipalOrgId { get; }
  • Type: string

QualifierRequired
public string Qualifier { get; }
  • Type: string

SourceAccountRequired
public string SourceAccount { get; }
  • Type: string

SourceArnRequired
public string SourceArn { get; }
  • Type: string

StatementIdRequired
public string StatementId { get; }
  • Type: string

StatementIdPrefixRequired
public string StatementIdPrefix { get; }
  • Type: string

Constants

Name Type Description
TfResourceType string No description.

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

Structs

LambdaPermissionConfig

Initializer

using HashiCorp.Cdktf.Providers.Aws;

new LambdaPermissionConfig {
    object Connection = null,
    object Count = null,
    ITerraformDependable[] DependsOn = null,
    ITerraformIterator ForEach = null,
    TerraformResourceLifecycle Lifecycle = null,
    TerraformProvider Provider = null,
    object[] Provisioners = null,
    string Action,
    string FunctionName,
    string Principal,
    string EventSourceToken = null,
    string FunctionUrlAuthType = null,
    string Id = null,
    string PrincipalOrgId = null,
    string Qualifier = null,
    string SourceAccount = null,
    string SourceArn = null,
    string StatementId = null,
    string StatementIdPrefix = null
};

Properties

Name Type Description
Connection object No description.
Count object No description.
DependsOn HashiCorp.Cdktf.ITerraformDependable[] No description.
ForEach HashiCorp.Cdktf.ITerraformIterator No description.
Lifecycle HashiCorp.Cdktf.TerraformResourceLifecycle No description.
Provider HashiCorp.Cdktf.TerraformProvider No description.
Provisioners object[] No description.
Action string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/lambda_permission#action LambdaPermission#action}.
FunctionName string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/lambda_permission#function_name LambdaPermission#function_name}.
Principal string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/lambda_permission#principal LambdaPermission#principal}.
EventSourceToken string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/lambda_permission#event_source_token LambdaPermission#event_source_token}.
FunctionUrlAuthType string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/lambda_permission#function_url_auth_type LambdaPermission#function_url_auth_type}.
Id string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/lambda_permission#id LambdaPermission#id}.
PrincipalOrgId string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/lambda_permission#principal_org_id LambdaPermission#principal_org_id}.
Qualifier string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/lambda_permission#qualifier LambdaPermission#qualifier}.
SourceAccount string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/lambda_permission#source_account LambdaPermission#source_account}.
SourceArn string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/lambda_permission#source_arn LambdaPermission#source_arn}.
StatementId string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/lambda_permission#statement_id LambdaPermission#statement_id}.
StatementIdPrefix string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/lambda_permission#statement_id_prefix LambdaPermission#statement_id_prefix}.

ConnectionOptional
public object Connection { get; set; }
  • Type: object

CountOptional
public object Count { get; set; }
  • Type: object

DependsOnOptional
public ITerraformDependable[] DependsOn { get; set; }
  • Type: HashiCorp.Cdktf.ITerraformDependable[]

ForEachOptional
public ITerraformIterator ForEach { get; set; }
  • Type: HashiCorp.Cdktf.ITerraformIterator

LifecycleOptional
public TerraformResourceLifecycle Lifecycle { get; set; }
  • Type: HashiCorp.Cdktf.TerraformResourceLifecycle

ProviderOptional
public TerraformProvider Provider { get; set; }
  • Type: HashiCorp.Cdktf.TerraformProvider

ProvisionersOptional
public object[] Provisioners { get; set; }
  • Type: object[]

ActionRequired
public string Action { get; set; }
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/lambda_permission#action LambdaPermission#action}.


FunctionNameRequired
public string FunctionName { get; set; }
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/lambda_permission#function_name LambdaPermission#function_name}.


PrincipalRequired
public string Principal { get; set; }
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/lambda_permission#principal LambdaPermission#principal}.


EventSourceTokenOptional
public string EventSourceToken { get; set; }
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/lambda_permission#event_source_token LambdaPermission#event_source_token}.


FunctionUrlAuthTypeOptional
public string FunctionUrlAuthType { get; set; }
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/lambda_permission#function_url_auth_type LambdaPermission#function_url_auth_type}.


IdOptional
public string Id { get; set; }
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/lambda_permission#id LambdaPermission#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.


PrincipalOrgIdOptional
public string PrincipalOrgId { get; set; }
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/lambda_permission#principal_org_id LambdaPermission#principal_org_id}.


QualifierOptional
public string Qualifier { get; set; }
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/lambda_permission#qualifier LambdaPermission#qualifier}.


SourceAccountOptional
public string SourceAccount { get; set; }
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/lambda_permission#source_account LambdaPermission#source_account}.


SourceArnOptional
public string SourceArn { get; set; }
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/lambda_permission#source_arn LambdaPermission#source_arn}.


StatementIdOptional
public string StatementId { get; set; }
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/lambda_permission#statement_id LambdaPermission#statement_id}.


StatementIdPrefixOptional
public string StatementIdPrefix { get; set; }
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/lambda_permission#statement_id_prefix LambdaPermission#statement_id_prefix}.