> ## Documentation Index
> Fetch the complete documentation index at: https://cdktn.io/docs/llms.txt
> Use this file to discover all available pages before exploring further.
# Java: OssBackend
> CDKTN Core API Reference for OssBackend in Java.
## Initializers
```java theme={null}
import io.cdktn.cdktn.OssBackend;
OssBackend.Builder.create(Construct scope)
.bucket(java.lang.String)
// .accessKey(java.lang.String)
// .acl(java.lang.String)
// .assumeRole(OssAssumeRole)
// .assumeRolePolicy(java.lang.String)
// .assumeRoleRoleArn(java.lang.String)
// .assumeRoleSessionExpiration(java.lang.Number)
// .assumeRoleSessionName(java.lang.String)
// .ecsRoleName(java.lang.String)
// .encrypt(java.lang.Boolean)
// .endpoint(java.lang.String)
// .key(java.lang.String)
// .prefix(java.lang.String)
// .profile(java.lang.String)
// .region(java.lang.String)
// .secretKey(java.lang.String)
// .securityToken(java.lang.String)
// .sharedCredentialsFile(java.lang.String)
// .stsEndpoint(java.lang.String)
// .tablestoreEndpoint(java.lang.String)
// .tablestoreTable(java.lang.String)
.build();
```
| **Name** | **Type** | **Description** |
| -------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| scope | software.constructs.Construct | *No description.* |
| bucket | java.lang.String | (Required) The name of the OSS bucket. |
| accessKey | java.lang.String | (Optional) Alibaba Cloud access key. |
| acl | java.lang.String | (Optional) Object ACL to be applied to the state file. |
| assumeRole | OssAssumeRole | *No description.* |
| assumeRolePolicy | java.lang.String | (Optional, Available in 1.1.0+) A more restrictive policy to apply to the temporary credentials. This gives you a way to further restrict the permissions for the resulting temporary security credentials. You cannot use this policy to grant permissions that exceed those of the role that is being assumed. |
| assumeRoleRoleArn | java.lang.String | (Optional, Available in 1.1.0+) The ARN of the role to assume. If ARN is set to an empty string, it does not perform role switching. It supports the environment variable ALICLOUD\_ASSUME\_ROLE\_ARN. Terraform executes configuration on account with provided credentials. |
| assumeRoleSessionExpiration | java.lang.Number | (Optional, Available in 1.1.0+) The time after which the established session for assuming role expires. Valid value range: \[900-3600] seconds. Default to 3600 (in this case Alibaba Cloud uses its own default value). It supports environment variable ALICLOUD\_ASSUME\_ROLE\_SESSION\_EXPIRATION. |
| assumeRoleSessionName | java.lang.String | (Optional, Available in 1.1.0+) The session name to use when assuming the role. If omitted, 'terraform' is passed to the AssumeRole call as session name. It supports environment variable ALICLOUD\_ASSUME\_ROLE\_SESSION\_NAME. |
| ecsRoleName | java.lang.String | (Optional, Available in 0.12.14+) The RAM Role Name attached on a ECS instance for API operations. You can retrieve this from the 'Access Control' section of the Alibaba Cloud console. |
| encrypt | java.lang.Boolean | (Optional) Whether to enable server side encryption of the state file. |
| endpoint | java.lang.String | (Optional) A custom endpoint for the OSS API. |
| key | java.lang.String | (Optional) The name of the state file. |
| prefix | java.lang.String | (Optional) The path directory of the state file will be stored. |
| profile | java.lang.String | (Optional, Available in 0.12.8+) This is the Alibaba Cloud profile name as set in the shared credentials file. It can also be sourced from the ALICLOUD\_PROFILE environment variable. |
| region | java.lang.String | (Optional) The region of the OSS bucket. |
| secretKey | java.lang.String | (Optional) Alibaba Cloud secret access key. |
| securityToken | java.lang.String | (Optional) STS access token. |
| sharedCredentialsFile | java.lang.String | (Optional, Available in 0.12.8+) This is the path to the shared credentials file. It can also be sourced from the ALICLOUD\_SHARED\_CREDENTIALS\_FILE environment variable. If this is not set and a profile is specified, \~/.aliyun/config.json will be used. |
| stsEndpoint | java.lang.String | (Optional, Available in 1.0.11+) Custom endpoint for the AliCloud Security Token Service (STS) API. It supports environment variable ALICLOUD\_STS\_ENDPOINT. |
| tablestoreEndpoint | java.lang.String | (Optional) A custom endpoint for the TableStore API. |
| tablestoreTable | java.lang.String | (Optional) A TableStore table for state locking and consistency. |
***
### `scope`Required
* *Type:* software.constructs.Construct
***
### `bucket`Required
* *Type:* java.lang.String
(Required) The name of the OSS bucket.
***
### `accessKey`Optional
* *Type:* java.lang.String
(Optional) Alibaba Cloud access key.
It supports environment variables ALICLOUD\_ACCESS\_KEY and ALICLOUD\_ACCESS\_KEY\_ID.
***
### `acl`Optional
* *Type:* java.lang.String
(Optional) Object ACL to be applied to the state file.
***
### ~~`assumeRole`~~Optional
* *Deprecated:* Use flattened assume role options
* *Type:* OssAssumeRole
***
### `assumeRolePolicy`Optional
* *Type:* java.lang.String
(Optional, Available in 1.1.0+) A more restrictive policy to apply to the temporary credentials. This gives you a way to further restrict the permissions for the resulting temporary security credentials. You cannot use this policy to grant permissions that exceed those of the role that is being assumed.
***
### `assumeRoleRoleArn`Optional
* *Type:* java.lang.String
(Optional, Available in 1.1.0+) The ARN of the role to assume. If ARN is set to an empty string, it does not perform role switching. It supports the environment variable ALICLOUD\_ASSUME\_ROLE\_ARN. Terraform executes configuration on account with provided credentials.
***
### `assumeRoleSessionExpiration`Optional
* *Type:* java.lang.Number
(Optional, Available in 1.1.0+) The time after which the established session for assuming role expires. Valid value range: \[900-3600] seconds. Default to 3600 (in this case Alibaba Cloud uses its own default value). It supports environment variable ALICLOUD\_ASSUME\_ROLE\_SESSION\_EXPIRATION.
***
### `assumeRoleSessionName`Optional
* *Type:* java.lang.String
(Optional, Available in 1.1.0+) The session name to use when assuming the role. If omitted, 'terraform' is passed to the AssumeRole call as session name. It supports environment variable ALICLOUD\_ASSUME\_ROLE\_SESSION\_NAME.
***
### `ecsRoleName`Optional
* *Type:* java.lang.String
(Optional, Available in 0.12.14+) The RAM Role Name attached on a ECS instance for API operations. You can retrieve this from the 'Access Control' section of the Alibaba Cloud console.
***
### `encrypt`Optional
* *Type:* java.lang.Boolean
(Optional) Whether to enable server side encryption of the state file.
If it is true, OSS will use 'AES256' encryption algorithm to encrypt state file.
***
### `endpoint`Optional
* *Type:* java.lang.String
(Optional) A custom endpoint for the OSS API.
It supports environment variables ALICLOUD\_OSS\_ENDPOINT and OSS\_ENDPOINT.
***
### `key`Optional
* *Type:* java.lang.String
(Optional) The name of the state file.
Defaults to terraform.tfstate.
***
### `prefix`Optional
* *Type:* java.lang.String
(Optional) The path directory of the state file will be stored.
Default to "env:".
***
### `profile`Optional
* *Type:* java.lang.String
(Optional, Available in 0.12.8+) This is the Alibaba Cloud profile name as set in the shared credentials file. It can also be sourced from the ALICLOUD\_PROFILE environment variable.
***
### `region`Optional
* *Type:* java.lang.String
(Optional) The region of the OSS bucket.
It supports environment variables ALICLOUD\_REGION and ALICLOUD\_DEFAULT\_REGION.
***
### `secretKey`Optional
* *Type:* java.lang.String
(Optional) Alibaba Cloud secret access key.
It supports environment variables ALICLOUD\_SECRET\_KEY and ALICLOUD\_ACCESS\_KEY\_SECRET.
***
### `securityToken`Optional
* *Type:* java.lang.String
(Optional) STS access token.
It supports environment variable ALICLOUD\_SECURITY\_TOKEN.
***
### `sharedCredentialsFile`Optional
* *Type:* java.lang.String
(Optional, Available in 0.12.8+) This is the path to the shared credentials file. It can also be sourced from the ALICLOUD\_SHARED\_CREDENTIALS\_FILE environment variable. If this is not set and a profile is specified, \~/.aliyun/config.json will be used.
***
### `stsEndpoint`Optional
* *Type:* java.lang.String
(Optional, Available in 1.0.11+) Custom endpoint for the AliCloud Security Token Service (STS) API. It supports environment variable ALICLOUD\_STS\_ENDPOINT.
***
### `tablestoreEndpoint`Optional
* *Type:* java.lang.String
(Optional) A custom endpoint for the TableStore API.
***
### `tablestoreTable`Optional
* *Type:* java.lang.String
(Optional) A TableStore table for state locking and consistency.
The table must have a primary key named LockID of type String.
***
## Methods
| **Name** | **Description** |
| ---------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- |
| toString | Returns a string representation of this construct. |
| with | Applies one or more mixins to 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 | *No description.* |
| toMetadata | *No description.* |
| toTerraform | Adds this resource to the terraform JSON output. |
| getRemoteStateDataSource | Creates a TerraformRemoteState resource that accesses this backend. |
***
### `toString`
```java theme={null}
public java.lang.String toString()
```
Returns a string representation of this construct.
### `with`
```java theme={null}
public IConstruct with(IMixin... mixins)
```
Applies one or more mixins to this construct.
Mixins are applied in order. The list of constructs is captured at the
start of the call, so constructs added by a mixin will not be visited.
Use multiple `with()` calls if subsequent mixins should apply to added
constructs.
#### `mixins`Required
* *Type:* software.constructs.IMixin...
The mixins to apply.
***
### `addOverride`
```java theme={null}
public void addOverride(java.lang.String path, java.lang.Object value)
```
#### `path`Required
* *Type:* java.lang.String
***
#### `value`Required
* *Type:* java.lang.Object
***
### `overrideLogicalId`
```java theme={null}
public void overrideLogicalId(java.lang.String newLogicalId)
```
Overrides the auto-generated logical ID with a specific ID.
#### `newLogicalId`Required
* *Type:* java.lang.String
The new logical ID to use for this stack element.
***
### `resetOverrideLogicalId`
```java theme={null}
public void resetOverrideLogicalId()
```
Resets a previously passed logical Id to use the auto-generated logical id again.
### `toHclTerraform`
```java theme={null}
public java.lang.Object toHclTerraform()
```
### `toMetadata`
```java theme={null}
public java.lang.Object toMetadata()
```
### `toTerraform`
```java theme={null}
public java.lang.Object toTerraform()
```
Adds this resource to the terraform JSON output.
### `getRemoteStateDataSource`
```java theme={null}
public TerraformRemoteState getRemoteStateDataSource(Construct scope, java.lang.String name, java.lang.String _fromStack)
```
Creates a TerraformRemoteState resource that accesses this backend.
#### `scope`Required
* *Type:* software.constructs.Construct
***
#### `name`Required
* *Type:* java.lang.String
***
#### `_fromStack`Required
* *Type:* java.lang.String
***
## Static Functions
| **Name** | **Description** |
| ---------------------------------------------------------------------------------- | ----------------------------- |
| isConstruct | Checks if `x` is a construct. |
| isTerraformElement | *No description.* |
| isBackend | *No description.* |
***
### `isConstruct`
```java theme={null}
import io.cdktn.cdktn.OssBackend;
OssBackend.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.
#### `x`Required
* *Type:* java.lang.Object
Any object.
***
### `isTerraformElement`
```java theme={null}
import io.cdktn.cdktn.OssBackend;
OssBackend.isTerraformElement(java.lang.Object x)
```
#### `x`Required
* *Type:* java.lang.Object
***
### `isBackend`
```java theme={null}
import io.cdktn.cdktn.OssBackend;
OssBackend.isBackend(java.lang.Object x)
```
#### `x`Required
* *Type:* java.lang.Object
***
## Properties
| **Name** | **Type** | **Description** |
| --------------------------------------------------------------------------------------- | --------------------------------------------------------------- | ----------------- |
| node | software.constructs.Node | The tree node. |
| cdktfStack | TerraformStack | *No description.* |
| fqn | java.lang.String | *No description.* |
| friendlyUniqueId | java.lang.String | *No description.* |
***
### `node`Required
```java theme={null}
public Node getNode();
```
* *Type:* software.constructs.Node
The tree node.
***
### `cdktfStack`Required
```java theme={null}
public TerraformStack getCdktfStack();
```
* *Type:* TerraformStack
***
### `fqn`Required
```java theme={null}
public java.lang.String getFqn();
```
* *Type:* java.lang.String
***
### `friendlyUniqueId`Required
```java theme={null}
public java.lang.String getFriendlyUniqueId();
```
* *Type:* java.lang.String
***