dataAwsS3BucketObject.csharp.md

dataAwsS3BucketObject Submodule

Constructs

DataAwsS3BucketObject

Represents a {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/data-sources/s3_bucket_object aws_s3_bucket_object}.

Initializers

using HashiCorp.Cdktf.Providers.Aws;

new DataAwsS3BucketObject(Construct Scope, string Id, DataAwsS3BucketObjectConfig Config);

Name	Type	Description
Scope	Constructs.Construct	The scope in which to define this construct.
Id	string	The scoped construct ID.
Config	DataAwsS3BucketObjectConfig	No description.

---

Scope^Required

• Type: Constructs.Construct

The scope in which to define this construct.

---

Id^Required

• Type: string

The scoped construct ID.

Must be unique amongst siblings in the same scope

---

Config^Required

• Type: DataAwsS3BucketObjectConfig

---

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	Adds this resource to the terraform JSON output.
ToMetadata	No description.
ToTerraform	Adds this resource to the terraform JSON output.
GetAnyMapAttribute	No description.
GetBooleanAttribute	No description.
GetBooleanMapAttribute	No description.
GetListAttribute	No description.
GetNumberAttribute	No description.
GetNumberListAttribute	No description.
GetNumberMapAttribute	No description.
GetStringAttribute	No description.
GetStringMapAttribute	No description.
InterpolationForAttribute	No description.
ResetId	No description.
ResetRange	No description.
ResetTags	No description.
ResetVersionId	No description.

---

ToString

private string ToString()

Returns a string representation of this construct.

AddOverride

private void AddOverride(string Path, object Value)

Path^Required

• Type: string

---

Value^Required

• Type: object

---

OverrideLogicalId

private void OverrideLogicalId(string NewLogicalId)

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

NewLogicalId^Required

• Type: string

The new logical ID to use for this stack element.

---

ResetOverrideLogicalId

private void ResetOverrideLogicalId()

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

ToHclTerraform

private object ToHclTerraform()

Adds this resource to the terraform JSON output.

ToMetadata

private object ToMetadata()

ToTerraform

private object ToTerraform()

Adds this resource to the terraform JSON output.

GetAnyMapAttribute

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

TerraformAttribute^Required

• Type: string

---

GetBooleanAttribute

private IResolvable GetBooleanAttribute(string TerraformAttribute)

TerraformAttribute^Required

• Type: string

---

GetBooleanMapAttribute

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

TerraformAttribute^Required

• Type: string

---

GetListAttribute

private string[] GetListAttribute(string TerraformAttribute)

TerraformAttribute^Required

• Type: string

---

GetNumberAttribute

private double GetNumberAttribute(string TerraformAttribute)

TerraformAttribute^Required

• Type: string

---

GetNumberListAttribute

private double[] GetNumberListAttribute(string TerraformAttribute)

TerraformAttribute^Required

• Type: string

---

GetNumberMapAttribute

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

TerraformAttribute^Required

• Type: string

---

GetStringAttribute

private string GetStringAttribute(string TerraformAttribute)

TerraformAttribute^Required

• Type: string

---

GetStringMapAttribute

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

TerraformAttribute^Required

• Type: string

---

InterpolationForAttribute

private IResolvable InterpolationForAttribute(string TerraformAttribute)

TerraformAttribute^Required

• Type: string

---

ResetId

private void ResetId()

ResetRange

private void ResetRange()

ResetTags

private void ResetTags()

ResetVersionId

private void ResetVersionId()

Static Functions

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

---

IsConstruct

using HashiCorp.Cdktf.Providers.Aws;

DataAwsS3BucketObject.IsConstruct(object X);

Checks if x is a construct.

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

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

X^Required

• Type: object

Any object.

---

IsTerraformElement

using HashiCorp.Cdktf.Providers.Aws;

DataAwsS3BucketObject.IsTerraformElement(object X);

X^Required

• Type: object

---

IsTerraformDataSource

using HashiCorp.Cdktf.Providers.Aws;

DataAwsS3BucketObject.IsTerraformDataSource(object X);

X^Required

• Type: object

---

GenerateConfigForImport

using HashiCorp.Cdktf.Providers.Aws;

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

Generates CDKTF code for importing a DataAwsS3BucketObject resource upon running "cdktf plan ".

Scope^Required

• Type: Constructs.Construct

The scope in which to define this construct.

---

ImportToId^Required

• Type: string

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

---

ImportFromId^Required

• Type: string

The id of the existing DataAwsS3BucketObject that should be imported.

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

---

Provider^Optional

• Type: HashiCorp.Cdktf.TerraformProvider

? Optional instance of the provider where the DataAwsS3BucketObject 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.
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.
Arn	string	No description.
Body	string	No description.
BucketKeyEnabled	HashiCorp.Cdktf.IResolvable	No description.
CacheControl	string	No description.
ContentDisposition	string	No description.
ContentEncoding	string	No description.
ContentLanguage	string	No description.
ContentLength	double	No description.
ContentType	string	No description.
Etag	string	No description.
Expiration	string	No description.
Expires	string	No description.
LastModified	string	No description.
Metadata	HashiCorp.Cdktf.StringMap	No description.
ObjectLockLegalHoldStatus	string	No description.
ObjectLockMode	string	No description.
ObjectLockRetainUntilDate	string	No description.
ServerSideEncryption	string	No description.
SseKmsKeyId	string	No description.
StorageClass	string	No description.
WebsiteRedirectLocation	string	No description.
BucketInput	string	No description.
IdInput	string	No description.
KeyInput	string	No description.
RangeInput	string	No description.
TagsInput	System.Collections.Generic.IDictionary<string, string>	No description.
VersionIdInput	string	No description.
Bucket	string	No description.
Id	string	No description.
Key	string	No description.
Range	string	No description.
Tags	System.Collections.Generic.IDictionary<string, string>	No description.
VersionId	string	No description.

---

Node^Required

public Node Node { get; }

• Type: Constructs.Node

The tree node.

---

CdktfStack^Required

public TerraformStack CdktfStack { get; }

• Type: HashiCorp.Cdktf.TerraformStack

---

Fqn^Required

public string Fqn { get; }

• Type: string

---

FriendlyUniqueId^Required

public string FriendlyUniqueId { get; }

• Type: string

---

TerraformMetaArguments^Required

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

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

---

TerraformResourceType^Required

public string TerraformResourceType { get; }

• Type: string

---

TerraformGeneratorMetadata^Optional

public TerraformProviderGeneratorMetadata TerraformGeneratorMetadata { get; }

• Type: HashiCorp.Cdktf.TerraformProviderGeneratorMetadata

---

Count^Optional

public object Count { get; }

• Type: object

---

DependsOn^Optional

public string[] DependsOn { get; }

• Type: string[]

---

ForEach^Optional

public ITerraformIterator ForEach { get; }

• Type: HashiCorp.Cdktf.ITerraformIterator

---

Lifecycle^Optional

public TerraformResourceLifecycle Lifecycle { get; }

• Type: HashiCorp.Cdktf.TerraformResourceLifecycle

---

Provider^Optional

public TerraformProvider Provider { get; }

• Type: HashiCorp.Cdktf.TerraformProvider

---

Arn^Required

public string Arn { get; }

• Type: string

---

Body^Required

public string Body { get; }

• Type: string

---

BucketKeyEnabled^Required

public IResolvable BucketKeyEnabled { get; }

• Type: HashiCorp.Cdktf.IResolvable

---

CacheControl^Required

public string CacheControl { get; }

• Type: string

---

ContentDisposition^Required

public string ContentDisposition { get; }

• Type: string

---

ContentEncoding^Required

public string ContentEncoding { get; }

• Type: string

---

ContentLanguage^Required

public string ContentLanguage { get; }

• Type: string

---

ContentLength^Required

public double ContentLength { get; }

• Type: double

---

ContentType^Required

public string ContentType { get; }

• Type: string

---

Etag^Required

public string Etag { get; }

• Type: string

---

Expiration^Required

public string Expiration { get; }

• Type: string

---

Expires^Required

public string Expires { get; }

• Type: string

---

LastModified^Required

public string LastModified { get; }

• Type: string

---

Metadata^Required

public StringMap Metadata { get; }

• Type: HashiCorp.Cdktf.StringMap

---

ObjectLockLegalHoldStatus^Required

public string ObjectLockLegalHoldStatus { get; }

• Type: string

---

ObjectLockMode^Required

public string ObjectLockMode { get; }

• Type: string

---

ObjectLockRetainUntilDate^Required

public string ObjectLockRetainUntilDate { get; }

• Type: string

---

ServerSideEncryption^Required

public string ServerSideEncryption { get; }

• Type: string

---

SseKmsKeyId^Required

public string SseKmsKeyId { get; }

• Type: string

---

StorageClass^Required

public string StorageClass { get; }

• Type: string

---

WebsiteRedirectLocation^Required

public string WebsiteRedirectLocation { get; }

• Type: string

---

BucketInput^Optional

public string BucketInput { get; }

• Type: string

---

IdInput^Optional

public string IdInput { get; }

• Type: string

---

KeyInput^Optional

public string KeyInput { get; }

• Type: string

---

RangeInput^Optional

public string RangeInput { get; }

• Type: string

---

TagsInput^Optional

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

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

---

VersionIdInput^Optional

public string VersionIdInput { get; }

• Type: string

---

Bucket^Required

public string Bucket { get; }

• Type: string

---

Id^Required

public string Id { get; }

• Type: string

---

Key^Required

public string Key { get; }

• Type: string

---

Range^Required

public string Range { get; }

• Type: string

---

Tags^Required

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

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

---

VersionId^Required

public string VersionId { get; }

• Type: string

---

Constants

Name	Type	Description
TfResourceType	string	No description.

---

TfResourceType^Required

public string TfResourceType { get; }

• Type: string

---

Structs

DataAwsS3BucketObjectConfig

Initializer

using HashiCorp.Cdktf.Providers.Aws;

new DataAwsS3BucketObjectConfig {
    object Connection = null,
    object Count = null,
    ITerraformDependable[] DependsOn = null,
    ITerraformIterator ForEach = null,
    TerraformResourceLifecycle Lifecycle = null,
    TerraformProvider Provider = null,
    object[] Provisioners = null,
    string Bucket,
    string Key,
    string Id = null,
    string Range = null,
    System.Collections.Generic.IDictionary<string, string> Tags = null,
    string VersionId = 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.
Bucket	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/data-sources/s3_bucket_object#bucket DataAwsS3BucketObject#bucket}.
Key	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/data-sources/s3_bucket_object#key DataAwsS3BucketObject#key}.
Id	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/data-sources/s3_bucket_object#id DataAwsS3BucketObject#id}.
Range	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/data-sources/s3_bucket_object#range DataAwsS3BucketObject#range}.
Tags	System.Collections.Generic.IDictionary<string, string>	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/data-sources/s3_bucket_object#tags DataAwsS3BucketObject#tags}.
VersionId	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/data-sources/s3_bucket_object#version_id DataAwsS3BucketObject#version_id}.

---

Connection^Optional

public object Connection { get; set; }

• Type: object

---

Count^Optional

public object Count { get; set; }

• Type: object

---

DependsOn^Optional

public ITerraformDependable[] DependsOn { get; set; }

• Type: HashiCorp.Cdktf.ITerraformDependable[]

---

ForEach^Optional

public ITerraformIterator ForEach { get; set; }

• Type: HashiCorp.Cdktf.ITerraformIterator

---

Lifecycle^Optional

public TerraformResourceLifecycle Lifecycle { get; set; }

• Type: HashiCorp.Cdktf.TerraformResourceLifecycle

---

Provider^Optional

public TerraformProvider Provider { get; set; }

• Type: HashiCorp.Cdktf.TerraformProvider

---

Provisioners^Optional

public object[] Provisioners { get; set; }

• Type: object[]

---

Bucket^Required

public string Bucket { get; set; }

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/data-sources/s3_bucket_object#bucket DataAwsS3BucketObject#bucket}.

---

Key^Required

public string Key { get; set; }

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/data-sources/s3_bucket_object#key DataAwsS3BucketObject#key}.

---

Id^Optional

public string Id { get; set; }

• Type: string

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

---

Range^Optional

public string Range { get; set; }

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/data-sources/s3_bucket_object#range DataAwsS3BucketObject#range}.

---

Tags^Optional

public System.Collections.Generic.IDictionary<string, string> Tags { get; set; }

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

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/data-sources/s3_bucket_object#tags DataAwsS3BucketObject#tags}.

---

VersionId^Optional

public string VersionId { get; set; }

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/data-sources/s3_bucket_object#version_id DataAwsS3BucketObject#version_id}.

---