published on Thursday, Sep 10, 2026 by Pulumi
published on Thursday, Sep 10, 2026 by Pulumi
Lists AWS Account Access Entitlements for a given Application.
Example Usage
Filter by Principal
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const example = aws.accountaccess.getEntitlements({
filter: {
principalRole: {
principal: {
identityCenter: {
userId: "11111111-2222-3333-4444-555555555555",
},
},
},
},
applicationArn: exampleAwsAccountaccessApplication.arn,
});
import pulumi
import pulumi_aws as aws
example = aws.accountaccess.get_entitlements(filter={
"principal_role": {
"principal": {
"identity_center": {
"user_id": "11111111-2222-3333-4444-555555555555",
},
},
},
},
application_arn=example_aws_accountaccess_application["arn"])
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/accountaccess"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := accountaccess.GetEntitlements(ctx, &accountaccess.GetEntitlementsArgs{
Filter: accountaccess.GetEntitlementsFilter{
PrincipalRole: accountaccess.GetEntitlementsFilterPrincipalRole{
Principal: accountaccess.GetEntitlementsFilterPrincipalRolePrincipal{
IdentityCenter: accountaccess.GetEntitlementsFilterPrincipalRolePrincipalIdentityCenter{
UserId: pulumi.StringRef("11111111-2222-3333-4444-555555555555"),
},
},
},
},
ApplicationArn: exampleAwsAccountaccessApplication.Arn,
}, nil)
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var example = Aws.AccountAccess.GetEntitlements.Invoke(new()
{
Filter = new Aws.AccountAccess.Inputs.GetEntitlementsFilterInputArgs
{
PrincipalRole = new Aws.AccountAccess.Inputs.GetEntitlementsFilterPrincipalRoleInputArgs
{
Principal = new Aws.AccountAccess.Inputs.GetEntitlementsFilterPrincipalRolePrincipalInputArgs
{
IdentityCenter = new Aws.AccountAccess.Inputs.GetEntitlementsFilterPrincipalRolePrincipalIdentityCenterInputArgs
{
UserId = "11111111-2222-3333-4444-555555555555",
},
},
},
},
ApplicationArn = exampleAwsAccountaccessApplication.Arn,
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.accountaccess.AccountaccessFunctions;
import com.pulumi.aws.accountaccess.inputs.GetEntitlementsArgs;
import com.pulumi.aws.accountaccess.inputs.GetEntitlementsFilterArgs;
import com.pulumi.aws.accountaccess.inputs.GetEntitlementsFilterPrincipalRoleArgs;
import com.pulumi.aws.accountaccess.inputs.GetEntitlementsFilterPrincipalRolePrincipalArgs;
import com.pulumi.aws.accountaccess.inputs.GetEntitlementsFilterPrincipalRolePrincipalIdentityCenterArgs;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
final var example = AccountaccessFunctions.getEntitlements(GetEntitlementsArgs.builder()
.filter(GetEntitlementsFilterArgs.builder()
.principalRole(GetEntitlementsFilterPrincipalRoleArgs.builder()
.principal(GetEntitlementsFilterPrincipalRolePrincipalArgs.builder()
.identityCenter(GetEntitlementsFilterPrincipalRolePrincipalIdentityCenterArgs.builder()
.userId("11111111-2222-3333-4444-555555555555")
.build())
.build())
.build())
.build())
.applicationArn(exampleAwsAccountaccessApplication.arn())
.build());
}
}
variables:
example:
fn::invoke:
function: aws:accountaccess:getEntitlements
arguments:
filter:
principalRole:
principal:
identityCenter:
userId: 11111111-2222-3333-4444-555555555555
applicationArn: ${exampleAwsAccountaccessApplication.arn}
pulumi {
required_providers {
aws = {
source = "pulumi/aws"
}
}
}
data "aws_accountaccess_getentitlements" "example" {
filter = {
principal_role = {
principal = {
identity_center = {
user_id = "11111111-2222-3333-4444-555555555555"
}
}
}
}
application_arn = exampleAwsAccountaccessApplication.arn
}
Filter by Target Account
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const example = aws.accountaccess.getEntitlements({
filter: {
principalRole: {
accountId: "123456789012",
},
},
applicationArn: exampleAwsAccountaccessApplication.arn,
});
import pulumi
import pulumi_aws as aws
example = aws.accountaccess.get_entitlements(filter={
"principal_role": {
"account_id": "123456789012",
},
},
application_arn=example_aws_accountaccess_application["arn"])
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/accountaccess"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := accountaccess.GetEntitlements(ctx, &accountaccess.GetEntitlementsArgs{
Filter: accountaccess.GetEntitlementsFilter{
PrincipalRole: accountaccess.GetEntitlementsFilterPrincipalRole{
AccountId: pulumi.StringRef("123456789012"),
},
},
ApplicationArn: exampleAwsAccountaccessApplication.Arn,
}, nil)
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var example = Aws.AccountAccess.GetEntitlements.Invoke(new()
{
Filter = new Aws.AccountAccess.Inputs.GetEntitlementsFilterInputArgs
{
PrincipalRole = new Aws.AccountAccess.Inputs.GetEntitlementsFilterPrincipalRoleInputArgs
{
AccountId = "123456789012",
},
},
ApplicationArn = exampleAwsAccountaccessApplication.Arn,
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.accountaccess.AccountaccessFunctions;
import com.pulumi.aws.accountaccess.inputs.GetEntitlementsArgs;
import com.pulumi.aws.accountaccess.inputs.GetEntitlementsFilterArgs;
import com.pulumi.aws.accountaccess.inputs.GetEntitlementsFilterPrincipalRoleArgs;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
final var example = AccountaccessFunctions.getEntitlements(GetEntitlementsArgs.builder()
.filter(GetEntitlementsFilterArgs.builder()
.principalRole(GetEntitlementsFilterPrincipalRoleArgs.builder()
.accountId("123456789012")
.build())
.build())
.applicationArn(exampleAwsAccountaccessApplication.arn())
.build());
}
}
variables:
example:
fn::invoke:
function: aws:accountaccess:getEntitlements
arguments:
filter:
principalRole:
accountId: '123456789012'
applicationArn: ${exampleAwsAccountaccessApplication.arn}
pulumi {
required_providers {
aws = {
source = "pulumi/aws"
}
}
}
data "aws_accountaccess_getentitlements" "example" {
filter = {
principal_role = {
account_id = "123456789012"
}
}
application_arn = exampleAwsAccountaccessApplication.arn
}
Using getEntitlements
Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.
function getEntitlements(args: GetEntitlementsArgs, opts?: InvokeOptions): Promise<GetEntitlementsResult>
function getEntitlementsOutput(args: GetEntitlementsOutputArgs, opts?: InvokeOutputOptions): Output<GetEntitlementsResult>def get_entitlements(application_arn: Optional[str] = None,
filter: Optional[GetEntitlementsFilter] = None,
region: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetEntitlementsResult
def get_entitlements_output(application_arn: pulumi.Input[Optional[str]] = None,
filter: pulumi.Input[Optional[GetEntitlementsFilterArgs]] = None,
region: pulumi.Input[Optional[str]] = None,
opts: Optional[InvokeOutputOptions] = None) -> Output[GetEntitlementsResult]func GetEntitlements(ctx *Context, args *GetEntitlementsArgs, opts ...InvokeOption) (*GetEntitlementsResult, error)
func GetEntitlementsOutput(ctx *Context, args *GetEntitlementsOutputArgs, opts ...InvokeOption) GetEntitlementsResultOutput> Note: This function is named GetEntitlements in the Go SDK.
public static class GetEntitlements
{
public static Task<GetEntitlementsResult> InvokeAsync(GetEntitlementsArgs args, InvokeOptions? opts = null)
public static Output<GetEntitlementsResult> Invoke(GetEntitlementsInvokeArgs args, InvokeOptions? opts = null)
public static Output<GetEntitlementsResult> Invoke(GetEntitlementsInvokeArgs args, InvokeOutputOptions opts)
}public static CompletableFuture<GetEntitlementsResult> getEntitlements(GetEntitlementsArgs args, InvokeOptions options)
public static Output<GetEntitlementsResult> getEntitlements(GetEntitlementsArgs args, InvokeOptions options)
public static Output<GetEntitlementsResult> getEntitlements(GetEntitlementsArgs args, InvokeOutputOptions options)
fn::invoke:
function: aws:accountaccess/getEntitlements:getEntitlements
arguments:
# arguments dictionarydata "aws_accountaccess_get_entitlements" "name" {
# arguments
}The following arguments are supported:
- Application
Arn string - ARN of the parent Application to list Entitlements within.
- Filter
Get
Entitlements Filter Filter criteria to narrow the entitlements returned. You can filter by principal, IAM role, or account. See
filterBlock below.The following arguments are optional:
- Region string
- Region where this resource will be managed. Defaults to the Region set in the provider configuration.
- Application
Arn string - ARN of the parent Application to list Entitlements within.
- Filter
Get
Entitlements Filter Filter criteria to narrow the entitlements returned. You can filter by principal, IAM role, or account. See
filterBlock below.The following arguments are optional:
- Region string
- Region where this resource will be managed. Defaults to the Region set in the provider configuration.
- application_
arn string - ARN of the parent Application to list Entitlements within.
- filter object
Filter criteria to narrow the entitlements returned. You can filter by principal, IAM role, or account. See
filterBlock below.The following arguments are optional:
- region string
- Region where this resource will be managed. Defaults to the Region set in the provider configuration.
- application
Arn String - ARN of the parent Application to list Entitlements within.
- filter
Get
Entitlements Filter Filter criteria to narrow the entitlements returned. You can filter by principal, IAM role, or account. See
filterBlock below.The following arguments are optional:
- region String
- Region where this resource will be managed. Defaults to the Region set in the provider configuration.
- application
Arn string - ARN of the parent Application to list Entitlements within.
- filter
Get
Entitlements Filter Filter criteria to narrow the entitlements returned. You can filter by principal, IAM role, or account. See
filterBlock below.The following arguments are optional:
- region string
- Region where this resource will be managed. Defaults to the Region set in the provider configuration.
- application_
arn str - ARN of the parent Application to list Entitlements within.
- filter
Get
Entitlements Filter Filter criteria to narrow the entitlements returned. You can filter by principal, IAM role, or account. See
filterBlock below.The following arguments are optional:
- region str
- Region where this resource will be managed. Defaults to the Region set in the provider configuration.
- application
Arn String - ARN of the parent Application to list Entitlements within.
- filter Property Map
Filter criteria to narrow the entitlements returned. You can filter by principal, IAM role, or account. See
filterBlock below.The following arguments are optional:
- region String
- Region where this resource will be managed. Defaults to the Region set in the provider configuration.
getEntitlements Result
The following output properties are available:
- Application
Arn string - Entitlements
List<Get
Entitlements Entitlement> - List of matching Entitlements. See
entitlementsBlock below. - Filter
Get
Entitlements Filter - Region string
- Application
Arn string - Entitlements
[]Get
Entitlements Entitlement - List of matching Entitlements. See
entitlementsBlock below. - Filter
Get
Entitlements Filter - Region string
- application_
arn string - entitlements list(object)
- List of matching Entitlements. See
entitlementsBlock below. - filter object
- region string
- application
Arn String - entitlements
List<Get
Entitlements Entitlement> - List of matching Entitlements. See
entitlementsBlock below. - filter
Get
Entitlements Filter - region String
- application
Arn string - entitlements
Get
Entitlements Entitlement[] - List of matching Entitlements. See
entitlementsBlock below. - filter
Get
Entitlements Filter - region string
- application_
arn str - entitlements
Sequence[Get
Entitlements Entitlement] - List of matching Entitlements. See
entitlementsBlock below. - filter
Get
Entitlements Filter - region str
- application
Arn String - entitlements List<Property Map>
- List of matching Entitlements. See
entitlementsBlock below. - filter Property Map
- region String
Supporting Types
GetEntitlementsEntitlement
- Created
At string - Date and time when the Entitlement was created in RFC 3339 format.
- Entitlement
Id string - Service-assigned unique identifier for the Entitlement.
- Entitlements
List<Get
Entitlements Entitlement Entitlement> - Principal-role entitlement configuration. See
entitlements.entitlementBlock below.
- Created
At string - Date and time when the Entitlement was created in RFC 3339 format.
- Entitlement
Id string - Service-assigned unique identifier for the Entitlement.
- Entitlements
[]Get
Entitlements Entitlement Entitlement - Principal-role entitlement configuration. See
entitlements.entitlementBlock below.
- created_
at string - Date and time when the Entitlement was created in RFC 3339 format.
- entitlement_
id string - Service-assigned unique identifier for the Entitlement.
- entitlements list(object)
- Principal-role entitlement configuration. See
entitlements.entitlementBlock below.
- created
At String - Date and time when the Entitlement was created in RFC 3339 format.
- entitlement
Id String - Service-assigned unique identifier for the Entitlement.
- entitlements
List<Get
Entitlements Entitlement Entitlement> - Principal-role entitlement configuration. See
entitlements.entitlementBlock below.
- created
At string - Date and time when the Entitlement was created in RFC 3339 format.
- entitlement
Id string - Service-assigned unique identifier for the Entitlement.
- entitlements
Get
Entitlements Entitlement Entitlement[] - Principal-role entitlement configuration. See
entitlements.entitlementBlock below.
- created_
at str - Date and time when the Entitlement was created in RFC 3339 format.
- entitlement_
id str - Service-assigned unique identifier for the Entitlement.
- entitlements
Sequence[Get
Entitlements Entitlement Entitlement] - Principal-role entitlement configuration. See
entitlements.entitlementBlock below.
- created
At String - Date and time when the Entitlement was created in RFC 3339 format.
- entitlement
Id String - Service-assigned unique identifier for the Entitlement.
- entitlements List<Property Map>
- Principal-role entitlement configuration. See
entitlements.entitlementBlock below.
GetEntitlementsEntitlementEntitlement
- Principal
Roles List<GetEntitlements Entitlement Entitlement Principal Role> - Principal-role entitlement configuration. See
entitlements.entitlement.principal_roleBlock below.
- Principal
Roles []GetEntitlements Entitlement Entitlement Principal Role - Principal-role entitlement configuration. See
entitlements.entitlement.principal_roleBlock below.
- principal_
roles list(object) - Principal-role entitlement configuration. See
entitlements.entitlement.principal_roleBlock below.
- principal
Roles List<GetEntitlements Entitlement Entitlement Principal Role> - Principal-role entitlement configuration. See
entitlements.entitlement.principal_roleBlock below.
- principal
Roles GetEntitlements Entitlement Entitlement Principal Role[] - Principal-role entitlement configuration. See
entitlements.entitlement.principal_roleBlock below.
- principal_
roles Sequence[GetEntitlements Entitlement Entitlement Principal Role] - Principal-role entitlement configuration. See
entitlements.entitlement.principal_roleBlock below.
- principal
Roles List<Property Map> - Principal-role entitlement configuration. See
entitlements.entitlement.principal_roleBlock below.
GetEntitlementsEntitlementEntitlementPrincipalRole
- Account
Id string - 12-digit AWS account ID for the target role.
- Account
Name string - Human-readable name of the target account.
- Principals
List<Get
Entitlements Entitlement Entitlement Principal Role Principal> - IAM Identity Center principal granted access. See
entitlements.entitlement.principal_role.principalBlock below. - Role
Arn string - Target IAM role ARN.
- Account
Id string - 12-digit AWS account ID for the target role.
- Account
Name string - Human-readable name of the target account.
- Principals
[]Get
Entitlements Entitlement Entitlement Principal Role Principal - IAM Identity Center principal granted access. See
entitlements.entitlement.principal_role.principalBlock below. - Role
Arn string - Target IAM role ARN.
- account_
id string - 12-digit AWS account ID for the target role.
- account_
name string - Human-readable name of the target account.
- principals list(object)
- IAM Identity Center principal granted access. See
entitlements.entitlement.principal_role.principalBlock below. - role_
arn string - Target IAM role ARN.
- account
Id String - 12-digit AWS account ID for the target role.
- account
Name String - Human-readable name of the target account.
- principals
List<Get
Entitlements Entitlement Entitlement Principal Role Principal> - IAM Identity Center principal granted access. See
entitlements.entitlement.principal_role.principalBlock below. - role
Arn String - Target IAM role ARN.
- account
Id string - 12-digit AWS account ID for the target role.
- account
Name string - Human-readable name of the target account.
- principals
Get
Entitlements Entitlement Entitlement Principal Role Principal[] - IAM Identity Center principal granted access. See
entitlements.entitlement.principal_role.principalBlock below. - role
Arn string - Target IAM role ARN.
- account_
id str - 12-digit AWS account ID for the target role.
- account_
name str - Human-readable name of the target account.
- principals
Sequence[Get
Entitlements Entitlement Entitlement Principal Role Principal] - IAM Identity Center principal granted access. See
entitlements.entitlement.principal_role.principalBlock below. - role_
arn str - Target IAM role ARN.
- account
Id String - 12-digit AWS account ID for the target role.
- account
Name String - Human-readable name of the target account.
- principals List<Property Map>
- IAM Identity Center principal granted access. See
entitlements.entitlement.principal_role.principalBlock below. - role
Arn String - Target IAM role ARN.
GetEntitlementsEntitlementEntitlementPrincipalRolePrincipal
- Identity
Centers List<GetEntitlements Entitlement Entitlement Principal Role Principal Identity Center> - IAM Identity Center principal. See
entitlements.entitlement.principal_role.principal.identity_centerBlock below.
- Identity
Centers []GetEntitlements Entitlement Entitlement Principal Role Principal Identity Center - IAM Identity Center principal. See
entitlements.entitlement.principal_role.principal.identity_centerBlock below.
- identity_
centers list(object) - IAM Identity Center principal. See
entitlements.entitlement.principal_role.principal.identity_centerBlock below.
- identity
Centers List<GetEntitlements Entitlement Entitlement Principal Role Principal Identity Center> - IAM Identity Center principal. See
entitlements.entitlement.principal_role.principal.identity_centerBlock below.
- identity
Centers GetEntitlements Entitlement Entitlement Principal Role Principal Identity Center[] - IAM Identity Center principal. See
entitlements.entitlement.principal_role.principal.identity_centerBlock below.
- identity_
centers Sequence[GetEntitlements Entitlement Entitlement Principal Role Principal Identity Center] - IAM Identity Center principal. See
entitlements.entitlement.principal_role.principal.identity_centerBlock below.
- identity
Centers List<Property Map> - IAM Identity Center principal. See
entitlements.entitlement.principal_role.principal.identity_centerBlock below.
GetEntitlementsEntitlementEntitlementPrincipalRolePrincipalIdentityCenter
GetEntitlementsFilter
- Principal
Role GetEntitlements Filter Principal Role - principal-to-role filter criteria for narrowing entitlement results. See
filter.principal_roleBlock below.
- Principal
Role GetEntitlements Filter Principal Role - principal-to-role filter criteria for narrowing entitlement results. See
filter.principal_roleBlock below.
- principal_
role object - principal-to-role filter criteria for narrowing entitlement results. See
filter.principal_roleBlock below.
- principal
Role GetEntitlements Filter Principal Role - principal-to-role filter criteria for narrowing entitlement results. See
filter.principal_roleBlock below.
- principal
Role GetEntitlements Filter Principal Role - principal-to-role filter criteria for narrowing entitlement results. See
filter.principal_roleBlock below.
- principal_
role GetEntitlements Filter Principal Role - principal-to-role filter criteria for narrowing entitlement results. See
filter.principal_roleBlock below.
- principal
Role Property Map - principal-to-role filter criteria for narrowing entitlement results. See
filter.principal_roleBlock below.
GetEntitlementsFilterPrincipalRole
- Account
Id string - AWS account ID to filter entitlements by.
- Principal
Get
Entitlements Filter Principal Role Principal - principal to filter entitlements by. See
filter.principal_role.principalBlock below. - Role
Arn string - IAM role ARN to filter entitlements by.
- Account
Id string - AWS account ID to filter entitlements by.
- Principal
Get
Entitlements Filter Principal Role Principal - principal to filter entitlements by. See
filter.principal_role.principalBlock below. - Role
Arn string - IAM role ARN to filter entitlements by.
- account_
id string - AWS account ID to filter entitlements by.
- principal object
- principal to filter entitlements by. See
filter.principal_role.principalBlock below. - role_
arn string - IAM role ARN to filter entitlements by.
- account
Id String - AWS account ID to filter entitlements by.
- principal
Get
Entitlements Filter Principal Role Principal - principal to filter entitlements by. See
filter.principal_role.principalBlock below. - role
Arn String - IAM role ARN to filter entitlements by.
- account
Id string - AWS account ID to filter entitlements by.
- principal
Get
Entitlements Filter Principal Role Principal - principal to filter entitlements by. See
filter.principal_role.principalBlock below. - role
Arn string - IAM role ARN to filter entitlements by.
- account_
id str - AWS account ID to filter entitlements by.
- principal
Get
Entitlements Filter Principal Role Principal - principal to filter entitlements by. See
filter.principal_role.principalBlock below. - role_
arn str - IAM role ARN to filter entitlements by.
- account
Id String - AWS account ID to filter entitlements by.
- principal Property Map
- principal to filter entitlements by. See
filter.principal_role.principalBlock below. - role
Arn String - IAM role ARN to filter entitlements by.
GetEntitlementsFilterPrincipalRolePrincipal
- Identity
Center GetEntitlements Filter Principal Role Principal Identity Center - IAM Identity Center principal filter criteria. See
filter.principal_role.principal.identity_centerBlock below.
- Identity
Center GetEntitlements Filter Principal Role Principal Identity Center - IAM Identity Center principal filter criteria. See
filter.principal_role.principal.identity_centerBlock below.
- identity_
center object - IAM Identity Center principal filter criteria. See
filter.principal_role.principal.identity_centerBlock below.
- identity
Center GetEntitlements Filter Principal Role Principal Identity Center - IAM Identity Center principal filter criteria. See
filter.principal_role.principal.identity_centerBlock below.
- identity
Center GetEntitlements Filter Principal Role Principal Identity Center - IAM Identity Center principal filter criteria. See
filter.principal_role.principal.identity_centerBlock below.
- identity_
center GetEntitlements Filter Principal Role Principal Identity Center - IAM Identity Center principal filter criteria. See
filter.principal_role.principal.identity_centerBlock below.
- identity
Center Property Map - IAM Identity Center principal filter criteria. See
filter.principal_role.principal.identity_centerBlock below.
GetEntitlementsFilterPrincipalRolePrincipalIdentityCenter
Package Details
- Repository
- AWS Classic pulumi/pulumi-aws
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
awsTerraform Provider.
published on Thursday, Sep 10, 2026 by Pulumi