Package com.pulumi.aws.grafana

Class WorkspaceSamlConfiguration

  • public class WorkspaceSamlConfiguration
extends com.pulumi.resources.CustomResource
    Provides an Amazon Managed Grafana workspace SAML configuration resource. ## Example Usage ### Basic configuration <!--Start PulumiCodeChooser --> 
     
 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.WorkspaceSamlConfiguration;
 import com.pulumi.aws.grafana.WorkspaceSamlConfigurationArgs;
 import static com.pulumi.codegen.internal.Serialization.*;
 import java.util.List;
 import java.util.ArrayList;
 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 WorkspaceSamlConfiguration("example", WorkspaceSamlConfigurationArgs.builder()
             .editorRoleValues("editor")
             .idpMetadataUrl("https://my_idp_metadata.url")
             .workspaceId(exampleWorkspace.id())
             .build());
 
     }
 }
    <!--End PulumiCodeChooser --> ## Import Using `pulumi import`, import Grafana Workspace SAML configuration using the workspace's `id`. For example: ```sh $ pulumi import aws:grafana/workspaceSamlConfiguration:WorkspaceSamlConfiguration example g-2054c75a02 ```

    • 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
      com.pulumi.core.Output<java.util.Optional<java.util.List<java.lang.String>>> adminRoleValues()  
      com.pulumi.core.Output<java.util.Optional<java.util.List<java.lang.String>>> allowedOrganizations()  
      com.pulumi.core.Output<java.util.List<java.lang.String>> editorRoleValues()  
      com.pulumi.core.Output<java.lang.String> emailAssertion()  
      static WorkspaceSamlConfiguration get​(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, WorkspaceSamlConfigurationState 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.lang.String>> groupsAssertion()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> idpMetadataUrl()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> idpMetadataXml()  
      com.pulumi.core.Output<java.lang.String> loginAssertion()  
      com.pulumi.core.Output<java.lang.Integer> loginValidityDuration()  
      com.pulumi.core.Output<java.lang.String> nameAssertion()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> orgAssertion()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> roleAssertion()  
      com.pulumi.core.Output<java.lang.String> status()  
      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

      • WorkspaceSamlConfiguration

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

      • WorkspaceSamlConfiguration

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

      • WorkspaceSamlConfiguration

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

      • adminRoleValues

        public com.pulumi.core.Output<java.util.Optional<java.util.List<java.lang.String>>> adminRoleValues()
        Returns:
        The admin role values.

      • allowedOrganizations

        public com.pulumi.core.Output<java.util.Optional<java.util.List<java.lang.String>>> allowedOrganizations()
        Returns:
        The allowed organizations.

      • editorRoleValues

        public com.pulumi.core.Output<java.util.List<java.lang.String>> editorRoleValues()
        Returns:
        The editor role values.

      • emailAssertion

        public com.pulumi.core.Output<java.lang.String> emailAssertion()
        Returns:
        The email assertion.

      • groupsAssertion

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> groupsAssertion()
        Returns:
        The groups assertion.

      • idpMetadataUrl

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> idpMetadataUrl()
        Returns:
        The IDP Metadata URL. Note that either `idp_metadata_url` or `idp_metadata_xml` (but not both) must be specified.

      • idpMetadataXml

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> idpMetadataXml()
        Returns:
        The IDP Metadata XML. Note that either `idp_metadata_url` or `idp_metadata_xml` (but not both) must be specified.

      • loginAssertion

        public com.pulumi.core.Output<java.lang.String> loginAssertion()
        Returns:
        The login assertion.

      • loginValidityDuration

        public com.pulumi.core.Output<java.lang.Integer> loginValidityDuration()
        Returns:
        The login validity duration.

      • nameAssertion

        public com.pulumi.core.Output<java.lang.String> nameAssertion()
        Returns:
        The name assertion.

      • orgAssertion

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> orgAssertion()
        Returns:
        The org assertion.

      • roleAssertion

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> roleAssertion()
        Returns:
        The role assertion.

      • status

        public com.pulumi.core.Output<java.lang.String> status()
        Returns:
        The status of the SAML configuration.

      • workspaceId

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

      • get

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