Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS
  3. API Docs
  4. ssoadmin
  5. ApplicationAssignmentConfiguration
AWS v6.60.0 published on Tuesday, Nov 19, 2024 by Pulumi
pulumi/pulumi-aws

aws.ssoadmin.ApplicationAssignmentConfiguration

Explore with Pulumi AI

aws logo
AWS v6.60.0 published on Tuesday, Nov 19, 2024 by Pulumi
pulumi/pulumi-aws

    Resource for managing an AWS SSO Admin Application Assignment Configuration.

    By default, applications will require users to have an explicit assignment in order to access an application. This resource can be used to adjust this default behavior if necessary.

    Deleting this resource will return the assignment configuration for the application to the default AWS behavior (ie. assignment_required = true).

    Example Usage

    Basic Usage

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

const example = new aws.ssoadmin.ApplicationAssignmentConfiguration("example", {
    applicationArn: exampleAwsSsoadminApplication.applicationArn,
    assignmentRequired: true,
});

    import pulumi
import pulumi_aws as aws

example = aws.ssoadmin.ApplicationAssignmentConfiguration("example",
    application_arn=example_aws_ssoadmin_application["applicationArn"],
    assignment_required=True)

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := ssoadmin.NewApplicationAssignmentConfiguration(ctx, "example", &ssoadmin.ApplicationAssignmentConfigurationArgs{
			ApplicationArn:     pulumi.Any(exampleAwsSsoadminApplication.ApplicationArn),
			AssignmentRequired: pulumi.Bool(true),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var example = new Aws.SsoAdmin.ApplicationAssignmentConfiguration("example", new()
    {
        ApplicationArn = exampleAwsSsoadminApplication.ApplicationArn,
        AssignmentRequired = true,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.ssoadmin.ApplicationAssignmentConfiguration;
import com.pulumi.aws.ssoadmin.ApplicationAssignmentConfigurationArgs;
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 example = new ApplicationAssignmentConfiguration("example", ApplicationAssignmentConfigurationArgs.builder()
            .applicationArn(exampleAwsSsoadminApplication.applicationArn())
            .assignmentRequired(true)
            .build());

    }
}

    resources:
  example:
    type: aws:ssoadmin:ApplicationAssignmentConfiguration
    properties:
      applicationArn: ${exampleAwsSsoadminApplication.applicationArn}
      assignmentRequired: true

    Create ApplicationAssignmentConfiguration Resource

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

    Constructor syntax

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

@overload
def ApplicationAssignmentConfiguration(resource_name: str,
                                       opts: Optional[ResourceOptions] = None,
                                       application_arn: Optional[str] = None,
                                       assignment_required: Optional[bool] = None)
    func NewApplicationAssignmentConfiguration(ctx *Context, name string, args ApplicationAssignmentConfigurationArgs, opts ...ResourceOption) (*ApplicationAssignmentConfiguration, error)
    public ApplicationAssignmentConfiguration(string name, ApplicationAssignmentConfigurationArgs args, CustomResourceOptions? opts = null)
    public ApplicationAssignmentConfiguration(String name, ApplicationAssignmentConfigurationArgs args)
public ApplicationAssignmentConfiguration(String name, ApplicationAssignmentConfigurationArgs args, CustomResourceOptions options)

    type: aws:ssoadmin:ApplicationAssignmentConfiguration
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 ApplicationAssignmentConfigurationArgs
    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 ApplicationAssignmentConfigurationArgs
    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 ApplicationAssignmentConfigurationArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ApplicationAssignmentConfigurationArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ApplicationAssignmentConfigurationArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

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

    var applicationAssignmentConfigurationResource = new Aws.SsoAdmin.ApplicationAssignmentConfiguration("applicationAssignmentConfigurationResource", new()
{
    ApplicationArn = "string",
    AssignmentRequired = false,
});

    example, err := ssoadmin.NewApplicationAssignmentConfiguration(ctx, "applicationAssignmentConfigurationResource", &ssoadmin.ApplicationAssignmentConfigurationArgs{
	ApplicationArn:     pulumi.String("string"),
	AssignmentRequired: pulumi.Bool(false),
})

    var applicationAssignmentConfigurationResource = new ApplicationAssignmentConfiguration("applicationAssignmentConfigurationResource", ApplicationAssignmentConfigurationArgs.builder()
    .applicationArn("string")
    .assignmentRequired(false)
    .build());

    application_assignment_configuration_resource = aws.ssoadmin.ApplicationAssignmentConfiguration("applicationAssignmentConfigurationResource",
    application_arn="string",
    assignment_required=False)

    const applicationAssignmentConfigurationResource = new aws.ssoadmin.ApplicationAssignmentConfiguration("applicationAssignmentConfigurationResource", {
    applicationArn: "string",
    assignmentRequired: false,
});

    type: aws:ssoadmin:ApplicationAssignmentConfiguration
properties:
    applicationArn: string
    assignmentRequired: false

    ApplicationAssignmentConfiguration Resource Properties

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

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The ApplicationAssignmentConfiguration resource accepts the following input properties:

    ApplicationArn string
    ARN of the application.
    AssignmentRequired bool
    Indicates whether users must have an explicit assignment to access the application. If false, all users have access to the application.
    ApplicationArn string
    ARN of the application.
    AssignmentRequired bool
    Indicates whether users must have an explicit assignment to access the application. If false, all users have access to the application.
    applicationArn String
    ARN of the application.
    assignmentRequired Boolean
    Indicates whether users must have an explicit assignment to access the application. If false, all users have access to the application.
    applicationArn string
    ARN of the application.
    assignmentRequired boolean
    Indicates whether users must have an explicit assignment to access the application. If false, all users have access to the application.
    application_arn str
    ARN of the application.
    assignment_required bool
    Indicates whether users must have an explicit assignment to access the application. If false, all users have access to the application.
    applicationArn String
    ARN of the application.
    assignmentRequired Boolean
    Indicates whether users must have an explicit assignment to access the application. If false, all users have access to the application.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing ApplicationAssignmentConfiguration Resource

    Get an existing ApplicationAssignmentConfiguration 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?: ApplicationAssignmentConfigurationState, opts?: CustomResourceOptions): ApplicationAssignmentConfiguration
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        application_arn: Optional[str] = None,
        assignment_required: Optional[bool] = None) -> ApplicationAssignmentConfiguration
    func GetApplicationAssignmentConfiguration(ctx *Context, name string, id IDInput, state *ApplicationAssignmentConfigurationState, opts ...ResourceOption) (*ApplicationAssignmentConfiguration, error)
    public static ApplicationAssignmentConfiguration Get(string name, Input<string> id, ApplicationAssignmentConfigurationState? state, CustomResourceOptions? opts = null)
    public static ApplicationAssignmentConfiguration get(String name, Output<String> id, ApplicationAssignmentConfigurationState 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:
    ApplicationArn string
    ARN of the application.
    AssignmentRequired bool
    Indicates whether users must have an explicit assignment to access the application. If false, all users have access to the application.
    ApplicationArn string
    ARN of the application.
    AssignmentRequired bool
    Indicates whether users must have an explicit assignment to access the application. If false, all users have access to the application.
    applicationArn String
    ARN of the application.
    assignmentRequired Boolean
    Indicates whether users must have an explicit assignment to access the application. If false, all users have access to the application.
    applicationArn string
    ARN of the application.
    assignmentRequired boolean
    Indicates whether users must have an explicit assignment to access the application. If false, all users have access to the application.
    application_arn str
    ARN of the application.
    assignment_required bool
    Indicates whether users must have an explicit assignment to access the application. If false, all users have access to the application.
    applicationArn String
    ARN of the application.
    assignmentRequired Boolean
    Indicates whether users must have an explicit assignment to access the application. If false, all users have access to the application.

    Import

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

    $ pulumi import aws:ssoadmin/applicationAssignmentConfiguration:ApplicationAssignmentConfiguration example arn:aws:sso::123456789012: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
    AWS v6.60.0 published on Tuesday, Nov 19, 2024 by Pulumi
    pulumi/pulumi-aws