Application class

Resource for managing an AWS SSO Admin Application.

> The CreateApplication API only supports custom OAuth 2.0 applications. Creation of 3rd party SAML or OAuth 2.0 applications require setup to be done through the associated app service or AWS console. See this issue for additional context.

Example Usage

Basic Usage

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = aws.ssoadmin.getInstances({});
const exampleApplication = new aws.ssoadmin.Application("example", {
    name: "example",
    applicationProviderArn: "arn:aws:sso::aws:applicationProvider/custom",
    instanceArn: example.then(example => example.arns?.[0]),
});

import pulumi
import pulumi_aws as aws

example = aws.ssoadmin.get_instances()
example_application = aws.ssoadmin.Application("example",
    name="example",
    application_provider_arn="arn:aws:sso::aws:applicationProvider/custom",
    instance_arn=example.arns[0])

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() =>
{
    var example = Aws.SsoAdmin.GetInstances.Invoke();

    var exampleApplication = new Aws.SsoAdmin.Application("example", new()
    {
        Name = "example",
        ApplicationProviderArn = "arn:aws:sso::aws:applicationProvider/custom",
        InstanceArn = example.Apply(getInstancesResult => getInstancesResult.Arns[0]),
    });

});

package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/ssoadmin"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		example, err := ssoadmin.GetInstances(ctx, &ssoadmin.GetInstancesArgs{}, nil)
		if err != nil {
			return err
		}
		_, err = ssoadmin.NewApplication(ctx, "example", &ssoadmin.ApplicationArgs{
			Name:                   pulumi.String("example"),
			ApplicationProviderArn: pulumi.String("arn:aws:sso::aws:applicationProvider/custom"),
			InstanceArn:            pulumi.String(example.Arns[0]),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

data "aws_ssoadmin_getinstances" "example" {
}

resource "aws_ssoadmin_application" "example" {
  name                     = "example"
  application_provider_arn = "arn:aws:sso::aws:applicationProvider/custom"
  instance_arn             = data.aws_ssoadmin_getinstances.example.arns[0]
}

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.Application;
import com.pulumi.aws.ssoadmin.ApplicationArgs;
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 exampleApplication = new Application("exampleApplication", ApplicationArgs.builder()
            .name("example")
            .applicationProviderArn("arn:aws:sso::aws:applicationProvider/custom")
            .instanceArn(example.arns()[0])
            .build());

    }
}

resources:
  exampleApplication:
    type: aws:ssoadmin:Application
    name: example
    properties:
      name: example
      applicationProviderArn: arn:aws:sso::aws:applicationProvider/custom
      instanceArn: ${example.arns[0]}
variables:
  example:
    fn::invoke:
      function: aws:ssoadmin:getInstances
      arguments: {}

With Portal Options

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = aws.ssoadmin.getInstances({});
const exampleApplication = new aws.ssoadmin.Application("example", {
    portalOptions: {
        signInOptions: {
            applicationUrl: "http://example.com",
            origin: "APPLICATION",
        },
        visibility: "ENABLED",
    },
    name: "example",
    applicationProviderArn: "arn:aws:sso::aws:applicationProvider/custom",
    instanceArn: example.then(example => example.arns?.[0]),
});

import pulumi
import pulumi_aws as aws

example = aws.ssoadmin.get_instances()
example_application = aws.ssoadmin.Application("example",
    portal_options={
        "sign_in_options": {
            "application_url": "http://example.com",
            "origin": "APPLICATION",
        },
        "visibility": "ENABLED",
    },
    name="example",
    application_provider_arn="arn:aws:sso::aws:applicationProvider/custom",
    instance_arn=example.arns[0])

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() =>
{
    var example = Aws.SsoAdmin.GetInstances.Invoke();

    var exampleApplication = new Aws.SsoAdmin.Application("example", new()
    {
        PortalOptions = new Aws.SsoAdmin.Inputs.ApplicationPortalOptionsArgs
        {
            SignInOptions = new Aws.SsoAdmin.Inputs.ApplicationPortalOptionsSignInOptionsArgs
            {
                ApplicationUrl = "http://example.com",
                Origin = "APPLICATION",
            },
            Visibility = "ENABLED",
        },
        Name = "example",
        ApplicationProviderArn = "arn:aws:sso::aws:applicationProvider/custom",
        InstanceArn = example.Apply(getInstancesResult => getInstancesResult.Arns[0]),
    });

});

package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/ssoadmin"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		example, err := ssoadmin.GetInstances(ctx, &ssoadmin.GetInstancesArgs{}, nil)
		if err != nil {
			return err
		}
		_, err = ssoadmin.NewApplication(ctx, "example", &ssoadmin.ApplicationArgs{
			PortalOptions: &ssoadmin.ApplicationPortalOptionsArgs{
				SignInOptions: &ssoadmin.ApplicationPortalOptionsSignInOptionsArgs{
					ApplicationUrl: pulumi.String("http://example.com"),
					Origin:         pulumi.String("APPLICATION"),
				},
				Visibility: pulumi.String("ENABLED"),
			},
			Name:                   pulumi.String("example"),
			ApplicationProviderArn: pulumi.String("arn:aws:sso::aws:applicationProvider/custom"),
			InstanceArn:            pulumi.String(example.Arns[0]),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

data "aws_ssoadmin_getinstances" "example" {
}

resource "aws_ssoadmin_application" "example" {
  portal_options = {
    sign_in_options = {
      application_url = "http://example.com"
      origin          = "APPLICATION"
    }
    visibility = "ENABLED"
  }
  name                     = "example"
  application_provider_arn = "arn:aws:sso::aws:applicationProvider/custom"
  instance_arn             = data.aws_ssoadmin_getinstances.example.arns[0]
}

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.Application;
import com.pulumi.aws.ssoadmin.ApplicationArgs;
import com.pulumi.aws.ssoadmin.inputs.ApplicationPortalOptionsArgs;
import com.pulumi.aws.ssoadmin.inputs.ApplicationPortalOptionsSignInOptionsArgs;
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 exampleApplication = new Application("exampleApplication", ApplicationArgs.builder()
            .portalOptions(ApplicationPortalOptionsArgs.builder()
                .signInOptions(ApplicationPortalOptionsSignInOptionsArgs.builder()
                    .applicationUrl("http://example.com")
                    .origin("APPLICATION")
                    .build())
                .visibility("ENABLED")
                .build())
            .name("example")
            .applicationProviderArn("arn:aws:sso::aws:applicationProvider/custom")
            .instanceArn(example.arns()[0])
            .build());

    }
}

resources:
  exampleApplication:
    type: aws:ssoadmin:Application
    name: example
    properties:
      portalOptions:
        signInOptions:
          applicationUrl: http://example.com
          origin: APPLICATION
        visibility: ENABLED
      name: example
      applicationProviderArn: arn:aws:sso::aws:applicationProvider/custom
      instanceArn: ${example.arns[0]}
variables:
  example:
    fn::invoke:
      function: aws:ssoadmin:getInstances
      arguments: {}

Import

Identity Schema

Required

arn (String) ARN of the SSO application.

Optional

region (String) Region where this resource is managed.

Using pulumi import, import SSO Admin Application using the id. For example:

$ pulumi import aws:ssoadmin/application:Application example arn:aws:sso::123456789012:application/id-12345678

Constructors

Application(String name, {ApplicationArgs? args, CustomResourceOptions? options}): Creates a new Application. name The Pulumi resource name. args Arguments used to configure this Application. The set of arguments for Application. options Resource options controlling this resource's behavior.
Application.reference(String urn): Creates a typed reference to an existing Application resource.

Properties

applicationAccount ↔ Output<String>: AWS account ID.
latefinal
applicationArn ↔ Output<String>: (Deprecated Reference arn instead) ARN of the application.
latefinal
applicationProviderArn ↔ Output<String>: ARN of the application provider.
latefinal
arn ↔ Output<String>: ARN of the application.
latefinal
childResources → Set<Resource>: finalinherited
clientToken ↔ Output<String?>: A unique, case-sensitive ID that you provide to ensure the idempotency of the request. AWS generates a random value when not provided.
latefinal
completionSources ↔ Map<String, IOutputCompletionSource>: latefinalinherited
description ↔ Output<String?>: Description of the application.
latefinal
hashCode → int: The hash code for this object.
no setterinherited
id ↔ Output<String>: getter/setter pairinherited
instanceArn ↔ Output<String>: ARN of the instance of IAM Identity Center.
latefinal
isCustom → bool: Returns whether this resource is provider-managed.
no setterinherited
isProtected → bool: Returns whether this resource is protected from deletion.
no setterinherited
isRemote → bool: Whether this resource is registered as remote.
no setterinherited
isResourceReference → bool: Whether this instance represents a resource value returned over RPC.
finalinherited
name ↔ Output<String>: Name of the application.
latefinal
portalOptions ↔ Output<ApplicationPortalOptions?>: Options for the portal associated with an application. See portalOptions below.
latefinal
region ↔ Output<String>: Region where this resource will be managed. Defaults to the Region set in the provider configuration.
latefinal
resourceTransforms → List<ResourceTransform>: Inherited/explicit async transforms.
no setterinherited
runtimeType → Type: A representation of the runtime type of the object.
no setterinherited
status ↔ Output<String>: Status of the application. Valid values are ENABLED and DISABLED.
latefinal
tags ↔ Output<Map<String, String>?>: Key-value mapping of resource tags. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
latefinal
tagsAll ↔ Output<Map<String, String>>: Map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.
latefinal
transformations → List<ResourceTransformation>: Inherited/explicit legacy transformations.
no setterinherited
urn ↔ Output<String>: latefinalinherited

Methods

failId(Object error) → void: Completes this resource ID with an error when registration fails.
inherited
failOutputs(Object error) → void: Completes all output properties with error.
inherited
failUrn(Object error) → void: Completes this resource URN with an error when registration fails.
inherited
getProvider(String moduleMember) → ProviderResource?: Returns provider for moduleMember's package, if configured.
inherited
getResourceName() → String: Returns this resource's logical name.
inherited
getResourceType() → String: Returns this resource's Pulumi type token.
inherited
noSuchMethod(Invocation invocation) → dynamic: Invoked when a nonexistent method or property is accessed.
inherited
registerOutput<T>(String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output<T>: Registers a dynamic output property for this resource.
inherited
resolveId(String? value, {required bool isKnown}) → void: Resolves the provider-assigned ID for this resource.
inherited
resolveOutputs(Struct outputs) → void: Resolves all output properties from a monitor response payload.
inherited
resolveUrn(String value) → void: Resolves this resource's URN once assigned by the engine.
inherited
serializeProperties(Map<String, dynamic> properties) → Future<Struct>: Serializes resource properties for RPC transmission.
inherited
toString() → String: A string representation of this object.
inherited

Operators

operator ==(Object other) → bool: The equality operator.
inherited

Static Methods

get(String name, Input<String> id, {ApplicationState? state, CustomResourceOptions? options}) → Application: Gets an existing Application resource's state with the given name and id.