View Source AWS.RolesAnywhere (aws-elixir v0.13.3)

AWS Identity and Access Management Roles Anywhere provides a secure way for your workloads such as servers, containers, and applications running outside of AWS to obtain Temporary AWS credentials.

Your workloads can use the same IAM policies and roles that you have configured with native AWS applications to access AWS resources. Using IAM Roles Anywhere will eliminate the need to manage long term credentials for workloads running outside of AWS.

To use IAM Roles Anywhere customer workloads will need to use X.509 certificates issued by their Certificate Authority (CA) . The Certificate Authority (CA) needs to be registered with IAM Roles Anywhere as a trust anchor to establish trust between customer PKI and IAM Roles Anywhere. Customers who do not manage their own PKI system can use AWS Certificate Manager Private Certificate Authority (ACM PCA) to create a Certificate Authority and use that to establish trust with IAM Roles Anywhere

This guide describes the IAM rolesanywhere operations that you can call programmatically. For general information about IAM Roles Anywhere see https://docs.aws.amazon.com/

Link to this section Summary

Functions

Deletes a certificate revocation list (CRL).

Disables a certificate revocation list (CRL).

Enables a certificate revocation list (CRL).

Enables the roles in a profile to receive session credentials in CreateSession.

Gets a certificate revocation list (CRL).

Imports the certificate revocation list (CRL).

Lists all Crls in the authenticated account and Amazon Web Services Region.

Lists all profiles in the authenticated account and Amazon Web Services Region.

Lists the subjects in the authenticated account and Amazon Web Services Region.

Lists the tags attached to the resource.

Lists the trust anchors in the authenticated account and Amazon Web Services Region.

Attaches tags to a resource.

Removes tags from the resource.

Updates the certificate revocation list (CRL).

Updates the trust anchor.You establish trust between IAM Roles Anywhere and your certificate authority (CA) by configuring a trust anchor.

Link to this section Functions

Link to this function

create_profile(client, input, options \\ [])

View Source

Creates a profile.

A profile is configuration resource to list the roles that RolesAnywhere service is trusted to assume. In addition, by applying a profile you can intersect permissions with IAM managed policies.

Required permissions: rolesanywhere:CreateProfile.

Link to this function

create_trust_anchor(client, input, options \\ [])

View Source

Creates a trust anchor.

You establish trust between IAM Roles Anywhere and your certificate authority (CA) by configuring a trust anchor. A Trust Anchor is defined either as a reference to a AWS Certificate Manager Private Certificate Authority (ACM PCA), or by uploading a Certificate Authority (CA) certificate. Your AWS workloads can authenticate with the trust anchor using certificates issued by the trusted Certificate Authority (CA) in exchange for temporary AWS credentials.

Required permissions: rolesanywhere:CreateTrustAnchor.

Link to this function

delete_crl(client, crl_id, input, options \\ [])

View Source

Deletes a certificate revocation list (CRL).

Required permissions: rolesanywhere:DeleteCrl.

Link to this function

delete_profile(client, profile_id, input, options \\ [])

View Source

Deletes a profile.

Required permissions: rolesanywhere:DeleteProfile.

Link to this function

delete_trust_anchor(client, trust_anchor_id, input, options \\ [])

View Source

Deletes a trust anchor.

Required permissions: rolesanywhere:DeleteTrustAnchor.

Link to this function

disable_crl(client, crl_id, input, options \\ [])

View Source

Disables a certificate revocation list (CRL).

Required permissions: rolesanywhere:DisableCrl.

Link to this function

disable_profile(client, profile_id, input, options \\ [])

View Source

Disables a profile.

When disabled, CreateSession requests with this profile fail.

Required permissions: rolesanywhere:DisableProfile.

Link to this function

disable_trust_anchor(client, trust_anchor_id, input, options \\ [])

View Source

Disables a trust anchor.

When disabled, CreateSession requests specifying this trust anchor are unauthorized.

Required permissions: rolesanywhere:DisableTrustAnchor.

Link to this function

enable_crl(client, crl_id, input, options \\ [])

View Source

Enables a certificate revocation list (CRL).

When enabled, certificates stored in the CRL are unauthorized to receive session credentials.

Required permissions: rolesanywhere:EnableCrl.

Link to this function

enable_profile(client, profile_id, input, options \\ [])

View Source

Enables the roles in a profile to receive session credentials in CreateSession.

Required permissions: rolesanywhere:EnableProfile.

Link to this function

enable_trust_anchor(client, trust_anchor_id, input, options \\ [])

View Source

Enables a trust anchor.

When enabled, certificates in the trust anchor chain are authorized for trust validation.

Required permissions: rolesanywhere:EnableTrustAnchor.

Link to this function

get_crl(client, crl_id, options \\ [])

View Source

Gets a certificate revocation list (CRL).

Required permissions: rolesanywhere:GetCrl.

Link to this function

get_profile(client, profile_id, options \\ [])

View Source

Gets a profile.

Required permissions: rolesanywhere:GetProfile.

Link to this function

get_subject(client, subject_id, options \\ [])

View Source

Gets a Subject.

A Subject associates a certificate identity with authentication attempts by CreateSession. The Subject resources stores audit information such as status of the last authentication attempt, the certificate data used in the attempt, and the last time the associated identity attempted authentication.

Required permissions: rolesanywhere:GetSubject.

Link to this function

get_trust_anchor(client, trust_anchor_id, options \\ [])

View Source

Gets a trust anchor.

Required permissions: rolesanywhere:GetTrustAnchor.

Link to this function

import_crl(client, input, options \\ [])

View Source

Imports the certificate revocation list (CRL).

CRl is a list of certificates that have been revoked by the issuing certificate Authority (CA). IAM Roles Anywhere validates against the crl list before issuing credentials.

Required permissions: rolesanywhere:ImportCrl.

Link to this function

list_crls(client, next_token \\ nil, page_size \\ nil, options \\ [])

View Source

Lists all Crls in the authenticated account and Amazon Web Services Region.

Required permissions: rolesanywhere:ListCrls.

Link to this function

list_profiles(client, next_token \\ nil, page_size \\ nil, options \\ [])

View Source

Lists all profiles in the authenticated account and Amazon Web Services Region.

Required permissions: rolesanywhere:ListProfiles.

Link to this function

list_subjects(client, next_token \\ nil, page_size \\ nil, options \\ [])

View Source

Lists the subjects in the authenticated account and Amazon Web Services Region.

Required permissions: rolesanywhere:ListSubjects.

Link to this function

list_tags_for_resource(client, resource_arn, options \\ [])

View Source

Lists the tags attached to the resource.

Required permissions: rolesanywhere:ListTagsForResource.

Link to this function

list_trust_anchors(client, next_token \\ nil, page_size \\ nil, options \\ [])

View Source

Lists the trust anchors in the authenticated account and Amazon Web Services Region.

Required permissions: rolesanywhere:ListTrustAnchors.

Link to this function

tag_resource(client, input, options \\ [])

View Source

Attaches tags to a resource.

Required permissions: rolesanywhere:TagResource.

Link to this function

untag_resource(client, input, options \\ [])

View Source

Removes tags from the resource.

Required permissions: rolesanywhere:UntagResource.

Link to this function

update_crl(client, crl_id, input, options \\ [])

View Source

Updates the certificate revocation list (CRL).

CRl is a list of certificates that have been revoked by the issuing certificate Authority (CA). IAM Roles Anywhere validates against the crl list before issuing credentials.

Required permissions: rolesanywhere:UpdateCrl.

Link to this function

update_profile(client, profile_id, input, options \\ [])

View Source

Updates the profile.

A profile is configuration resource to list the roles that RolesAnywhere service is trusted to assume. In addition, by applying a profile you can scope-down permissions with IAM managed policies.

Required permissions: rolesanywhere:UpdateProfile.

Link to this function

update_trust_anchor(client, trust_anchor_id, input, options \\ [])

View Source

Updates the trust anchor.You establish trust between IAM Roles Anywhere and your certificate authority (CA) by configuring a trust anchor.

A Trust Anchor is defined either as a reference to a AWS Certificate Manager Private Certificate Authority (ACM PCA), or by uploading a Certificate Authority (CA) certificate. Your AWS workloads can authenticate with the trust anchor using certificates issued by the trusted Certificate Authority (CA) in exchange for temporary AWS credentials.

Required permissions: rolesanywhere:UpdateTrustAnchor.