1. Docs
  2. Reference
  3. API
  4. @pulumi/aws
  5. config

Module config

This page documents the language specification for the aws package. If you're looking for help working with the inputs, outputs, or functions of aws 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-aws repo; however, if that doesn’t turn up anything, please consult the source terraform-providers/terraform-provider-aws repo.

APIs

APIs

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: AssumeRole | undefined =  __config.getObject<outputs.config.AssumeRole>("assumeRole");

let endpoints

let endpoints: Endpoints[] | undefined =  __config.getObject<outputs.config.Endpoints[]>("endpoints");

let forbiddenAccountIds

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

let ignoreTags

let ignoreTags: IgnoreTags | undefined =  __config.getObject<outputs.config.IgnoreTags>("ignoreTags");

Configuration block with settings to ignore resource tags across all resources.

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 =  <Region>__config.get("region") || <any>utilities.getEnv("AWS_REGION", "AWS_DEFAULT_REGION");

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

function requireRegion

requireRegion(): Region

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

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.