github.com/leeprovoost/terraform@v0.6.10-0.20160119085442-96f3f76118e7/website/source/docs/providers/aws/index.html.markdown (about)

     1  ---
     2  layout: "aws"
     3  page_title: "Provider: AWS"
     4  sidebar_current: "docs-aws-index"
     5  description: |-
     6    The Amazon Web Services (AWS) provider is used to interact with the many resources supported by AWS. The provider needs to be configured with the proper credentials before it can be used.
     7  ---
     8  
     9  # AWS Provider
    10  
    11  The Amazon Web Services (AWS) provider is used to interact with the
    12  many resources supported by AWS. The provider needs to be configured
    13  with the proper credentials before it can be used.
    14  
    15  Use the navigation to the left to read about the available resources.
    16  
    17  ## Example Usage
    18  
    19  ```
    20  # Configure the AWS Provider
    21  provider "aws" {
    22      access_key = "${var.aws_access_key}"
    23      secret_key = "${var.aws_secret_key}"
    24      region = "us-east-1"
    25  }
    26  
    27  # Create a web server
    28  resource "aws_instance" "web" {
    29      ...
    30  }
    31  ```
    32  
    33  ## Argument Reference
    34  
    35  The following arguments are supported in the `provider` block:
    36  
    37  * `access_key` - (Optional) This is the AWS access key. It must be provided, but
    38    it can also be sourced from the `AWS_ACCESS_KEY_ID` environment variable, or via
    39    a shared credentials file if `profile` is specified.
    40  
    41  * `secret_key` - (Optional) This is the AWS secret key. It must be provided, but
    42    it can also be sourced from the `AWS_SECRET_ACCESS_KEY` environment variable, or
    43    via a shared credentials file if `profile` is specified.
    44  
    45  * `region` - (Required) This is the AWS region. It must be provided, but
    46    it can also be sourced from the `AWS_DEFAULT_REGION` environment variables, or
    47    via a shared credentials file if `profile` is specified.
    48  
    49  * `profile` - (Optional) This is the AWS profile name as set in the shared credentials
    50    file.
    51  
    52  * `shared_credentials_file` = (Optional) This is the path to the shared credentials file.
    53    If this is not set and a profile is specified, ~/.aws/credentials will be used.
    54  
    55  * `token` - (Optional) Use this to set an MFA token. It can also be sourced
    56    from the `AWS_SECURITY_TOKEN` environment variable.
    57  
    58  * `max_retries` - (Optional) This is the maximum number of times an API call is
    59    being retried in case requests are being throttled or experience transient failures.
    60    The delay between the subsequent API calls increases exponentially.
    61  
    62  * `allowed_account_ids` - (Optional) List of allowed AWS account IDs (whitelist)
    63    to prevent you mistakenly using a wrong one (and end up destroying live environment).
    64    Conflicts with `forbidden_account_ids`.
    65  
    66  * `forbidden_account_ids` - (Optional) List of forbidden AWS account IDs (blacklist)
    67    to prevent you mistakenly using a wrong one (and end up destroying live environment).
    68    Conflicts with `allowed_account_ids`.
    69  
    70  * `dynamodb_endpoint` - (Optional) Use this to override the default endpoint
    71    URL constructed from the `region`. It's typically used to connect to
    72    dynamodb-local.
    73  
    74  * `kinesis_endpoint` - (Optional) Use this to override the default endpoint URL
    75    constructed from the `region`. It's typically used to connect to kinesalite.
    76