Class AccountAssignment


  • public class AccountAssignment
    extends com.pulumi.resources.CustomResource
    Provides a Single Sign-On (SSO) Account Assignment resource ## Example Usage ### Basic Usage
     
     package generated_program;
     
     import com.pulumi.Context;
     import com.pulumi.Pulumi;
     import com.pulumi.core.Output;
     import com.pulumi.aws.ssoadmin.SsoadminFunctions;
     import com.pulumi.aws.ssoadmin.inputs.GetInstancesArgs;
     import com.pulumi.aws.ssoadmin.inputs.GetPermissionSetArgs;
     import com.pulumi.aws.identitystore.IdentitystoreFunctions;
     import com.pulumi.aws.identitystore.inputs.GetGroupArgs;
     import com.pulumi.aws.identitystore.inputs.GetGroupAlternateIdentifierArgs;
     import com.pulumi.aws.identitystore.inputs.GetGroupAlternateIdentifierUniqueAttributeArgs;
     import com.pulumi.aws.ssoadmin.AccountAssignment;
     import com.pulumi.aws.ssoadmin.AccountAssignmentArgs;
     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 = SsoadminFunctions.getInstances(GetInstancesArgs.builder()
                 .build());
     
             final var exampleGetPermissionSet = SsoadminFunctions.getPermissionSet(GetPermissionSetArgs.builder()
                 .instanceArn(example.arns()[0])
                 .name("AWSReadOnlyAccess")
                 .build());
     
             final var exampleGetGroup = IdentitystoreFunctions.getGroup(GetGroupArgs.builder()
                 .alternateIdentifier(GetGroupAlternateIdentifierArgs.builder()
                     .uniqueAttribute(GetGroupAlternateIdentifierUniqueAttributeArgs.builder()
                         .attributePath("DisplayName")
                         .attributeValue("ExampleGroup")
                         .build())
                     .build())
                 .identityStoreId(example.identityStoreIds()[0])
                 .build());
     
             var exampleAccountAssignment = new AccountAssignment("exampleAccountAssignment", AccountAssignmentArgs.builder()
                 .instanceArn(example.arns()[0])
                 .permissionSetArn(exampleGetPermissionSet.arn())
                 .principalId(exampleGetGroup.groupId())
                 .principalType("GROUP")
                 .targetId("123456789012")
                 .targetType("AWS_ACCOUNT")
                 .build());
     
         }
     }
     
     
    ### With Managed Policy Attachment > Because destruction of a managed policy attachment resource also re-provisions the associated permission set to all accounts, explicitly indicating the dependency with the account assignment resource via the `dependsOn` meta argument is necessary to ensure proper deletion order when these resources are used together.
     
     package generated_program;
     
     import com.pulumi.Context;
     import com.pulumi.Pulumi;
     import com.pulumi.core.Output;
     import com.pulumi.aws.ssoadmin.SsoadminFunctions;
     import com.pulumi.aws.ssoadmin.inputs.GetInstancesArgs;
     import com.pulumi.aws.ssoadmin.PermissionSet;
     import com.pulumi.aws.ssoadmin.PermissionSetArgs;
     import com.pulumi.aws.identitystore.Group;
     import com.pulumi.aws.identitystore.GroupArgs;
     import com.pulumi.aws.ssoadmin.AccountAssignment;
     import com.pulumi.aws.ssoadmin.AccountAssignmentArgs;
     import com.pulumi.aws.ssoadmin.ManagedPolicyAttachment;
     import com.pulumi.aws.ssoadmin.ManagedPolicyAttachmentArgs;
     import com.pulumi.resources.CustomResourceOptions;
     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 = SsoadminFunctions.getInstances(GetInstancesArgs.builder()
                 .build());
     
             var examplePermissionSet = new PermissionSet("examplePermissionSet", PermissionSetArgs.builder()
                 .name("Example")
                 .instanceArn(example.arns()[0])
                 .build());
     
             var exampleGroup = new Group("exampleGroup", GroupArgs.builder()
                 .identityStoreId(example.identityStoreIds()[0])
                 .displayName("Admin")
                 .description("Admin Group")
                 .build());
     
             var exampleAccountAssignment = new AccountAssignment("exampleAccountAssignment", AccountAssignmentArgs.builder()
                 .instanceArn(example.arns()[0])
                 .permissionSetArn(examplePermissionSet.arn())
                 .principalId(exampleGroup.groupId())
                 .principalType("GROUP")
                 .targetId("123456789012")
                 .targetType("AWS_ACCOUNT")
                 .build());
     
             var exampleManagedPolicyAttachment = new ManagedPolicyAttachment("exampleManagedPolicyAttachment", ManagedPolicyAttachmentArgs.builder()
                 .instanceArn(example.arns()[0])
                 .managedPolicyArn("arn:aws:iam::aws:policy/AlexaForBusinessDeviceSetup")
                 .permissionSetArn(examplePermissionSet.arn())
                 .build(), CustomResourceOptions.builder()
                     .dependsOn(exampleAccountAssignment)
                     .build());
     
         }
     }
     
     
    ## Import ### Identity Schema #### Required * `instanceArn` (String) ARN of the SSO Instance. * `permissionSetArn` (String) ARN of the Permission Set. * `principalId` (String) Identifier of the principal in IAM Identity Center. * `principalType` (String) Type of principal. Valid values are `USER` and `GROUP`. * `targetId` (String) AWS account identifier. * `targetType` (String) Target type. Valid value is `AWS_ACCOUNT`. #### Optional * `accountId` (String) AWS Account where this resource is managed. * `region` (String) Region where this resource is managed. Using `pulumi import`, import SSO Account Assignments using the `principalId`, `principalType`, `targetId`, `targetType`, `permissionSetArn`, `instanceArn` separated by commas (`,`). For example: ```sh $ 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 ```
    • Nested Class Summary

      • Nested classes/interfaces inherited from class com.pulumi.resources.CustomResource

        com.pulumi.resources.CustomResource.CustomResourceInternal
      • Nested classes/interfaces inherited from class com.pulumi.resources.Resource

        com.pulumi.resources.Resource.LazyField<T extends java.lang.Object>, com.pulumi.resources.Resource.LazyFields, com.pulumi.resources.Resource.ResourceInternal
    • Field Summary

      • Fields inherited from class com.pulumi.resources.Resource

        childResources, remote
    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      static AccountAssignment get​(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, AccountAssignmentState state, com.pulumi.resources.CustomResourceOptions options)
      Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
      com.pulumi.core.Output<java.lang.String> instanceArn()  
      com.pulumi.core.Output<java.lang.String> permissionSetArn()  
      com.pulumi.core.Output<java.lang.String> principalId()  
      com.pulumi.core.Output<java.lang.String> principalType()  
      com.pulumi.core.Output<java.lang.String> region()  
      com.pulumi.core.Output<java.lang.String> targetId()  
      com.pulumi.core.Output<java.lang.String> targetType()  
      • Methods inherited from class com.pulumi.resources.CustomResource

        getId, id, idFuture
      • Methods inherited from class com.pulumi.resources.Resource

        getChildResources, getResourceName, getResourceType, getUrn, pulumiChildResources, pulumiResourceName, pulumiResourceType, urn
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

      • AccountAssignment

        public AccountAssignment​(java.lang.String name)
        Parameters:
        name - The _unique_ name of the resulting resource.
      • AccountAssignment

        public AccountAssignment​(java.lang.String name,
                                 AccountAssignmentArgs args)
        Parameters:
        name - The _unique_ name of the resulting resource.
        args - The arguments to use to populate this resource's properties.
      • AccountAssignment

        public AccountAssignment​(java.lang.String name,
                                 AccountAssignmentArgs args,
                                 @Nullable
                                 com.pulumi.resources.CustomResourceOptions options)
        Parameters:
        name - The _unique_ name of the resulting resource.
        args - The arguments to use to populate this resource's properties.
        options - A bag of options that control this resource's behavior.
    • Method Detail

      • instanceArn

        public com.pulumi.core.Output<java.lang.String> instanceArn()
        Returns:
        ARN of the SSO Instance.
      • permissionSetArn

        public com.pulumi.core.Output<java.lang.String> permissionSetArn()
        Returns:
        ARN of the Permission Set that the admin wants to grant the principal access to.
      • principalId

        public com.pulumi.core.Output<java.lang.String> principalId()
        Returns:
        An identifier for an object in SSO, such as a user or group. PrincipalIds are GUIDs (For example, `f81d4fae-7dec-11d0-a765-00a0c91e6bf6`).
      • principalType

        public com.pulumi.core.Output<java.lang.String> principalType()
        Returns:
        The entity type for which the assignment will be created. Valid values: `USER`, `GROUP`.
      • region

        public com.pulumi.core.Output<java.lang.String> region()
        Returns:
        Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.
      • targetId

        public com.pulumi.core.Output<java.lang.String> targetId()
        Returns:
        An AWS account identifier, typically a 10-12 digit string.
      • targetType

        public com.pulumi.core.Output<java.lang.String> targetType()
        Returns:
        The entity type for which the assignment will be created. Valid values: `AWS_ACCOUNT`.
      • get

        public static AccountAssignment get​(java.lang.String name,
                                            com.pulumi.core.Output<java.lang.String> id,
                                            @Nullable
                                            AccountAssignmentState state,
                                            @Nullable
                                            com.pulumi.resources.CustomResourceOptions options)
        Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
        Parameters:
        name - The _unique_ name of the resulting resource.
        id - The _unique_ provider ID of the resource to lookup.
        state -
        options - Optional settings to control the behavior of the CustomResource.