Skip to content
This repository has been archived by the owner on Jun 11, 2024. It is now read-only.

Latest commit

 

History

History
1674 lines (1030 loc) · 67.1 KB

API.md

File metadata and controls

1674 lines (1030 loc) · 67.1 KB
Raw

API Reference

Constructs

IamPolicy

Initializers 

import { fusionaws } from '@slalombuild/fusion-cdk'

new fusionaws.IamPolicy(scope: Construct, id: string, options: IamPolicyProps)
Name Type Description
scope constructs.Construct — The scope in which to define this construct.
id string — The scoped construct ID.
options @slalombuild/fusion-cdk.fusionaws.IamPolicyProps — IamPolicyProps.
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.

optionsRequired
  • Type: @slalombuild/fusion-cdk.fusionaws.IamPolicyProps

— IamPolicyProps.

Methods

Name Description
toString Returns a string representation of this construct.
toString 
public toString(): string

Returns a string representation of this construct.

Static Functions

Name Description
isConstruct Checks if x is a construct.
isConstruct 
import { fusionaws } from '@slalombuild/fusion-cdk'

fusionaws.IamPolicy.isConstruct(x: any)

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

xRequired
  • Type: any

Any object.

Properties

Name Type Description
node constructs.Node The tree node.
construct @cdktf/provider-aws.iam.IamPolicy No description.
nodeRequired 
public readonly node: Node;
  • Type: constructs.Node

The tree node.

constructRequired 
public readonly construct: IamPolicy;
  • Type: @cdktf/provider-aws.iam.IamPolicy

IamRole

Initializers 

import { fusionaws } from '@slalombuild/fusion-cdk'

new fusionaws.IamRole(scope: Construct, id: string, options: IamRoleProps)
Name Type Description
scope constructs.Construct — The scope in which to define this construct.
id string — The scoped construct ID.
options @slalombuild/fusion-cdk.fusionaws.IamRoleProps — IamRoleProps.
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.

optionsRequired
  • Type: @slalombuild/fusion-cdk.fusionaws.IamRoleProps

— IamRoleProps.

Methods

Name Description
toString Returns a string representation of this construct.
toString 
public toString(): string

Returns a string representation of this construct.

Static Functions

Name Description
isConstruct Checks if x is a construct.
isConstruct 
import { fusionaws } from '@slalombuild/fusion-cdk'

fusionaws.IamRole.isConstruct(x: any)

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

xRequired
  • Type: any

Any object.

Properties

Name Type Description
node constructs.Node The tree node.
construct @cdktf/provider-aws.iam.IamRole No description.
nodeRequired 
public readonly node: Node;
  • Type: constructs.Node

The tree node.

constructRequired 
public readonly construct: IamRole;
  • Type: @cdktf/provider-aws.iam.IamRole

S3Bucket

Initializers 

import { fusionaws } from '@slalombuild/fusion-cdk'

new fusionaws.S3Bucket(scope: Construct, id: string, options: S3BucketProps)
Name Type Description
scope constructs.Construct — The scope in which to define this construct.
id string — The scoped construct ID.
options @slalombuild/fusion-cdk.fusionaws.S3BucketProps — S3BucketProps.
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.

optionsRequired
  • Type: @slalombuild/fusion-cdk.fusionaws.S3BucketProps

— S3BucketProps.

Methods

Name Description
toString Returns a string representation of this construct.
toString 
public toString(): string

Returns a string representation of this construct.

Static Functions

Name Description
isConstruct Checks if x is a construct.
isConstruct 
import { fusionaws } from '@slalombuild/fusion-cdk'

fusionaws.S3Bucket.isConstruct(x: any)

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

xRequired
  • Type: any

Any object.

Properties

Name Type Description
node constructs.Node The tree node.
construct @cdktf/provider-aws.s3.S3Bucket No description.
nodeRequired 
public readonly node: Node;
  • Type: constructs.Node

The tree node.

constructRequired 
public readonly construct: S3Bucket;
  • Type: @cdktf/provider-aws.s3.S3Bucket

SecurityGroup

Initializers 

import { fusionaws } from '@slalombuild/fusion-cdk'

new fusionaws.SecurityGroup(scope: Construct, id: string, options: SecurityGroupProps)
Name Type Description
scope constructs.Construct — The scope in which to define this construct.
id string — The scoped construct ID.
options @slalombuild/fusion-cdk.fusionaws.SecurityGroupProps — SecurityGroupProps.
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.

optionsRequired
  • Type: @slalombuild/fusion-cdk.fusionaws.SecurityGroupProps

— SecurityGroupProps.

Methods

Name Description
toString Returns a string representation of this construct.
toString 
public toString(): string

Returns a string representation of this construct.

Static Functions

Name Description
isConstruct Checks if x is a construct.
isConstruct 
import { fusionaws } from '@slalombuild/fusion-cdk'

fusionaws.SecurityGroup.isConstruct(x: any)

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

xRequired
  • Type: any

Any object.

Properties

Name Type Description
node constructs.Node The tree node.
construct @cdktf/provider-aws.vpc.SecurityGroup No description.
nodeRequired 
public readonly node: Node;
  • Type: constructs.Node

The tree node.

constructRequired 
public readonly construct: SecurityGroup;
  • Type: @cdktf/provider-aws.vpc.SecurityGroup

Structs

IamPolicyProps

Initializer 

import { fusionaws } from '@slalombuild/fusion-cdk'

const iamPolicyProps: fusionaws.IamPolicyProps = { ... }

Properties

Name Type Description
connection cdktf.ISSHProvisionerConnection | cdktf.IWinrmProvisionerConnection No description.
count number No description.
dependsOn cdktf.ITerraformDependable[] No description.
forEach cdktf.ITerraformIterator No description.
lifecycle cdktf.TerraformResourceLifecycle No description.
provider cdktf.TerraformProvider No description.
provisioners cdktf.IFileProvisioner | cdktf.ILocalExecProvisioner | cdktf.IRemoteExecProvisioner[] No description.
policy string Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/aws/r/iam_policy#policy IamPolicy#policy}.
description string Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/aws/r/iam_policy#description IamPolicy#description}.
id string Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/aws/r/iam_policy#id IamPolicy#id}.
name string Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/aws/r/iam_policy#name IamPolicy#name}.
namePrefix string Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/aws/r/iam_policy#name_prefix IamPolicy#name_prefix}.
path string Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/aws/r/iam_policy#path IamPolicy#path}.
tags {[ key: string ]: string} Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/aws/r/iam_policy#tags IamPolicy#tags}.
tagsAll {[ key: string ]: string} Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/aws/r/iam_policy#tags_all IamPolicy#tags_all}.
connectionOptional 
public readonly connection: ISSHProvisionerConnection | IWinrmProvisionerConnection;
  • Type: cdktf.ISSHProvisionerConnection | cdktf.IWinrmProvisionerConnection
countOptional 
public readonly count: number;
  • Type: number
dependsOnOptional 
public readonly dependsOn: ITerraformDependable[];
  • Type: cdktf.ITerraformDependable[]
forEachOptional 
public readonly forEach: ITerraformIterator;
  • Type: cdktf.ITerraformIterator
lifecycleOptional 
public readonly lifecycle: TerraformResourceLifecycle;
  • Type: cdktf.TerraformResourceLifecycle
providerOptional 
public readonly provider: TerraformProvider;
  • Type: cdktf.TerraformProvider
provisionersOptional 
public readonly provisioners: IFileProvisioner | ILocalExecProvisioner | IRemoteExecProvisioner[];
  • Type: cdktf.IFileProvisioner | cdktf.ILocalExecProvisioner | cdktf.IRemoteExecProvisioner[]
policyRequired 
public readonly policy: string;
  • Type: string

Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/aws/r/iam_policy#policy IamPolicy#policy}.

descriptionOptional 
public readonly description: string;
  • Type: string

Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/aws/r/iam_policy#description IamPolicy#description}.

idOptional 
public readonly id: string;
  • Type: string

Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/aws/r/iam_policy#id IamPolicy#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.

nameOptional 
public readonly name: string;
  • Type: string

Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/aws/r/iam_policy#name IamPolicy#name}.

namePrefixOptional 
public readonly namePrefix: string;
  • Type: string

Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/aws/r/iam_policy#name_prefix IamPolicy#name_prefix}.

pathOptional 
public readonly path: string;
  • Type: string

Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/aws/r/iam_policy#path IamPolicy#path}.

tagsOptional 
public readonly tags: {[ key: string ]: string};
  • Type: {[ key: string ]: string}

Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/aws/r/iam_policy#tags IamPolicy#tags}.

tagsAllOptional 
public readonly tagsAll: {[ key: string ]: string};
  • Type: {[ key: string ]: string}

Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/aws/r/iam_policy#tags_all IamPolicy#tags_all}.

IamRoleProps

Initializer 

import { fusionaws } from '@slalombuild/fusion-cdk'

const iamRoleProps: fusionaws.IamRoleProps = { ... }

Properties

Name Type Description
connection cdktf.ISSHProvisionerConnection | cdktf.IWinrmProvisionerConnection No description.
count number No description.
dependsOn cdktf.ITerraformDependable[] No description.
forEach cdktf.ITerraformIterator No description.
lifecycle cdktf.TerraformResourceLifecycle No description.
provider cdktf.TerraformProvider No description.
provisioners cdktf.IFileProvisioner | cdktf.ILocalExecProvisioner | cdktf.IRemoteExecProvisioner[] No description.
assumeRolePolicy string Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/aws/r/iam_role#assume_role_policy IamRole#assume_role_policy}.
description string Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/aws/r/iam_role#description IamRole#description}.
forceDetachPolicies boolean | cdktf.IResolvable Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/aws/r/iam_role#force_detach_policies IamRole#force_detach_policies}.
id string Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/aws/r/iam_role#id IamRole#id}.
inlinePolicy cdktf.IResolvable | @cdktf/provider-aws.iam.IamRoleInlinePolicy[] inline_policy block.
managedPolicyArns string[] Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/aws/r/iam_role#managed_policy_arns IamRole#managed_policy_arns}.
maxSessionDuration number Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/aws/r/iam_role#max_session_duration IamRole#max_session_duration}.
name string Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/aws/r/iam_role#name IamRole#name}.
namePrefix string Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/aws/r/iam_role#name_prefix IamRole#name_prefix}.
path string Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/aws/r/iam_role#path IamRole#path}.
permissionsBoundary string Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/aws/r/iam_role#permissions_boundary IamRole#permissions_boundary}.
tags {[ key: string ]: string} Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/aws/r/iam_role#tags IamRole#tags}.
tagsAll {[ key: string ]: string} Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/aws/r/iam_role#tags_all IamRole#tags_all}.
connectionOptional 
public readonly connection: ISSHProvisionerConnection | IWinrmProvisionerConnection;
  • Type: cdktf.ISSHProvisionerConnection | cdktf.IWinrmProvisionerConnection
countOptional 
public readonly count: number;
  • Type: number
dependsOnOptional 
public readonly dependsOn: ITerraformDependable[];
  • Type: cdktf.ITerraformDependable[]
forEachOptional 
public readonly forEach: ITerraformIterator;
  • Type: cdktf.ITerraformIterator
lifecycleOptional 
public readonly lifecycle: TerraformResourceLifecycle;
  • Type: cdktf.TerraformResourceLifecycle
providerOptional 
public readonly provider: TerraformProvider;
  • Type: cdktf.TerraformProvider
provisionersOptional 
public readonly provisioners: IFileProvisioner | ILocalExecProvisioner | IRemoteExecProvisioner[];
  • Type: cdktf.IFileProvisioner | cdktf.ILocalExecProvisioner | cdktf.IRemoteExecProvisioner[]
assumeRolePolicyRequired 
public readonly assumeRolePolicy: string;
  • Type: string

Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/aws/r/iam_role#assume_role_policy IamRole#assume_role_policy}.

descriptionOptional 
public readonly description: string;
  • Type: string

Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/aws/r/iam_role#description IamRole#description}.

forceDetachPoliciesOptional 
public readonly forceDetachPolicies: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/aws/r/iam_role#force_detach_policies IamRole#force_detach_policies}.

idOptional 
public readonly id: string;
  • Type: string

Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/aws/r/iam_role#id IamRole#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.

inlinePolicyOptional 
public readonly inlinePolicy: IResolvable | IamRoleInlinePolicy[];
  • Type: cdktf.IResolvable | @cdktf/provider-aws.iam.IamRoleInlinePolicy[]

inline_policy block.

Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/aws/r/iam_role#inline_policy IamRole#inline_policy}

managedPolicyArnsOptional 
public readonly managedPolicyArns: string[];
  • Type: string[]

Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/aws/r/iam_role#managed_policy_arns IamRole#managed_policy_arns}.

maxSessionDurationOptional 
public readonly maxSessionDuration: number;
  • Type: number

Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/aws/r/iam_role#max_session_duration IamRole#max_session_duration}.

nameOptional 
public readonly name: string;
  • Type: string

Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/aws/r/iam_role#name IamRole#name}.

namePrefixOptional 
public readonly namePrefix: string;
  • Type: string

Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/aws/r/iam_role#name_prefix IamRole#name_prefix}.

pathOptional 
public readonly path: string;
  • Type: string

Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/aws/r/iam_role#path IamRole#path}.

permissionsBoundaryOptional 
public readonly permissionsBoundary: string;
  • Type: string

Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/aws/r/iam_role#permissions_boundary IamRole#permissions_boundary}.

tagsOptional 
public readonly tags: {[ key: string ]: string};
  • Type: {[ key: string ]: string}

Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/aws/r/iam_role#tags IamRole#tags}.

tagsAllOptional 
public readonly tagsAll: {[ key: string ]: string};
  • Type: {[ key: string ]: string}

Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/aws/r/iam_role#tags_all IamRole#tags_all}.

S3BucketProps

Initializer 

import { fusionaws } from '@slalombuild/fusion-cdk'

const s3BucketProps: fusionaws.S3BucketProps = { ... }

Properties

Name Type Description
connection cdktf.ISSHProvisionerConnection | cdktf.IWinrmProvisionerConnection No description.
count number No description.
dependsOn cdktf.ITerraformDependable[] No description.
forEach cdktf.ITerraformIterator No description.
lifecycle cdktf.TerraformResourceLifecycle No description.
provider cdktf.TerraformProvider No description.
provisioners cdktf.IFileProvisioner | cdktf.ILocalExecProvisioner | cdktf.IRemoteExecProvisioner[] No description.
accelerationStatus string Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/aws/r/s3_bucket#acceleration_status S3Bucket#acceleration_status}.
acl string Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/aws/r/s3_bucket#acl S3Bucket#acl}.
arn string Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/aws/r/s3_bucket#arn S3Bucket#arn}.
bucket string Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/aws/r/s3_bucket#bucket S3Bucket#bucket}.
bucketPrefix string Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/aws/r/s3_bucket#bucket_prefix S3Bucket#bucket_prefix}.
corsRule cdktf.IResolvable | @cdktf/provider-aws.s3.S3BucketCorsRule[] cors_rule block.
forceDestroy boolean | cdktf.IResolvable Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/aws/r/s3_bucket#force_destroy S3Bucket#force_destroy}.
grant cdktf.IResolvable | @cdktf/provider-aws.s3.S3BucketGrant[] grant block.
hostedZoneId string Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/aws/r/s3_bucket#hosted_zone_id S3Bucket#hosted_zone_id}.
id string Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/aws/r/s3_bucket#id S3Bucket#id}.
lifecycleRule cdktf.IResolvable | @cdktf/provider-aws.s3.S3BucketLifecycleRule[] lifecycle_rule block.
logging @cdktf/provider-aws.s3.S3BucketLogging logging block.
objectLockConfiguration @cdktf/provider-aws.s3.S3BucketObjectLockConfiguration object_lock_configuration block.
objectLockEnabled boolean | cdktf.IResolvable Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/aws/r/s3_bucket#object_lock_enabled S3Bucket#object_lock_enabled}.
policy string Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/aws/r/s3_bucket#policy S3Bucket#policy}.
replicationConfiguration @cdktf/provider-aws.s3.S3BucketReplicationConfiguration replication_configuration block.
requestPayer string Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/aws/r/s3_bucket#request_payer S3Bucket#request_payer}.
serverSideEncryptionConfiguration @cdktf/provider-aws.s3.S3BucketServerSideEncryptionConfiguration server_side_encryption_configuration block.
tags {[ key: string ]: string} Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/aws/r/s3_bucket#tags S3Bucket#tags}.
tagsAll {[ key: string ]: string} Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/aws/r/s3_bucket#tags_all S3Bucket#tags_all}.
timeouts @cdktf/provider-aws.s3.S3BucketTimeouts timeouts block.
versioning @cdktf/provider-aws.s3.S3BucketVersioning versioning block.
website @cdktf/provider-aws.s3.S3BucketWebsite website block.
encryptionKey @cdktf/provider-aws.kms.KmsKey | string No description.
connectionOptional 
public readonly connection: ISSHProvisionerConnection | IWinrmProvisionerConnection;
  • Type: cdktf.ISSHProvisionerConnection | cdktf.IWinrmProvisionerConnection
countOptional 
public readonly count: number;
  • Type: number
dependsOnOptional 
public readonly dependsOn: ITerraformDependable[];
  • Type: cdktf.ITerraformDependable[]
forEachOptional 
public readonly forEach: ITerraformIterator;
  • Type: cdktf.ITerraformIterator
lifecycleOptional 
public readonly lifecycle: TerraformResourceLifecycle;
  • Type: cdktf.TerraformResourceLifecycle
providerOptional 
public readonly provider: TerraformProvider;
  • Type: cdktf.TerraformProvider
provisionersOptional 
public readonly provisioners: IFileProvisioner | ILocalExecProvisioner | IRemoteExecProvisioner[];
  • Type: cdktf.IFileProvisioner | cdktf.ILocalExecProvisioner | cdktf.IRemoteExecProvisioner[]
accelerationStatusOptional 
public readonly accelerationStatus: string;
  • Type: string

Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/aws/r/s3_bucket#acceleration_status S3Bucket#acceleration_status}.

aclOptional 
public readonly acl: string;
  • Type: string

Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/aws/r/s3_bucket#acl S3Bucket#acl}.

arnOptional 
public readonly arn: string;
  • Type: string

Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/aws/r/s3_bucket#arn S3Bucket#arn}.

bucketOptional 
public readonly bucket: string;
  • Type: string

Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/aws/r/s3_bucket#bucket S3Bucket#bucket}.

bucketPrefixOptional 
public readonly bucketPrefix: string;
  • Type: string

Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/aws/r/s3_bucket#bucket_prefix S3Bucket#bucket_prefix}.

corsRuleOptional 
public readonly corsRule: IResolvable | S3BucketCorsRule[];
  • Type: cdktf.IResolvable | @cdktf/provider-aws.s3.S3BucketCorsRule[]

cors_rule block.

Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/aws/r/s3_bucket#cors_rule S3Bucket#cors_rule}

forceDestroyOptional 
public readonly forceDestroy: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/aws/r/s3_bucket#force_destroy S3Bucket#force_destroy}.

grantOptional 
public readonly grant: IResolvable | S3BucketGrant[];
  • Type: cdktf.IResolvable | @cdktf/provider-aws.s3.S3BucketGrant[]

grant block.

Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/aws/r/s3_bucket#grant S3Bucket#grant}

hostedZoneIdOptional 
public readonly hostedZoneId: string;
  • Type: string

Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/aws/r/s3_bucket#hosted_zone_id S3Bucket#hosted_zone_id}.

idOptional 
public readonly id: string;
  • Type: string

Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/aws/r/s3_bucket#id S3Bucket#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.

lifecycleRuleOptional 
public readonly lifecycleRule: IResolvable | S3BucketLifecycleRule[];
  • Type: cdktf.IResolvable | @cdktf/provider-aws.s3.S3BucketLifecycleRule[]

lifecycle_rule block.

Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/aws/r/s3_bucket#lifecycle_rule S3Bucket#lifecycle_rule}

loggingOptional 
public readonly logging: S3BucketLogging;
  • Type: @cdktf/provider-aws.s3.S3BucketLogging

logging block.

Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/aws/r/s3_bucket#logging S3Bucket#logging}

objectLockConfigurationOptional 
public readonly objectLockConfiguration: S3BucketObjectLockConfiguration;
  • Type: @cdktf/provider-aws.s3.S3BucketObjectLockConfiguration

object_lock_configuration block.

Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/aws/r/s3_bucket#object_lock_configuration S3Bucket#object_lock_configuration}

objectLockEnabledOptional 
public readonly objectLockEnabled: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/aws/r/s3_bucket#object_lock_enabled S3Bucket#object_lock_enabled}.

policyOptional 
public readonly policy: string;
  • Type: string

Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/aws/r/s3_bucket#policy S3Bucket#policy}.

replicationConfigurationOptional 
public readonly replicationConfiguration: S3BucketReplicationConfiguration;
  • Type: @cdktf/provider-aws.s3.S3BucketReplicationConfiguration

replication_configuration block.

Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/aws/r/s3_bucket#replication_configuration S3Bucket#replication_configuration}

requestPayerOptional 
public readonly requestPayer: string;
  • Type: string

Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/aws/r/s3_bucket#request_payer S3Bucket#request_payer}.

serverSideEncryptionConfigurationOptional 
public readonly serverSideEncryptionConfiguration: S3BucketServerSideEncryptionConfiguration;
  • Type: @cdktf/provider-aws.s3.S3BucketServerSideEncryptionConfiguration

server_side_encryption_configuration block.

Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/aws/r/s3_bucket#server_side_encryption_configuration S3Bucket#server_side_encryption_configuration}

tagsOptional 
public readonly tags: {[ key: string ]: string};
  • Type: {[ key: string ]: string}

Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/aws/r/s3_bucket#tags S3Bucket#tags}.

tagsAllOptional 
public readonly tagsAll: {[ key: string ]: string};
  • Type: {[ key: string ]: string}

Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/aws/r/s3_bucket#tags_all S3Bucket#tags_all}.

timeoutsOptional 
public readonly timeouts: S3BucketTimeouts;
  • Type: @cdktf/provider-aws.s3.S3BucketTimeouts

timeouts block.

Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/aws/r/s3_bucket#timeouts S3Bucket#timeouts}

versioningOptional 
public readonly versioning: S3BucketVersioning;
  • Type: @cdktf/provider-aws.s3.S3BucketVersioning

versioning block.

Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/aws/r/s3_bucket#versioning S3Bucket#versioning}

websiteOptional 
public readonly website: S3BucketWebsite;
  • Type: @cdktf/provider-aws.s3.S3BucketWebsite

website block.

Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/aws/r/s3_bucket#website S3Bucket#website}

encryptionKeyRequired 
public readonly encryptionKey: KmsKey | string;
  • Type: @cdktf/provider-aws.kms.KmsKey | string

SecurityGroupProps

Initializer 

import { fusionaws } from '@slalombuild/fusion-cdk'

const securityGroupProps: fusionaws.SecurityGroupProps = { ... }

Properties

Name Type Description
connection cdktf.ISSHProvisionerConnection | cdktf.IWinrmProvisionerConnection No description.
count number No description.
dependsOn cdktf.ITerraformDependable[] No description.
forEach cdktf.ITerraformIterator No description.
lifecycle cdktf.TerraformResourceLifecycle No description.
provider cdktf.TerraformProvider No description.
provisioners cdktf.IFileProvisioner | cdktf.ILocalExecProvisioner | cdktf.IRemoteExecProvisioner[] No description.
description string Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/aws/r/security_group#description SecurityGroup#description}.
egress cdktf.IResolvable | @cdktf/provider-aws.vpc.SecurityGroupEgress[] Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/aws/r/security_group#egress SecurityGroup#egress}.
id string Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/aws/r/security_group#id SecurityGroup#id}.
ingress cdktf.IResolvable | @cdktf/provider-aws.vpc.SecurityGroupIngress[] Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/aws/r/security_group#ingress SecurityGroup#ingress}.
name string Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/aws/r/security_group#name SecurityGroup#name}.
namePrefix string Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/aws/r/security_group#name_prefix SecurityGroup#name_prefix}.
revokeRulesOnDelete boolean | cdktf.IResolvable Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/aws/r/security_group#revoke_rules_on_delete SecurityGroup#revoke_rules_on_delete}.
tags {[ key: string ]: string} Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/aws/r/security_group#tags SecurityGroup#tags}.
tagsAll {[ key: string ]: string} Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/aws/r/security_group#tags_all SecurityGroup#tags_all}.
timeouts @cdktf/provider-aws.vpc.SecurityGroupTimeouts timeouts block.
vpcId string Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/aws/r/security_group#vpc_id SecurityGroup#vpc_id}.
connectionOptional 
public readonly connection: ISSHProvisionerConnection | IWinrmProvisionerConnection;
  • Type: cdktf.ISSHProvisionerConnection | cdktf.IWinrmProvisionerConnection
countOptional 
public readonly count: number;
  • Type: number
dependsOnOptional 
public readonly dependsOn: ITerraformDependable[];
  • Type: cdktf.ITerraformDependable[]
forEachOptional 
public readonly forEach: ITerraformIterator;
  • Type: cdktf.ITerraformIterator
lifecycleOptional 
public readonly lifecycle: TerraformResourceLifecycle;
  • Type: cdktf.TerraformResourceLifecycle
providerOptional 
public readonly provider: TerraformProvider;
  • Type: cdktf.TerraformProvider
provisionersOptional 
public readonly provisioners: IFileProvisioner | ILocalExecProvisioner | IRemoteExecProvisioner[];
  • Type: cdktf.IFileProvisioner | cdktf.ILocalExecProvisioner | cdktf.IRemoteExecProvisioner[]
descriptionOptional 
public readonly description: string;
  • Type: string

Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/aws/r/security_group#description SecurityGroup#description}.

egressOptional 
public readonly egress: IResolvable | SecurityGroupEgress[];
  • Type: cdktf.IResolvable | @cdktf/provider-aws.vpc.SecurityGroupEgress[]

Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/aws/r/security_group#egress SecurityGroup#egress}.

idOptional 
public readonly id: string;
  • Type: string

Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/aws/r/security_group#id SecurityGroup#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.

ingressOptional 
public readonly ingress: IResolvable | SecurityGroupIngress[];
  • Type: cdktf.IResolvable | @cdktf/provider-aws.vpc.SecurityGroupIngress[]

Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/aws/r/security_group#ingress SecurityGroup#ingress}.

nameOptional 
public readonly name: string;
  • Type: string

Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/aws/r/security_group#name SecurityGroup#name}.

namePrefixOptional 
public readonly namePrefix: string;
  • Type: string

Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/aws/r/security_group#name_prefix SecurityGroup#name_prefix}.

revokeRulesOnDeleteOptional 
public readonly revokeRulesOnDelete: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/aws/r/security_group#revoke_rules_on_delete SecurityGroup#revoke_rules_on_delete}.

tagsOptional 
public readonly tags: {[ key: string ]: string};
  • Type: {[ key: string ]: string}

Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/aws/r/security_group#tags SecurityGroup#tags}.

tagsAllOptional 
public readonly tagsAll: {[ key: string ]: string};
  • Type: {[ key: string ]: string}

Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/aws/r/security_group#tags_all SecurityGroup#tags_all}.

timeoutsOptional 
public readonly timeouts: SecurityGroupTimeouts;
  • Type: @cdktf/provider-aws.vpc.SecurityGroupTimeouts

timeouts block.

Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/aws/r/security_group#timeouts SecurityGroup#timeouts}

vpcIdOptional 
public readonly vpcId: string;
  • Type: string

Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/aws/r/security_group#vpc_id SecurityGroup#vpc_id}.