dataawss3objects

README

data_aws_s3_objects

Refer to the Terraform Registry for docs: data_aws_s3_objects.

Documentation

Index

• func DataAwsS3Objects_GenerateConfigForImport(scope constructs.Construct, importToId *string, importFromId *string, ...) cdktf.ImportableResource
• func DataAwsS3Objects_IsConstruct(x interface{}) *bool
• func DataAwsS3Objects_IsTerraformDataSource(x interface{}) *bool
• func DataAwsS3Objects_IsTerraformElement(x interface{}) *bool
• func DataAwsS3Objects_TfResourceType() *string
• func NewDataAwsS3Objects_Override(d DataAwsS3Objects, scope constructs.Construct, id *string, ...)
• type DataAwsS3Objects
  • func NewDataAwsS3Objects(scope constructs.Construct, id *string, config *DataAwsS3ObjectsConfig) DataAwsS3Objects
• type DataAwsS3ObjectsConfig

Functions

func DataAwsS3Objects_GenerateConfigForImport

func DataAwsS3Objects_GenerateConfigForImport(scope constructs.Construct, importToId *string, importFromId *string, provider cdktf.TerraformProvider) cdktf.ImportableResource

Generates CDKTF code for importing a DataAwsS3Objects resource upon running "cdktf plan <stack-name>".

func DataAwsS3Objects_IsConstruct

func DataAwsS3Objects_IsConstruct(x interface{}) *bool

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.

Returns: true if `x` is an object created from a class which extends `Construct`.

func DataAwsS3Objects_IsTerraformDataSource

func DataAwsS3Objects_IsTerraformDataSource(x interface{}) *bool

Experimental.

func DataAwsS3Objects_IsTerraformElement

func DataAwsS3Objects_IsTerraformElement(x interface{}) *bool

Experimental.

func DataAwsS3Objects_TfResourceType

func DataAwsS3Objects_TfResourceType() *string

func NewDataAwsS3Objects_Override

func NewDataAwsS3Objects_Override(d DataAwsS3Objects, scope constructs.Construct, id *string, config *DataAwsS3ObjectsConfig)

Create a new {@link https://registry.terraform.io/providers/hashicorp/aws/5.48.0/docs/data-sources/s3_objects aws_s3_objects} Data Source.

Types

type DataAwsS3Objects

type DataAwsS3Objects interface {
	cdktf.TerraformDataSource
	Bucket() *string
	SetBucket(val *string)
	BucketInput() *string
	// Experimental.
	CdktfStack() cdktf.TerraformStack
	CommonPrefixes() *[]*string
	// Experimental.
	ConstructNodeMetadata() *map[string]interface{}
	// Experimental.
	Count() interface{}
	// Experimental.
	SetCount(val interface{})
	Delimiter() *string
	SetDelimiter(val *string)
	DelimiterInput() *string
	// Experimental.
	DependsOn() *[]*string
	// Experimental.
	SetDependsOn(val *[]*string)
	EncodingType() *string
	SetEncodingType(val *string)
	EncodingTypeInput() *string
	FetchOwner() interface{}
	SetFetchOwner(val interface{})
	FetchOwnerInput() interface{}
	// Experimental.
	ForEach() cdktf.ITerraformIterator
	// Experimental.
	SetForEach(val cdktf.ITerraformIterator)
	// Experimental.
	Fqn() *string
	// Experimental.
	FriendlyUniqueId() *string
	Id() *string
	SetId(val *string)
	IdInput() *string
	Keys() *[]*string
	// Experimental.
	Lifecycle() *cdktf.TerraformResourceLifecycle
	// Experimental.
	SetLifecycle(val *cdktf.TerraformResourceLifecycle)
	MaxKeys() *float64
	SetMaxKeys(val *float64)
	MaxKeysInput() *float64
	// The tree node.
	Node() constructs.Node
	Owners() *[]*string
	Prefix() *string
	SetPrefix(val *string)
	PrefixInput() *string
	// Experimental.
	Provider() cdktf.TerraformProvider
	// Experimental.
	SetProvider(val cdktf.TerraformProvider)
	// Experimental.
	RawOverrides() interface{}
	RequestCharged() *string
	RequestPayer() *string
	SetRequestPayer(val *string)
	RequestPayerInput() *string
	StartAfter() *string
	SetStartAfter(val *string)
	StartAfterInput() *string
	// Experimental.
	TerraformGeneratorMetadata() *cdktf.TerraformProviderGeneratorMetadata
	// Experimental.
	TerraformMetaArguments() *map[string]interface{}
	// Experimental.
	TerraformResourceType() *string
	// Experimental.
	AddOverride(path *string, value interface{})
	// Experimental.
	GetAnyMapAttribute(terraformAttribute *string) *map[string]interface{}
	// Experimental.
	GetBooleanAttribute(terraformAttribute *string) cdktf.IResolvable
	// Experimental.
	GetBooleanMapAttribute(terraformAttribute *string) *map[string]*bool
	// Experimental.
	GetListAttribute(terraformAttribute *string) *[]*string
	// Experimental.
	GetNumberAttribute(terraformAttribute *string) *float64
	// Experimental.
	GetNumberListAttribute(terraformAttribute *string) *[]*float64
	// Experimental.
	GetNumberMapAttribute(terraformAttribute *string) *map[string]*float64
	// Experimental.
	GetStringAttribute(terraformAttribute *string) *string
	// Experimental.
	GetStringMapAttribute(terraformAttribute *string) *map[string]*string
	// Experimental.
	InterpolationForAttribute(terraformAttribute *string) cdktf.IResolvable
	// Overrides the auto-generated logical ID with a specific ID.
	// Experimental.
	OverrideLogicalId(newLogicalId *string)
	ResetDelimiter()
	ResetEncodingType()
	ResetFetchOwner()
	ResetId()
	ResetMaxKeys()
	// Resets a previously passed logical Id to use the auto-generated logical id again.
	// Experimental.
	ResetOverrideLogicalId()
	ResetPrefix()
	ResetRequestPayer()
	ResetStartAfter()
	SynthesizeAttributes() *map[string]interface{}
	SynthesizeHclAttributes() *map[string]interface{}
	// Adds this resource to the terraform JSON output.
	// Experimental.
	ToHclTerraform() interface{}
	// Experimental.
	ToMetadata() interface{}
	// Returns a string representation of this construct.
	ToString() *string
	// Adds this resource to the terraform JSON output.
	// Experimental.
	ToTerraform() interface{}
}

Represents a {@link https://registry.terraform.io/providers/hashicorp/aws/5.48.0/docs/data-sources/s3_objects aws_s3_objects}.

func NewDataAwsS3Objects

func NewDataAwsS3Objects(scope constructs.Construct, id *string, config *DataAwsS3ObjectsConfig) DataAwsS3Objects

Create a new {@link https://registry.terraform.io/providers/hashicorp/aws/5.48.0/docs/data-sources/s3_objects aws_s3_objects} Data Source.

type DataAwsS3ObjectsConfig

type DataAwsS3ObjectsConfig struct {
	// Experimental.
	Connection interface{} `field:"optional" json:"connection" yaml:"connection"`
	// Experimental.
	Count interface{} `field:"optional" json:"count" yaml:"count"`
	// Experimental.
	DependsOn *[]cdktf.ITerraformDependable `field:"optional" json:"dependsOn" yaml:"dependsOn"`
	// Experimental.
	ForEach cdktf.ITerraformIterator `field:"optional" json:"forEach" yaml:"forEach"`
	// Experimental.
	Lifecycle *cdktf.TerraformResourceLifecycle `field:"optional" json:"lifecycle" yaml:"lifecycle"`
	// Experimental.
	Provider cdktf.TerraformProvider `field:"optional" json:"provider" yaml:"provider"`
	// Experimental.
	Provisioners *[]interface{} `field:"optional" json:"provisioners" yaml:"provisioners"`
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.48.0/docs/data-sources/s3_objects#bucket DataAwsS3Objects#bucket}.
	Bucket *string `field:"required" json:"bucket" yaml:"bucket"`
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.48.0/docs/data-sources/s3_objects#delimiter DataAwsS3Objects#delimiter}.
	Delimiter *string `field:"optional" json:"delimiter" yaml:"delimiter"`
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.48.0/docs/data-sources/s3_objects#encoding_type DataAwsS3Objects#encoding_type}.
	EncodingType *string `field:"optional" json:"encodingType" yaml:"encodingType"`
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.48.0/docs/data-sources/s3_objects#fetch_owner DataAwsS3Objects#fetch_owner}.
	FetchOwner interface{} `field:"optional" json:"fetchOwner" yaml:"fetchOwner"`
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.48.0/docs/data-sources/s3_objects#id DataAwsS3Objects#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.
	Id *string `field:"optional" json:"id" yaml:"id"`
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.48.0/docs/data-sources/s3_objects#max_keys DataAwsS3Objects#max_keys}.
	MaxKeys *float64 `field:"optional" json:"maxKeys" yaml:"maxKeys"`
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.48.0/docs/data-sources/s3_objects#prefix DataAwsS3Objects#prefix}.
	Prefix *string `field:"optional" json:"prefix" yaml:"prefix"`
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.48.0/docs/data-sources/s3_objects#request_payer DataAwsS3Objects#request_payer}.
	RequestPayer *string `field:"optional" json:"requestPayer" yaml:"requestPayer"`
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.48.0/docs/data-sources/s3_objects#start_after DataAwsS3Objects#start_after}.
	StartAfter *string `field:"optional" json:"startAfter" yaml:"startAfter"`
}