iam library

Classes

AccessKey
Provides an IAM access key. This is a set of credentials that allow API requests to be made as an IAM user.
AccessKeyArgs
The set of arguments for AccessKey. The set of arguments for AccessKey.
AccessKeyState
Input properties used for looking up and filtering AccessKey resources.
AccountAlias
> Note: There is only a single account alias per AWS account.
AccountAliasArgs
The set of arguments for AccountAlias. The set of arguments for AccountAlias.
AccountAliasState
Input properties used for looking up and filtering AccountAlias resources.
AccountPasswordPolicy
> Note: There is only a single policy allowed per AWS account. An existing policy will be lost when using this resource as an effect of this limitation.
AccountPasswordPolicyArgs
The set of arguments for AccountPasswordPolicy. The set of arguments for AccountPasswordPolicy.
AccountPasswordPolicyState
Input properties used for looking up and filtering AccountPasswordPolicy resources.
AWSPrincipal
When you use an AWS account identifier as the principal in a policy, the permissions in the policy statement can be granted to all identities contained in that account. This includes IAM users and roles in that account.
FederatedPrincipal
Federated principal for identity providers.
GetAccessKeysAccessKey
GetAccessKeysArgs
Arguments for getAccessKeys. Arguments for getAccessKeys.
GetAccessKeysResult
Result data returned by getAccessKeys.
GetAccountAliasResult
Result data returned by getAccountAlias.
GetGroupArgs
Arguments for getGroup. Arguments for getGroup.
GetGroupResult
Result data returned by getGroup.
GetGroupUser
GetInstanceProfileArgs
Arguments for getInstanceProfile. Arguments for getInstanceProfile.
GetInstanceProfileResult
Result data returned by getInstanceProfile.
GetInstanceProfilesArgs
Arguments for getInstanceProfiles. Arguments for getInstanceProfiles.
GetInstanceProfilesResult
Result data returned by getInstanceProfiles.
GetOpenIdConnectProviderArgs
Arguments for getOpenIdConnectProvider. Arguments for getOpenIdConnectProvider.
GetOpenIdConnectProviderResult
Result data returned by getOpenIdConnectProvider.
GetOutboundWebIdentityFederationResult
Result data returned by getOutboundWebIdentityFederation.
GetPolicyArgs
Arguments for getPolicy. Arguments for getPolicy.
GetPolicyDocumentArgs
Arguments for getPolicyDocument. Arguments for getPolicyDocument.
GetPolicyDocumentResult
Result data returned by getPolicyDocument.
GetPolicyDocumentStatement
GetPolicyDocumentStatementCondition
GetPolicyDocumentStatementNotPrincipal
GetPolicyDocumentStatementPrincipal
GetPolicyResult
Result data returned by getPolicy.
GetPrincipalPolicySimulationArgs
Arguments for getPrincipalPolicySimulation. Arguments for getPrincipalPolicySimulation.
GetPrincipalPolicySimulationContext
GetPrincipalPolicySimulationIamResult
Result data returned by getPrincipalPolicySimulation.
GetPrincipalPolicySimulationResult
GetPrincipalPolicySimulationResultMatchedStatement
GetRoleArgs
Arguments for getRole. Arguments for getRole.
GetRolePoliciesArgs
Arguments for getRolePolicies. Arguments for getRolePolicies.
GetRolePoliciesResult
Result data returned by getRolePolicies.
GetRolePolicyAttachmentsArgs
Arguments for getRolePolicyAttachments. Arguments for getRolePolicyAttachments.
GetRolePolicyAttachmentsAttachedPolicy
GetRolePolicyAttachmentsResult
Result data returned by getRolePolicyAttachments.
GetRoleResult
Result data returned by getRole.
GetRoleRoleLastUsed
GetRolesArgs
Arguments for getRoles. Arguments for getRoles.
GetRolesResult
Result data returned by getRoles.
GetSamlProviderArgs
Arguments for getSamlProvider. Arguments for getSamlProvider.
GetSamlProviderResult
Result data returned by getSamlProvider.
GetServerCertificateArgs
Arguments for getServerCertificate. Arguments for getServerCertificate.
GetServerCertificateResult
Result data returned by getServerCertificate.
GetSessionContextArgs
Arguments for getSessionContext. Arguments for getSessionContext.
GetSessionContextResult
Result data returned by getSessionContext.
GetUserArgs
Arguments for getUser. Arguments for getUser.
GetUserResult
Result data returned by getUser.
GetUsersArgs
Arguments for getUsers. Arguments for getUsers.
GetUsersResult
Result data returned by getUsers.
GetUserSshKeyArgs
Arguments for getUserSshKey. Arguments for getUserSshKey.
GetUserSshKeyResult
Result data returned by getUserSshKey.
Group
Provides an IAM group.
GroupArgs
The set of arguments for Group. The set of arguments for Group.
GroupMembership
> WARNING: Multiple aws.iam.GroupMembership resources with the same group name will produce inconsistent behavior!
GroupMembershipArgs
The set of arguments for GroupMembership. The set of arguments for GroupMembership.
GroupMembershipState
Input properties used for looking up and filtering GroupMembership resources.
GroupPoliciesExclusive
Resource for maintaining exclusive management of inline policies assigned to an AWS IAM (Identity & Access Management) group.
GroupPoliciesExclusiveArgs
The set of arguments for GroupPoliciesExclusive. The set of arguments for GroupPoliciesExclusive.
GroupPoliciesExclusiveState
Input properties used for looking up and filtering GroupPoliciesExclusive resources.
GroupPolicy
Provides an IAM policy attached to a group.
GroupPolicyArgs
The set of arguments for GroupPolicy. The set of arguments for GroupPolicy.
GroupPolicyAttachment
Attaches a Managed IAM Policy to an IAM group
GroupPolicyAttachmentArgs
The set of arguments for GroupPolicyAttachment. The set of arguments for GroupPolicyAttachment.
GroupPolicyAttachmentsExclusive
Resource for maintaining exclusive management of managed IAM policies assigned to an AWS IAM (Identity & Access Management) group.
GroupPolicyAttachmentsExclusiveArgs
The set of arguments for GroupPolicyAttachmentsExclusive. The set of arguments for GroupPolicyAttachmentsExclusive.
GroupPolicyAttachmentsExclusiveState
Input properties used for looking up and filtering GroupPolicyAttachmentsExclusive resources.
GroupPolicyAttachmentState
Input properties used for looking up and filtering GroupPolicyAttachment resources.
GroupPolicyState
Input properties used for looking up and filtering GroupPolicy resources.
GroupState
Input properties used for looking up and filtering Group resources.
InstanceProfile
Provides an IAM instance profile.
InstanceProfileArgs
The set of arguments for InstanceProfile. The set of arguments for InstanceProfile.
InstanceProfileState
Input properties used for looking up and filtering InstanceProfile resources.
OpenIdConnectProvider
Provides an IAM OpenID Connect provider.
OpenIdConnectProviderArgs
The set of arguments for OpenIdConnectProvider. The set of arguments for OpenIdConnectProvider.
OpenIdConnectProviderState
Input properties used for looking up and filtering OpenIdConnectProvider resources.
OrganizationsFeatures
Manages centralized root access features across AWS member accounts managed using AWS Organizations. More information about managing root access in IAM can be found in the Centralize root access for member accounts.
OrganizationsFeaturesArgs
The set of arguments for OrganizationsFeatures. The set of arguments for OrganizationsFeatures.
OrganizationsFeaturesState
Input properties used for looking up and filtering OrganizationsFeatures resources.
OutboundWebIdentityFederation
Manages an AWS IAM (Identity & Access Management) Outbound Web Identity Federation.
OutboundWebIdentityFederationState
Input properties used for looking up and filtering OutboundWebIdentityFederation resources.
Policy
Provides an IAM policy.
PolicyArgs
The set of arguments for Policy. The set of arguments for Policy.
PolicyAttachment
Attaches a Managed IAM Policy to user(s), role(s), and/or group(s)
PolicyAttachmentArgs
The set of arguments for PolicyAttachment. The set of arguments for PolicyAttachment.
PolicyAttachmentState
Input properties used for looking up and filtering PolicyAttachment resources.
PolicyDocument
Represents an AWS IAM policy document that defines permissions for AWS resources and actions.
PolicyState
Input properties used for looking up and filtering Policy resources.
PolicyStatement
The Statement element is the main element for a policy. This element is required. It can include multiple elements (see the subsequent sections in this page). The Statement element contains an array of individual statements.
Role
Provides an IAM role.
RoleArgs
The set of arguments for Role. The set of arguments for Role.
RoleInlinePolicy
RolePoliciesExclusive
> NOTE:: To reliably detect drift between customer managed inline policies listed in this resource and actual policies attached to the role in the cloud, you currently need to run Pulumi with pulumi up --refresh. See #4766 for tracking making this work with regular pulumi up invocations.
RolePoliciesExclusiveArgs
The set of arguments for RolePoliciesExclusive. The set of arguments for RolePoliciesExclusive.
RolePoliciesExclusiveState
Input properties used for looking up and filtering RolePoliciesExclusive resources.
RolePolicy
Provides an IAM role inline policy.
RolePolicyArgs
The set of arguments for RolePolicy. The set of arguments for RolePolicy.
RolePolicyAttachment
Attaches a Managed IAM Policy to an IAM role
RolePolicyAttachmentArgs
The set of arguments for RolePolicyAttachment. The set of arguments for RolePolicyAttachment.
RolePolicyAttachmentsExclusive
> NOTE:: To reliably detect drift between customer managed policies listed in this resource and actual policies attached to the role in the cloud, you currently need to run Pulumi with pulumi up --refresh. See #4766 for tracking making this work with regular pulumi up
RolePolicyAttachmentsExclusiveArgs
The set of arguments for RolePolicyAttachmentsExclusive. The set of arguments for RolePolicyAttachmentsExclusive.
RolePolicyAttachmentsExclusiveState
Input properties used for looking up and filtering RolePolicyAttachmentsExclusive resources.
RolePolicyAttachmentState
Input properties used for looking up and filtering RolePolicyAttachment resources.
RolePolicyState
Input properties used for looking up and filtering RolePolicy resources.
RoleState
Input properties used for looking up and filtering Role resources.
SamlProvider
Provides an IAM SAML provider.
SamlProviderArgs
The set of arguments for SamlProvider. The set of arguments for SamlProvider.
SamlProviderState
Input properties used for looking up and filtering SamlProvider resources.
SecurityTokenServicePreferences
Provides an IAM Security Token Service Preferences resource.
SecurityTokenServicePreferencesArgs
The set of arguments for SecurityTokenServicePreferences. The set of arguments for SecurityTokenServicePreferences.
SecurityTokenServicePreferencesState
Input properties used for looking up and filtering SecurityTokenServicePreferences resources.
ServerCertificate
Provides an IAM Server Certificate resource to upload Server Certificates. Certs uploaded to IAM can easily work with other AWS services such as:
ServerCertificateArgs
The set of arguments for ServerCertificate. The set of arguments for ServerCertificate.
ServerCertificateState
Input properties used for looking up and filtering ServerCertificate resources.
ServiceLinkedRole
Provides an IAM service-linked role.
ServiceLinkedRoleArgs
The set of arguments for ServiceLinkedRole. The set of arguments for ServiceLinkedRole.
ServiceLinkedRoleState
Input properties used for looking up and filtering ServiceLinkedRole resources.
ServicePrincipal
IAM roles that can be assumed by an AWS service are called service roles. Service roles must include a trust policy. A service principal is an identifier that is used to grant permissions to a service.
ServiceSpecificCredential
Provides an IAM Service Specific Credential.
ServiceSpecificCredentialArgs
The set of arguments for ServiceSpecificCredential. The set of arguments for ServiceSpecificCredential.
ServiceSpecificCredentialState
Input properties used for looking up and filtering ServiceSpecificCredential resources.
SigningCertificate
Provides an IAM Signing Certificate resource to upload Signing Certificates.
SigningCertificateArgs
The set of arguments for SigningCertificate. The set of arguments for SigningCertificate.
SigningCertificateState
Input properties used for looking up and filtering SigningCertificate resources.
SshKey
Uploads an SSH public key and associates it with the specified IAM user.
SshKeyArgs
The set of arguments for SshKey. The set of arguments for SshKey.
SshKeyState
Input properties used for looking up and filtering SshKey resources.
User
Provides an IAM user.
UserArgs
The set of arguments for User. The set of arguments for User.
UserGroupMembership
Provides a resource for adding an IAM User to IAM Groups. This resource can be used multiple times with the same user for non-overlapping groups.
UserGroupMembershipArgs
The set of arguments for UserGroupMembership. The set of arguments for UserGroupMembership.
UserGroupMembershipState
Input properties used for looking up and filtering UserGroupMembership resources.
UserLoginProfile
Manages an IAM User Login Profile with limited support for password creation during this provider resource creation. Uses PGP to encrypt the password for safe transport to the user. PGP keys can be obtained from Keybase.
UserLoginProfileArgs
The set of arguments for UserLoginProfile. The set of arguments for UserLoginProfile.
UserLoginProfileState
Input properties used for looking up and filtering UserLoginProfile resources.
UserPoliciesExclusive
Resource for maintaining exclusive management of inline policies assigned to an AWS IAM (Identity & Access Management) user.
UserPoliciesExclusiveArgs
The set of arguments for UserPoliciesExclusive. The set of arguments for UserPoliciesExclusive.
UserPoliciesExclusiveState
Input properties used for looking up and filtering UserPoliciesExclusive resources.
UserPolicy
Provides an IAM policy attached to a user.
UserPolicyArgs
The set of arguments for UserPolicy. The set of arguments for UserPolicy.
UserPolicyAttachment
Attaches a Managed IAM Policy to an IAM user
UserPolicyAttachmentArgs
The set of arguments for UserPolicyAttachment. The set of arguments for UserPolicyAttachment.
UserPolicyAttachmentsExclusive
Resource for maintaining exclusive management of managed IAM policies assigned to an AWS IAM (Identity & Access Management) user.
UserPolicyAttachmentsExclusiveArgs
The set of arguments for UserPolicyAttachmentsExclusive. The set of arguments for UserPolicyAttachmentsExclusive.
UserPolicyAttachmentsExclusiveState
Input properties used for looking up and filtering UserPolicyAttachmentsExclusive resources.
UserPolicyAttachmentState
Input properties used for looking up and filtering UserPolicyAttachment resources.
UserPolicyState
Input properties used for looking up and filtering UserPolicy resources.
UserState
Input properties used for looking up and filtering User resources.
VirtualMfaDevice
Provides an IAM Virtual MFA Device.
VirtualMfaDeviceArgs
The set of arguments for VirtualMfaDevice. The set of arguments for VirtualMfaDevice.
VirtualMfaDeviceState
Input properties used for looking up and filtering VirtualMfaDevice resources.

Enums

ManagedPolicy
PolicyDocumentVersion
The version of the policy language that you want to use. As a best practice, use the latest '2012-10-17' version.
PolicyStatementEffect
Indicate whether the policy allows or denies access.

Functions

getAccessKeys(GetAccessKeysArgs args, {InvokeOptions? options}) → Future<GetAccessKeysResult>
This data source can be used to fetch information about IAM access keys of a specific IAM user.
getAccessKeysOutput(GetAccessKeysArgs args, {InvokeOutputOptions? options}) → Output<GetAccessKeysResult>
getAccountAlias({InvokeOptions? options}) → Future<GetAccountAliasResult>
The IAM Account Alias data source allows access to the account alias for the effective account in which this provider is working.
getAccountAliasOutput({InvokeOutputOptions? options}) → Output<GetAccountAliasResult>
getGroup(GetGroupArgs args, {InvokeOptions? options}) → Future<GetGroupResult>
This data source can be used to fetch information about a specific IAM group. By using this data source, you can reference IAM group properties without having to hard code ARNs as input.
getGroupOutput(GetGroupArgs args, {InvokeOutputOptions? options}) → Output<GetGroupResult>
getInstanceProfile(GetInstanceProfileArgs args, {InvokeOptions? options}) → Future<GetInstanceProfileResult>
This data source can be used to fetch information about a specific IAM instance profile. By using this data source, you can reference IAM instance profile properties without having to hard code ARNs as input.
getInstanceProfileOutput(GetInstanceProfileArgs args, {InvokeOutputOptions? options}) → Output<GetInstanceProfileResult>
getInstanceProfiles(GetInstanceProfilesArgs args, {InvokeOptions? options}) → Future<GetInstanceProfilesResult>
This data source can be used to fetch information about all IAM instance profiles under a role. By using this data source, you can reference IAM instance profile properties without having to hard code ARNs as input.
getInstanceProfilesOutput(GetInstanceProfilesArgs args, {InvokeOutputOptions? options}) → Output<GetInstanceProfilesResult>
getOpenIdConnectProvider(GetOpenIdConnectProviderArgs args, {InvokeOptions? options}) → Future<GetOpenIdConnectProviderResult>
This data source can be used to fetch information about a specific IAM OpenID Connect provider. By using this data source, you can retrieve the the resource information by either its arn or url.
getOpenIdConnectProviderOutput(GetOpenIdConnectProviderArgs args, {InvokeOutputOptions? options}) → Output<GetOpenIdConnectProviderResult>
getOutboundWebIdentityFederation({InvokeOptions? options}) → Future<GetOutboundWebIdentityFederationResult>
Use this data source to retrieve information about an AWS IAM (Identity & Access Management) Outbound Web Identity Federation.
getOutboundWebIdentityFederationOutput({InvokeOutputOptions? options}) → Output<GetOutboundWebIdentityFederationResult>
getPolicy(GetPolicyArgs args, {InvokeOptions? options}) → Future<GetPolicyResult>
This data source can be used to fetch information about a specific IAM policy.
getPolicyDocument(GetPolicyDocumentArgs args, {InvokeOptions? options}) → Future<GetPolicyDocumentResult>
Generates an IAM policy document in JSON format for use with resources that expect policy documents such as aws.iam.Policy.
getPolicyDocumentOutput(GetPolicyDocumentArgs args, {InvokeOutputOptions? options}) → Output<GetPolicyDocumentResult>
getPolicyOutput(GetPolicyArgs args, {InvokeOutputOptions? options}) → Output<GetPolicyResult>
getPrincipalPolicySimulation(GetPrincipalPolicySimulationArgs args, {InvokeOptions? options}) → Future<GetPrincipalPolicySimulationIamResult>
Runs a simulation of the IAM policies of a particular principal against a given hypothetical request.
getPrincipalPolicySimulationOutput(GetPrincipalPolicySimulationArgs args, {InvokeOutputOptions? options}) → Output<GetPrincipalPolicySimulationIamResult>
getRole(GetRoleArgs args, {InvokeOptions? options}) → Future<GetRoleResult>
This data source can be used to fetch information about a specific IAM role. By using this data source, you can reference IAM role properties without having to hard code ARNs as input.
getRoleOutput(GetRoleArgs args, {InvokeOutputOptions? options}) → Output<GetRoleResult>
getRolePolicies(GetRolePoliciesArgs args, {InvokeOptions? options}) → Future<GetRolePoliciesResult>
Use this data source to get the names of inline policies associated with an IAM role.
getRolePoliciesOutput(GetRolePoliciesArgs args, {InvokeOutputOptions? options}) → Output<GetRolePoliciesResult>
getRolePolicyAttachments(GetRolePolicyAttachmentsArgs args, {InvokeOptions? options}) → Future<GetRolePolicyAttachmentsResult>
Provides details about the managed policies attached to an AWS IAM Role.
getRolePolicyAttachmentsOutput(GetRolePolicyAttachmentsArgs args, {InvokeOutputOptions? options}) → Output<GetRolePolicyAttachmentsResult>
getRoles(GetRolesArgs args, {InvokeOptions? options}) → Future<GetRolesResult>
Use this data source to get the ARNs and Names of IAM Roles.
getRolesOutput(GetRolesArgs args, {InvokeOutputOptions? options}) → Output<GetRolesResult>
getSamlProvider(GetSamlProviderArgs args, {InvokeOptions? options}) → Future<GetSamlProviderResult>
This data source can be used to fetch information about a specific IAM SAML provider. This will allow you to easily retrieve the metadata document of an existing SAML provider.
getSamlProviderOutput(GetSamlProviderArgs args, {InvokeOutputOptions? options}) → Output<GetSamlProviderResult>
getServerCertificate(GetServerCertificateArgs args, {InvokeOptions? options}) → Future<GetServerCertificateResult>
Use this data source to lookup information about IAM Server Certificates.
getServerCertificateOutput(GetServerCertificateArgs args, {InvokeOutputOptions? options}) → Output<GetServerCertificateResult>
getSessionContext(GetSessionContextArgs args, {InvokeOptions? options}) → Future<GetSessionContextResult>
This data source provides information on the IAM source role of an STS assumed role. For non-role ARNs, this data source simply passes the ARN through in issuerArn.
getSessionContextOutput(GetSessionContextArgs args, {InvokeOutputOptions? options}) → Output<GetSessionContextResult>
getUser(GetUserArgs args, {InvokeOptions? options}) → Future<GetUserResult>
This data source can be used to fetch information about a specific IAM user. By using this data source, you can reference IAM user properties without having to hard code ARNs or unique IDs as input.
getUserOutput(GetUserArgs args, {InvokeOutputOptions? options}) → Output<GetUserResult>
getUsers(GetUsersArgs args, {InvokeOptions? options}) → Future<GetUsersResult>
Use this data source to get the ARNs and Names of IAM Users.
getUsersOutput(GetUsersArgs args, {InvokeOutputOptions? options}) → Output<GetUsersResult>
getUserSshKey(GetUserSshKeyArgs args, {InvokeOptions? options}) → Future<GetUserSshKeyResult>
Use this data source to get information about a SSH public key associated with the specified IAM user.
getUserSshKeyOutput(GetUserSshKeyArgs args, {InvokeOutputOptions? options}) → Output<GetUserSshKeyResult>