> ## 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.
# Go: DataTerraformRemoteStateOssConfig
> CDKTN Core API Reference for DataTerraformRemoteStateOssConfig in Go.
## Initializer
```go theme={null}
import "github.com/open-constructs/cdk-terrain-go/cdktn"
&cdktn.DataTerraformRemoteStateOssConfig {
Defaults: *map[string]interface{},
Workspace: *string,
Bucket: *string,
AccessKey: *string,
Acl: *string,
AssumeRole: github.com/open-constructs/cdk-terrain-go/cdktn.OssAssumeRole,
AssumeRolePolicy: *string,
AssumeRoleRoleArn: *string,
AssumeRoleSessionExpiration: *f64,
AssumeRoleSessionName: *string,
EcsRoleName: *string,
Encrypt: *bool,
Endpoint: *string,
Key: *string,
Prefix: *string,
Profile: *string,
Region: *string,
SecretKey: *string,
SecurityToken: *string,
SharedCredentialsFile: *string,
StsEndpoint: *string,
TablestoreEndpoint: *string,
TablestoreTable: *string,
}
```
## Properties
| **Name** | **Type** | **Description** |
| ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Defaults | \*map\[string]interface\{} | *No description.* |
| Workspace | \*string | *No 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 | \*f64 | (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 | \*bool | (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. |
***
### `Defaults`Optional
```go theme={null}
Defaults *map[string]interface{}
```
* *Type:* \*map\[string]interface\{}
***
### `Workspace`Optional
```go theme={null}
Workspace *string
```
* *Type:* \*string
***
### `Bucket`Required
```go theme={null}
Bucket *string
```
* *Type:* \*string
(Required) The name of the OSS bucket.
***
### `AccessKey`Optional
```go theme={null}
AccessKey *string
```
* *Type:* \*string
(Optional) Alibaba Cloud access key.
It supports environment variables ALICLOUD\_ACCESS\_KEY and ALICLOUD\_ACCESS\_KEY\_ID.
***
### `Acl`Optional
```go theme={null}
Acl *string
```
* *Type:* \*string
(Optional) Object ACL to be applied to the state file.
***
### ~~`AssumeRole`~~Optional
* *Deprecated:* Use flattened assume role options
```go theme={null}
AssumeRole OssAssumeRole
```
* *Type:* OssAssumeRole
***
### `AssumeRolePolicy`Optional
```go theme={null}
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
```go theme={null}
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
```go theme={null}
AssumeRoleSessionExpiration *f64
```
* *Type:* \*f64
(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
```go theme={null}
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
```go theme={null}
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
```go theme={null}
Encrypt *bool
```
* *Type:* \*bool
(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
```go theme={null}
Endpoint *string
```
* *Type:* \*string
(Optional) A custom endpoint for the OSS API.
It supports environment variables ALICLOUD\_OSS\_ENDPOINT and OSS\_ENDPOINT.
***
### `Key`Optional
```go theme={null}
Key *string
```
* *Type:* \*string
(Optional) The name of the state file.
Defaults to terraform.tfstate.
***
### `Prefix`Optional
```go theme={null}
Prefix *string
```
* *Type:* \*string
(Optional) The path directory of the state file will be stored.
Default to "env:".
***
### `Profile`Optional
```go theme={null}
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
```go theme={null}
Region *string
```
* *Type:* \*string
(Optional) The region of the OSS bucket.
It supports environment variables ALICLOUD\_REGION and ALICLOUD\_DEFAULT\_REGION.
***
### `SecretKey`Optional
```go theme={null}
SecretKey *string
```
* *Type:* \*string
(Optional) Alibaba Cloud secret access key.
It supports environment variables ALICLOUD\_SECRET\_KEY and ALICLOUD\_ACCESS\_KEY\_SECRET.
***
### `SecurityToken`Optional
```go theme={null}
SecurityToken *string
```
* *Type:* \*string
(Optional) STS access token.
It supports environment variable ALICLOUD\_SECURITY\_TOKEN.
***
### `SharedCredentialsFile`Optional
```go theme={null}
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
```go theme={null}
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
```go theme={null}
TablestoreEndpoint *string
```
* *Type:* \*string
(Optional) A custom endpoint for the TableStore API.
***
### `TablestoreTable`Optional
```go theme={null}
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.
***