(constructor)

[configuration]

Constructs a new instance of the <code>RolesAnywhereClient</code> class

config

The resolved configuration of RolesAnywhereClient class. This is resolved and normalized from the [constructor configuration interface](@aws-sdk/client-rolesanywhere!RolesAnywhereClientConfig:Interface).

destroy

Destroy underlying resources, like sockets. It's usually not necessary to do this. However in Node.js, it's best to explicitly shut down the client's agent when it is no longer needed. Otherwise, sockets might stay open for quite a long time before the server terminates them.

middlewareStack

send

command

options

RolesAnywhereClient

Identity and Access Management Roles Anywhere provides a secure way for your workloads such as servers, containers, and applications that run outside of Amazon Web Services to obtain temporary Amazon Web Services credentials. Your workloads can use the same IAM policies and roles you have for native Amazon Web Services applications to access Amazon Web Services resources. Using IAM Roles Anywhere eliminates the need to manage long-term credentials for workloads running outside of Amazon Web Services. To use IAM Roles Anywhere, your workloads must use X.509 certificates issued by their certificate authority (CA). You register the CA with IAM Roles Anywhere as a trust anchor to establish trust between your public key infrastructure (PKI) and IAM Roles Anywhere. If you don't manage your own PKI system, you can use Private Certificate Authority to create a CA and then use that to establish trust with IAM Roles Anywhere. This guide describes the IAM Roles Anywhere operations that you can call programmatically. For more information about IAM Roles Anywhere, see the <a href="https://docs.aws.amazon.com/rolesanywhere/latest/userguide/introduction.html">IAM Roles Anywhere User Guide</a>.

defaultsMode

The [@smithy/smithy-client#DefaultsMode](@smithy/smithy-client!DefaultsMode:type) that will be used to determine how certain default configuration options are resolved in the SDK.

disableHostPrefix

Disable dynamically changing the endpoint of the client based on the hostPrefix trait of an operation.

extensions

logger

Optional logger for logging debug/info/warn/error.

maxAttempts

Value for how many times a request will be made at most in case of retry.

region

The AWS region to which this client will send requests

requestHandler

The HTTP handler to use or its constructor options. Fetch in browser and Https in Nodejs.

retryMode

useDualstackEndpoint

useFipsEndpoint

ClientDefaults

CreateProfileCommand

Creates a profile, a list of the roles that Roles Anywhere service is trusted to assume. You use profiles to intersect permissions with IAM managed policies. Required permissions: <code>rolesanywhere:CreateProfile</code>.

CreateTrustAnchorCommand

Creates a trust anchor to establish trust between IAM Roles Anywhere and your certificate authority (CA). You can define a trust anchor as a reference to an Private Certificate Authority (Private CA) or by uploading a CA certificate. Your Amazon Web Services workloads can authenticate with the trust anchor using certificates issued by the CA in exchange for temporary Amazon Web Services credentials. Required permissions: <code>rolesanywhere:CreateTrustAnchor</code>.

DeleteAttributeMappingCommand

Delete an entry from the attribute mapping rules enforced by a given profile.

DeleteCrlCommand

Deletes a certificate revocation list (CRL). Required permissions: <code>rolesanywhere:DeleteCrl</code>.

DeleteProfileCommand

Deletes a profile. Required permissions: <code>rolesanywhere:DeleteProfile</code>.

DeleteTrustAnchorCommand

Deletes a trust anchor. Required permissions: <code>rolesanywhere:DeleteTrustAnchor</code>.

DisableCrlCommand

Disables a certificate revocation list (CRL). Required permissions: <code>rolesanywhere:DisableCrl</code>.

DisableProfileCommand

Disables a profile. When disabled, temporary credential requests with this profile fail. Required permissions: <code>rolesanywhere:DisableProfile</code>.

DisableTrustAnchorCommand

Disables a trust anchor. When disabled, temporary credential requests specifying this trust anchor are unauthorized. Required permissions: <code>rolesanywhere:DisableTrustAnchor</code>.

EnableCrlCommand

Enables a certificate revocation list (CRL). When enabled, certificates stored in the CRL are unauthorized to receive session credentials. Required permissions: <code>rolesanywhere:EnableCrl</code>.

EnableProfileCommand

Enables temporary credential requests for a profile. Required permissions: <code>rolesanywhere:EnableProfile</code>.

EnableTrustAnchorCommand

Enables a trust anchor. When enabled, certificates in the trust anchor chain are authorized for trust validation. Required permissions: <code>rolesanywhere:EnableTrustAnchor</code>.

GetCrlCommand

Gets a certificate revocation list (CRL). Required permissions: <code>rolesanywhere:GetCrl</code>.

GetProfileCommand

Gets a profile. Required permissions: <code>rolesanywhere:GetProfile</code>.

GetSubjectCommand

Gets a subject, which associates a certificate identity with authentication attempts. The subject stores auditing information such as the status of the last authentication attempt, the certificate data used in the attempt, and the last time the associated identity attempted authentication. Required permissions: <code>rolesanywhere:GetSubject</code>.

GetTrustAnchorCommand

Gets a trust anchor. Required permissions: <code>rolesanywhere:GetTrustAnchor</code>.

ImportCrlCommand

Imports the certificate revocation list (CRL). A CRL is a list of certificates that have been revoked by the issuing certificate Authority (CA).In order to be properly imported, a CRL must be in PEM format. IAM Roles Anywhere validates against the CRL before issuing credentials. Required permissions: <code>rolesanywhere:ImportCrl</code>.

ListCrlsCommand

Lists all certificate revocation lists (CRL) in the authenticated account and Amazon Web Services Region. Required permissions: <code>rolesanywhere:ListCrls</code>.

ListProfilesCommand

Lists all profiles in the authenticated account and Amazon Web Services Region. Required permissions: <code>rolesanywhere:ListProfiles</code>.

ListSubjectsCommand

Lists the subjects in the authenticated account and Amazon Web Services Region. Required permissions: <code>rolesanywhere:ListSubjects</code>.

ListTagsForResourceCommand

Lists the tags attached to the resource. Required permissions: <code>rolesanywhere:ListTagsForResource</code>.

ListTrustAnchorsCommand

Lists the trust anchors in the authenticated account and Amazon Web Services Region. Required permissions: <code>rolesanywhere:ListTrustAnchors</code>.

PutAttributeMappingCommand

Put an entry in the attribute mapping rules that will be enforced by a given profile. A mapping specifies a certificate field and one or more specifiers that have contextual meanings.

PutNotificationSettingsCommand

Attaches a list of notification settings to a trust anchor. A notification setting includes information such as event name, threshold, status of the notification setting, and the channel to notify. Required permissions: <code>rolesanywhere:PutNotificationSettings</code>.

ResetNotificationSettingsCommand

Resets the custom notification setting to IAM Roles Anywhere default setting. Required permissions: <code>rolesanywhere:ResetNotificationSettings</code>.

TagResourceCommand

Attaches tags to a resource. Required permissions: <code>rolesanywhere:TagResource</code>.

UntagResourceCommand

Removes tags from the resource. Required permissions: <code>rolesanywhere:UntagResource</code>.

UpdateCrlCommand

Updates the certificate revocation list (CRL). A CRL is a list of certificates that have been revoked by the issuing certificate authority (CA). IAM Roles Anywhere validates against the CRL before issuing credentials. Required permissions: <code>rolesanywhere:UpdateCrl</code>.

UpdateProfileCommand

Updates a profile, a list of the roles that IAM Roles Anywhere service is trusted to assume. You use profiles to intersect permissions with IAM managed policies. Required permissions: <code>rolesanywhere:UpdateProfile</code>.

UpdateTrustAnchorCommand

Updates a trust anchor. You establish trust between IAM Roles Anywhere and your certificate authority (CA) by configuring a trust anchor. You can define a trust anchor as a reference to an Private Certificate Authority (Private CA) or by uploading a CA certificate. Your Amazon Web Services workloads can authenticate with the trust anchor using certificates issued by the CA in exchange for temporary Amazon Web Services credentials. Required permissions: <code>rolesanywhere:UpdateTrustAnchor</code>.