Module config

@pulumi/aws > config

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-aws repo; however, if that doesn’t turn up anything, please consult the source terraform-providers/terraform-provider-aws repo.

function requireRegion

requireRegion(): Region

requireRegion fetches the AWS region, requiring that it exists; if it has not been configured, an error is thrown.

let accessKey

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

The access key for API operations. You can retrieve this from the ‘Security & Credentials’ section of the AWS console.

let allowedAccountIds

let allowedAccountIds: string[] | undefined =  __config.getObject<string[]>("allowedAccountIds");

let assumeRole

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

let endpoints

let endpoints: {
    acm: undefined | string;
    acmpca: undefined | string;
    apigateway: undefined | string;
    applicationautoscaling: undefined | string;
    applicationinsights: undefined | string;
    appmesh: undefined | string;
    appsync: undefined | string;
    athena: undefined | string;
    autoscaling: undefined | string;
    autoscalingplans: undefined | string;
    backup: undefined | string;
    batch: undefined | string;
    budgets: undefined | string;
    cloud9: undefined | string;
    cloudformation: undefined | string;
    cloudfront: undefined | string;
    cloudhsm: undefined | string;
    cloudsearch: undefined | string;
    cloudtrail: undefined | string;
    cloudwatch: undefined | string;
    cloudwatchevents: undefined | string;
    cloudwatchlogs: undefined | string;
    codebuild: undefined | string;
    codecommit: undefined | string;
    codedeploy: undefined | string;
    codepipeline: undefined | string;
    cognitoidentity: undefined | string;
    cognitoidp: undefined | string;
    configservice: undefined | string;
    cur: undefined | string;
    datapipeline: undefined | string;
    datasync: undefined | string;
    dax: undefined | string;
    devicefarm: undefined | string;
    directconnect: undefined | string;
    dlm: undefined | string;
    dms: undefined | string;
    docdb: undefined | string;
    ds: undefined | string;
    dynamodb: undefined | string;
    ec2: undefined | string;
    ecr: undefined | string;
    ecs: undefined | string;
    efs: undefined | string;
    eks: undefined | string;
    elasticache: undefined | string;
    elasticbeanstalk: undefined | string;
    elastictranscoder: undefined | string;
    elb: undefined | string;
    emr: undefined | string;
    es: undefined | string;
    firehose: undefined | string;
    fms: undefined | string;
    fsx: undefined | string;
    gamelift: undefined | string;
    glacier: undefined | string;
    globalaccelerator: undefined | string;
    glue: undefined | string;
    guardduty: undefined | string;
    iam: undefined | string;
    inspector: undefined | string;
    iot: undefined | string;
    kafka: undefined | string;
    kinesis: undefined | string;
    kinesisAnalytics: undefined | string;
    kinesisanalytics: undefined | string;
    kinesisvideo: undefined | string;
    kms: undefined | string;
    lambda: undefined | string;
    lexmodels: undefined | string;
    licensemanager: undefined | string;
    lightsail: undefined | string;
    macie: undefined | string;
    managedblockchain: undefined | string;
    mediaconnect: undefined | string;
    mediaconvert: undefined | string;
    medialive: undefined | string;
    mediapackage: undefined | string;
    mediastore: undefined | string;
    mediastoredata: undefined | string;
    mq: undefined | string;
    neptune: undefined | string;
    opsworks: undefined | string;
    organizations: undefined | string;
    pinpoint: undefined | string;
    pricing: undefined | string;
    quicksight: undefined | string;
    r53: undefined | string;
    ram: undefined | string;
    rds: undefined | string;
    redshift: undefined | string;
    resourcegroups: undefined | string;
    route53: undefined | string;
    route53resolver: undefined | string;
    s3: undefined | string;
    s3control: undefined | string;
    sagemaker: undefined | string;
    sdb: undefined | string;
    secretsmanager: undefined | string;
    securityhub: undefined | string;
    serverlessrepo: undefined | string;
    servicecatalog: undefined | string;
    servicediscovery: undefined | string;
    servicequotas: undefined | string;
    ses: undefined | string;
    shield: undefined | string;
    sns: undefined | string;
    sqs: undefined | string;
    ssm: undefined | string;
    stepfunctions: undefined | string;
    storagegateway: undefined | string;
    sts: undefined | string;
    swf: undefined | string;
    transfer: undefined | string;
    waf: undefined | string;
    wafregional: undefined | string;
    worklink: undefined | string;
    workspaces: undefined | string;
    xray: undefined | string;
}[] | undefined =  __config.getObject<{ acm?: string, acmpca?: string, apigateway?: string, applicationautoscaling?: string, applicationinsights?: string, appmesh?: string, appsync?: string, athena?: string, autoscaling?: string, autoscalingplans?: string, backup?: string, batch?: string, budgets?: string, cloud9?: string, cloudformation?: string, cloudfront?: string, cloudhsm?: string, cloudsearch?: string, cloudtrail?: string, cloudwatch?: string, cloudwatchevents?: string, cloudwatchlogs?: string, codebuild?: string, codecommit?: string, codedeploy?: string, codepipeline?: string, cognitoidentity?: string, cognitoidp?: string, configservice?: string, cur?: string, datapipeline?: string, datasync?: string, dax?: string, devicefarm?: string, directconnect?: string, dlm?: string, dms?: string, docdb?: string, ds?: string, dynamodb?: string, ec2?: string, ecr?: string, ecs?: string, efs?: string, eks?: string, elasticache?: string, elasticbeanstalk?: string, elastictranscoder?: string, elb?: string, emr?: string, es?: string, firehose?: string, fms?: string, fsx?: string, gamelift?: string, glacier?: string, globalaccelerator?: string, glue?: string, guardduty?: string, iam?: string, inspector?: string, iot?: string, kafka?: string, kinesis?: string, kinesisAnalytics?: string, kinesisanalytics?: string, kinesisvideo?: string, kms?: string, lambda?: string, lexmodels?: string, licensemanager?: string, lightsail?: string, macie?: string, managedblockchain?: string, mediaconnect?: string, mediaconvert?: string, medialive?: string, mediapackage?: string, mediastore?: string, mediastoredata?: string, mq?: string, neptune?: string, opsworks?: string, organizations?: string, pinpoint?: string, pricing?: string, quicksight?: string, r53?: string, ram?: string, rds?: string, redshift?: string, resourcegroups?: string, route53?: string, route53resolver?: string, s3?: string, s3control?: string, sagemaker?: string, sdb?: string, secretsmanager?: string, securityhub?: string, serverlessrepo?: string, servicecatalog?: string, servicediscovery?: string, servicequotas?: string, ses?: string, shield?: string, sns?: string, sqs?: string, ssm?: string, stepfunctions?: string, storagegateway?: string, sts?: string, swf?: string, transfer?: string, waf?: string, wafregional?: string, worklink?: string, workspaces?: string, xray?: string }[]>("endpoints");

let forbiddenAccountIds

let forbiddenAccountIds: string[] | undefined =  __config.getObject<string[]>("forbiddenAccountIds");

let insecure

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

Explicitly allow the provider to perform “insecure” SSL requests. If omitted,default value is false

let maxRetries

let maxRetries: number | undefined =  __config.getObject<number>("maxRetries");

The maximum number of times an AWS API request is being executed. If the API request still fails, an error is thrown.

let profile

let profile: string | undefined =  config.get("profile") || utilities.getEnv("AWS_PROFILE");

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

let region

let region: Region | undefined =  <any>config.get("region") || utilities.getEnv("AWS_REGION", "AWS_DEFAULT_REGION");

The region where AWS operations will take place. Examples are us-east-1, us-west-2, etc.

let s3ForcePathStyle

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

Set this to true to force the request to use path-style addressing, i.e., http://s3.amazonaws.com/BUCKET/KEY. By default, the S3 client will use virtual hosted bucket addressing when possible (http://BUCKET.s3.amazonaws.com/KEY). Specific to the Amazon S3 service.

let secretKey

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

The secret key for API operations. You can retrieve this from the ‘Security & Credentials’ section of the AWS console.

let sharedCredentialsFile

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

The path to the shared credentials file. If not set this defaults to ~/.aws/credentials.

let skipCredentialsValidation

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

Skip the credentials validation via STS API. Used for AWS API implementations that do not have STS available/implemented.

let skipGetEc2Platforms

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

Skip getting the supported EC2 platforms. Used by users that don’t have ec2:DescribeAccountAttributes permissions.

let skipMetadataApiCheck

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

let skipRegionValidation

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

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

let skipRequestingAccountId

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

Skip requesting the account ID. Used for AWS API implementations that do not have IAM/STS API and/or metadata API.

let token

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

session token. A session token is only required if you are using temporary security credentials.