| Name | pulumi-aws JSON |
| Version |
6.32.0
JSON |
| download |
| home_page | None |
| Summary | A Pulumi package for creating and managing Amazon Web Services (AWS) cloud resources. |
| upload_time | 2024-04-20 02:31:26 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.8 |
| license | Apache-2.0 |
| keywords |
pulumi
aws
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
[](https://github.com/pulumi/pulumi-aws/actions)
[](https://slack.pulumi.com)
[](https://www.npmjs.com/package/@pulumi/aws)
[](https://pypi.org/project/pulumi-aws)
[](https://badge.fury.io/nu/pulumi.aws)
[](https://pkg.go.dev/github.com/pulumi/pulumi-aws/sdk/v6/go)
[](https://github.com/pulumi/pulumi-aws/blob/master/LICENSE)
# Amazon Web Services (AWS) provider
The 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](https://www.pulumi.com/docs/get-started/install/). For a streamlined Pulumi walkthrough, including language runtime installation and AWS configuration, select "Get Started" below.
<div>
<a href="https://www.pulumi.com/docs/get-started/aws" title="Get Started">
<img src="https://www.pulumi.com/images/get-started.svg?" width="120">
</a>
</div>
## Installing
This 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 either `npm`:
$ npm install @pulumi/aws
or `yarn`:
$ yarn add @pulumi/aws
### Python
To use from Python, install using `pip`:
$ pip install pulumi_aws
### Go
To use from Go, use `go get` to grab the latest version of the library
$ go get github.com/pulumi/pulumi-aws/sdk/v6
### .NET
To use from .NET, install using `dotnet add package`:
$ dotnet add package Pulumi.Aws
## Concepts
The `@pulumi/aws` package 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 Functions
The `aws.lambda.CallbackFunction` class 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 the `examples/` directory.
## Configuration
The 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 the
`AWS_ACCESS_KEY_ID` environment variable, or via a shared credentials file if `aws:profile` is specified.
- `aws:secretKey` - (Optional) This is the AWS secret key. It can also be sourced from the
`AWS_SECRET_ACCESS_KEY` environment variable, or via a shared credentials file if `aws:profile` is 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 the
`AWS_SHARED_CREDENTIALS_FILE` environment 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 the
`AWS_SESSION_TOKEN` environment 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 is `25`.
- `aws:allowedAccountIds` - (Optional) List of allowed AWS account IDs to prevent you from mistakenly using an incorrect
one. Conflicts with `aws: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 also `aws:useFipsEndpoint`.
- `aws:forbiddenAccountIds` - (Optional) List of forbidden AWS account IDs to prevent you from mistakenly using the wrong
one. Conflicts with `aws: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 is `false`.
- `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 is `false`. Can be set via the environment variable `AWS_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 is `true`.
- `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 is `false`. 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 is `true`. Can be set via the environment variable `AWS_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 is `false`.
- `aws:useFipsEndpoint` - (Optional) Force the provider to resolve endpoints with FIPS capability. Can also be set with the `AWS_USE_FIPS_ENDPOINT` environment variable.
### Authenticating pulumi-aws via EC2 Instance Metadata?
As of pulumi-aws v3.28.1, the default behaviour for the provider [was changed](https://github.com/pulumi/pulumi-aws/blob/master/CHANGELOG_OLD.md#3281-2021-02-10) to disable MetadataApiCheck by default. This means, you need to do either of the following
1. When using the default provider:
```
pulumi config set aws:skipMetadataApiCheck false
```
2. When using a named provider
```typescript
const myProvider = new aws.Provider("named-provider", {
// other config
skipMetadataApiCheck: false,
});
```
```csharp
var provider = new Aws.Provider("named-provider", new Aws.ProviderArgs
{
// other config
SkipMetadataApiCheck = false,
});
```
```go
provider, err := aws.NewProvider(ctx, "named-provider", &aws.ProviderArgs{
// other config
SkipMetadataApiCheck: pulumi.BoolPtr(false),
})
```
```python
provider = pulumi_aws.Provider('named-provider', skip_metadata_api_check=False)
```
## Reference
For further information, visit [AWS in the Pulumi Registry](https://www.pulumi.com/registry/packages/aws/)
or for detailed API reference documentation, visit [AWS API Docs in the Pulumi Registry](https://www.pulumi.com/registry/packages/aws/api-docs/).
Raw data
{
"_id": null,
"home_page": null,
"name": "pulumi-aws",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "pulumi, aws",
"author": null,
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/4c/af/5ec4d4c96d709d1591554ab32e2a56b16184021897b8b38e0dad359b155b/pulumi_aws-6.32.0.tar.gz",
"platform": null,
"description": "[](https://github.com/pulumi/pulumi-aws/actions)\n[](https://slack.pulumi.com)\n[](https://www.npmjs.com/package/@pulumi/aws)\n[](https://pypi.org/project/pulumi-aws)\n[](https://badge.fury.io/nu/pulumi.aws)\n[](https://pkg.go.dev/github.com/pulumi/pulumi-aws/sdk/v6/go)\n[](https://github.com/pulumi/pulumi-aws/blob/master/LICENSE)\n\n# Amazon Web Services (AWS) provider\n\nThe Amazon Web Services (AWS) resource provider for Pulumi lets you use AWS resources in your cloud programs. To use\nthis package, [install the Pulumi CLI](https://www.pulumi.com/docs/get-started/install/). For a streamlined Pulumi walkthrough, including language runtime installation and AWS configuration, select \"Get Started\" below.\n\n<div>\n <a href=\"https://www.pulumi.com/docs/get-started/aws\" title=\"Get Started\">\n <img src=\"https://www.pulumi.com/images/get-started.svg?\" width=\"120\">\n </a>\n</div>\n\n## Installing\n\nThis package is available in many languages in the standard packaging formats.\n\n### Node.js (Java/TypeScript)\n\nTo use from JavaScript or TypeScript in Node.js, install using either `npm`:\n\n $ npm install @pulumi/aws\n\nor `yarn`:\n\n $ yarn add @pulumi/aws\n\n### Python\n\nTo use from Python, install using `pip`:\n\n $ pip install pulumi_aws\n\n### Go\n\nTo use from Go, use `go get` to grab the latest version of the library\n\n $ go get github.com/pulumi/pulumi-aws/sdk/v6\n\n### .NET\n\nTo use from .NET, install using `dotnet add package`:\n\n $ dotnet add package Pulumi.Aws\n\n## Concepts\n\nThe `@pulumi/aws` package provides a strongly-typed means to create cloud applications that create and interact closely\nwith AWS resources. Resources are exposed for the entirety of AWS resources and their properties, including (but not\nlimited to), 'apigateway', 'cloudformation', 'EC2', 'ECS', 'iam', 'lambda', etc. Many convenience APIs have also been\nadded to make development easier and to help avoid common mistakes, and to get stronger typing.\n\n### Serverless Functions\n\nThe `aws.lambda.CallbackFunction` class allows you to create an AWS lambda function directly out of a JavaScript/TypeScript\nfunction object of the right signature. This allows a Pulumi program to simply define a lambda using a simple lambda in\nthe language of choice, while having Pulumi itself do the appropriate transformation into the final AWS Lambda resource.\n\nThis makes many APIs easier to use, such as defining a Lambda to execute when an S3 Bucket is manipulated,\nor a CloudWatch timer is fired. To see some examples of this in action, please refer to the `examples/` directory.\n\n## Configuration\n\nThe following configuration points are available:\n\n- `aws:region` - (Required) This is the AWS region.\n\n- `aws:accessKey` - (Optional) This is the AWS access key. It can also be sourced from the\n `AWS_ACCESS_KEY_ID` environment variable, or via a shared credentials file if `aws:profile` is specified.\n- `aws:secretKey` - (Optional) This is the AWS secret key. It can also be sourced from the\n `AWS_SECRET_ACCESS_KEY` environment variable, or via a shared credentials file if `aws:profile` is specified.\n- `aws:profile` - (Optional) This is the AWS profile name as set in the shared credentials file.\n- `aws:sharedCredentialsFiles` - (Optional) List of paths to the shared credentials file. If not set and a profile\n is used, the default value is [~/.aws/credentials]. A single value can also be set with the\n `AWS_SHARED_CREDENTIALS_FILE` environment variable.\n- `aws:token` - (Optional) Session token for validating temporary credentials. Typically provided after successful\n identity federation or Multi-Factor Authentication (MFA) login. With MFA login, this is the session token provided\n afterward, not the 6 digit MFA code used to get temporary credentials. It can also be sourced from the\n `AWS_SESSION_TOKEN` environment variable.\n- `aws:maxRetries` - (Optional) This is the maximum number of times an API call is retried, in the case where requests\n are being throttled or experiencing transient failures. The delay between the subsequent API calls increases\n exponentially. If omitted, the default value is `25`.\n- `aws:allowedAccountIds` - (Optional) List of allowed AWS account IDs to prevent you from mistakenly using an incorrect\n one. Conflicts with `aws:forbiddenAccountIds`.\n- `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 also `aws:useFipsEndpoint`.\n- `aws:forbiddenAccountIds` - (Optional) List of forbidden AWS account IDs to prevent you from mistakenly using the wrong\n one. Conflicts with `aws:allowedAccountIds`.\n- `aws:assumeRole` - (Optional) Supports the following (optional) arguments:\n `durationSections`: Number of seconds to restrict the assume role session duration.\n `externalId`: External identifier to use when assuming the role.\n `policy`: IAM Policy JSON describing further restricting permissions for the IAM Role being assumed.\n `policyArns`: Set of Amazon Resource Names (ARNs) of IAM Policies describing further restricting permissions for the role.\n `roleArn`: Amazon Resource Name (ARN) of the IAM Role to assume.\n `sessionName`: Session name to use when assuming the role.\n `tags`: Map of assume role session tags.\n- `aws:insecure` - (Optional) Explicitly allow the provider to perform \"insecure\" SSL requests. If omitted, the default value is `false`.\n- `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 is `false`. Can be set via the environment variable `AWS_SKIP_CREDENTIALS_VALIDATION`.\n- `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 is `true`.\n- `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 is `false`. When specified, the use of ARNs is compromised as there is no accountID available to construct the ARN.\n- `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 is `true`. Can be set via the environment variable `AWS_SKIP_METADATA_API_CHECK`.\n- `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 is `false`.\n- `aws:useFipsEndpoint` - (Optional) Force the provider to resolve endpoints with FIPS capability. Can also be set with the `AWS_USE_FIPS_ENDPOINT` environment variable.\n\n### Authenticating pulumi-aws via EC2 Instance Metadata?\n\nAs of pulumi-aws v3.28.1, the default behaviour for the provider [was changed](https://github.com/pulumi/pulumi-aws/blob/master/CHANGELOG_OLD.md#3281-2021-02-10) to disable MetadataApiCheck by default. This means, you need to do either of the following\n\n1. When using the default provider:\n```\npulumi config set aws:skipMetadataApiCheck false\n```\n\n2. When using a named provider\n```typescript\nconst myProvider = new aws.Provider(\"named-provider\", {\n // other config\n skipMetadataApiCheck: false,\n});\n```\n\n```csharp\nvar provider = new Aws.Provider(\"named-provider\", new Aws.ProviderArgs\n{\n // other config\n SkipMetadataApiCheck = false,\n});\n```\n\n```go\nprovider, err := aws.NewProvider(ctx, \"named-provider\", &aws.ProviderArgs{\n // other config\n SkipMetadataApiCheck: pulumi.BoolPtr(false),\n})\n```\n\n```python\nprovider = pulumi_aws.Provider('named-provider', skip_metadata_api_check=False)\n```\n\n## Reference\n\nFor further information, visit [AWS in the Pulumi Registry](https://www.pulumi.com/registry/packages/aws/)\nor for detailed API reference documentation, visit [AWS API Docs in the Pulumi Registry](https://www.pulumi.com/registry/packages/aws/api-docs/).\n",
"bugtrack_url": null,
"license": "Apache-2.0",
"summary": "A Pulumi package for creating and managing Amazon Web Services (AWS) cloud resources.",
"version": "6.32.0",
"project_urls": {
"Homepage": "https://pulumi.io",
"Repository": "https://github.com/pulumi/pulumi-aws"
},
"split_keywords": [
"pulumi",
" aws"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "e8857aa4c519052f3b527c0adc4041d0539865bb5c649bfdf0ae587461e14941",
"md5": "471d37df0668aa5a5204f76122ba2bb4",
"sha256": "584ec43de4efc821bf5f8f46ebfb0a074a6281c64bcfaddae239f2ac1ecf21ac"
},
"downloads": -1,
"filename": "pulumi_aws-6.32.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "471d37df0668aa5a5204f76122ba2bb4",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 8818557,
"upload_time": "2024-04-20T02:31:13",
"upload_time_iso_8601": "2024-04-20T02:31:13.998929Z",
"url": "https://files.pythonhosted.org/packages/e8/85/7aa4c519052f3b527c0adc4041d0539865bb5c649bfdf0ae587461e14941/pulumi_aws-6.32.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "4caf5ec4d4c96d709d1591554ab32e2a56b16184021897b8b38e0dad359b155b",
"md5": "8f0ac9c3f4ce2e6dfa6f1d80f0736358",
"sha256": "8aff673d5eaeaaea894ce4e8b71a4f77da3a6c084258c34db651d0319f862045"
},
"downloads": -1,
"filename": "pulumi_aws-6.32.0.tar.gz",
"has_sig": false,
"md5_digest": "8f0ac9c3f4ce2e6dfa6f1d80f0736358",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 6384394,
"upload_time": "2024-04-20T02:31:26",
"upload_time_iso_8601": "2024-04-20T02:31:26.451461Z",
"url": "https://files.pythonhosted.org/packages/4c/af/5ec4d4c96d709d1591554ab32e2a56b16184021897b8b38e0dad359b155b/pulumi_aws-6.32.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-20 02:31:26",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "pulumi",
"github_project": "pulumi-aws",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "pulumi-aws"
}
