AppAuthorization class

Resource for managing an AWS AppFabric App Authorization.

Example Usage

Basic Usage

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

const example = new aws.appfabric.AppAuthorization("example", {
    credential: {
        apiKeyCredentials: [{
            apiKey: "exampleapikeytoken",
        }],
    },
    tenants: [{
        tenantDisplayName: "example",
        tenantIdentifier: "example",
    }],
    app: "TERRAFORMCLOUD",
    appBundleArn: arn,
    authType: "apiKey",
});
import pulumi
import pulumi_aws as aws

example = aws.appfabric.AppAuthorization("example",
    credential={
        "api_key_credentials": [{
            "api_key": "exampleapikeytoken",
        }],
    },
    tenants=[{
        "tenant_display_name": "example",
        "tenant_identifier": "example",
    }],
    app="TERRAFORMCLOUD",
    app_bundle_arn=arn,
    auth_type="apiKey")
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() =>
{
    var example = new Aws.AppFabric.AppAuthorization("example", new()
    {
        Credential = new Aws.AppFabric.Inputs.AppAuthorizationCredentialArgs
        {
            ApiKeyCredentials = new[]
            {
                new Aws.AppFabric.Inputs.AppAuthorizationCredentialApiKeyCredentialArgs
                {
                    ApiKey = "exampleapikeytoken",
                },
            },
        },
        Tenants = new[]
        {
            new Aws.AppFabric.Inputs.AppAuthorizationTenantArgs
            {
                TenantDisplayName = "example",
                TenantIdentifier = "example",
            },
        },
        App = "TERRAFORMCLOUD",
        AppBundleArn = arn,
        AuthType = "apiKey",
    });

});
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := appfabric.NewAppAuthorization(ctx, "example", &appfabric.AppAuthorizationArgs{
			Credential: &appfabric.AppAuthorizationCredentialArgs{
				ApiKeyCredentials: appfabric.AppAuthorizationCredentialApiKeyCredentialArray{
					&appfabric.AppAuthorizationCredentialApiKeyCredentialArgs{
						ApiKey: pulumi.String("exampleapikeytoken"),
					},
				},
			},
			Tenants: appfabric.AppAuthorizationTenantArray{
				&appfabric.AppAuthorizationTenantArgs{
					TenantDisplayName: pulumi.String("example"),
					TenantIdentifier:  pulumi.String("example"),
				},
			},
			App:          pulumi.String("TERRAFORMCLOUD"),
			AppBundleArn: pulumi.Any(arn),
			AuthType:     pulumi.String("apiKey"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

resource "aws_appfabric_appauthorization" "example" {
  credential = {
    api_key_credentials = [{
      "apiKey" = "exampleapikeytoken"
    }]
  }
  tenants {
    tenant_display_name = "example"
    tenant_identifier   = "example"
  }
  app            = "TERRAFORMCLOUD"
  app_bundle_arn = arn
  auth_type      = "apiKey"
}
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.appfabric.AppAuthorization;
import com.pulumi.aws.appfabric.AppAuthorizationArgs;
import com.pulumi.aws.appfabric.inputs.AppAuthorizationCredentialArgs;
import com.pulumi.aws.appfabric.inputs.AppAuthorizationCredentialApiKeyCredentialArgs;
import com.pulumi.aws.appfabric.inputs.AppAuthorizationTenantArgs;
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 AppAuthorization("example", AppAuthorizationArgs.builder()
            .credential(AppAuthorizationCredentialArgs.builder()
                .apiKeyCredentials(AppAuthorizationCredentialApiKeyCredentialArgs.builder()
                    .apiKey("exampleapikeytoken")
                    .build())
                .build())
            .tenants(AppAuthorizationTenantArgs.builder()
                .tenantDisplayName("example")
                .tenantIdentifier("example")
                .build())
            .app("TERRAFORMCLOUD")
            .appBundleArn(arn)
            .authType("apiKey")
            .build());

    }
}
resources:
  example:
    type: aws:appfabric:AppAuthorization
    properties:
      credential:
        apiKeyCredentials:
          - apiKey: exampleapikeytoken
      tenants:
        - tenantDisplayName: example
          tenantIdentifier: example
      app: TERRAFORMCLOUD
      appBundleArn: ${arn}
      authType: apiKey

Constructors

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

Properties

app ↔ Output<String>
Name of the application. For valid values, see the CreateAppAuthorization API reference.
latefinal
appBundleArn ↔ Output<String>
ARN of the app bundle to use for the request.
latefinal
arn ↔ Output<String>
ARN of the App Authorization.
latefinal
authType ↔ Output<String>
Authorization type for the app authorization. Valid values are oauth2 and apiKey.
latefinal
authUrl ↔ Output<String>
Application URL for the OAuth flow.
latefinal
childResources → Set<Resource>
finalinherited
completionSources ↔ Map<String, IOutputCompletionSource>
latefinalinherited
createdAt ↔ Output<String>
Timestamp of when the app authorization was created.
latefinal
credential ↔ Output<AppAuthorizationCredential>
Credentials for the application, such as an API key or OAuth2 client ID and secret. Specify credentials that match the authorization type for your request. For example, if the authorization type for your request is OAuth2 (oauth2), then you should provide only the OAuth2 credentials. See credential Block for details.
latefinal
hashCode → int
The hash code for this object.
no setterinherited
id ↔ Output<String>
getter/setter pairinherited
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
persona ↔ Output<String>
User persona of the app authorization.
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
tags ↔ Output<Map<String, String>?>
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.
latefinal
tagsAll ↔ Output<Map<String, String>>
Map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.
latefinal
tenants ↔ Output<List<AppAuthorizationTenant>>
Information about an application tenant, such as the application display name and identifier. See tenant Block for details.
latefinal
timeouts ↔ Output<AppAuthorizationTimeouts?>
latefinal
transformations → List<ResourceTransformation>
Inherited/explicit legacy transformations.
no setterinherited
updatedAt ↔ Output<String>
Timestamp of when the app authorization was last updated.
latefinal
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, {AppAuthorizationState? state, CustomResourceOptions? options}) → AppAuthorization
Gets an existing AppAuthorization resource's state with the given name and id.