Module config

This page documents the language specification for the alicloud package. If you're looking for help working with the inputs, outputs, or functions of alicloud resources in a Pulumi program, please see the resource documentation for examples and API reference.

This provider is a derived work of the Terraform Provider distributed under MPL 2.0. If you encounter a bug or missing feature, first check the pulumi/pulumi-alicloud repo; however, if that doesn’t turn up anything, please consult the source terraform-providers/terraform-provider-alicloud repo.

APIs

APIs

let accessKey

let accessKey: string | undefined =  __config.get("accessKey") || utilities.getEnv("ALICLOUD_ACCESS_KEY");

The access key for API operations. You can retrieve this from the ‘Security Management’ section of the Alibaba Cloud console.

let accountId

let accountId: string | undefined =  __config.get("accountId") || utilities.getEnv("ALICLOUD_ACCOUNT_ID");

The account ID for some service API operations. You can retrieve this from the ‘Security Settings’ section of the Alibaba Cloud console.

let assumeRole

let assumeRole: {
    policy?: undefined | string;
    roleArn: string;
    sessionExpiration?: undefined | number;
    sessionName?: undefined | string;
} | undefined =  __config.getObject<{ policy?: string, roleArn: string, sessionExpiration?: number, sessionName?: string }>("assumeRole");

let configurationSource

let configurationSource: string | undefined =  __config.get("configurationSource");

Use this to mark a terraform configuration file source.

let ecsRoleName

let ecsRoleName: string | undefined =  __config.get("ecsRoleName") || utilities.getEnv("ALICLOUD_ECS_ROLE_NAME");

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.

let endpoints

let endpoints: {
    actiontrail?: undefined | string;
    adb?: undefined | string;
    alidns?: undefined | string;
    alikafka?: undefined | string;
    apigateway?: undefined | string;
    bssopenapi?: undefined | string;
    cas?: undefined | string;
    cbn?: undefined | string;
    cdn?: undefined | string;
    cen?: undefined | string;
    cms?: undefined | string;
    cr?: undefined | string;
    cs?: undefined | string;
    datahub?: undefined | string;
    ddosbgp?: undefined | string;
    ddoscoo?: undefined | string;
    dds?: undefined | string;
    dmsEnterprise?: undefined | string;
    dns?: undefined | string;
    drds?: undefined | string;
    ecs?: undefined | string;
    elasticsearch?: undefined | string;
    emr?: undefined | string;
    ess?: undefined | string;
    fc?: undefined | string;
    gpdb?: undefined | string;
    kms?: undefined | string;
    kvstore?: undefined | string;
    location?: undefined | string;
    log?: undefined | string;
    market?: undefined | string;
    maxcompute?: undefined | string;
    mns?: undefined | string;
    nas?: undefined | string;
    ons?: undefined | string;
    oss?: undefined | string;
    ots?: undefined | string;
    polardb?: undefined | string;
    pvtz?: undefined | string;
    ram?: undefined | string;
    rds?: undefined | string;
    resourcemanager?: undefined | string;
    slb?: undefined | string;
    sts?: undefined | string;
    vpc?: undefined | string;
    wafOpenapi?: undefined | string;
}[] | undefined =  __config.getObject<{ actiontrail?: string, adb?: string, alidns?: string, alikafka?: string, apigateway?: string, bssopenapi?: string, cas?: string, cbn?: string, cdn?: string, cen?: string, cms?: string, cr?: string, cs?: string, datahub?: string, ddosbgp?: string, ddoscoo?: string, dds?: string, dmsEnterprise?: string, dns?: string, drds?: string, ecs?: string, elasticsearch?: string, emr?: string, ess?: string, fc?: string, gpdb?: string, kms?: string, kvstore?: string, location?: string, log?: string, market?: string, maxcompute?: string, mns?: string, nas?: string, ons?: string, oss?: string, ots?: string, polardb?: string, pvtz?: string, ram?: string, rds?: string, resourcemanager?: string, slb?: string, sts?: string, vpc?: string, wafOpenapi?: string }[]>("endpoints");

let fc

let fc: string | undefined =  __config.get("fc");

let logEndpoint

let logEndpoint: string | undefined =  __config.get("logEndpoint");

let mnsEndpoint

let mnsEndpoint: string | undefined =  __config.get("mnsEndpoint");

let otsInstanceName

let otsInstanceName: string | undefined =  __config.get("otsInstanceName");

let profile

let profile: string | undefined =  __config.get("profile") || utilities.getEnv("ALICLOUD_PROFILE");

The profile for API operations. If not set, the default profile created with aliyun configure will be used.

let protocol

let protocol: string | undefined =  __config.get("protocol");

let region

let region: string | undefined =  __config.get("region") || utilities.getEnv("ALICLOUD_REGION");

The region where Alibaba Cloud operations will take place. Examples are cn-beijing, cn-hangzhou, eu-central-1, etc.

let secretKey

let secretKey: string | undefined =  __config.get("secretKey") || utilities.getEnv("ALICLOUD_SECRET_KEY");

The secret key for API operations. You can retrieve this from the ‘Security Management’ section of the Alibaba Cloud console.

let securityToken

let securityToken: string | undefined =  __config.get("securityToken") || utilities.getEnv("ALICLOUD_SECURITY_TOKEN");

security token. A security token is only required if you are using Security Token Service.

let sharedCredentialsFile

let sharedCredentialsFile: string | undefined =  __config.get("sharedCredentialsFile") || utilities.getEnv("ALICLOUD_SHARED_CREDENTIALS_FILE");

The path to the shared credentials file. If not set this defaults to ~/.aliyun/config.json

let skipRegionValidation

let skipRegionValidation: boolean | undefined =  __config.getObject<boolean>("skipRegionValidation");

Skip static validation of region ID. Used by users of alternative AlibabaCloud-like APIs or users w/ access to regions that are not public (yet).