Fork me on GitHub

Module config

@pulumi/aws > config

Index

config/require.ts config/vars.ts

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: { ... } | undefined =  __config.getObject<{ externalId?: string, policy?: string, roleArn?: string, sessionName?: string }>("assumeRole");

let dynamodbEndpoint

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

Use this to override the default endpoint URL constructed from the region. It’s typically used to connect to dynamodb-local.

let endpoints

let endpoints: { ... }[] | undefined =  __config.getObject<{ acm?: string, apigateway?: string, autoscaling?: string, cloudformation?: string, cloudwatch?: string, cloudwatchevents?: string, cloudwatchlogs?: string, devicefarm?: string, dynamodb?: string, ec2?: string, ecr?: string, ecs?: string, efs?: string, elb?: string, es?: string, iam?: string, kinesis?: string, kms?: string, lambda?: string, r53?: string, rds?: string, s3?: string, sns?: string, sqs?: string, ssm?: string, sts?: 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 kinesisEndpoint

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

Use this to override the default endpoint URL constructed from the region. It’s typically used to connect to kinesalite.

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");

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

let region

let region: Region =  <any>utilities.requireWithDefault(() => __config.require("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.