step-security/"Configure AWS Credentials" Action for GitHub Actions

Configures AWS credentials for use in subsequent steps in a GitHub Action workflow

View on GitHub

Trust Signals

Scorecard Score
not yet scored
Maintenance Recency
Stale
License
None
namedescriptionrequireddefault
aws-regionAWS Region, e.g. us-east-2yes
aws-profileName of the AWS profile to configure. When provided, credentials are written to ~/.aws/credentials and ~/.aws/config files instead of env variables (unless output-env-credentials is manually set to true). Name cannot contain whitespace, square brackets, or slashes.no
overwrite-aws-profileOverwrite the given AWS profile if it already exists. Requires aws-profile. When set to false or not set, an error will be thrown if the profile already exists.no
role-to-assumeThe Amazon Resource Name (ARN) of the role to assume. Use the provided credentials to assume an IAM role and configure the Actions environment with the assumed role credentials rather than with the provided credentials.no
aws-access-key-idAWS Access Key ID. Provide this key if you want to assume a role using access keys rather than a web identity token.no
aws-secret-access-keyAWS Secret Access Key. Required if aws-access-key-id is provided.no
aws-session-tokenAWS Session Token.no
web-identity-token-fileUse the web identity token file from the provided file system path in order to assume an IAM role using a web identity, e.g. from within an Amazon EKS worker node.no
role-chainingUse existing credentials from the environment to assume a new role, rather than providing credentials as input.no
audienceThe audience to use for the OIDC providernosts.amazonaws.com
http-proxyProxy to use for the AWS SDK agentno
no-proxyHosts to skip for the proxy configurationno
mask-aws-account-idWhether to mask the AWS account ID for these credentials as a secret value. By default the account ID will not be maskedno
role-duration-secondsRole duration in seconds. Default is one hour.no
role-external-idThe external ID of the role to assume.no
role-session-nameRole session name (default: GitHubActions)no
role-skip-session-taggingSkip session tagging during role assumptionno
transitive-tag-keysDefine a list of transitive tag keys to pass when assuming a roleno
inline-session-policyDefine an inline session policy to use when assuming a roleno
managed-session-policiesDefine a list of managed session policies to use when assuming a roleno
output-credentialsWhether to set credentials as step outputno
output-env-credentialsWhether to export credentials as environment variables. If you set this to false, you probably want to use output-credentials.no
unset-current-credentialsWhether to unset the existing credentials in your runner. May be useful if you run this action multiple times in the same jobno
disable-retryWhether to disable the retry and backoff mechanism when the assume role call fails. By default the retry mechanism is enabledno
retry-max-attemptsThe maximum number of attempts it will attempt to retry the assume role call. By default it will retry 12 timesno
special-characters-workaroundSome environments do not support special characters in AWS_SECRET_ACCESS_KEY. This option will retry fetching credentials until the secret access key does not contain special characters. This option overrides disable-retry and retry-max-attempts. This option is disabled by defaultno
use-existing-credentialsWhen enabled, this option will check if there are already valid credentials in the environment. If there are, new credentials will not be fetched. If there are not, the action will run as normal.no
allowed-account-idsAn option comma-delimited list of expected AWS account IDs. The action will fail if we receive credentials for the wrong account.no
force-skip-oidcWhen enabled, this option will skip using GitHub OIDC provider even if the id-token permission is set. This is sometimes useful when using IAM instance credentials.no
action-timeout-sA global timeout in seconds for the action. When the timeout is reached, the action immediately exits. The default is to run without a timeout.no
custom-tagsAdditional tags to apply to the assumed role session. Must be a JSON object provided as a string.no
sts-endpointCustom STS endpoint URL. Use this to point to an STS-compatible API (e.g. MinIO, LocalStack) instead of the default AWS STS endpoint for the region.no
namedescription
aws-account-idThe AWS account ID for the provided credentials
aws-access-key-idThe AWS access key ID for the provided credentials
aws-secret-access-keyThe AWS secret access key for the provided credentials
aws-session-tokenThe AWS session token for the provided credentials
aws-expirationThe expiration time for the provided credentials