Package: pulumi-aws
Amazon Web Services (AWS) providerThe Amazon Web Services (AWS) resource provider for Pulumi lets you use AWS resources in your cloud programs. To use
this package,install the Pulumi CLI. For a streamlined Pulumi walkthrough, including language runtime installation and AWS configuration, select "Get Started" below.InstallingThis package is available in many languages in the standard packaging formats.Node.js (Java/TypeScript)To use from JavaScript or TypeScript in Node.js, install using eithernpm:$ npm install @pulumi/awsoryarn:$ yarn add @pulumi/awsPythonTo use from Python, install usingpip:$ pip install pulumi_awsGoTo use from Go, usego getto grab the latest version of the library$ go get github.com/pulumi/pulumi-aws/sdk/v6.NETTo use from .NET, install usingdotnet add package:$ dotnet add package Pulumi.AwsConceptsThe@pulumi/awspackage provides a strongly-typed means to create cloud applications that create and interact closely
with AWS resources.  Resources are exposed for the entirety of AWS resources and their properties, including (but not
limited to), 'apigateway', 'cloudformation', 'EC2', 'ECS', 'iam', 'lambda', etc.  Many convenience APIs have also been
added to make development easier and to help avoid common mistakes, and to get stronger typing.Serverless FunctionsTheaws.lambda.CallbackFunctionclass allows you to create an AWS lambda function directly out of a JavaScript/TypeScript
function object of the right signature. This allows a Pulumi program to simply define a lambda using a simple lambda in
the language of choice, while having Pulumi itself do the appropriate transformation into the final AWS Lambda resource.This makes many APIs easier to use, such as defining a Lambda to execute when an S3 Bucket is manipulated,
or a CloudWatch timer is fired. To see some examples of this in action, please refer to theexamples/directory.ConfigurationThe following configuration points are available:aws:region- (Required) This is the AWS region.aws:accessKey- (Optional) This is the AWS access key. It can also be sourced from theAWS_ACCESS_KEY_IDenvironment variable, or via a shared credentials file ifaws:profileis specified.aws:secretKey- (Optional) This is the AWS secret key. It can also be sourced from theAWS_SECRET_ACCESS_KEYenvironment variable, or via a shared credentials file ifaws:profileis specified.aws:profile- (Optional) This is the AWS profile name as set in the shared credentials file.aws:sharedCredentialsFiles- (Optional) List of paths to the shared credentials file. If not set and a profile
is used, the default value is [~/.aws/credentials]. A single value can also be set with theAWS_SHARED_CREDENTIALS_FILEenvironment variable.aws:token- (Optional) Session token for validating temporary credentials. Typically provided after successful
identity federation or Multi-Factor Authentication (MFA) login. With MFA login, this is the session token provided
afterward, not the 6 digit MFA code used to get temporary credentials. It can also be sourced from theAWS_SESSION_TOKENenvironment variable.aws:maxRetries- (Optional) This is the maximum number of times an API call is retried, in the case where requests
are being throttled or experiencing transient failures. The delay between the subsequent API calls increases
exponentially. If omitted, the default value is25.aws:allowedAccountIds- (Optional)  List of allowed AWS account IDs to prevent you from mistakenly using an incorrect
one. Conflicts withaws:forbiddenAccountIds.aws:endpoints- (Optional) Configuration block for customizing service endpoints. See the Custom Service Endpoints Guide for more information about connecting to alternate AWS endpoints or AWS compatible solutions. See alsoaws:useFipsEndpoint.aws:forbiddenAccountIds- (Optional) List of forbidden AWS account IDs to prevent you from mistakenly using the wrong
one. Conflicts withaws:allowedAccountIds.aws:assumeRole- (Optional) Supports the following (optional) arguments:durationSections: Number of seconds to restrict the assume role session duration.externalId: External identifier to use when assuming the role.policy: IAM Policy JSON describing further restricting permissions for the IAM Role being assumed.policyArns: Set of Amazon Resource Names (ARNs) of IAM Policies describing further restricting permissions for the role.roleArn: Amazon Resource Name (ARN) of the IAM Role to assume.sessionName: Session name to use when assuming the role.tags: Map of assume role session tags.aws:insecure- (Optional) Explicitly allow the provider to perform "insecure" SSL requests. If omitted, the default value isfalse.aws:skipCredentialsValidation- (Optional) Skip the credentials validation via the STS API. Useful for AWS API implementations that do not have STS available or implemented. Default value isfalse. Can be set via the environment variableAWS_SKIP_CREDENTIALS_VALIDATION.aws:skipRegionValidation- (Optional) Skip validation of provided region name. Useful for AWS-like implementations that use their own region names or to bypass the validation for regions that aren't publicly available yet. Default value istrue.aws:skipRequestionAccountId- (Optional) Skip requesting the account ID. Useful for AWS API implementations that do not have the IAM, STS API, or metadata API. Default value isfalse. When specified, the use of ARNs is compromised as there is no accountID available to construct the ARN.aws:skipMetadataApiCheck- (Optional) Skip the AWS Metadata API check. Useful for AWS API implementations that do not have a metadata API endpoint. This provider from authenticating via the Metadata API by default. You may need to use other authentication methods like static credentials, configuration variables, or environment variables. Default istrue. Can be set via the environment variableAWS_SKIP_METADATA_API_CHECK.aws:s3UsePathStyle- (Optional) 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,http://BUCKET.s3.amazonaws.com/KEY, when possible. Specific to the Amazon S3 service. Default isfalse.aws:useFipsEndpoint- (Optional) Force the provider to resolve endpoints with FIPS capability. Can also be set with theAWS_USE_FIPS_ENDPOINTenvironment variable.Authenticating pulumi-aws via EC2 Instance Metadata?As of pulumi-aws v3.28.1, the default behaviour for the providerwas changedto disable MetadataApiCheck by default. This means, you need to do either of the followingWhen using the default provider:pulumi config set aws:skipMetadataApiCheck falseWhen using a named providerconstmyProvider=newaws.Provider("named-provider",{// other configskipMetadataApiCheck:false,});varprovider=newAws.Provider("named-provider",newAws.ProviderArgs{// other configSkipMetadataApiCheck=false,});provider,err:=aws.NewProvider(ctx,"named-provider",&aws.ProviderArgs{// other configSkipMetadataApiCheck:pulumi.BoolPtr(false),})provider=pulumi_aws.Provider('named-provider',skip_metadata_api_check=False)ReferenceFor further information, visitAWS in the Pulumi Registryor for detailed API reference documentation, visitAWS API Docs in the Pulumi Registry.