CSharp: OssBackendConfig

Initializer

using Io.Cdktn;

new OssBackendConfig {
    string Bucket,
    string AccessKey = null,
    string Acl = null,
    OssAssumeRole AssumeRole = null,
    string AssumeRolePolicy = null,
    string AssumeRoleRoleArn = null,
    double AssumeRoleSessionExpiration = null,
    string AssumeRoleSessionName = null,
    string EcsRoleName = null,
    bool Encrypt = null,
    string Endpoint = null,
    string Key = null,
    string Prefix = null,
    string Profile = null,
    string Region = null,
    string SecretKey = null,
    string SecurityToken = null,
    string SharedCredentialsFile = null,
    string StsEndpoint = null,
    string TablestoreEndpoint = null,
    string TablestoreTable = null
};

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`	`double`	(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.

`Bucket`^Required

public string Bucket { get; set; }

Type: string

(Required) The name of the OSS bucket.

`AccessKey`^Optional

public string AccessKey { get; set; }

Type: string

(Optional) Alibaba Cloud access key. It supports environment variables ALICLOUD_ACCESS_KEY and ALICLOUD_ACCESS_KEY_ID.

`Acl`^Optional

public string Acl { get; set; }

Type: string

(Optional) Object ACL to be applied to the state file.

`AssumeRole`^Optional

Deprecated: Use flattened assume role options

public OssAssumeRole AssumeRole { get; set; }

Type: OssAssumeRole

`AssumeRolePolicy`^Optional

public string AssumeRolePolicy { get; set; }

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

public string AssumeRoleRoleArn { get; set; }

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

public double AssumeRoleSessionExpiration { get; set; }

Type: double

(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

public string AssumeRoleSessionName { get; set; }

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

public string EcsRoleName { get; set; }

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

public bool Encrypt { get; set; }

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

public string Endpoint { get; set; }

Type: string

(Optional) A custom endpoint for the OSS API. It supports environment variables ALICLOUD_OSS_ENDPOINT and OSS_ENDPOINT.

`Key`^Optional

public string Key { get; set; }

Type: string

(Optional) The name of the state file. Defaults to terraform.tfstate.

`Prefix`^Optional

public string Prefix { get; set; }

Type: string

(Optional) The path directory of the state file will be stored. Default to “env:”.

`Profile`^Optional

public string Profile { get; set; }

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

public string Region { get; set; }

Type: string

(Optional) The region of the OSS bucket. It supports environment variables ALICLOUD_REGION and ALICLOUD_DEFAULT_REGION.

`SecretKey`^Optional

public string SecretKey { get; set; }

Type: string

(Optional) Alibaba Cloud secret access key. It supports environment variables ALICLOUD_SECRET_KEY and ALICLOUD_ACCESS_KEY_SECRET.

`SecurityToken`^Optional

public string SecurityToken { get; set; }

Type: string

(Optional) STS access token. It supports environment variable ALICLOUD_SECURITY_TOKEN.

`SharedCredentialsFile`^Optional

public string SharedCredentialsFile { get; set; }

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

public string StsEndpoint { get; set; }

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

public string TablestoreEndpoint { get; set; }

Type: string

(Optional) A custom endpoint for the TableStore API.

`TablestoreTable`^Optional

public string TablestoreTable { get; set; }

Type: string

(Optional) A TableStore table for state locking and consistency. The table must have a primary key named LockID of type String.

Overview

TypeScript

Python

Java

C#

Go

Initializer

Properties

`Bucket`^Required

`AccessKey`^Optional

`Acl`^Optional

`AssumeRole`^Optional

`AssumeRolePolicy`^Optional

`AssumeRoleRoleArn`^Optional

`AssumeRoleSessionExpiration`^Optional

`AssumeRoleSessionName`^Optional

`EcsRoleName`^Optional

`Encrypt`^Optional

`Endpoint`^Optional

`Key`^Optional

`Prefix`^Optional

`Profile`^Optional

`Region`^Optional

`SecretKey`^Optional

`SecurityToken`^Optional

`SharedCredentialsFile`^Optional

`StsEndpoint`^Optional

`TablestoreEndpoint`^Optional

`TablestoreTable`^Optional

Overview

TypeScript

Python

Java

C#

Go

​Initializer

​Properties

​BucketRequired

​AccessKeyOptional

​AclOptional

​AssumeRoleOptional

​AssumeRolePolicyOptional

​AssumeRoleRoleArnOptional

​AssumeRoleSessionExpirationOptional

​AssumeRoleSessionNameOptional

​EcsRoleNameOptional

​EncryptOptional

​EndpointOptional

​KeyOptional

​PrefixOptional

​ProfileOptional

​RegionOptional

​SecretKeyOptional

​SecurityTokenOptional

​SharedCredentialsFileOptional

​StsEndpointOptional

​TablestoreEndpointOptional

​TablestoreTableOptional

Initializer

Properties

`Bucket`^Required

`AccessKey`^Optional

`Acl`^Optional

`AssumeRole`^Optional

`AssumeRolePolicy`^Optional

`AssumeRoleRoleArn`^Optional

`AssumeRoleSessionExpiration`^Optional

`AssumeRoleSessionName`^Optional

`EcsRoleName`^Optional

`Encrypt`^Optional

`Endpoint`^Optional

`Key`^Optional

`Prefix`^Optional

`Profile`^Optional

`Region`^Optional

`SecretKey`^Optional

`SecurityToken`^Optional

`SharedCredentialsFile`^Optional

`StsEndpoint`^Optional

`TablestoreEndpoint`^Optional

`TablestoreTable`^Optional