AWS Classic v5.33.0, Mar 24 23

aws.ssoadmin.AccountAssignment

Provides a Single Sign-On (SSO) Account Assignment resource

Create AccountAssignment Resource

new AccountAssignment(name: string, args: AccountAssignmentArgs, opts?: CustomResourceOptions);

@overload
def AccountAssignment(resource_name: str,
                      opts: Optional[ResourceOptions] = None,
                      instance_arn: Optional[str] = None,
                      permission_set_arn: Optional[str] = None,
                      principal_id: Optional[str] = None,
                      principal_type: Optional[str] = None,
                      target_id: Optional[str] = None,
                      target_type: Optional[str] = None)
@overload
def AccountAssignment(resource_name: str,
                      args: AccountAssignmentArgs,
                      opts: Optional[ResourceOptions] = None)

func NewAccountAssignment(ctx *Context, name string, args AccountAssignmentArgs, opts ...ResourceOption) (*AccountAssignment, error)

public AccountAssignment(string name, AccountAssignmentArgs args, CustomResourceOptions? opts = null)

public AccountAssignment(String name, AccountAssignmentArgs args)
public AccountAssignment(String name, AccountAssignmentArgs args, CustomResourceOptions options)

type: aws:ssoadmin:AccountAssignment
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

name string: The unique name of the resource.
args AccountAssignmentArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
args AccountAssignmentArgs: The arguments to resource properties.
opts ResourceOptions: Bag of options to control resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args AccountAssignmentArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args AccountAssignmentArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args AccountAssignmentArgs: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

AccountAssignment Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

The AccountAssignment resource accepts the following input properties:

InstanceArn string: The Amazon Resource Name (ARN) of the SSO Instance.
PermissionSetArn string: The Amazon Resource Name (ARN) of the Permission Set that the admin wants to grant the principal access to.
PrincipalId string: An identifier for an object in SSO, such as a user or group. PrincipalIds are GUIDs (For example, f81d4fae-7dec-11d0-a765-00a0c91e6bf6).
PrincipalType string: The entity type for which the assignment will be created. Valid values: USER, GROUP.
TargetId string: An AWS account identifier, typically a 10-12 digit string.
TargetType string: The entity type for which the assignment will be created. Valid values: AWS_ACCOUNT.

InstanceArn string: The Amazon Resource Name (ARN) of the SSO Instance.
PermissionSetArn string: The Amazon Resource Name (ARN) of the Permission Set that the admin wants to grant the principal access to.
PrincipalId string: An identifier for an object in SSO, such as a user or group. PrincipalIds are GUIDs (For example, f81d4fae-7dec-11d0-a765-00a0c91e6bf6).
PrincipalType string: The entity type for which the assignment will be created. Valid values: USER, GROUP.
TargetId string: An AWS account identifier, typically a 10-12 digit string.
TargetType string: The entity type for which the assignment will be created. Valid values: AWS_ACCOUNT.

instanceArn String: The Amazon Resource Name (ARN) of the SSO Instance.
permissionSetArn String: The Amazon Resource Name (ARN) of the Permission Set that the admin wants to grant the principal access to.
principalId String: An identifier for an object in SSO, such as a user or group. PrincipalIds are GUIDs (For example, f81d4fae-7dec-11d0-a765-00a0c91e6bf6).
principalType String: The entity type for which the assignment will be created. Valid values: USER, GROUP.
targetId String: An AWS account identifier, typically a 10-12 digit string.
targetType String: The entity type for which the assignment will be created. Valid values: AWS_ACCOUNT.

instanceArn string: The Amazon Resource Name (ARN) of the SSO Instance.
permissionSetArn string: The Amazon Resource Name (ARN) of the Permission Set that the admin wants to grant the principal access to.
principalId string: An identifier for an object in SSO, such as a user or group. PrincipalIds are GUIDs (For example, f81d4fae-7dec-11d0-a765-00a0c91e6bf6).
principalType string: The entity type for which the assignment will be created. Valid values: USER, GROUP.
targetId string: An AWS account identifier, typically a 10-12 digit string.
targetType string: The entity type for which the assignment will be created. Valid values: AWS_ACCOUNT.

instance_arn str: The Amazon Resource Name (ARN) of the SSO Instance.
permission_set_arn str: The Amazon Resource Name (ARN) of the Permission Set that the admin wants to grant the principal access to.
principal_id str: An identifier for an object in SSO, such as a user or group. PrincipalIds are GUIDs (For example, f81d4fae-7dec-11d0-a765-00a0c91e6bf6).
principal_type str: The entity type for which the assignment will be created. Valid values: USER, GROUP.
target_id str: An AWS account identifier, typically a 10-12 digit string.
target_type str: The entity type for which the assignment will be created. Valid values: AWS_ACCOUNT.

instanceArn String: The Amazon Resource Name (ARN) of the SSO Instance.
permissionSetArn String: The Amazon Resource Name (ARN) of the Permission Set that the admin wants to grant the principal access to.
principalId String: An identifier for an object in SSO, such as a user or group. PrincipalIds are GUIDs (For example, f81d4fae-7dec-11d0-a765-00a0c91e6bf6).
principalType String: The entity type for which the assignment will be created. Valid values: USER, GROUP.
targetId String: An AWS account identifier, typically a 10-12 digit string.
targetType String: The entity type for which the assignment will be created. Valid values: AWS_ACCOUNT.

Outputs

All input properties are implicitly available as output properties. Additionally, the AccountAssignment resource produces the following output properties:

Id string: The provider-assigned unique ID for this managed resource.

Id string: The provider-assigned unique ID for this managed resource.

id String: The provider-assigned unique ID for this managed resource.

id string: The provider-assigned unique ID for this managed resource.

id str: The provider-assigned unique ID for this managed resource.

id String: The provider-assigned unique ID for this managed resource.

Look up Existing AccountAssignment Resource

Get an existing AccountAssignment resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: AccountAssignmentState, opts?: CustomResourceOptions): AccountAssignment

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        instance_arn: Optional[str] = None,
        permission_set_arn: Optional[str] = None,
        principal_id: Optional[str] = None,
        principal_type: Optional[str] = None,
        target_id: Optional[str] = None,
        target_type: Optional[str] = None) -> AccountAssignment

func GetAccountAssignment(ctx *Context, name string, id IDInput, state *AccountAssignmentState, opts ...ResourceOption) (*AccountAssignment, error)

public static AccountAssignment Get(string name, Input<string> id, AccountAssignmentState? state, CustomResourceOptions? opts = null)

public static AccountAssignment get(String name, Output<String> id, AccountAssignmentState state, CustomResourceOptions options)

Resource lookup is not supported in YAML

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

resource_name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

The following state arguments are supported:

InstanceArn string: The Amazon Resource Name (ARN) of the SSO Instance.
PermissionSetArn string: The Amazon Resource Name (ARN) of the Permission Set that the admin wants to grant the principal access to.
PrincipalId string: An identifier for an object in SSO, such as a user or group. PrincipalIds are GUIDs (For example, f81d4fae-7dec-11d0-a765-00a0c91e6bf6).
PrincipalType string: The entity type for which the assignment will be created. Valid values: USER, GROUP.
TargetId string: An AWS account identifier, typically a 10-12 digit string.
TargetType string: The entity type for which the assignment will be created. Valid values: AWS_ACCOUNT.

InstanceArn string: The Amazon Resource Name (ARN) of the SSO Instance.
PermissionSetArn string: The Amazon Resource Name (ARN) of the Permission Set that the admin wants to grant the principal access to.
PrincipalId string: An identifier for an object in SSO, such as a user or group. PrincipalIds are GUIDs (For example, f81d4fae-7dec-11d0-a765-00a0c91e6bf6).
PrincipalType string: The entity type for which the assignment will be created. Valid values: USER, GROUP.
TargetId string: An AWS account identifier, typically a 10-12 digit string.
TargetType string: The entity type for which the assignment will be created. Valid values: AWS_ACCOUNT.

instanceArn String: The Amazon Resource Name (ARN) of the SSO Instance.
permissionSetArn String: The Amazon Resource Name (ARN) of the Permission Set that the admin wants to grant the principal access to.
principalId String: An identifier for an object in SSO, such as a user or group. PrincipalIds are GUIDs (For example, f81d4fae-7dec-11d0-a765-00a0c91e6bf6).
principalType String: The entity type for which the assignment will be created. Valid values: USER, GROUP.
targetId String: An AWS account identifier, typically a 10-12 digit string.
targetType String: The entity type for which the assignment will be created. Valid values: AWS_ACCOUNT.

instanceArn string: The Amazon Resource Name (ARN) of the SSO Instance.
permissionSetArn string: The Amazon Resource Name (ARN) of the Permission Set that the admin wants to grant the principal access to.
principalId string: An identifier for an object in SSO, such as a user or group. PrincipalIds are GUIDs (For example, f81d4fae-7dec-11d0-a765-00a0c91e6bf6).
principalType string: The entity type for which the assignment will be created. Valid values: USER, GROUP.
targetId string: An AWS account identifier, typically a 10-12 digit string.
targetType string: The entity type for which the assignment will be created. Valid values: AWS_ACCOUNT.

instance_arn str: The Amazon Resource Name (ARN) of the SSO Instance.
permission_set_arn str: The Amazon Resource Name (ARN) of the Permission Set that the admin wants to grant the principal access to.
principal_id str: An identifier for an object in SSO, such as a user or group. PrincipalIds are GUIDs (For example, f81d4fae-7dec-11d0-a765-00a0c91e6bf6).
principal_type str: The entity type for which the assignment will be created. Valid values: USER, GROUP.
target_id str: An AWS account identifier, typically a 10-12 digit string.
target_type str: The entity type for which the assignment will be created. Valid values: AWS_ACCOUNT.

instanceArn String: The Amazon Resource Name (ARN) of the SSO Instance.
permissionSetArn String: The Amazon Resource Name (ARN) of the Permission Set that the admin wants to grant the principal access to.
principalId String: An identifier for an object in SSO, such as a user or group. PrincipalIds are GUIDs (For example, f81d4fae-7dec-11d0-a765-00a0c91e6bf6).
principalType String: The entity type for which the assignment will be created. Valid values: USER, GROUP.
targetId String: An AWS account identifier, typically a 10-12 digit string.
targetType String: The entity type for which the assignment will be created. Valid values: AWS_ACCOUNT.

Import

SSO Account Assignments can be imported using the principal_id, principal_type, target_id, target_type, permission_set_arn, instance_arn separated by commas (,) e.g.,

 $ pulumi import aws:ssoadmin/accountAssignment:AccountAssignment example f81d4fae-7dec-11d0-a765-00a0c91e6bf6,GROUP,1234567890,AWS_ACCOUNT,arn:aws:sso:::permissionSet/ssoins-0123456789abcdef/ps-0123456789abcdef,arn:aws:sso:::instance/ssoins-0123456789abcdef

Package Details

Repository: AWS Classic pulumi/pulumi-aws
License: Apache-2.0
Notes: This Pulumi package is based on the aws Terraform Provider.