1. Packages
  2. AWS
  3. API Docs
  4. appfabric
  5. AppAuthorizationConnection
AWS v6.60.0 published on Tuesday, Nov 19, 2024 by Pulumi

aws.appfabric.AppAuthorizationConnection

Explore with Pulumi AI

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

    Resource for managing an AWS AppFabric App Authorization Connection.

    Example Usage

    Basic Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as aws from "@pulumi/aws";
    
    const example = new aws.appfabric.AppAuthorizationConnection("example", {
        appAuthorizationArn: test.arn,
        appBundleArn: arn,
    });
    
    import pulumi
    import pulumi_aws as aws
    
    example = aws.appfabric.AppAuthorizationConnection("example",
        app_authorization_arn=test["arn"],
        app_bundle_arn=arn)
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/appfabric"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := appfabric.NewAppAuthorizationConnection(ctx, "example", &appfabric.AppAuthorizationConnectionArgs{
    			AppAuthorizationArn: pulumi.Any(test.Arn),
    			AppBundleArn:        pulumi.Any(arn),
    		})
    		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.AppFabric.AppAuthorizationConnection("example", new()
        {
            AppAuthorizationArn = test.Arn,
            AppBundleArn = arn,
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.aws.appfabric.AppAuthorizationConnection;
    import com.pulumi.aws.appfabric.AppAuthorizationConnectionArgs;
    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 AppAuthorizationConnection("example", AppAuthorizationConnectionArgs.builder()
                .appAuthorizationArn(test.arn())
                .appBundleArn(arn)
                .build());
    
        }
    }
    
    resources:
      example:
        type: aws:appfabric:AppAuthorizationConnection
        properties:
          appAuthorizationArn: ${test.arn}
          appBundleArn: ${arn}
    

    Create AppAuthorizationConnection Resource

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

    Constructor syntax

    new AppAuthorizationConnection(name: string, args: AppAuthorizationConnectionArgs, opts?: CustomResourceOptions);
    @overload
    def AppAuthorizationConnection(resource_name: str,
                                   args: AppAuthorizationConnectionArgs,
                                   opts: Optional[ResourceOptions] = None)
    
    @overload
    def AppAuthorizationConnection(resource_name: str,
                                   opts: Optional[ResourceOptions] = None,
                                   app_authorization_arn: Optional[str] = None,
                                   app_bundle_arn: Optional[str] = None,
                                   auth_request: Optional[AppAuthorizationConnectionAuthRequestArgs] = None,
                                   timeouts: Optional[AppAuthorizationConnectionTimeoutsArgs] = None)
    func NewAppAuthorizationConnection(ctx *Context, name string, args AppAuthorizationConnectionArgs, opts ...ResourceOption) (*AppAuthorizationConnection, error)
    public AppAuthorizationConnection(string name, AppAuthorizationConnectionArgs args, CustomResourceOptions? opts = null)
    public AppAuthorizationConnection(String name, AppAuthorizationConnectionArgs args)
    public AppAuthorizationConnection(String name, AppAuthorizationConnectionArgs args, CustomResourceOptions options)
    
    type: aws:appfabric:AppAuthorizationConnection
    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 AppAuthorizationConnectionArgs
    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 AppAuthorizationConnectionArgs
    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 AppAuthorizationConnectionArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args AppAuthorizationConnectionArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args AppAuthorizationConnectionArgs
    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 appAuthorizationConnectionResource = new Aws.AppFabric.AppAuthorizationConnection("appAuthorizationConnectionResource", new()
    {
        AppAuthorizationArn = "string",
        AppBundleArn = "string",
        AuthRequest = new Aws.AppFabric.Inputs.AppAuthorizationConnectionAuthRequestArgs
        {
            Code = "string",
            RedirectUri = "string",
        },
        Timeouts = new Aws.AppFabric.Inputs.AppAuthorizationConnectionTimeoutsArgs
        {
            Create = "string",
        },
    });
    
    example, err := appfabric.NewAppAuthorizationConnection(ctx, "appAuthorizationConnectionResource", &appfabric.AppAuthorizationConnectionArgs{
    	AppAuthorizationArn: pulumi.String("string"),
    	AppBundleArn:        pulumi.String("string"),
    	AuthRequest: &appfabric.AppAuthorizationConnectionAuthRequestArgs{
    		Code:        pulumi.String("string"),
    		RedirectUri: pulumi.String("string"),
    	},
    	Timeouts: &appfabric.AppAuthorizationConnectionTimeoutsArgs{
    		Create: pulumi.String("string"),
    	},
    })
    
    var appAuthorizationConnectionResource = new AppAuthorizationConnection("appAuthorizationConnectionResource", AppAuthorizationConnectionArgs.builder()
        .appAuthorizationArn("string")
        .appBundleArn("string")
        .authRequest(AppAuthorizationConnectionAuthRequestArgs.builder()
            .code("string")
            .redirectUri("string")
            .build())
        .timeouts(AppAuthorizationConnectionTimeoutsArgs.builder()
            .create("string")
            .build())
        .build());
    
    app_authorization_connection_resource = aws.appfabric.AppAuthorizationConnection("appAuthorizationConnectionResource",
        app_authorization_arn="string",
        app_bundle_arn="string",
        auth_request={
            "code": "string",
            "redirect_uri": "string",
        },
        timeouts={
            "create": "string",
        })
    
    const appAuthorizationConnectionResource = new aws.appfabric.AppAuthorizationConnection("appAuthorizationConnectionResource", {
        appAuthorizationArn: "string",
        appBundleArn: "string",
        authRequest: {
            code: "string",
            redirectUri: "string",
        },
        timeouts: {
            create: "string",
        },
    });
    
    type: aws:appfabric:AppAuthorizationConnection
    properties:
        appAuthorizationArn: string
        appBundleArn: string
        authRequest:
            code: string
            redirectUri: string
        timeouts:
            create: string
    

    AppAuthorizationConnection 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 AppAuthorizationConnection resource accepts the following input properties:

    AppAuthorizationArn string
    The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app authorization to use for the request.
    AppBundleArn string
    The Amazon Resource Name (ARN) of the app bundle to use for the request.
    AuthRequest AppAuthorizationConnectionAuthRequest
    Contains OAuth2 authorization information.This is required if the app authorization for the request is configured with an OAuth2 (oauth2) authorization type.
    Timeouts AppAuthorizationConnectionTimeouts
    AppAuthorizationArn string
    The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app authorization to use for the request.
    AppBundleArn string
    The Amazon Resource Name (ARN) of the app bundle to use for the request.
    AuthRequest AppAuthorizationConnectionAuthRequestArgs
    Contains OAuth2 authorization information.This is required if the app authorization for the request is configured with an OAuth2 (oauth2) authorization type.
    Timeouts AppAuthorizationConnectionTimeoutsArgs
    appAuthorizationArn String
    The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app authorization to use for the request.
    appBundleArn String
    The Amazon Resource Name (ARN) of the app bundle to use for the request.
    authRequest AppAuthorizationConnectionAuthRequest
    Contains OAuth2 authorization information.This is required if the app authorization for the request is configured with an OAuth2 (oauth2) authorization type.
    timeouts AppAuthorizationConnectionTimeouts
    appAuthorizationArn string
    The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app authorization to use for the request.
    appBundleArn string
    The Amazon Resource Name (ARN) of the app bundle to use for the request.
    authRequest AppAuthorizationConnectionAuthRequest
    Contains OAuth2 authorization information.This is required if the app authorization for the request is configured with an OAuth2 (oauth2) authorization type.
    timeouts AppAuthorizationConnectionTimeouts
    app_authorization_arn str
    The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app authorization to use for the request.
    app_bundle_arn str
    The Amazon Resource Name (ARN) of the app bundle to use for the request.
    auth_request AppAuthorizationConnectionAuthRequestArgs
    Contains OAuth2 authorization information.This is required if the app authorization for the request is configured with an OAuth2 (oauth2) authorization type.
    timeouts AppAuthorizationConnectionTimeoutsArgs
    appAuthorizationArn String
    The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app authorization to use for the request.
    appBundleArn String
    The Amazon Resource Name (ARN) of the app bundle to use for the request.
    authRequest Property Map
    Contains OAuth2 authorization information.This is required if the app authorization for the request is configured with an OAuth2 (oauth2) authorization type.
    timeouts Property Map

    Outputs

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

    App string
    The name of the application.
    Id string
    The provider-assigned unique ID for this managed resource.
    Tenants List<AppAuthorizationConnectionTenant>
    Contains information about an application tenant, such as the application display name and identifier.
    App string
    The name of the application.
    Id string
    The provider-assigned unique ID for this managed resource.
    Tenants []AppAuthorizationConnectionTenant
    Contains information about an application tenant, such as the application display name and identifier.
    app String
    The name of the application.
    id String
    The provider-assigned unique ID for this managed resource.
    tenants List<AppAuthorizationConnectionTenant>
    Contains information about an application tenant, such as the application display name and identifier.
    app string
    The name of the application.
    id string
    The provider-assigned unique ID for this managed resource.
    tenants AppAuthorizationConnectionTenant[]
    Contains information about an application tenant, such as the application display name and identifier.
    app str
    The name of the application.
    id str
    The provider-assigned unique ID for this managed resource.
    tenants Sequence[AppAuthorizationConnectionTenant]
    Contains information about an application tenant, such as the application display name and identifier.
    app String
    The name of the application.
    id String
    The provider-assigned unique ID for this managed resource.
    tenants List<Property Map>
    Contains information about an application tenant, such as the application display name and identifier.

    Look up Existing AppAuthorizationConnection Resource

    Get an existing AppAuthorizationConnection 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?: AppAuthorizationConnectionState, opts?: CustomResourceOptions): AppAuthorizationConnection
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            app: Optional[str] = None,
            app_authorization_arn: Optional[str] = None,
            app_bundle_arn: Optional[str] = None,
            auth_request: Optional[AppAuthorizationConnectionAuthRequestArgs] = None,
            tenants: Optional[Sequence[AppAuthorizationConnectionTenantArgs]] = None,
            timeouts: Optional[AppAuthorizationConnectionTimeoutsArgs] = None) -> AppAuthorizationConnection
    func GetAppAuthorizationConnection(ctx *Context, name string, id IDInput, state *AppAuthorizationConnectionState, opts ...ResourceOption) (*AppAuthorizationConnection, error)
    public static AppAuthorizationConnection Get(string name, Input<string> id, AppAuthorizationConnectionState? state, CustomResourceOptions? opts = null)
    public static AppAuthorizationConnection get(String name, Output<String> id, AppAuthorizationConnectionState 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:
    App string
    The name of the application.
    AppAuthorizationArn string
    The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app authorization to use for the request.
    AppBundleArn string
    The Amazon Resource Name (ARN) of the app bundle to use for the request.
    AuthRequest AppAuthorizationConnectionAuthRequest
    Contains OAuth2 authorization information.This is required if the app authorization for the request is configured with an OAuth2 (oauth2) authorization type.
    Tenants List<AppAuthorizationConnectionTenant>
    Contains information about an application tenant, such as the application display name and identifier.
    Timeouts AppAuthorizationConnectionTimeouts
    App string
    The name of the application.
    AppAuthorizationArn string
    The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app authorization to use for the request.
    AppBundleArn string
    The Amazon Resource Name (ARN) of the app bundle to use for the request.
    AuthRequest AppAuthorizationConnectionAuthRequestArgs
    Contains OAuth2 authorization information.This is required if the app authorization for the request is configured with an OAuth2 (oauth2) authorization type.
    Tenants []AppAuthorizationConnectionTenantArgs
    Contains information about an application tenant, such as the application display name and identifier.
    Timeouts AppAuthorizationConnectionTimeoutsArgs
    app String
    The name of the application.
    appAuthorizationArn String
    The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app authorization to use for the request.
    appBundleArn String
    The Amazon Resource Name (ARN) of the app bundle to use for the request.
    authRequest AppAuthorizationConnectionAuthRequest
    Contains OAuth2 authorization information.This is required if the app authorization for the request is configured with an OAuth2 (oauth2) authorization type.
    tenants List<AppAuthorizationConnectionTenant>
    Contains information about an application tenant, such as the application display name and identifier.
    timeouts AppAuthorizationConnectionTimeouts
    app string
    The name of the application.
    appAuthorizationArn string
    The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app authorization to use for the request.
    appBundleArn string
    The Amazon Resource Name (ARN) of the app bundle to use for the request.
    authRequest AppAuthorizationConnectionAuthRequest
    Contains OAuth2 authorization information.This is required if the app authorization for the request is configured with an OAuth2 (oauth2) authorization type.
    tenants AppAuthorizationConnectionTenant[]
    Contains information about an application tenant, such as the application display name and identifier.
    timeouts AppAuthorizationConnectionTimeouts
    app str
    The name of the application.
    app_authorization_arn str
    The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app authorization to use for the request.
    app_bundle_arn str
    The Amazon Resource Name (ARN) of the app bundle to use for the request.
    auth_request AppAuthorizationConnectionAuthRequestArgs
    Contains OAuth2 authorization information.This is required if the app authorization for the request is configured with an OAuth2 (oauth2) authorization type.
    tenants Sequence[AppAuthorizationConnectionTenantArgs]
    Contains information about an application tenant, such as the application display name and identifier.
    timeouts AppAuthorizationConnectionTimeoutsArgs
    app String
    The name of the application.
    appAuthorizationArn String
    The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app authorization to use for the request.
    appBundleArn String
    The Amazon Resource Name (ARN) of the app bundle to use for the request.
    authRequest Property Map
    Contains OAuth2 authorization information.This is required if the app authorization for the request is configured with an OAuth2 (oauth2) authorization type.
    tenants List<Property Map>
    Contains information about an application tenant, such as the application display name and identifier.
    timeouts Property Map

    Supporting Types

    AppAuthorizationConnectionAuthRequest, AppAuthorizationConnectionAuthRequestArgs

    Code string
    The authorization code returned by the application after permission is granted in the application OAuth page (after clicking on the AuthURL)..
    RedirectUri string
    The redirect URL that is specified in the AuthURL and the application client.
    Code string
    The authorization code returned by the application after permission is granted in the application OAuth page (after clicking on the AuthURL)..
    RedirectUri string
    The redirect URL that is specified in the AuthURL and the application client.
    code String
    The authorization code returned by the application after permission is granted in the application OAuth page (after clicking on the AuthURL)..
    redirectUri String
    The redirect URL that is specified in the AuthURL and the application client.
    code string
    The authorization code returned by the application after permission is granted in the application OAuth page (after clicking on the AuthURL)..
    redirectUri string
    The redirect URL that is specified in the AuthURL and the application client.
    code str
    The authorization code returned by the application after permission is granted in the application OAuth page (after clicking on the AuthURL)..
    redirect_uri str
    The redirect URL that is specified in the AuthURL and the application client.
    code String
    The authorization code returned by the application after permission is granted in the application OAuth page (after clicking on the AuthURL)..
    redirectUri String
    The redirect URL that is specified in the AuthURL and the application client.

    AppAuthorizationConnectionTenant, AppAuthorizationConnectionTenantArgs

    AppAuthorizationConnectionTimeouts, AppAuthorizationConnectionTimeoutsArgs

    Create string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    Create string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    create String
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    create string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    create str
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    create String
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).

    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