Docs Packages
  1. Packages
  2. AWS Classic
  3. API Docs
  4. ssoadmin
  5. Application

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.33.1 published on Thursday, May 2, 2024 by Pulumi
pulumi/pulumi-aws

aws.ssoadmin.Application

Explore with Pulumi AI

aws logo

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.33.1 published on Thursday, May 2, 2024 by Pulumi
pulumi/pulumi-aws

    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

    Create Application Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Application(name: string, args: ApplicationArgs, opts?: CustomResourceOptions);
    @overload
def Application(resource_name: str,
                args: ApplicationArgs,
                opts: Optional[ResourceOptions] = None)

@overload
def Application(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                application_provider_arn: Optional[str] = None,
                instance_arn: Optional[str] = None,
                client_token: Optional[str] = None,
                description: Optional[str] = None,
                name: Optional[str] = None,
                portal_options: Optional[ApplicationPortalOptionsArgs] = None,
                status: Optional[str] = None,
                tags: Optional[Mapping[str, str]] = None)
    func NewApplication(ctx *Context, name string, args ApplicationArgs, opts ...ResourceOption) (*Application, error)
    public Application(string name, ApplicationArgs args, CustomResourceOptions? opts = null)
    public Application(String name, ApplicationArgs args)
public Application(String name, ApplicationArgs args, CustomResourceOptions options)

    type: aws:ssoadmin:Application
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args ApplicationArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args ApplicationArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args ApplicationArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ApplicationArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ApplicationArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

    The following reference example uses placeholder values for all input properties.

    var exampleapplicationResourceResourceFromSsoadminapplication = new Aws.SsoAdmin.Application("exampleapplicationResourceResourceFromSsoadminapplication", new()
{
    ApplicationProviderArn = "string",
    InstanceArn = "string",
    ClientToken = "string",
    Description = "string",
    Name = "string",
    PortalOptions = new Aws.SsoAdmin.Inputs.ApplicationPortalOptionsArgs
    {
        SignInOptions = new Aws.SsoAdmin.Inputs.ApplicationPortalOptionsSignInOptionsArgs
        {
            Origin = "string",
            ApplicationUrl = "string",
        },
        Visibility = "string",
    },
    Status = "string",
    Tags = 
    {
        { "string", "string" },
    },
});

    example, err := ssoadmin.NewApplication(ctx, "exampleapplicationResourceResourceFromSsoadminapplication", &ssoadmin.ApplicationArgs{
	ApplicationProviderArn: pulumi.String("string"),
	InstanceArn:            pulumi.String("string"),
	ClientToken:            pulumi.String("string"),
	Description:            pulumi.String("string"),
	Name:                   pulumi.String("string"),
	PortalOptions: &ssoadmin.ApplicationPortalOptionsArgs{
		SignInOptions: &ssoadmin.ApplicationPortalOptionsSignInOptionsArgs{
			Origin:         pulumi.String("string"),
			ApplicationUrl: pulumi.String("string"),
		},
		Visibility: pulumi.String("string"),
	},
	Status: pulumi.String("string"),
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
})

    var exampleapplicationResourceResourceFromSsoadminapplication = new Application("exampleapplicationResourceResourceFromSsoadminapplication", ApplicationArgs.builder()        
    .applicationProviderArn("string")
    .instanceArn("string")
    .clientToken("string")
    .description("string")
    .name("string")
    .portalOptions(ApplicationPortalOptionsArgs.builder()
        .signInOptions(ApplicationPortalOptionsSignInOptionsArgs.builder()
            .origin("string")
            .applicationUrl("string")
            .build())
        .visibility("string")
        .build())
    .status("string")
    .tags(Map.of("string", "string"))
    .build());

    exampleapplication_resource_resource_from_ssoadminapplication = aws.ssoadmin.Application("exampleapplicationResourceResourceFromSsoadminapplication",
    application_provider_arn="string",
    instance_arn="string",
    client_token="string",
    description="string",
    name="string",
    portal_options=aws.ssoadmin.ApplicationPortalOptionsArgs(
        sign_in_options=aws.ssoadmin.ApplicationPortalOptionsSignInOptionsArgs(
            origin="string",
            application_url="string",
        ),
        visibility="string",
    ),
    status="string",
    tags={
        "string": "string",
    })

    const exampleapplicationResourceResourceFromSsoadminapplication = new aws.ssoadmin.Application("exampleapplicationResourceResourceFromSsoadminapplication", {
    applicationProviderArn: "string",
    instanceArn: "string",
    clientToken: "string",
    description: "string",
    name: "string",
    portalOptions: {
        signInOptions: {
            origin: "string",
            applicationUrl: "string",
        },
        visibility: "string",
    },
    status: "string",
    tags: {
        string: "string",
    },
});

    type: aws:ssoadmin:Application
properties:
    applicationProviderArn: string
    clientToken: string
    description: string
    instanceArn: string
    name: string
    portalOptions:
        signInOptions:
            applicationUrl: string
            origin: string
        visibility: string
    status: string
    tags:
        string: string

    Application Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The Application resource accepts the following input properties:

    ApplicationProviderArn string
    ARN of the application provider.
    InstanceArn string
    ARN of the instance of IAM Identity Center.
    ClientToken string
    A unique, case-sensitive ID that you provide to ensure the idempotency of the request. AWS generates a random value when not provided.
    Description string
    Description of the application.
    Name string

    Name of the application.

    The following arguments are optional:

    PortalOptions ApplicationPortalOptions
    Options for the portal associated with an application. See portal_options below.
    Status string
    Status of the application. Valid values are ENABLED and DISABLED.
    Tags Dictionary<string, string>
    Key-value mapping of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    ApplicationProviderArn string
    ARN of the application provider.
    InstanceArn string
    ARN of the instance of IAM Identity Center.
    ClientToken string
    A unique, case-sensitive ID that you provide to ensure the idempotency of the request. AWS generates a random value when not provided.
    Description string
    Description of the application.
    Name string

    Name of the application.

    The following arguments are optional:

    PortalOptions ApplicationPortalOptionsArgs
    Options for the portal associated with an application. See portal_options below.
    Status string
    Status of the application. Valid values are ENABLED and DISABLED.
    Tags map[string]string
    Key-value mapping of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    applicationProviderArn String
    ARN of the application provider.
    instanceArn String
    ARN of the instance of IAM Identity Center.
    clientToken String
    A unique, case-sensitive ID that you provide to ensure the idempotency of the request. AWS generates a random value when not provided.
    description String
    Description of the application.
    name String

    Name of the application.

    The following arguments are optional:

    portalOptions ApplicationPortalOptions
    Options for the portal associated with an application. See portal_options below.
    status String
    Status of the application. Valid values are ENABLED and DISABLED.
    tags Map<String,String>
    Key-value mapping of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    applicationProviderArn string
    ARN of the application provider.
    instanceArn string
    ARN of the instance of IAM Identity Center.
    clientToken string
    A unique, case-sensitive ID that you provide to ensure the idempotency of the request. AWS generates a random value when not provided.
    description string
    Description of the application.
    name string

    Name of the application.

    The following arguments are optional:

    portalOptions ApplicationPortalOptions
    Options for the portal associated with an application. See portal_options below.
    status string
    Status of the application. Valid values are ENABLED and DISABLED.
    tags {[key: string]: string}
    Key-value mapping of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    application_provider_arn str
    ARN of the application provider.
    instance_arn str
    ARN of the instance of IAM Identity Center.
    client_token str
    A unique, case-sensitive ID that you provide to ensure the idempotency of the request. AWS generates a random value when not provided.
    description str
    Description of the application.
    name str

    Name of the application.

    The following arguments are optional:

    portal_options ApplicationPortalOptionsArgs
    Options for the portal associated with an application. See portal_options below.
    status str
    Status of the application. Valid values are ENABLED and DISABLED.
    tags Mapping[str, str]
    Key-value mapping of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    applicationProviderArn String
    ARN of the application provider.
    instanceArn String
    ARN of the instance of IAM Identity Center.
    clientToken String
    A unique, case-sensitive ID that you provide to ensure the idempotency of the request. AWS generates a random value when not provided.
    description String
    Description of the application.
    name String

    Name of the application.

    The following arguments are optional:

    portalOptions Property Map
    Options for the portal associated with an application. See portal_options below.
    status String
    Status of the application. Valid values are ENABLED and DISABLED.
    tags Map<String>
    Key-value mapping of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Application resource produces the following output properties:

    ApplicationAccount string
    AWS account ID.
    ApplicationArn string
    ARN of the application.
    Id string
    The provider-assigned unique ID for this managed resource.
    TagsAll Dictionary<string, string>
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    ApplicationAccount string
    AWS account ID.
    ApplicationArn string
    ARN of the application.
    Id string
    The provider-assigned unique ID for this managed resource.
    TagsAll map[string]string
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    applicationAccount String
    AWS account ID.
    applicationArn String
    ARN of the application.
    id String
    The provider-assigned unique ID for this managed resource.
    tagsAll Map<String,String>
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    applicationAccount string
    AWS account ID.
    applicationArn string
    ARN of the application.
    id string
    The provider-assigned unique ID for this managed resource.
    tagsAll {[key: string]: string}
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    application_account str
    AWS account ID.
    application_arn str
    ARN of the application.
    id str
    The provider-assigned unique ID for this managed resource.
    tags_all Mapping[str, str]
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    applicationAccount String
    AWS account ID.
    applicationArn String
    ARN of the application.
    id String
    The provider-assigned unique ID for this managed resource.
    tagsAll Map<String>
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Look up Existing Application Resource

    Get an existing Application resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: ApplicationState, opts?: CustomResourceOptions): Application
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        application_account: Optional[str] = None,
        application_arn: Optional[str] = None,
        application_provider_arn: Optional[str] = None,
        client_token: Optional[str] = None,
        description: Optional[str] = None,
        instance_arn: Optional[str] = None,
        name: Optional[str] = None,
        portal_options: Optional[ApplicationPortalOptionsArgs] = None,
        status: Optional[str] = None,
        tags: Optional[Mapping[str, str]] = None,
        tags_all: Optional[Mapping[str, str]] = None) -> Application
    func GetApplication(ctx *Context, name string, id IDInput, state *ApplicationState, opts ...ResourceOption) (*Application, error)
    public static Application Get(string name, Input<string> id, ApplicationState? state, CustomResourceOptions? opts = null)
    public static Application get(String name, Output<String> id, ApplicationState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    ApplicationAccount string
    AWS account ID.
    ApplicationArn string
    ARN of the application.
    ApplicationProviderArn string
    ARN of the application provider.
    ClientToken string
    A unique, case-sensitive ID that you provide to ensure the idempotency of the request. AWS generates a random value when not provided.
    Description string
    Description of the application.
    InstanceArn string
    ARN of the instance of IAM Identity Center.
    Name string

    Name of the application.

    The following arguments are optional:

    PortalOptions ApplicationPortalOptions
    Options for the portal associated with an application. See portal_options below.
    Status string
    Status of the application. Valid values are ENABLED and DISABLED.
    Tags Dictionary<string, string>
    Key-value mapping of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    TagsAll Dictionary<string, string>
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    ApplicationAccount string
    AWS account ID.
    ApplicationArn string
    ARN of the application.
    ApplicationProviderArn string
    ARN of the application provider.
    ClientToken string
    A unique, case-sensitive ID that you provide to ensure the idempotency of the request. AWS generates a random value when not provided.
    Description string
    Description of the application.
    InstanceArn string
    ARN of the instance of IAM Identity Center.
    Name string

    Name of the application.

    The following arguments are optional:

    PortalOptions ApplicationPortalOptionsArgs
    Options for the portal associated with an application. See portal_options below.
    Status string
    Status of the application. Valid values are ENABLED and DISABLED.
    Tags map[string]string
    Key-value mapping of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    TagsAll map[string]string
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    applicationAccount String
    AWS account ID.
    applicationArn String
    ARN of the application.
    applicationProviderArn String
    ARN of the application provider.
    clientToken String
    A unique, case-sensitive ID that you provide to ensure the idempotency of the request. AWS generates a random value when not provided.
    description String
    Description of the application.
    instanceArn String
    ARN of the instance of IAM Identity Center.
    name String

    Name of the application.

    The following arguments are optional:

    portalOptions ApplicationPortalOptions
    Options for the portal associated with an application. See portal_options below.
    status String
    Status of the application. Valid values are ENABLED and DISABLED.
    tags Map<String,String>
    Key-value mapping of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll Map<String,String>
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    applicationAccount string
    AWS account ID.
    applicationArn string
    ARN of the application.
    applicationProviderArn string
    ARN of the application provider.
    clientToken string
    A unique, case-sensitive ID that you provide to ensure the idempotency of the request. AWS generates a random value when not provided.
    description string
    Description of the application.
    instanceArn string
    ARN of the instance of IAM Identity Center.
    name string

    Name of the application.

    The following arguments are optional:

    portalOptions ApplicationPortalOptions
    Options for the portal associated with an application. See portal_options below.
    status string
    Status of the application. Valid values are ENABLED and DISABLED.
    tags {[key: string]: string}
    Key-value mapping of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll {[key: string]: string}
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    application_account str
    AWS account ID.
    application_arn str
    ARN of the application.
    application_provider_arn str
    ARN of the application provider.
    client_token str
    A unique, case-sensitive ID that you provide to ensure the idempotency of the request. AWS generates a random value when not provided.
    description str
    Description of the application.
    instance_arn str
    ARN of the instance of IAM Identity Center.
    name str

    Name of the application.

    The following arguments are optional:

    portal_options ApplicationPortalOptionsArgs
    Options for the portal associated with an application. See portal_options below.
    status str
    Status of the application. Valid values are ENABLED and DISABLED.
    tags Mapping[str, str]
    Key-value mapping of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tags_all Mapping[str, str]
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    applicationAccount String
    AWS account ID.
    applicationArn String
    ARN of the application.
    applicationProviderArn String
    ARN of the application provider.
    clientToken String
    A unique, case-sensitive ID that you provide to ensure the idempotency of the request. AWS generates a random value when not provided.
    description String
    Description of the application.
    instanceArn String
    ARN of the instance of IAM Identity Center.
    name String

    Name of the application.

    The following arguments are optional:

    portalOptions Property Map
    Options for the portal associated with an application. See portal_options below.
    status String
    Status of the application. Valid values are ENABLED and DISABLED.
    tags Map<String>
    Key-value mapping of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll Map<String>
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Supporting Types

    ApplicationPortalOptions, ApplicationPortalOptionsArgs

    SignInOptions ApplicationPortalOptionsSignInOptions
    Sign-in options for the access portal. See sign_in_options below.
    Visibility string
    Indicates whether this application is visible in the access portal. Valid values are ENABLED and DISABLED.
    SignInOptions ApplicationPortalOptionsSignInOptions
    Sign-in options for the access portal. See sign_in_options below.
    Visibility string
    Indicates whether this application is visible in the access portal. Valid values are ENABLED and DISABLED.
    signInOptions ApplicationPortalOptionsSignInOptions
    Sign-in options for the access portal. See sign_in_options below.
    visibility String
    Indicates whether this application is visible in the access portal. Valid values are ENABLED and DISABLED.
    signInOptions ApplicationPortalOptionsSignInOptions
    Sign-in options for the access portal. See sign_in_options below.
    visibility string
    Indicates whether this application is visible in the access portal. Valid values are ENABLED and DISABLED.
    sign_in_options ApplicationPortalOptionsSignInOptions
    Sign-in options for the access portal. See sign_in_options below.
    visibility str
    Indicates whether this application is visible in the access portal. Valid values are ENABLED and DISABLED.
    signInOptions Property Map
    Sign-in options for the access portal. See sign_in_options below.
    visibility String
    Indicates whether this application is visible in the access portal. Valid values are ENABLED and DISABLED.

    ApplicationPortalOptionsSignInOptions, ApplicationPortalOptionsSignInOptionsArgs

    Origin string
    Determines how IAM Identity Center navigates the user to the target application. Valid values are APPLICATION and IDENTITY_CENTER. If APPLICATION is set, IAM Identity Center redirects the customer to the configured application_url. If IDENTITY_CENTER is set, IAM Identity Center uses SAML identity-provider initiated authentication to sign the customer directly into a SAML-based application.
    ApplicationUrl string
    URL that accepts authentication requests for an application.
    Origin string
    Determines how IAM Identity Center navigates the user to the target application. Valid values are APPLICATION and IDENTITY_CENTER. If APPLICATION is set, IAM Identity Center redirects the customer to the configured application_url. If IDENTITY_CENTER is set, IAM Identity Center uses SAML identity-provider initiated authentication to sign the customer directly into a SAML-based application.
    ApplicationUrl string
    URL that accepts authentication requests for an application.
    origin String
    Determines how IAM Identity Center navigates the user to the target application. Valid values are APPLICATION and IDENTITY_CENTER. If APPLICATION is set, IAM Identity Center redirects the customer to the configured application_url. If IDENTITY_CENTER is set, IAM Identity Center uses SAML identity-provider initiated authentication to sign the customer directly into a SAML-based application.
    applicationUrl String
    URL that accepts authentication requests for an application.
    origin string
    Determines how IAM Identity Center navigates the user to the target application. Valid values are APPLICATION and IDENTITY_CENTER. If APPLICATION is set, IAM Identity Center redirects the customer to the configured application_url. If IDENTITY_CENTER is set, IAM Identity Center uses SAML identity-provider initiated authentication to sign the customer directly into a SAML-based application.
    applicationUrl string
    URL that accepts authentication requests for an application.
    origin str
    Determines how IAM Identity Center navigates the user to the target application. Valid values are APPLICATION and IDENTITY_CENTER. If APPLICATION is set, IAM Identity Center redirects the customer to the configured application_url. If IDENTITY_CENTER is set, IAM Identity Center uses SAML identity-provider initiated authentication to sign the customer directly into a SAML-based application.
    application_url str
    URL that accepts authentication requests for an application.
    origin String
    Determines how IAM Identity Center navigates the user to the target application. Valid values are APPLICATION and IDENTITY_CENTER. If APPLICATION is set, IAM Identity Center redirects the customer to the configured application_url. If IDENTITY_CENTER is set, IAM Identity Center uses SAML identity-provider initiated authentication to sign the customer directly into a SAML-based application.
    applicationUrl String
    URL that accepts authentication requests for an application.

    Import

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

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

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    AWS Classic pulumi/pulumi-aws
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the aws Terraform Provider.
    aws logo

    Try AWS Native preview for resources not in the classic version.

    AWS Classic v6.33.1 published on Thursday, May 2, 2024 by Pulumi
    pulumi/pulumi-aws