Package com.pulumi.aws.workspacesweb

Class IdentityProvider

  • public class IdentityProvider
extends com.pulumi.resources.CustomResource
    Resource for managing an AWS WorkSpaces Web Identity Provider. ## Example Usage ### Basic Usage with SAML 
     
 package generated_program;
 
 import com.pulumi.Context;
 import com.pulumi.Pulumi;
 import com.pulumi.core.Output;
 import com.pulumi.aws.workspacesweb.Portal;
 import com.pulumi.aws.workspacesweb.PortalArgs;
 import com.pulumi.aws.workspacesweb.IdentityProvider;
 import com.pulumi.aws.workspacesweb.IdentityProviderArgs;
 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 example = new Portal("example", PortalArgs.builder()
             .displayName("example")
             .build());
 
         var exampleIdentityProvider = new IdentityProvider("exampleIdentityProvider", IdentityProviderArgs.builder()
             .identityProviderName("example-saml")
             .identityProviderType("SAML")
             .portalArn(example.portalArn())
             .identityProviderDetails(Map.of("MetadataURL", "https://example.com/metadata"))
             .build());
 
     }
 }
    ### OIDC Identity Provider 
     
 package generated_program;
 
 import com.pulumi.Context;
 import com.pulumi.Pulumi;
 import com.pulumi.core.Output;
 import com.pulumi.aws.workspacesweb.Portal;
 import com.pulumi.aws.workspacesweb.PortalArgs;
 import com.pulumi.aws.workspacesweb.IdentityProvider;
 import com.pulumi.aws.workspacesweb.IdentityProviderArgs;
 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 test = new Portal("test", PortalArgs.builder()
             .displayName("test")
             .build());
 
         var testIdentityProvider = new IdentityProvider("testIdentityProvider", IdentityProviderArgs.builder()
             .identityProviderName("test-updated")
             .identityProviderType("OIDC")
             .portalArn(test.portalArn())
             .identityProviderDetails(Map.ofEntries(
                 Map.entry("client_id", "test-client-id"),
                 Map.entry("client_secret", "test-client-secret"),
                 Map.entry("oidc_issuer", "https://accounts.google.com"),
                 Map.entry("attributes_request_method", "POST"),
                 Map.entry("authorize_scopes", "openid, email")
             ))
             .build());
 
     }
 }
    ## Import Using `pulumi import`, import WorkSpaces Web Identity Provider using the `identityProviderArn`. For example: ```sh $ pulumi import aws:workspacesweb/identityProvider:IdentityProvider example arn:aws:workspaces-web:us-west-2:123456789012:identityprovider/abcdef12345678/12345678-1234-1234-1234-123456789012 ```

    • 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 IdentityProvider get​(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, IdentityProviderState 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> identityProviderArn()  
      com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>> identityProviderDetails()  
      com.pulumi.core.Output<java.lang.String> identityProviderName()  
      com.pulumi.core.Output<java.lang.String> identityProviderType()  
      com.pulumi.core.Output<java.lang.String> portalArn()  
      com.pulumi.core.Output<java.lang.String> region()  
      com.pulumi.core.Output<java.util.Optional<java.util.Map<java.lang.String,​java.lang.String>>> tags()  
      com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>> tagsAll()  

      • 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

      • IdentityProvider

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

      • IdentityProvider

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

      • IdentityProvider

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

      • identityProviderArn

        public com.pulumi.core.Output<java.lang.String> identityProviderArn()
        Returns:
        ARN of the identity provider.

      • identityProviderDetails

        public com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>> identityProviderDetails()
        Returns:
        Identity provider details. The following list describes the provider detail keys for each identity provider type: * For Google and Login with Amazon:

      • identityProviderName

        public com.pulumi.core.Output<java.lang.String> identityProviderName()
        Returns:
        Identity provider name.

      • identityProviderType

        public com.pulumi.core.Output<java.lang.String> identityProviderType()
        Returns:
        Identity provider type. Valid values: `SAML`, `Facebook`, `Google`, `LoginWithAmazon`, `SignInWithApple`, `OIDC`.

      • portalArn

        public com.pulumi.core.Output<java.lang.String> portalArn()
        Returns:
        ARN of the web portal. Forces replacement if changed. The following arguments are optional:

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

      • tags

        public com.pulumi.core.Output<java.util.Optional<java.util.Map<java.lang.String,​java.lang.String>>> tags()
        Returns:
        Map of tags to assign to the resource. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.

      • tagsAll

        public com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>> tagsAll()
        Returns:
        Map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block.

      • get

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