Package com.pulumi.aws.grafana

Class RoleAssociation

  • public class RoleAssociation
extends com.pulumi.resources.CustomResource
    Provides an Amazon Managed Grafana workspace role association resource. ## Example Usage ### Basic configuration 
     
 package generated_program;
 
 import com.pulumi.Context;
 import com.pulumi.Pulumi;
 import com.pulumi.core.Output;
 import com.pulumi.aws.iam.Role;
 import com.pulumi.aws.iam.RoleArgs;
 import com.pulumi.aws.grafana.Workspace;
 import com.pulumi.aws.grafana.WorkspaceArgs;
 import com.pulumi.aws.grafana.RoleAssociation;
 import com.pulumi.aws.grafana.RoleAssociationArgs;
 import static com.pulumi.codegen.internal.Serialization.*;
 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) {
         var assume = new Role("assume", RoleArgs.builder()
             .name("grafana-assume")
             .assumeRolePolicy(serializeJson(
                 jsonObject(
                     jsonProperty("Version", "2012-10-17"),
                     jsonProperty("Statement", jsonArray(jsonObject(
                         jsonProperty("Action", "sts:AssumeRole"),
                         jsonProperty("Effect", "Allow"),
                         jsonProperty("Sid", ""),
                         jsonProperty("Principal", jsonObject(
                             jsonProperty("Service", "grafana.amazonaws.com")
                         ))
                     )))
                 )))
             .build());
 
         var exampleWorkspace = new Workspace("exampleWorkspace", WorkspaceArgs.builder()
             .accountAccessType("CURRENT_ACCOUNT")
             .authenticationProviders("SAML")
             .permissionType("SERVICE_MANAGED")
             .roleArn(assume.arn())
             .build());
 
         var example = new RoleAssociation("example", RoleAssociationArgs.builder()
             .role("ADMIN")
             .userIds(            
                 "USER_ID_1",
                 "USER_ID_2")
             .workspaceId(exampleWorkspace.id())
             .build());
 
     }
 }

    • 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 RoleAssociation get​(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, RoleAssociationState 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.util.Optional<java.util.List<java.lang.String>>> groupIds()  
      com.pulumi.core.Output<java.lang.String> region()  
      com.pulumi.core.Output<java.lang.String> role()  
      com.pulumi.core.Output<java.util.Optional<java.util.List<java.lang.String>>> userIds()  
      com.pulumi.core.Output<java.lang.String> workspaceId()  

      • 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

      • RoleAssociation

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

      • RoleAssociation

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

      • RoleAssociation

        public RoleAssociation​(java.lang.String name,
                       RoleAssociationArgs 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

      • groupIds

        public com.pulumi.core.Output<java.util.Optional<java.util.List<java.lang.String>>> groupIds()
        Returns:
        AWS SSO group IDs to be assigned the role given in `role`.

      • 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.

      • role

        public com.pulumi.core.Output<java.lang.String> role()
        Returns:
        Grafana role. Valid values can be found [here](https://docs.aws.amazon.com/grafana/latest/APIReference/API_UpdateInstruction.html#ManagedGrafana-Type-UpdateInstruction-role).

      • userIds

        public com.pulumi.core.Output<java.util.Optional<java.util.List<java.lang.String>>> userIds()
        Returns:
        AWS SSO user IDs to be assigned the role given in `role`.

      • workspaceId

        public com.pulumi.core.Output<java.lang.String> workspaceId()
        Returns:
        Workspace ID. The following arguments are optional:

      • get

        public static RoleAssociation get​(java.lang.String name,
                                  com.pulumi.core.Output<java.lang.String> id,
                                  @Nullable
                                  RoleAssociationState 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.