Skip to content

Latest commit

 

History

History
1148 lines (722 loc) · 59.8 KB

dataDigitaloceanSpacesBucketObject.java.md

File metadata and controls

1148 lines (722 loc) · 59.8 KB

dataDigitaloceanSpacesBucketObject Submodule

Constructs

DataDigitaloceanSpacesBucketObject

Represents a {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/data-sources/spaces_bucket_object digitalocean_spaces_bucket_object}.

Initializers

import com.hashicorp.cdktf.providers.digitalocean.data_digitalocean_spaces_bucket_object.DataDigitaloceanSpacesBucketObject;

DataDigitaloceanSpacesBucketObject.Builder.create(Construct scope, java.lang.String id)
//  .connection(SSHProvisionerConnection)
//  .connection(WinrmProvisionerConnection)
//  .count(java.lang.Number)
//  .count(TerraformCount)
//  .dependsOn(java.util.List<ITerraformDependable>)
//  .forEach(ITerraformIterator)
//  .lifecycle(TerraformResourceLifecycle)
//  .provider(TerraformProvider)
//  .provisioners(java.util.List<FileProvisioner)
//  .provisioners(LocalExecProvisioner)
//  .provisioners(RemoteExecProvisioner>)
    .bucket(java.lang.String)
    .key(java.lang.String)
    .region(java.lang.String)
//  .id(java.lang.String)
//  .range(java.lang.String)
//  .versionId(java.lang.String)
    .build();
Name Type Description
scope software.constructs.Construct The scope in which to define this construct.
id java.lang.String The scoped construct ID.
connection com.hashicorp.cdktf.SSHProvisionerConnection OR com.hashicorp.cdktf.WinrmProvisionerConnection No description.
count java.lang.Number OR com.hashicorp.cdktf.TerraformCount No description.
dependsOn java.util.List<com.hashicorp.cdktf.ITerraformDependable> No description.
forEach com.hashicorp.cdktf.ITerraformIterator No description.
lifecycle com.hashicorp.cdktf.TerraformResourceLifecycle No description.
provider com.hashicorp.cdktf.TerraformProvider No description.
provisioners java.util.List<com.hashicorp.cdktf.FileProvisioner OR com.hashicorp.cdktf.LocalExecProvisioner OR com.hashicorp.cdktf.RemoteExecProvisioner> No description.
bucket java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/data-sources/spaces_bucket_object#bucket DataDigitaloceanSpacesBucketObject#bucket}.
key java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/data-sources/spaces_bucket_object#key DataDigitaloceanSpacesBucketObject#key}.
region java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/data-sources/spaces_bucket_object#region DataDigitaloceanSpacesBucketObject#region}.
id java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/data-sources/spaces_bucket_object#id DataDigitaloceanSpacesBucketObject#id}.
range java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/data-sources/spaces_bucket_object#range DataDigitaloceanSpacesBucketObject#range}.
versionId java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/data-sources/spaces_bucket_object#version_id DataDigitaloceanSpacesBucketObject#version_id}.

scopeRequired
  • Type: software.constructs.Construct

The scope in which to define this construct.


idRequired
  • Type: java.lang.String

The scoped construct ID.

Must be unique amongst siblings in the same scope


connectionOptional
  • Type: com.hashicorp.cdktf.SSHProvisionerConnection OR com.hashicorp.cdktf.WinrmProvisionerConnection

countOptional
  • Type: java.lang.Number OR com.hashicorp.cdktf.TerraformCount

dependsOnOptional
  • Type: java.util.List<com.hashicorp.cdktf.ITerraformDependable>

forEachOptional
  • Type: com.hashicorp.cdktf.ITerraformIterator

lifecycleOptional
  • Type: com.hashicorp.cdktf.TerraformResourceLifecycle

providerOptional
  • Type: com.hashicorp.cdktf.TerraformProvider

provisionersOptional
  • Type: java.util.List<com.hashicorp.cdktf.FileProvisioner OR com.hashicorp.cdktf.LocalExecProvisioner OR com.hashicorp.cdktf.RemoteExecProvisioner>

bucketRequired
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/data-sources/spaces_bucket_object#bucket DataDigitaloceanSpacesBucketObject#bucket}.


keyRequired
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/data-sources/spaces_bucket_object#key DataDigitaloceanSpacesBucketObject#key}.


regionRequired
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/data-sources/spaces_bucket_object#region DataDigitaloceanSpacesBucketObject#region}.


idOptional
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/data-sources/spaces_bucket_object#id DataDigitaloceanSpacesBucketObject#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.


rangeOptional
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/data-sources/spaces_bucket_object#range DataDigitaloceanSpacesBucketObject#range}.


versionIdOptional
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/data-sources/spaces_bucket_object#version_id DataDigitaloceanSpacesBucketObject#version_id}.


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.
resetVersionId No description.

toString
public java.lang.String toString()

Returns a string representation of this construct.

addOverride
public void addOverride(java.lang.String path, java.lang.Object value)
pathRequired
  • Type: java.lang.String

valueRequired
  • Type: java.lang.Object

overrideLogicalId
public void overrideLogicalId(java.lang.String newLogicalId)

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

newLogicalIdRequired
  • Type: java.lang.String

The new logical ID to use for this stack element.


resetOverrideLogicalId
public void resetOverrideLogicalId()

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

toHclTerraform
public java.lang.Object toHclTerraform()

Adds this resource to the terraform JSON output.

toMetadata
public java.lang.Object toMetadata()
toTerraform
public java.lang.Object toTerraform()

Adds this resource to the terraform JSON output.

getAnyMapAttribute
public java.util.Map<java.lang.String, java.lang.Object> getAnyMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String

getBooleanAttribute
public IResolvable getBooleanAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String

getBooleanMapAttribute
public java.util.Map<java.lang.String, java.lang.Boolean> getBooleanMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String

getListAttribute
public java.util.List<java.lang.String> getListAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String

getNumberAttribute
public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String

getNumberListAttribute
public java.util.List<java.lang.Number> getNumberListAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String

getNumberMapAttribute
public java.util.Map<java.lang.String, java.lang.Number> getNumberMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String

getStringAttribute
public java.lang.String getStringAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String

getStringMapAttribute
public java.util.Map<java.lang.String, java.lang.String> getStringMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String

interpolationForAttribute
public IResolvable interpolationForAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String

resetId
public void resetId()
resetRange
public void resetRange()
resetVersionId
public 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 DataDigitaloceanSpacesBucketObject resource upon running "cdktf plan ".

isConstruct
import com.hashicorp.cdktf.providers.digitalocean.data_digitalocean_spaces_bucket_object.DataDigitaloceanSpacesBucketObject;

DataDigitaloceanSpacesBucketObject.isConstruct(java.lang.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: java.lang.Object

Any object.


isTerraformElement
import com.hashicorp.cdktf.providers.digitalocean.data_digitalocean_spaces_bucket_object.DataDigitaloceanSpacesBucketObject;

DataDigitaloceanSpacesBucketObject.isTerraformElement(java.lang.Object x)
xRequired
  • Type: java.lang.Object

isTerraformDataSource
import com.hashicorp.cdktf.providers.digitalocean.data_digitalocean_spaces_bucket_object.DataDigitaloceanSpacesBucketObject;

DataDigitaloceanSpacesBucketObject.isTerraformDataSource(java.lang.Object x)
xRequired
  • Type: java.lang.Object

generateConfigForImport
import com.hashicorp.cdktf.providers.digitalocean.data_digitalocean_spaces_bucket_object.DataDigitaloceanSpacesBucketObject;

DataDigitaloceanSpacesBucketObject.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId),DataDigitaloceanSpacesBucketObject.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId, TerraformProvider provider)

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

scopeRequired
  • Type: software.constructs.Construct

The scope in which to define this construct.


importToIdRequired
  • Type: java.lang.String

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


importFromIdRequired
  • Type: java.lang.String

The id of the existing DataDigitaloceanSpacesBucketObject that should be imported.

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


providerOptional
  • Type: com.hashicorp.cdktf.TerraformProvider

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


Properties

Name Type Description
node software.constructs.Node The tree node.
cdktfStack com.hashicorp.cdktf.TerraformStack No description.
fqn java.lang.String No description.
friendlyUniqueId java.lang.String No description.
terraformMetaArguments java.util.Map<java.lang.String, java.lang.Object> No description.
terraformResourceType java.lang.String No description.
terraformGeneratorMetadata com.hashicorp.cdktf.TerraformProviderGeneratorMetadata No description.
count java.lang.Number OR com.hashicorp.cdktf.TerraformCount No description.
dependsOn java.util.List<java.lang.String> No description.
forEach com.hashicorp.cdktf.ITerraformIterator No description.
lifecycle com.hashicorp.cdktf.TerraformResourceLifecycle No description.
provider com.hashicorp.cdktf.TerraformProvider No description.
body java.lang.String No description.
cacheControl java.lang.String No description.
contentDisposition java.lang.String No description.
contentEncoding java.lang.String No description.
contentLanguage java.lang.String No description.
contentLength java.lang.Number No description.
contentType java.lang.String No description.
etag java.lang.String No description.
expiration java.lang.String No description.
expires java.lang.String No description.
lastModified java.lang.String No description.
metadata com.hashicorp.cdktf.StringMap No description.
websiteRedirectLocation java.lang.String No description.
bucketInput java.lang.String No description.
idInput java.lang.String No description.
keyInput java.lang.String No description.
rangeInput java.lang.String No description.
regionInput java.lang.String No description.
versionIdInput java.lang.String No description.
bucket java.lang.String No description.
id java.lang.String No description.
key java.lang.String No description.
range java.lang.String No description.
region java.lang.String No description.
versionId java.lang.String No description.

nodeRequired
public Node getNode();
  • Type: software.constructs.Node

The tree node.


cdktfStackRequired
public TerraformStack getCdktfStack();
  • Type: com.hashicorp.cdktf.TerraformStack

fqnRequired
public java.lang.String getFqn();
  • Type: java.lang.String

friendlyUniqueIdRequired
public java.lang.String getFriendlyUniqueId();
  • Type: java.lang.String

terraformMetaArgumentsRequired
public java.util.Map<java.lang.String, java.lang.Object> getTerraformMetaArguments();
  • Type: java.util.Map<java.lang.String, java.lang.Object>

terraformResourceTypeRequired
public java.lang.String getTerraformResourceType();
  • Type: java.lang.String

terraformGeneratorMetadataOptional
public TerraformProviderGeneratorMetadata getTerraformGeneratorMetadata();
  • Type: com.hashicorp.cdktf.TerraformProviderGeneratorMetadata

countOptional
public java.lang.Object getCount();
  • Type: java.lang.Number OR com.hashicorp.cdktf.TerraformCount

dependsOnOptional
public java.util.List<java.lang.String> getDependsOn();
  • Type: java.util.List<java.lang.String>

forEachOptional
public ITerraformIterator getForEach();
  • Type: com.hashicorp.cdktf.ITerraformIterator

lifecycleOptional
public TerraformResourceLifecycle getLifecycle();
  • Type: com.hashicorp.cdktf.TerraformResourceLifecycle

providerOptional
public TerraformProvider getProvider();
  • Type: com.hashicorp.cdktf.TerraformProvider

bodyRequired
public java.lang.String getBody();
  • Type: java.lang.String

cacheControlRequired
public java.lang.String getCacheControl();
  • Type: java.lang.String

contentDispositionRequired
public java.lang.String getContentDisposition();
  • Type: java.lang.String

contentEncodingRequired
public java.lang.String getContentEncoding();
  • Type: java.lang.String

contentLanguageRequired
public java.lang.String getContentLanguage();
  • Type: java.lang.String

contentLengthRequired
public java.lang.Number getContentLength();
  • Type: java.lang.Number

contentTypeRequired
public java.lang.String getContentType();
  • Type: java.lang.String

etagRequired
public java.lang.String getEtag();
  • Type: java.lang.String

expirationRequired
public java.lang.String getExpiration();
  • Type: java.lang.String

expiresRequired
public java.lang.String getExpires();
  • Type: java.lang.String

lastModifiedRequired
public java.lang.String getLastModified();
  • Type: java.lang.String

metadataRequired
public StringMap getMetadata();
  • Type: com.hashicorp.cdktf.StringMap

websiteRedirectLocationRequired
public java.lang.String getWebsiteRedirectLocation();
  • Type: java.lang.String

bucketInputOptional
public java.lang.String getBucketInput();
  • Type: java.lang.String

idInputOptional
public java.lang.String getIdInput();
  • Type: java.lang.String

keyInputOptional
public java.lang.String getKeyInput();
  • Type: java.lang.String

rangeInputOptional
public java.lang.String getRangeInput();
  • Type: java.lang.String

regionInputOptional
public java.lang.String getRegionInput();
  • Type: java.lang.String

versionIdInputOptional
public java.lang.String getVersionIdInput();
  • Type: java.lang.String

bucketRequired
public java.lang.String getBucket();
  • Type: java.lang.String

idRequired
public java.lang.String getId();
  • Type: java.lang.String

keyRequired
public java.lang.String getKey();
  • Type: java.lang.String

rangeRequired
public java.lang.String getRange();
  • Type: java.lang.String

regionRequired
public java.lang.String getRegion();
  • Type: java.lang.String

versionIdRequired
public java.lang.String getVersionId();
  • Type: java.lang.String

Constants

Name Type Description
tfResourceType java.lang.String No description.

tfResourceTypeRequired
public java.lang.String getTfResourceType();
  • Type: java.lang.String

Structs

DataDigitaloceanSpacesBucketObjectConfig

Initializer

import com.hashicorp.cdktf.providers.digitalocean.data_digitalocean_spaces_bucket_object.DataDigitaloceanSpacesBucketObjectConfig;

DataDigitaloceanSpacesBucketObjectConfig.builder()
//  .connection(SSHProvisionerConnection)
//  .connection(WinrmProvisionerConnection)
//  .count(java.lang.Number)
//  .count(TerraformCount)
//  .dependsOn(java.util.List<ITerraformDependable>)
//  .forEach(ITerraformIterator)
//  .lifecycle(TerraformResourceLifecycle)
//  .provider(TerraformProvider)
//  .provisioners(java.util.List<FileProvisioner)
//  .provisioners(LocalExecProvisioner)
//  .provisioners(RemoteExecProvisioner>)
    .bucket(java.lang.String)
    .key(java.lang.String)
    .region(java.lang.String)
//  .id(java.lang.String)
//  .range(java.lang.String)
//  .versionId(java.lang.String)
    .build();

Properties

Name Type Description
connection com.hashicorp.cdktf.SSHProvisionerConnection OR com.hashicorp.cdktf.WinrmProvisionerConnection No description.
count java.lang.Number OR com.hashicorp.cdktf.TerraformCount No description.
dependsOn java.util.List<com.hashicorp.cdktf.ITerraformDependable> No description.
forEach com.hashicorp.cdktf.ITerraformIterator No description.
lifecycle com.hashicorp.cdktf.TerraformResourceLifecycle No description.
provider com.hashicorp.cdktf.TerraformProvider No description.
provisioners java.util.List<com.hashicorp.cdktf.FileProvisioner OR com.hashicorp.cdktf.LocalExecProvisioner OR com.hashicorp.cdktf.RemoteExecProvisioner> No description.
bucket java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/data-sources/spaces_bucket_object#bucket DataDigitaloceanSpacesBucketObject#bucket}.
key java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/data-sources/spaces_bucket_object#key DataDigitaloceanSpacesBucketObject#key}.
region java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/data-sources/spaces_bucket_object#region DataDigitaloceanSpacesBucketObject#region}.
id java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/data-sources/spaces_bucket_object#id DataDigitaloceanSpacesBucketObject#id}.
range java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/data-sources/spaces_bucket_object#range DataDigitaloceanSpacesBucketObject#range}.
versionId java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/data-sources/spaces_bucket_object#version_id DataDigitaloceanSpacesBucketObject#version_id}.

connectionOptional
public java.lang.Object getConnection();
  • Type: com.hashicorp.cdktf.SSHProvisionerConnection OR com.hashicorp.cdktf.WinrmProvisionerConnection

countOptional
public java.lang.Object getCount();
  • Type: java.lang.Number OR com.hashicorp.cdktf.TerraformCount

dependsOnOptional
public java.util.List<ITerraformDependable> getDependsOn();
  • Type: java.util.List<com.hashicorp.cdktf.ITerraformDependable>

forEachOptional
public ITerraformIterator getForEach();
  • Type: com.hashicorp.cdktf.ITerraformIterator

lifecycleOptional
public TerraformResourceLifecycle getLifecycle();
  • Type: com.hashicorp.cdktf.TerraformResourceLifecycle

providerOptional
public TerraformProvider getProvider();
  • Type: com.hashicorp.cdktf.TerraformProvider

provisionersOptional
public java.lang.Object getProvisioners();
  • Type: java.util.List<com.hashicorp.cdktf.FileProvisioner OR com.hashicorp.cdktf.LocalExecProvisioner OR com.hashicorp.cdktf.RemoteExecProvisioner>

bucketRequired
public java.lang.String getBucket();
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/data-sources/spaces_bucket_object#bucket DataDigitaloceanSpacesBucketObject#bucket}.


keyRequired
public java.lang.String getKey();
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/data-sources/spaces_bucket_object#key DataDigitaloceanSpacesBucketObject#key}.


regionRequired
public java.lang.String getRegion();
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/data-sources/spaces_bucket_object#region DataDigitaloceanSpacesBucketObject#region}.


idOptional
public java.lang.String getId();
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/data-sources/spaces_bucket_object#id DataDigitaloceanSpacesBucketObject#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.


rangeOptional
public java.lang.String getRange();
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/data-sources/spaces_bucket_object#range DataDigitaloceanSpacesBucketObject#range}.


versionIdOptional
public java.lang.String getVersionId();
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/data-sources/spaces_bucket_object#version_id DataDigitaloceanSpacesBucketObject#version_id}.