cloudFormationType.go

// *** WARNING: this file was generated by the Pulumi Terraform Bridge (tfgen) Tool. ***
// *** Do not edit by hand unless you're certain you know what you are doing! ***

package cloudformation

import (
	"context"
	"reflect"

	"github.com/pkg/errors"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

// ## Import
//
// `aws_cloudformation_type` can be imported with their type version Amazon Resource Name (ARN), e.g.
//
// ```sh
//  $ pulumi import aws:cloudformation/cloudFormationType:CloudFormationType example arn:aws:cloudformation:us-east-1:123456789012:type/resource/ExampleCompany-ExampleService-ExampleType/1
// ```
type CloudFormationType struct {
	pulumi.CustomResourceState

	// (Optional) Amazon Resource Name (ARN) of the CloudFormation Type version. See also `typeArn`.
	Arn pulumi.StringOutput `pulumi:"arn"`
	// Identifier of the CloudFormation Type default version.
	DefaultVersionId pulumi.StringOutput `pulumi:"defaultVersionId"`
	// Deprecation status of the version.
	DeprecatedStatus pulumi.StringOutput `pulumi:"deprecatedStatus"`
	// Description of the version.
	Description pulumi.StringOutput `pulumi:"description"`
	// URL of the documentation for the CloudFormation Type.
	DocumentationUrl pulumi.StringOutput `pulumi:"documentationUrl"`
	// Amazon Resource Name (ARN) of the IAM Role for CloudFormation to assume when invoking the extension. If your extension calls AWS APIs in any of its handlers, you must create an IAM execution role that includes the necessary permissions to call those AWS APIs, and provision that execution role in your account. When CloudFormation needs to invoke the extension handler, CloudFormation assumes this execution role to create a temporary session token, which it then passes to the extension handler, thereby supplying your extension with the appropriate credentials.
	ExecutionRoleArn pulumi.StringPtrOutput `pulumi:"executionRoleArn"`
	// Whether the CloudFormation Type version is the default version.
	IsDefaultVersion pulumi.BoolOutput `pulumi:"isDefaultVersion"`
	// Configuration block containing logging configuration.
	LoggingConfig CloudFormationTypeLoggingConfigPtrOutput `pulumi:"loggingConfig"`
	// Provisioning behavior of the CloudFormation Type.
	ProvisioningType pulumi.StringOutput `pulumi:"provisioningType"`
	// JSON document of the CloudFormation Type schema.
	Schema pulumi.StringOutput `pulumi:"schema"`
	// URL to the S3 bucket containing the extension project package that contains the necessary files for the extension you want to register. Must begin with `s3://` or `https://`. For example, `s3://example-bucket/example-object`.
	SchemaHandlerPackage pulumi.StringOutput `pulumi:"schemaHandlerPackage"`
	// URL of the source code for the CloudFormation Type.
	SourceUrl pulumi.StringOutput `pulumi:"sourceUrl"`
	// CloudFormation Registry Type. For example, `RESOURCE` or `MODULE`.
	Type pulumi.StringOutput `pulumi:"type"`
	// (Optional) Amazon Resource Name (ARN) of the CloudFormation Type. See also `arn`.
	TypeArn pulumi.StringOutput `pulumi:"typeArn"`
	// CloudFormation Type name. For example, `ExampleCompany::ExampleService::ExampleResource`.
	TypeName pulumi.StringOutput `pulumi:"typeName"`
	// (Optional) Identifier of the CloudFormation Type version.
	VersionId pulumi.StringOutput `pulumi:"versionId"`
	// Scope of the CloudFormation Type.
	Visibility pulumi.StringOutput `pulumi:"visibility"`
}

// NewCloudFormationType registers a new resource with the given unique name, arguments, and options.
func NewCloudFormationType(ctx *pulumi.Context,
	name string, args *CloudFormationTypeArgs, opts ...pulumi.ResourceOption) (*CloudFormationType, error) {
	if args == nil {
		return nil, errors.New("missing one or more required arguments")
	}

	if args.SchemaHandlerPackage == nil {
		return nil, errors.New("invalid value for required argument 'SchemaHandlerPackage'")
	}
	if args.TypeName == nil {
		return nil, errors.New("invalid value for required argument 'TypeName'")
	}
	var resource CloudFormationType
	err := ctx.RegisterResource("aws:cloudformation/cloudFormationType:CloudFormationType", name, args, &resource, opts...)
	if err != nil {
		return nil, err
	}
	return &resource, nil
}

// GetCloudFormationType gets an existing CloudFormationType resource's state with the given name, ID, and optional
// state properties that are used to uniquely qualify the lookup (nil if not required).
func GetCloudFormationType(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *CloudFormationTypeState, opts ...pulumi.ResourceOption) (*CloudFormationType, error) {
	var resource CloudFormationType
	err := ctx.ReadResource("aws:cloudformation/cloudFormationType:CloudFormationType", name, id, state, &resource, opts...)
	if err != nil {
		return nil, err
	}
	return &resource, nil
}

// Input properties used for looking up and filtering CloudFormationType resources.
type cloudFormationTypeState struct {
	// (Optional) Amazon Resource Name (ARN) of the CloudFormation Type version. See also `typeArn`.
	Arn *string `pulumi:"arn"`
	// Identifier of the CloudFormation Type default version.
	DefaultVersionId *string `pulumi:"defaultVersionId"`
	// Deprecation status of the version.
	DeprecatedStatus *string `pulumi:"deprecatedStatus"`
	// Description of the version.
	Description *string `pulumi:"description"`
	// URL of the documentation for the CloudFormation Type.
	DocumentationUrl *string `pulumi:"documentationUrl"`
	// Amazon Resource Name (ARN) of the IAM Role for CloudFormation to assume when invoking the extension. If your extension calls AWS APIs in any of its handlers, you must create an IAM execution role that includes the necessary permissions to call those AWS APIs, and provision that execution role in your account. When CloudFormation needs to invoke the extension handler, CloudFormation assumes this execution role to create a temporary session token, which it then passes to the extension handler, thereby supplying your extension with the appropriate credentials.
	ExecutionRoleArn *string `pulumi:"executionRoleArn"`
	// Whether the CloudFormation Type version is the default version.
	IsDefaultVersion *bool `pulumi:"isDefaultVersion"`
	// Configuration block containing logging configuration.
	LoggingConfig *CloudFormationTypeLoggingConfig `pulumi:"loggingConfig"`
	// Provisioning behavior of the CloudFormation Type.
	ProvisioningType *string `pulumi:"provisioningType"`
	// JSON document of the CloudFormation Type schema.
	Schema *string `pulumi:"schema"`
	// URL to the S3 bucket containing the extension project package that contains the necessary files for the extension you want to register. Must begin with `s3://` or `https://`. For example, `s3://example-bucket/example-object`.
	SchemaHandlerPackage *string `pulumi:"schemaHandlerPackage"`
	// URL of the source code for the CloudFormation Type.
	SourceUrl *string `pulumi:"sourceUrl"`
	// CloudFormation Registry Type. For example, `RESOURCE` or `MODULE`.
	Type *string `pulumi:"type"`
	// (Optional) Amazon Resource Name (ARN) of the CloudFormation Type. See also `arn`.
	TypeArn *string `pulumi:"typeArn"`
	// CloudFormation Type name. For example, `ExampleCompany::ExampleService::ExampleResource`.
	TypeName *string `pulumi:"typeName"`
	// (Optional) Identifier of the CloudFormation Type version.
	VersionId *string `pulumi:"versionId"`
	// Scope of the CloudFormation Type.
	Visibility *string `pulumi:"visibility"`
}

type CloudFormationTypeState struct {
	// (Optional) Amazon Resource Name (ARN) of the CloudFormation Type version. See also `typeArn`.
	Arn pulumi.StringPtrInput
	// Identifier of the CloudFormation Type default version.
	DefaultVersionId pulumi.StringPtrInput
	// Deprecation status of the version.
	DeprecatedStatus pulumi.StringPtrInput
	// Description of the version.
	Description pulumi.StringPtrInput
	// URL of the documentation for the CloudFormation Type.
	DocumentationUrl pulumi.StringPtrInput
	// Amazon Resource Name (ARN) of the IAM Role for CloudFormation to assume when invoking the extension. If your extension calls AWS APIs in any of its handlers, you must create an IAM execution role that includes the necessary permissions to call those AWS APIs, and provision that execution role in your account. When CloudFormation needs to invoke the extension handler, CloudFormation assumes this execution role to create a temporary session token, which it then passes to the extension handler, thereby supplying your extension with the appropriate credentials.
	ExecutionRoleArn pulumi.StringPtrInput
	// Whether the CloudFormation Type version is the default version.
	IsDefaultVersion pulumi.BoolPtrInput
	// Configuration block containing logging configuration.
	LoggingConfig CloudFormationTypeLoggingConfigPtrInput
	// Provisioning behavior of the CloudFormation Type.
	ProvisioningType pulumi.StringPtrInput
	// JSON document of the CloudFormation Type schema.
	Schema pulumi.StringPtrInput
	// URL to the S3 bucket containing the extension project package that contains the necessary files for the extension you want to register. Must begin with `s3://` or `https://`. For example, `s3://example-bucket/example-object`.
	SchemaHandlerPackage pulumi.StringPtrInput
	// URL of the source code for the CloudFormation Type.
	SourceUrl pulumi.StringPtrInput
	// CloudFormation Registry Type. For example, `RESOURCE` or `MODULE`.
	Type pulumi.StringPtrInput
	// (Optional) Amazon Resource Name (ARN) of the CloudFormation Type. See also `arn`.
	TypeArn pulumi.StringPtrInput
	// CloudFormation Type name. For example, `ExampleCompany::ExampleService::ExampleResource`.
	TypeName pulumi.StringPtrInput
	// (Optional) Identifier of the CloudFormation Type version.
	VersionId pulumi.StringPtrInput
	// Scope of the CloudFormation Type.
	Visibility pulumi.StringPtrInput
}

func (CloudFormationTypeState) ElementType() reflect.Type {
	return reflect.TypeOf((*cloudFormationTypeState)(nil)).Elem()
}

type cloudFormationTypeArgs struct {
	// Amazon Resource Name (ARN) of the IAM Role for CloudFormation to assume when invoking the extension. If your extension calls AWS APIs in any of its handlers, you must create an IAM execution role that includes the necessary permissions to call those AWS APIs, and provision that execution role in your account. When CloudFormation needs to invoke the extension handler, CloudFormation assumes this execution role to create a temporary session token, which it then passes to the extension handler, thereby supplying your extension with the appropriate credentials.
	ExecutionRoleArn *string `pulumi:"executionRoleArn"`
	// Configuration block containing logging configuration.
	LoggingConfig *CloudFormationTypeLoggingConfig `pulumi:"loggingConfig"`
	// URL to the S3 bucket containing the extension project package that contains the necessary files for the extension you want to register. Must begin with `s3://` or `https://`. For example, `s3://example-bucket/example-object`.
	SchemaHandlerPackage string `pulumi:"schemaHandlerPackage"`
	// CloudFormation Registry Type. For example, `RESOURCE` or `MODULE`.
	Type *string `pulumi:"type"`
	// CloudFormation Type name. For example, `ExampleCompany::ExampleService::ExampleResource`.
	TypeName string `pulumi:"typeName"`
}

// The set of arguments for constructing a CloudFormationType resource.
type CloudFormationTypeArgs struct {
	// Amazon Resource Name (ARN) of the IAM Role for CloudFormation to assume when invoking the extension. If your extension calls AWS APIs in any of its handlers, you must create an IAM execution role that includes the necessary permissions to call those AWS APIs, and provision that execution role in your account. When CloudFormation needs to invoke the extension handler, CloudFormation assumes this execution role to create a temporary session token, which it then passes to the extension handler, thereby supplying your extension with the appropriate credentials.
	ExecutionRoleArn pulumi.StringPtrInput
	// Configuration block containing logging configuration.
	LoggingConfig CloudFormationTypeLoggingConfigPtrInput
	// URL to the S3 bucket containing the extension project package that contains the necessary files for the extension you want to register. Must begin with `s3://` or `https://`. For example, `s3://example-bucket/example-object`.
	SchemaHandlerPackage pulumi.StringInput
	// CloudFormation Registry Type. For example, `RESOURCE` or `MODULE`.
	Type pulumi.StringPtrInput
	// CloudFormation Type name. For example, `ExampleCompany::ExampleService::ExampleResource`.
	TypeName pulumi.StringInput
}

func (CloudFormationTypeArgs) ElementType() reflect.Type {
	return reflect.TypeOf((*cloudFormationTypeArgs)(nil)).Elem()
}

type CloudFormationTypeInput interface {
	pulumi.Input

	ToCloudFormationTypeOutput() CloudFormationTypeOutput
	ToCloudFormationTypeOutputWithContext(ctx context.Context) CloudFormationTypeOutput
}

func (*CloudFormationType) ElementType() reflect.Type {
	return reflect.TypeOf((*CloudFormationType)(nil))
}

func (i *CloudFormationType) ToCloudFormationTypeOutput() CloudFormationTypeOutput {
	return i.ToCloudFormationTypeOutputWithContext(context.Background())
}

func (i *CloudFormationType) ToCloudFormationTypeOutputWithContext(ctx context.Context) CloudFormationTypeOutput {
	return pulumi.ToOutputWithContext(ctx, i).(CloudFormationTypeOutput)
}

func (i *CloudFormationType) ToCloudFormationTypePtrOutput() CloudFormationTypePtrOutput {
	return i.ToCloudFormationTypePtrOutputWithContext(context.Background())
}

func (i *CloudFormationType) ToCloudFormationTypePtrOutputWithContext(ctx context.Context) CloudFormationTypePtrOutput {
	return pulumi.ToOutputWithContext(ctx, i).(CloudFormationTypePtrOutput)
}

type CloudFormationTypePtrInput interface {
	pulumi.Input

	ToCloudFormationTypePtrOutput() CloudFormationTypePtrOutput
	ToCloudFormationTypePtrOutputWithContext(ctx context.Context) CloudFormationTypePtrOutput
}

type cloudFormationTypePtrType CloudFormationTypeArgs

func (*cloudFormationTypePtrType) ElementType() reflect.Type {
	return reflect.TypeOf((**CloudFormationType)(nil))
}

func (i *cloudFormationTypePtrType) ToCloudFormationTypePtrOutput() CloudFormationTypePtrOutput {
	return i.ToCloudFormationTypePtrOutputWithContext(context.Background())
}

func (i *cloudFormationTypePtrType) ToCloudFormationTypePtrOutputWithContext(ctx context.Context) CloudFormationTypePtrOutput {
	return pulumi.ToOutputWithContext(ctx, i).(CloudFormationTypePtrOutput)
}

// CloudFormationTypeArrayInput is an input type that accepts CloudFormationTypeArray and CloudFormationTypeArrayOutput values.
// You can construct a concrete instance of `CloudFormationTypeArrayInput` via:
//
//          CloudFormationTypeArray{ CloudFormationTypeArgs{...} }
type CloudFormationTypeArrayInput interface {
	pulumi.Input

	ToCloudFormationTypeArrayOutput() CloudFormationTypeArrayOutput
	ToCloudFormationTypeArrayOutputWithContext(context.Context) CloudFormationTypeArrayOutput
}

type CloudFormationTypeArray []CloudFormationTypeInput

func (CloudFormationTypeArray) ElementType() reflect.Type {
	return reflect.TypeOf((*[]*CloudFormationType)(nil)).Elem()
}

func (i CloudFormationTypeArray) ToCloudFormationTypeArrayOutput() CloudFormationTypeArrayOutput {
	return i.ToCloudFormationTypeArrayOutputWithContext(context.Background())
}

func (i CloudFormationTypeArray) ToCloudFormationTypeArrayOutputWithContext(ctx context.Context) CloudFormationTypeArrayOutput {
	return pulumi.ToOutputWithContext(ctx, i).(CloudFormationTypeArrayOutput)
}

// CloudFormationTypeMapInput is an input type that accepts CloudFormationTypeMap and CloudFormationTypeMapOutput values.
// You can construct a concrete instance of `CloudFormationTypeMapInput` via:
//
//          CloudFormationTypeMap{ "key": CloudFormationTypeArgs{...} }
type CloudFormationTypeMapInput interface {
	pulumi.Input

	ToCloudFormationTypeMapOutput() CloudFormationTypeMapOutput
	ToCloudFormationTypeMapOutputWithContext(context.Context) CloudFormationTypeMapOutput
}

type CloudFormationTypeMap map[string]CloudFormationTypeInput

func (CloudFormationTypeMap) ElementType() reflect.Type {
	return reflect.TypeOf((*map[string]*CloudFormationType)(nil)).Elem()
}

func (i CloudFormationTypeMap) ToCloudFormationTypeMapOutput() CloudFormationTypeMapOutput {
	return i.ToCloudFormationTypeMapOutputWithContext(context.Background())
}

func (i CloudFormationTypeMap) ToCloudFormationTypeMapOutputWithContext(ctx context.Context) CloudFormationTypeMapOutput {
	return pulumi.ToOutputWithContext(ctx, i).(CloudFormationTypeMapOutput)
}

type CloudFormationTypeOutput struct{ *pulumi.OutputState }

func (CloudFormationTypeOutput) ElementType() reflect.Type {
	return reflect.TypeOf((*CloudFormationType)(nil))
}

func (o CloudFormationTypeOutput) ToCloudFormationTypeOutput() CloudFormationTypeOutput {
	return o
}

func (o CloudFormationTypeOutput) ToCloudFormationTypeOutputWithContext(ctx context.Context) CloudFormationTypeOutput {
	return o
}

func (o CloudFormationTypeOutput) ToCloudFormationTypePtrOutput() CloudFormationTypePtrOutput {
	return o.ToCloudFormationTypePtrOutputWithContext(context.Background())
}

func (o CloudFormationTypeOutput) ToCloudFormationTypePtrOutputWithContext(ctx context.Context) CloudFormationTypePtrOutput {
	return o.ApplyTWithContext(ctx, func(_ context.Context, v CloudFormationType) *CloudFormationType {
		return &v
	}).(CloudFormationTypePtrOutput)
}

type CloudFormationTypePtrOutput struct{ *pulumi.OutputState }

func (CloudFormationTypePtrOutput) ElementType() reflect.Type {
	return reflect.TypeOf((**CloudFormationType)(nil))
}

func (o CloudFormationTypePtrOutput) ToCloudFormationTypePtrOutput() CloudFormationTypePtrOutput {
	return o
}

func (o CloudFormationTypePtrOutput) ToCloudFormationTypePtrOutputWithContext(ctx context.Context) CloudFormationTypePtrOutput {
	return o
}

func (o CloudFormationTypePtrOutput) Elem() CloudFormationTypeOutput {
	return o.ApplyT(func(v *CloudFormationType) CloudFormationType {
		if v != nil {
			return *v
		}
		var ret CloudFormationType
		return ret
	}).(CloudFormationTypeOutput)
}

type CloudFormationTypeArrayOutput struct{ *pulumi.OutputState }

func (CloudFormationTypeArrayOutput) ElementType() reflect.Type {
	return reflect.TypeOf((*[]CloudFormationType)(nil))
}

func (o CloudFormationTypeArrayOutput) ToCloudFormationTypeArrayOutput() CloudFormationTypeArrayOutput {
	return o
}

func (o CloudFormationTypeArrayOutput) ToCloudFormationTypeArrayOutputWithContext(ctx context.Context) CloudFormationTypeArrayOutput {
	return o
}

func (o CloudFormationTypeArrayOutput) Index(i pulumi.IntInput) CloudFormationTypeOutput {
	return pulumi.All(o, i).ApplyT(func(vs []interface{}) CloudFormationType {
		return vs[0].([]CloudFormationType)[vs[1].(int)]
	}).(CloudFormationTypeOutput)
}

type CloudFormationTypeMapOutput struct{ *pulumi.OutputState }

func (CloudFormationTypeMapOutput) ElementType() reflect.Type {
	return reflect.TypeOf((*map[string]CloudFormationType)(nil))
}

func (o CloudFormationTypeMapOutput) ToCloudFormationTypeMapOutput() CloudFormationTypeMapOutput {
	return o
}

func (o CloudFormationTypeMapOutput) ToCloudFormationTypeMapOutputWithContext(ctx context.Context) CloudFormationTypeMapOutput {
	return o
}

func (o CloudFormationTypeMapOutput) MapIndex(k pulumi.StringInput) CloudFormationTypeOutput {
	return pulumi.All(o, k).ApplyT(func(vs []interface{}) CloudFormationType {
		return vs[0].(map[string]CloudFormationType)[vs[1].(string)]
	}).(CloudFormationTypeOutput)
}

func init() {
	pulumi.RegisterOutputType(CloudFormationTypeOutput{})
	pulumi.RegisterOutputType(CloudFormationTypePtrOutput{})
	pulumi.RegisterOutputType(CloudFormationTypeArrayOutput{})
	pulumi.RegisterOutputType(CloudFormationTypeMapOutput{})
}