> ## 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.
# Typescript: OssBackendConfig
> CDKTN Core API Reference for OssBackendConfig in Typescript.
## Initializer
```typescript theme={null}
import { OssBackendConfig } from 'cdktn'
const ossBackendConfig: OssBackendConfig = { ... }
```
## Properties
| **Name** | **Type** | **Description** |
| ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| bucket | string | (Required) The name of the OSS bucket. |
| accessKey | string | (Optional) Alibaba Cloud access key. |
| acl | string | (Optional) Object ACL to be applied to the state file. |
| assumeRole | OssAssumeRole | *No description.* |
| assumeRolePolicy | 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 | 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 | 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 | 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 | 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 | boolean | (Optional) Whether to enable server side encryption of the state file. |
| endpoint | string | (Optional) A custom endpoint for the OSS API. |
| key | string | (Optional) The name of the state file. |
| prefix | string | (Optional) The path directory of the state file will be stored. |
| profile | 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 | string | (Optional) The region of the OSS bucket. |
| secretKey | string | (Optional) Alibaba Cloud secret access key. |
| securityToken | string | (Optional) STS access token. |
| sharedCredentialsFile | 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 | 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 | string | (Optional) A custom endpoint for the TableStore API. |
| tablestoreTable | string | (Optional) A TableStore table for state locking and consistency. |
***
### `bucket`Required
```typescript theme={null}
public readonly bucket: string;
```
* *Type:* string
(Required) The name of the OSS bucket.
***
### `accessKey`Optional
```typescript theme={null}
public readonly accessKey: string;
```
* *Type:* string
(Optional) Alibaba Cloud access key.
It supports environment variables ALICLOUD\_ACCESS\_KEY and ALICLOUD\_ACCESS\_KEY\_ID.
***
### `acl`Optional
```typescript theme={null}
public readonly acl: string;
```
* *Type:* string
(Optional) Object ACL to be applied to the state file.
***
### ~~`assumeRole`~~Optional
* *Deprecated:* Use flattened assume role options
```typescript theme={null}
public readonly assumeRole: OssAssumeRole;
```
* *Type:* OssAssumeRole
***
### `assumeRolePolicy`Optional
```typescript theme={null}
public readonly assumeRolePolicy: string;
```
* *Type:* 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
```typescript theme={null}
public readonly assumeRoleRoleArn: string;
```
* *Type:* 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
```typescript theme={null}
public readonly assumeRoleSessionExpiration: number;
```
* *Type:* 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
```typescript theme={null}
public readonly assumeRoleSessionName: string;
```
* *Type:* 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
```typescript theme={null}
public readonly ecsRoleName: string;
```
* *Type:* 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
```typescript theme={null}
public readonly encrypt: boolean;
```
* *Type:* 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
```typescript theme={null}
public readonly endpoint: string;
```
* *Type:* string
(Optional) A custom endpoint for the OSS API.
It supports environment variables ALICLOUD\_OSS\_ENDPOINT and OSS\_ENDPOINT.
***
### `key`Optional
```typescript theme={null}
public readonly key: string;
```
* *Type:* string
(Optional) The name of the state file.
Defaults to terraform.tfstate.
***
### `prefix`Optional
```typescript theme={null}
public readonly prefix: string;
```
* *Type:* string
(Optional) The path directory of the state file will be stored.
Default to "env:".
***
### `profile`Optional
```typescript theme={null}
public readonly profile: string;
```
* *Type:* 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
```typescript theme={null}
public readonly region: string;
```
* *Type:* string
(Optional) The region of the OSS bucket.
It supports environment variables ALICLOUD\_REGION and ALICLOUD\_DEFAULT\_REGION.
***
### `secretKey`Optional
```typescript theme={null}
public readonly secretKey: string;
```
* *Type:* string
(Optional) Alibaba Cloud secret access key.
It supports environment variables ALICLOUD\_SECRET\_KEY and ALICLOUD\_ACCESS\_KEY\_SECRET.
***
### `securityToken`Optional
```typescript theme={null}
public readonly securityToken: string;
```
* *Type:* string
(Optional) STS access token.
It supports environment variable ALICLOUD\_SECURITY\_TOKEN.
***
### `sharedCredentialsFile`Optional
```typescript theme={null}
public readonly sharedCredentialsFile: string;
```
* *Type:* 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
```typescript theme={null}
public readonly stsEndpoint: string;
```
* *Type:* 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
```typescript theme={null}
public readonly tablestoreEndpoint: string;
```
* *Type:* string
(Optional) A custom endpoint for the TableStore API.
***
### `tablestoreTable`Optional
```typescript theme={null}
public readonly tablestoreTable: string;
```
* *Type:* string
(Optional) A TableStore table for state locking and consistency.
The table must have a primary key named LockID of type String.
***