`dataAwsS3BucketObject` Submodule

Constructs

DataAwsS3BucketObject

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

Initializers

from cdktf_cdktf_provider_aws import data_aws_s3_bucket_object

dataAwsS3BucketObject.DataAwsS3BucketObject(
  scope: Construct,
  id: str,
  connection: typing.Union[SSHProvisionerConnection, WinrmProvisionerConnection] = None,
  count: typing.Union[typing.Union[int, float], TerraformCount] = None,
  depends_on: typing.List[ITerraformDependable] = None,
  for_each: ITerraformIterator = None,
  lifecycle: TerraformResourceLifecycle = None,
  provider: TerraformProvider = None,
  provisioners: typing.List[typing.Union[FileProvisioner, LocalExecProvisioner, RemoteExecProvisioner]] = None,
  bucket: str,
  key: str,
  id: str = None,
  range: str = None,
  tags: typing.Mapping[str] = None,
  version_id: str = None
)

Name	Type	Description
`scope`	`constructs.Construct`	The scope in which to define this construct.
`id`	`str`	The scoped construct ID.
`connection`	`typing.Union[cdktf.SSHProvisionerConnection, cdktf.WinrmProvisionerConnection]`	No description.
`count`	`typing.Union[typing.Union[int, float], cdktf.TerraformCount]`	No description.
`depends_on`	`typing.List[cdktf.ITerraformDependable]`	No description.
`for_each`	`cdktf.ITerraformIterator`	No description.
`lifecycle`	`cdktf.TerraformResourceLifecycle`	No description.
`provider`	`cdktf.TerraformProvider`	No description.
`provisioners`	`typing.List[typing.Union[cdktf.FileProvisioner, cdktf.LocalExecProvisioner, cdktf.RemoteExecProvisioner]]`	No description.
`bucket`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.65.0/docs/data-sources/s3_bucket_object#bucket DataAwsS3BucketObject#bucket}.
`key`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.65.0/docs/data-sources/s3_bucket_object#key DataAwsS3BucketObject#key}.
`id`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.65.0/docs/data-sources/s3_bucket_object#id DataAwsS3BucketObject#id}.
`range`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.65.0/docs/data-sources/s3_bucket_object#range DataAwsS3BucketObject#range}.
`tags`	`typing.Mapping[str]`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.65.0/docs/data-sources/s3_bucket_object#tags DataAwsS3BucketObject#tags}.
`version_id`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.65.0/docs/data-sources/s3_bucket_object#version_id DataAwsS3BucketObject#version_id}.

`scope`^Required

Type: constructs.Construct

The scope in which to define this construct.

`id`^Required

Type: str

The scoped construct ID.

Must be unique amongst siblings in the same scope

`connection`^Optional

Type: typing.Union[cdktf.SSHProvisionerConnection, cdktf.WinrmProvisionerConnection]

`count`^Optional

Type: typing.Union[typing.Union[int, float], cdktf.TerraformCount]

`depends_on`^Optional

Type: typing.List[cdktf.ITerraformDependable]

`for_each`^Optional

Type: cdktf.ITerraformIterator

`lifecycle`^Optional

Type: cdktf.TerraformResourceLifecycle

`provider`^Optional

Type: cdktf.TerraformProvider

`provisioners`^Optional

Type: typing.List[typing.Union[cdktf.FileProvisioner, cdktf.LocalExecProvisioner, cdktf.RemoteExecProvisioner]]

`bucket`^Required

Type: str

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

`key`^Required

Type: str

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

`id`^Optional

Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.65.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

Type: str

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

`tags`^Optional

Type: typing.Mapping[str]

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

`version_id`^Optional

Type: str

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

Methods

Name	Description
`to_string`	Returns a string representation of this construct.
`add_override`	No description.
`override_logical_id`	Overrides the auto-generated logical ID with a specific ID.
`reset_override_logical_id`	Resets a previously passed logical Id to use the auto-generated logical id again.
`to_hcl_terraform`	Adds this resource to the terraform JSON output.
`to_metadata`	No description.
`to_terraform`	Adds this resource to the terraform JSON output.
`get_any_map_attribute`	No description.
`get_boolean_attribute`	No description.
`get_boolean_map_attribute`	No description.
`get_list_attribute`	No description.
`get_number_attribute`	No description.
`get_number_list_attribute`	No description.
`get_number_map_attribute`	No description.
`get_string_attribute`	No description.
`get_string_map_attribute`	No description.
`interpolation_for_attribute`	No description.
`reset_id`	No description.
`reset_range`	No description.
`reset_tags`	No description.
`reset_version_id`	No description.

`to_string`

def to_string() -> str

Returns a string representation of this construct.

`add_override`

def add_override(
  path: str,
  value: typing.Any
) -> None

`path`^Required

Type: str

`value`^Required

Type: typing.Any

`override_logical_id`

def override_logical_id(
  new_logical_id: str
) -> None

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

`new_logical_id`^Required

Type: str

The new logical ID to use for this stack element.

`reset_override_logical_id`

def reset_override_logical_id() -> None

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

`to_hcl_terraform`

def to_hcl_terraform() -> typing.Any

Adds this resource to the terraform JSON output.

`to_metadata`

def to_metadata() -> typing.Any

`to_terraform`

def to_terraform() -> typing.Any

Adds this resource to the terraform JSON output.

`get_any_map_attribute`

def get_any_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[typing.Any]

`terraform_attribute`^Required

Type: str

`get_boolean_attribute`

def get_boolean_attribute(
  terraform_attribute: str
) -> IResolvable

`terraform_attribute`^Required

Type: str

`get_boolean_map_attribute`

def get_boolean_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[bool]

`terraform_attribute`^Required

Type: str

`get_list_attribute`

def get_list_attribute(
  terraform_attribute: str
) -> typing.List[str]

`terraform_attribute`^Required

Type: str

`get_number_attribute`

def get_number_attribute(
  terraform_attribute: str
) -> typing.Union[int, float]

`terraform_attribute`^Required

Type: str

`get_number_list_attribute`

def get_number_list_attribute(
  terraform_attribute: str
) -> typing.List[typing.Union[int, float]]

`terraform_attribute`^Required

Type: str

`get_number_map_attribute`

def get_number_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[typing.Union[int, float]]

`terraform_attribute`^Required

Type: str

`get_string_attribute`

def get_string_attribute(
  terraform_attribute: str
) -> str

`terraform_attribute`^Required

Type: str

`get_string_map_attribute`

def get_string_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[str]

`terraform_attribute`^Required

Type: str

`interpolation_for_attribute`

def interpolation_for_attribute(
  terraform_attribute: str
) -> IResolvable

`terraform_attribute`^Required

Type: str

`reset_id`

def reset_id() -> None

`reset_range`

def reset_range() -> None

`reset_tags`

def reset_tags() -> None

`reset_version_id`

def reset_version_id() -> None

Static Functions

Name	Description
`is_construct`	Checks if `x` is a construct.
`is_terraform_element`	No description.
`is_terraform_data_source`	No description.
`generate_config_for_import`	Generates CDKTF code for importing a DataAwsS3BucketObject resource upon running "cdktf plan ".

`is_construct`

from cdktf_cdktf_provider_aws import data_aws_s3_bucket_object

dataAwsS3BucketObject.DataAwsS3BucketObject.is_construct(
  x: typing.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.

`x`^Required

Type: typing.Any

Any object.

`is_terraform_element`

from cdktf_cdktf_provider_aws import data_aws_s3_bucket_object

dataAwsS3BucketObject.DataAwsS3BucketObject.is_terraform_element(
  x: typing.Any
)

`x`^Required

Type: typing.Any

`is_terraform_data_source`

from cdktf_cdktf_provider_aws import data_aws_s3_bucket_object

dataAwsS3BucketObject.DataAwsS3BucketObject.is_terraform_data_source(
  x: typing.Any
)

`x`^Required

Type: typing.Any

`generate_config_for_import`

from cdktf_cdktf_provider_aws import data_aws_s3_bucket_object

dataAwsS3BucketObject.DataAwsS3BucketObject.generate_config_for_import(
  scope: Construct,
  import_to_id: str,
  import_from_id: str,
  provider: TerraformProvider = None
)

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.

`import_to_id`^Required

Type: str

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

`import_from_id`^Required

Type: str

The id of the existing DataAwsS3BucketObject that should be imported.

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

`provider`^Optional

Type: cdktf.TerraformProvider

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

Properties

Name	Type	Description
`node`	`constructs.Node`	The tree node.
`cdktf_stack`	`cdktf.TerraformStack`	No description.
`fqn`	`str`	No description.
`friendly_unique_id`	`str`	No description.
`terraform_meta_arguments`	`typing.Mapping[typing.Any]`	No description.
`terraform_resource_type`	`str`	No description.
`terraform_generator_metadata`	`cdktf.TerraformProviderGeneratorMetadata`	No description.
`count`	`typing.Union[typing.Union[int, float], cdktf.TerraformCount]`	No description.
`depends_on`	`typing.List[str]`	No description.
`for_each`	`cdktf.ITerraformIterator`	No description.
`lifecycle`	`cdktf.TerraformResourceLifecycle`	No description.
`provider`	`cdktf.TerraformProvider`	No description.
`arn`	`str`	No description.
`body`	`str`	No description.
`bucket_key_enabled`	`cdktf.IResolvable`	No description.
`cache_control`	`str`	No description.
`content_disposition`	`str`	No description.
`content_encoding`	`str`	No description.
`content_language`	`str`	No description.
`content_length`	`typing.Union[int, float]`	No description.
`content_type`	`str`	No description.
`etag`	`str`	No description.
`expiration`	`str`	No description.
`expires`	`str`	No description.
`last_modified`	`str`	No description.
`metadata`	`cdktf.StringMap`	No description.
`object_lock_legal_hold_status`	`str`	No description.
`object_lock_mode`	`str`	No description.
`object_lock_retain_until_date`	`str`	No description.
`server_side_encryption`	`str`	No description.
`sse_kms_key_id`	`str`	No description.
`storage_class`	`str`	No description.
`website_redirect_location`	`str`	No description.
`bucket_input`	`str`	No description.
`id_input`	`str`	No description.
`key_input`	`str`	No description.
`range_input`	`str`	No description.
`tags_input`	`typing.Mapping[str]`	No description.
`version_id_input`	`str`	No description.
`bucket`	`str`	No description.
`id`	`str`	No description.
`key`	`str`	No description.
`range`	`str`	No description.
`tags`	`typing.Mapping[str]`	No description.
`version_id`	`str`	No description.

`node`^Required

node: Node

Type: constructs.Node

The tree node.

`cdktf_stack`^Required

cdktf_stack: TerraformStack

Type: cdktf.TerraformStack

`fqn`^Required

fqn: str

Type: str

`friendly_unique_id`^Required

friendly_unique_id: str

Type: str

`terraform_meta_arguments`^Required

terraform_meta_arguments: typing.Mapping[typing.Any]

Type: typing.Mapping[typing.Any]

`terraform_resource_type`^Required

terraform_resource_type: str

Type: str

`terraform_generator_metadata`^Optional

terraform_generator_metadata: TerraformProviderGeneratorMetadata

Type: cdktf.TerraformProviderGeneratorMetadata

`count`^Optional

count: typing.Union[typing.Union[int, float], TerraformCount]

Type: typing.Union[typing.Union[int, float], cdktf.TerraformCount]

`depends_on`^Optional

depends_on: typing.List[str]

Type: typing.List[str]

`for_each`^Optional

for_each: ITerraformIterator

Type: cdktf.ITerraformIterator

`lifecycle`^Optional

lifecycle: TerraformResourceLifecycle

Type: cdktf.TerraformResourceLifecycle

`provider`^Optional

provider: TerraformProvider

Type: cdktf.TerraformProvider

`arn`^Required

arn: str

Type: str

`body`^Required

body: str

Type: str

`bucket_key_enabled`^Required

bucket_key_enabled: IResolvable

Type: cdktf.IResolvable

`cache_control`^Required

cache_control: str

Type: str

`content_disposition`^Required

content_disposition: str

Type: str

`content_encoding`^Required

content_encoding: str

Type: str

`content_language`^Required

content_language: str

Type: str

`content_length`^Required

content_length: typing.Union[int, float]

Type: typing.Union[int, float]

`content_type`^Required

content_type: str

Type: str

`etag`^Required

etag: str

Type: str

`expiration`^Required

expiration: str

Type: str

`expires`^Required

expires: str

Type: str

`last_modified`^Required

last_modified: str

Type: str

`metadata`^Required

metadata: StringMap

Type: cdktf.StringMap

`object_lock_legal_hold_status`^Required

object_lock_legal_hold_status: str

Type: str

`object_lock_mode`^Required

object_lock_mode: str

Type: str

`object_lock_retain_until_date`^Required

object_lock_retain_until_date: str

Type: str

`server_side_encryption`^Required

server_side_encryption: str

Type: str

`sse_kms_key_id`^Required

sse_kms_key_id: str

Type: str

`storage_class`^Required

storage_class: str

Type: str

`website_redirect_location`^Required

website_redirect_location: str

Type: str

`bucket_input`^Optional

bucket_input: str

Type: str

`id_input`^Optional

id_input: str

Type: str

`key_input`^Optional

key_input: str

Type: str

`range_input`^Optional

range_input: str

Type: str

`tags_input`^Optional

tags_input: typing.Mapping[str]

Type: typing.Mapping[str]

`version_id_input`^Optional

version_id_input: str

Type: str

`bucket`^Required

bucket: str

Type: str

`id`^Required

id: str

Type: str

`key`^Required

key: str

Type: str

`range`^Required

range: str

Type: str

`tags`^Required

tags: typing.Mapping[str]

Type: typing.Mapping[str]

`version_id`^Required

version_id: str

Type: str

Constants

Name	Type	Description
`tfResourceType`	`str`	No description.

`tfResourceType`^Required

tfResourceType: str

Type: str

Structs

DataAwsS3BucketObjectConfig

Initializer

from cdktf_cdktf_provider_aws import data_aws_s3_bucket_object

dataAwsS3BucketObject.DataAwsS3BucketObjectConfig(
  connection: typing.Union[SSHProvisionerConnection, WinrmProvisionerConnection] = None,
  count: typing.Union[typing.Union[int, float], TerraformCount] = None,
  depends_on: typing.List[ITerraformDependable] = None,
  for_each: ITerraformIterator = None,
  lifecycle: TerraformResourceLifecycle = None,
  provider: TerraformProvider = None,
  provisioners: typing.List[typing.Union[FileProvisioner, LocalExecProvisioner, RemoteExecProvisioner]] = None,
  bucket: str,
  key: str,
  id: str = None,
  range: str = None,
  tags: typing.Mapping[str] = None,
  version_id: str = None
)

Properties

Name	Type	Description
`connection`	`typing.Union[cdktf.SSHProvisionerConnection, cdktf.WinrmProvisionerConnection]`	No description.
`count`	`typing.Union[typing.Union[int, float], cdktf.TerraformCount]`	No description.
`depends_on`	`typing.List[cdktf.ITerraformDependable]`	No description.
`for_each`	`cdktf.ITerraformIterator`	No description.
`lifecycle`	`cdktf.TerraformResourceLifecycle`	No description.
`provider`	`cdktf.TerraformProvider`	No description.
`provisioners`	`typing.List[typing.Union[cdktf.FileProvisioner, cdktf.LocalExecProvisioner, cdktf.RemoteExecProvisioner]]`	No description.
`bucket`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.65.0/docs/data-sources/s3_bucket_object#bucket DataAwsS3BucketObject#bucket}.
`key`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.65.0/docs/data-sources/s3_bucket_object#key DataAwsS3BucketObject#key}.
`id`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.65.0/docs/data-sources/s3_bucket_object#id DataAwsS3BucketObject#id}.
`range`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.65.0/docs/data-sources/s3_bucket_object#range DataAwsS3BucketObject#range}.
`tags`	`typing.Mapping[str]`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.65.0/docs/data-sources/s3_bucket_object#tags DataAwsS3BucketObject#tags}.
`version_id`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.65.0/docs/data-sources/s3_bucket_object#version_id DataAwsS3BucketObject#version_id}.

`connection`^Optional

connection: typing.Union[SSHProvisionerConnection, WinrmProvisionerConnection]

Type: typing.Union[cdktf.SSHProvisionerConnection, cdktf.WinrmProvisionerConnection]

`count`^Optional

count: typing.Union[typing.Union[int, float], TerraformCount]

Type: typing.Union[typing.Union[int, float], cdktf.TerraformCount]

`depends_on`^Optional

depends_on: typing.List[ITerraformDependable]

Type: typing.List[cdktf.ITerraformDependable]

`for_each`^Optional

for_each: ITerraformIterator

Type: cdktf.ITerraformIterator

`lifecycle`^Optional

lifecycle: TerraformResourceLifecycle

Type: cdktf.TerraformResourceLifecycle

`provider`^Optional

provider: TerraformProvider

Type: cdktf.TerraformProvider

`provisioners`^Optional

provisioners: typing.List[typing.Union[FileProvisioner, LocalExecProvisioner, RemoteExecProvisioner]]

Type: typing.List[typing.Union[cdktf.FileProvisioner, cdktf.LocalExecProvisioner, cdktf.RemoteExecProvisioner]]

`bucket`^Required

bucket: str

Type: str

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

`key`^Required

key: str

Type: str

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

`id`^Optional

id: str

Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.65.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

range: str

Type: str

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

`tags`^Optional

tags: typing.Mapping[str]

Type: typing.Mapping[str]

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

`version_id`^Optional

version_id: str

Type: str

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

Files

dataAwsS3BucketObject.python.md

Latest commit

History

dataAwsS3BucketObject.python.md

File metadata and controls

dataAwsS3BucketObject Submodule

Constructs