bucket_website#

Exec functions for s3 bucket’s website configurations.

async idem_aws.exec.aws.s3.bucket_website.get(hub, ctx, resource_id: str, name: str = None, expected_bucket_owner: str = None) → Dict[source]#

Returns the website configuration of a bucket.

Parameters:

  • resource_id (str) – AWS S3 bucket name.

  • name (str, Optional) – The name of the Idem state.

  • expected_bucket_owner (str, Optional) – The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied). Defaults to None.

Examples

Calling from the CLI:

$ idem exec aws.s3.bucket_website.get name="bucket-name" resource_id="bucket-id"

Using in a state:

get_a_bucket:
  exec.run:
    - path: aws.s3.bucket.get
    - kwargs:
       name: bucket-name
       resource_id: bucket-id