pulumi-aws-kotlin/com.pulumi.aws.iam.kotlin/IamFunctions

IamFunctions

object IamFunctions

Functions

getAccessKeys

suspend fun getAccessKeys(argument: GetAccessKeysPlainArgs): GetAccessKeysResult

This data source can be used to fetch information about IAM access keys of a specific IAM user.

suspend fun getAccessKeys(user: String): GetAccessKeysResult

suspend fun getAccessKeys(argument: suspend GetAccessKeysPlainArgsBuilder.() -> Unit): GetAccessKeysResult

getAccountAlias

suspend fun getAccountAlias(): GetAccountAliasResult

The IAM Account Alias data source allows access to the account alias for the effective account in which this provider is working.

getGroup

suspend fun getGroup(argument: GetGroupPlainArgs): 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.

suspend fun getGroup(groupName: String): GetGroupResult

suspend fun getGroup(argument: suspend GetGroupPlainArgsBuilder.() -> Unit): GetGroupResult

getInstanceProfile

suspend fun getInstanceProfile(argument: GetInstanceProfilePlainArgs): 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.

suspend fun getInstanceProfile(name: String): GetInstanceProfileResult

suspend fun getInstanceProfile(argument: suspend GetInstanceProfilePlainArgsBuilder.() -> Unit): GetInstanceProfileResult

getInstanceProfiles

suspend fun getInstanceProfiles(argument: GetInstanceProfilesPlainArgs): 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.

suspend fun getInstanceProfiles(roleName: String): GetInstanceProfilesResult

suspend fun getInstanceProfiles(argument: suspend GetInstanceProfilesPlainArgsBuilder.() -> Unit): GetInstanceProfilesResult

getOpenidConnectProvider

suspend fun getOpenidConnectProvider(argument: GetOpenidConnectProviderPlainArgs): 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.

suspend fun getOpenidConnectProvider(argument: suspend GetOpenidConnectProviderPlainArgsBuilder.() -> Unit): GetOpenidConnectProviderResult

suspend fun getOpenidConnectProvider(arn: String? = null, tags: Map<String, String>? = null, url: String? = null): GetOpenidConnectProviderResult

getPolicy

suspend fun getPolicy(argument: GetPolicyPlainArgs): GetPolicyResult

This data source can be used to fetch information about a specific IAM policy.

suspend fun getPolicy(argument: suspend GetPolicyPlainArgsBuilder.() -> Unit): GetPolicyResult

suspend fun getPolicy(arn: String? = null, name: String? = null, pathPrefix: String? = null, tags: Map<String, String>? = null): GetPolicyResult

getPolicyDocument

suspend fun getPolicyDocument(argument: GetPolicyDocumentPlainArgs): GetPolicyDocumentResult

Generates an IAM policy document in JSON format for use with resources that expect policy documents such as aws.iam.Policy. Using this data source to generate policy documents is optional. It is also valid to use literal JSON strings in your configuration or to use the file interpolation function to read a raw JSON policy document from a file.

suspend fun getPolicyDocument(argument: suspend GetPolicyDocumentPlainArgsBuilder.() -> Unit): GetPolicyDocumentResult

suspend fun getPolicyDocument(overrideJson: String? = null, overridePolicyDocuments: List<String>? = null, policyId: String? = null, sourceJson: String? = null, sourcePolicyDocuments: List<String>? = null, statements: List<GetPolicyDocumentStatement>? = null, version: String? = null): GetPolicyDocumentResult

getRole

suspend fun getRole(argument: GetRolePlainArgs): 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.

suspend fun getRole(argument: suspend GetRolePlainArgsBuilder.() -> Unit): GetRoleResult

suspend fun getRole(name: String, tags: Map<String, String>? = null): GetRoleResult

getRoles

suspend fun getRoles(argument: GetRolesPlainArgs): GetRolesResult

Use this data source to get the ARNs and Names of IAM Roles.

suspend fun getRoles(argument: suspend GetRolesPlainArgsBuilder.() -> Unit): GetRolesResult

suspend fun getRoles(nameRegex: String? = null, pathPrefix: String? = null): GetRolesResult

getSamlProvider

suspend fun getSamlProvider(argument: GetSamlProviderPlainArgs): 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.

suspend fun getSamlProvider(argument: suspend GetSamlProviderPlainArgsBuilder.() -> Unit): GetSamlProviderResult

suspend fun getSamlProvider(arn: String, tags: Map<String, String>? = null): GetSamlProviderResult

getServerCertificate

suspend fun getServerCertificate(argument: GetServerCertificatePlainArgs): GetServerCertificateResult

Use this data source to lookup information about IAM Server Certificates.

suspend fun getServerCertificate(argument: suspend GetServerCertificatePlainArgsBuilder.() -> Unit): GetServerCertificateResult

suspend fun getServerCertificate(latest: Boolean? = null, name: String? = null, namePrefix: String? = null, pathPrefix: String? = null): GetServerCertificateResult

getSessionContext

suspend fun getSessionContext(argument: GetSessionContextPlainArgs): 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 issuer_arn. For some AWS resources, multiple types of principals are allowed in the same argument (e.g., IAM users and IAM roles). However, these arguments often do not allow assumed-role (i.e., STS, temporary credential) principals. Given an STS ARN, this data source provides the ARN for the source IAM role.

suspend fun getSessionContext(arn: String): GetSessionContextResult

suspend fun getSessionContext(argument: suspend GetSessionContextPlainArgsBuilder.() -> Unit): GetSessionContextResult

getUser

suspend fun getUser(argument: GetUserPlainArgs): 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.

suspend fun getUser(argument: suspend GetUserPlainArgsBuilder.() -> Unit): GetUserResult

suspend fun getUser(tags: Map<String, String>? = null, userName: String): GetUserResult

getUsers

suspend fun getUsers(argument: GetUsersPlainArgs): GetUsersResult

Use this data source to get the ARNs and Names of IAM Users.

suspend fun getUsers(argument: suspend GetUsersPlainArgsBuilder.() -> Unit): GetUsersResult

suspend fun getUsers(nameRegex: String? = null, pathPrefix: String? = null): GetUsersResult

getUserSshKey

suspend fun getUserSshKey(argument: GetUserSshKeyPlainArgs): GetUserSshKeyResult

Use this data source to get information about a SSH public key associated with the specified IAM user.

suspend fun getUserSshKey(argument: suspend GetUserSshKeyPlainArgsBuilder.() -> Unit): GetUserSshKeyResult

suspend fun getUserSshKey(encoding: String, sshPublicKeyId: String, username: String): GetUserSshKeyResult