`boto3_s3`¶

Manage S3 Resources using boto3.¶

Renamed from boto_s3 to boto3_s3 and updated to call the refactored boto3_s3 execution module.

Manage S3 resources. Be aware that this interacts with Amazon’s services, and so may incur charges.

depends:

boto3 >= 1.28.0
botocore >= 1.31.0

This module uses boto3, which can be installed via package, or pip.

This module accepts explicit AWS credentials but can also utilize IAM roles assigned to the instance through Instance Profiles. Dynamic credentials are then automatically obtained from AWS API and no further configuration is necessary. More information available here.

If IAM roles are not used you need to specify them either in a pillar file or in the minion’s config file:

s3.keyid: GKTADJGHEIQSXMKKRBJ08H
s3.key: askdjghsdfjkghWupUjasdflkdfklgjsdfjajkghs

It’s also possible to specify key, keyid and region via a profile, either passed in as a dict, or as a string to pull from pillars or minion config:

myprofile:
    keyid: GKTADJGHEIQSXMKKRBJ08H
    key: askdjghsdfjkghWupUjasdflkdfklgjsdfjajkghs
        region: us-east-1

Ensure s3 object exists:
    boto3_s3.object_present:
        - name: s3-bucket/s3-key
        - source: /path/to/local/file
        - region: us-east-1
        - keyid: GKTADJGHEIQSXMKKRBJ08H
        - key: askdjghsdfjkghWupUjasdflkdfklgjsdfjajkghs
        - profile: my-profile

Added in version 1.0.0.

saltext.boto3.states.boto3_s3.__virtual__()[source]¶: Only load if boto is available.

saltext.boto3.states.boto3_s3.object_present(name, source=None, hash_type=None, extra_args=None, extra_args_from_pillar='boto3_s3_object_extra_args', region=None, key=None, keyid=None, profile=None)[source]¶

Ensure object exists in S3.

name: The name of the state definition. This will be used to determine the location of the object in S3, by splitting on the first slash and using the first part as the bucket name and the remainder as the S3 key.
source: The source file to upload to S3, currently this only supports files hosted on the minion’s local file system (starting with /).
hash_type: Hash algorithm to use to check that the object contents are correct. Defaults to the value of the hash_type config option.
extra_args: A dictionary of extra arguments to use when uploading the file. Note that these are only enforced if new objects are uploaded, and not modified on existing objects. The supported args are those in the ALLOWED_UPLOAD_ARGS list at http://boto3.readthedocs.io/en/latest/reference/customizations/s3.html. However, Note that the ‘ACL’, ‘GrantFullControl’, ‘GrantRead’, ‘GrantReadACP’, and ‘GrantWriteACL’ keys are currently not supported.
extra_args_from_pillar: Name of pillar dict that contains extra arguments. Extra arguments defined for this specific state will be merged over those from the pillar.
region: Region to connect to.
key: Secret key to be used.
keyid: Access key to be used.
profile: A dict with region, key and keyid, or a pillar key (string) that contains a dict with region, key and keyid.

Example:

ensure-object-present:
  boto3_s3.object_present:
    - name: example

boto3_s3¶

Manage S3 Resources using boto3.¶

`boto3_s3`¶