> ## 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.

# CSharp: DataTerraformRemoteStateCosConfig

> CDKTN Core API Reference for DataTerraformRemoteStateCosConfig in CSharp.

## Initializer <a name="Initializer" id="cdktn.DataTerraformRemoteStateCosConfig.Initializer" />

```csharp theme={null}
using Io.Cdktn;

new DataTerraformRemoteStateCosConfig {
    System.Collections.Generic.IDictionary<string, object> Defaults = null,
    string Workspace = null,
    string Bucket,
    bool Accelerate = null,
    string Acl = null,
    CosBackendAssumeRole AssumeRole = null,
    string Domain = null,
    bool Encrypt = null,
    string Endpoint = null,
    string Key = null,
    string Prefix = null,
    string Region = null,
    string SecretId = null,
    string SecretKey = null,
    string SecurityToken = null
};
```

## Properties <a name="Properties" id="Properties" />

| **Name**                                                                                                 | **Type**                                                                    | **Description**                                                                        |
| -------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- |
| <code><a href="#cdktn.DataTerraformRemoteStateCosConfig.property.defaults">Defaults</a></code>           | <code>System.Collections.Generic.IDictionary\< string, object ></code>      | *No description.*                                                                      |
| <code><a href="#cdktn.DataTerraformRemoteStateCosConfig.property.workspace">Workspace</a></code>         | <code>string</code>                                                         | *No description.*                                                                      |
| <code><a href="#cdktn.DataTerraformRemoteStateCosConfig.property.bucket">Bucket</a></code>               | <code>string</code>                                                         | (Required) The name of the COS bucket.                                                 |
| <code><a href="#cdktn.DataTerraformRemoteStateCosConfig.property.accelerate">Accelerate</a></code>       | <code>bool</code>                                                           | (Optional) Whether to enable global Acceleration.                                      |
| <code><a href="#cdktn.DataTerraformRemoteStateCosConfig.property.acl">Acl</a></code>                     | <code>string</code>                                                         | (Optional) Object ACL to be applied to the state file, allows private and public-read. |
| <code><a href="#cdktn.DataTerraformRemoteStateCosConfig.property.assumeRole">AssumeRole</a></code>       | <code><a href="#cdktn.CosBackendAssumeRole">CosBackendAssumeRole</a></code> | (Optional) The assume\_role block.                                                     |
| <code><a href="#cdktn.DataTerraformRemoteStateCosConfig.property.domain">Domain</a></code>               | <code>string</code>                                                         | (Optional) The root domain of the API request.                                         |
| <code><a href="#cdktn.DataTerraformRemoteStateCosConfig.property.encrypt">Encrypt</a></code>             | <code>bool</code>                                                           | (Optional) Whether to enable server side encryption of the state file.                 |
| <code><a href="#cdktn.DataTerraformRemoteStateCosConfig.property.endpoint">Endpoint</a></code>           | <code>string</code>                                                         | (Optional) The Custom Endpoint for the COS backend.                                    |
| <code><a href="#cdktn.DataTerraformRemoteStateCosConfig.property.key">Key</a></code>                     | <code>string</code>                                                         | (Optional) The path for saving the state file in bucket.                               |
| <code><a href="#cdktn.DataTerraformRemoteStateCosConfig.property.prefix">Prefix</a></code>               | <code>string</code>                                                         | (Optional) The directory for saving the state file in bucket.                          |
| <code><a href="#cdktn.DataTerraformRemoteStateCosConfig.property.region">Region</a></code>               | <code>string</code>                                                         | (Optional) The region of the COS bucket.                                               |
| <code><a href="#cdktn.DataTerraformRemoteStateCosConfig.property.secretId">SecretId</a></code>           | <code>string</code>                                                         | (Optional) Secret id of Tencent Cloud.                                                 |
| <code><a href="#cdktn.DataTerraformRemoteStateCosConfig.property.secretKey">SecretKey</a></code>         | <code>string</code>                                                         | (Optional) Secret key of Tencent Cloud.                                                |
| <code><a href="#cdktn.DataTerraformRemoteStateCosConfig.property.securityToken">SecurityToken</a></code> | <code>string</code>                                                         | (Optional) TencentCloud Security Token of temporary access credentials.                |

***

### `Defaults`<sup>Optional</sup> <a name="Defaults" id="cdktn.DataTerraformRemoteStateCosConfig.property.defaults" />

```csharp theme={null}
public System.Collections.Generic.IDictionary<string, object> Defaults { get; set; }
```

* *Type:* System.Collections.Generic.IDictionary\< string, object >

***

### `Workspace`<sup>Optional</sup> <a name="Workspace" id="cdktn.DataTerraformRemoteStateCosConfig.property.workspace" />

```csharp theme={null}
public string Workspace { get; set; }
```

* *Type:* string

***

### `Bucket`<sup>Required</sup> <a name="Bucket" id="cdktn.DataTerraformRemoteStateCosConfig.property.bucket" />

```csharp theme={null}
public string Bucket { get; set; }
```

* *Type:* string

(Required) The name of the COS bucket.

You shall manually create it first.

***

### `Accelerate`<sup>Optional</sup> <a name="Accelerate" id="cdktn.DataTerraformRemoteStateCosConfig.property.accelerate" />

```csharp theme={null}
public bool Accelerate { get; set; }
```

* *Type:* bool

(Optional) Whether to enable global Acceleration.

Defaults to false.

***

### `Acl`<sup>Optional</sup> <a name="Acl" id="cdktn.DataTerraformRemoteStateCosConfig.property.acl" />

```csharp theme={null}
public string Acl { get; set; }
```

* *Type:* string

(Optional) Object ACL to be applied to the state file, allows private and public-read.

Defaults to private.

***

### `AssumeRole`<sup>Optional</sup> <a name="AssumeRole" id="cdktn.DataTerraformRemoteStateCosConfig.property.assumeRole" />

```csharp theme={null}
public CosBackendAssumeRole AssumeRole { get; set; }
```

* *Type:* <a href="#cdktn.CosBackendAssumeRole">CosBackendAssumeRole</a>

(Optional) The assume\_role block.

If provided, terraform will attempt to assume this role using the supplied credentials.

***

### `Domain`<sup>Optional</sup> <a name="Domain" id="cdktn.DataTerraformRemoteStateCosConfig.property.domain" />

```csharp theme={null}
public string Domain { get; set; }
```

* *Type:* string

(Optional) The root domain of the API request.

Defaults to tencentcloudapi.com.
It supports the environment variable TENCENTCLOUD\_DOMAIN.

***

### `Encrypt`<sup>Optional</sup> <a name="Encrypt" id="cdktn.DataTerraformRemoteStateCosConfig.property.encrypt" />

```csharp theme={null}
public bool Encrypt { get; set; }
```

* *Type:* bool

(Optional) Whether to enable server side encryption of the state file.

If it is true, COS will use 'AES256' encryption algorithm to encrypt state file.

***

### `Endpoint`<sup>Optional</sup> <a name="Endpoint" id="cdktn.DataTerraformRemoteStateCosConfig.property.endpoint" />

```csharp theme={null}
public string Endpoint { get; set; }
```

* *Type:* string

(Optional) The Custom Endpoint for the COS backend.

It supports the environment variable TENCENTCLOUD\_ENDPOINT.

***

### `Key`<sup>Optional</sup> <a name="Key" id="cdktn.DataTerraformRemoteStateCosConfig.property.key" />

```csharp theme={null}
public string Key { get; set; }
```

* *Type:* string

(Optional) The path for saving the state file in bucket.

Defaults to terraform.tfstate.

***

### `Prefix`<sup>Optional</sup> <a name="Prefix" id="cdktn.DataTerraformRemoteStateCosConfig.property.prefix" />

```csharp theme={null}
public string Prefix { get; set; }
```

* *Type:* string

(Optional) The directory for saving the state file in bucket.

Default to "env:".

***

### `Region`<sup>Optional</sup> <a name="Region" id="cdktn.DataTerraformRemoteStateCosConfig.property.region" />

```csharp theme={null}
public string Region { get; set; }
```

* *Type:* string

(Optional) The region of the COS bucket.

It supports environment variables TENCENTCLOUD\_REGION.

***

### `SecretId`<sup>Optional</sup> <a name="SecretId" id="cdktn.DataTerraformRemoteStateCosConfig.property.secretId" />

```csharp theme={null}
public string SecretId { get; set; }
```

* *Type:* string

(Optional) Secret id of Tencent Cloud.

It supports environment variables TENCENTCLOUD\_SECRET\_ID.

***

### `SecretKey`<sup>Optional</sup> <a name="SecretKey" id="cdktn.DataTerraformRemoteStateCosConfig.property.secretKey" />

```csharp theme={null}
public string SecretKey { get; set; }
```

* *Type:* string

(Optional) Secret key of Tencent Cloud.

It supports environment variables TENCENTCLOUD\_SECRET\_KEY.

***

### `SecurityToken`<sup>Optional</sup> <a name="SecurityToken" id="cdktn.DataTerraformRemoteStateCosConfig.property.securityToken" />

```csharp theme={null}
public string SecurityToken { get; set; }
```

* *Type:* string

(Optional) TencentCloud Security Token of temporary access credentials.

It supports environment variables TENCENTCLOUD\_SECURITY\_TOKEN.

***