CloudFormationType

Manages a version of a CloudFormation Type.

Example Usage

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

return await Deployment.RunAsync(() => 
{
    var example = new Aws.CloudFormation.CloudFormationType("example", new()
    {
        SchemaHandlerPackage = $"s3://{aws_s3_object.Example.Bucket}/{aws_s3_object.Example.Key}",
        Type = "RESOURCE",
        TypeName = "ExampleCompany::ExampleService::ExampleResource",
        LoggingConfig = new Aws.CloudFormation.Inputs.CloudFormationTypeLoggingConfigArgs
        {
            LogGroupName = aws_cloudwatch_log_group.Example.Name,
            LogRoleArn = aws_iam_role.Example.Arn,
        },
    });

});
package main

import (
	"fmt"

	"github.com/pulumi/pulumi-aws/sdk/v5/go/aws/cloudformation"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := cloudformation.NewCloudFormationType(ctx, "example", &cloudformation.CloudFormationTypeArgs{
			SchemaHandlerPackage: pulumi.String(fmt.Sprintf("s3://%v/%v", aws_s3_object.Example.Bucket, aws_s3_object.Example.Key)),
			Type:                 pulumi.String("RESOURCE"),
			TypeName:             pulumi.String("ExampleCompany::ExampleService::ExampleResource"),
			LoggingConfig: &cloudformation.CloudFormationTypeLoggingConfigArgs{
				LogGroupName: pulumi.Any(aws_cloudwatch_log_group.Example.Name),
				LogRoleArn:   pulumi.Any(aws_iam_role.Example.Arn),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.cloudformation.CloudFormationType;
import com.pulumi.aws.cloudformation.CloudFormationTypeArgs;
import com.pulumi.aws.cloudformation.inputs.CloudFormationTypeLoggingConfigArgs;
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 CloudFormationType("example", CloudFormationTypeArgs.builder()        
            .schemaHandlerPackage(String.format("s3://%s/%s", aws_s3_object.example().bucket(),aws_s3_object.example().key()))
            .type("RESOURCE")
            .typeName("ExampleCompany::ExampleService::ExampleResource")
            .loggingConfig(CloudFormationTypeLoggingConfigArgs.builder()
                .logGroupName(aws_cloudwatch_log_group.example().name())
                .logRoleArn(aws_iam_role.example().arn())
                .build())
            .build());

    }
}
import pulumi
import pulumi_aws as aws

example = aws.cloudformation.CloudFormationType("example",
    schema_handler_package=f"s3://{aws_s3_object['example']['bucket']}/{aws_s3_object['example']['key']}",
    type="RESOURCE",
    type_name="ExampleCompany::ExampleService::ExampleResource",
    logging_config=aws.cloudformation.CloudFormationTypeLoggingConfigArgs(
        log_group_name=aws_cloudwatch_log_group["example"]["name"],
        log_role_arn=aws_iam_role["example"]["arn"],
    ))
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.cloudformation.CloudFormationType("example", {
    schemaHandlerPackage: `s3://${aws_s3_object.example.bucket}/${aws_s3_object.example.key}`,
    type: "RESOURCE",
    typeName: "ExampleCompany::ExampleService::ExampleResource",
    loggingConfig: {
        logGroupName: aws_cloudwatch_log_group.example.name,
        logRoleArn: aws_iam_role.example.arn,
    },
});
resources:
  example:
    type: aws:cloudformation:CloudFormationType
    properties:
      schemaHandlerPackage: s3://${aws_s3_object.example.bucket}/${aws_s3_object.example.key}
      type: RESOURCE
      typeName: ExampleCompany::ExampleService::ExampleResource
      loggingConfig:
        logGroupName: ${aws_cloudwatch_log_group.example.name}
        logRoleArn: ${aws_iam_role.example.arn}

Create CloudFormationType Resource

new CloudFormationType(name: string, args: CloudFormationTypeArgs, opts?: CustomResourceOptions);
@overload
def CloudFormationType(resource_name: str,
                       opts: Optional[ResourceOptions] = None,
                       execution_role_arn: Optional[str] = None,
                       logging_config: Optional[CloudFormationTypeLoggingConfigArgs] = None,
                       schema_handler_package: Optional[str] = None,
                       type: Optional[str] = None,
                       type_name: Optional[str] = None)
@overload
def CloudFormationType(resource_name: str,
                       args: CloudFormationTypeArgs,
                       opts: Optional[ResourceOptions] = None)
func NewCloudFormationType(ctx *Context, name string, args CloudFormationTypeArgs, opts ...ResourceOption) (*CloudFormationType, error)
public CloudFormationType(string name, CloudFormationTypeArgs args, CustomResourceOptions? opts = null)
public CloudFormationType(String name, CloudFormationTypeArgs args)
public CloudFormationType(String name, CloudFormationTypeArgs args, CustomResourceOptions options)
type: aws:cloudformation:CloudFormationType
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

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

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

SchemaHandlerPackage string

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.

TypeName string

CloudFormation Type name. For example, ExampleCompany::ExampleService::ExampleResource.

ExecutionRoleArn string

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.

LoggingConfig CloudFormationTypeLoggingConfigArgs

Configuration block containing logging configuration.

Type string

CloudFormation Registry Type. For example, RESOURCE or MODULE.

SchemaHandlerPackage string

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.

TypeName string

CloudFormation Type name. For example, ExampleCompany::ExampleService::ExampleResource.

ExecutionRoleArn string

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.

LoggingConfig CloudFormationTypeLoggingConfigArgs

Configuration block containing logging configuration.

Type string

CloudFormation Registry Type. For example, RESOURCE or MODULE.

schemaHandlerPackage String

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.

typeName String

CloudFormation Type name. For example, ExampleCompany::ExampleService::ExampleResource.

executionRoleArn String

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.

loggingConfig CloudFormationTypeLoggingConfigArgs

Configuration block containing logging configuration.

type String

CloudFormation Registry Type. For example, RESOURCE or MODULE.

schemaHandlerPackage string

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.

typeName string

CloudFormation Type name. For example, ExampleCompany::ExampleService::ExampleResource.

executionRoleArn string

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.

loggingConfig CloudFormationTypeLoggingConfigArgs

Configuration block containing logging configuration.

type string

CloudFormation Registry Type. For example, RESOURCE or MODULE.

schema_handler_package str

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.

type_name str

CloudFormation Type name. For example, ExampleCompany::ExampleService::ExampleResource.

execution_role_arn str

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.

logging_config CloudFormationTypeLoggingConfigArgs

Configuration block containing logging configuration.

type str

CloudFormation Registry Type. For example, RESOURCE or MODULE.

schemaHandlerPackage String

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.

typeName String

CloudFormation Type name. For example, ExampleCompany::ExampleService::ExampleResource.

executionRoleArn String

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.

loggingConfig Property Map

Configuration block containing logging configuration.

type String

CloudFormation Registry Type. For example, RESOURCE or MODULE.

Outputs

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

Arn string

(Optional) Amazon Resource Name (ARN) of the CloudFormation Type version. See also type_arn.

DefaultVersionId string

Identifier of the CloudFormation Type default version.

DeprecatedStatus string

Deprecation status of the version.

Description string

Description of the version.

DocumentationUrl string

URL of the documentation for the CloudFormation Type.

Id string

The provider-assigned unique ID for this managed resource.

IsDefaultVersion bool

Whether the CloudFormation Type version is the default version.

ProvisioningType string

Provisioning behavior of the CloudFormation Type.

Schema string

JSON document of the CloudFormation Type schema.

SourceUrl string

URL of the source code for the CloudFormation Type.

TypeArn string

(Optional) Amazon Resource Name (ARN) of the CloudFormation Type. See also arn.

VersionId string

(Optional) Identifier of the CloudFormation Type version.

Visibility string

Scope of the CloudFormation Type.

Arn string

(Optional) Amazon Resource Name (ARN) of the CloudFormation Type version. See also type_arn.

DefaultVersionId string

Identifier of the CloudFormation Type default version.

DeprecatedStatus string

Deprecation status of the version.

Description string

Description of the version.

DocumentationUrl string

URL of the documentation for the CloudFormation Type.

Id string

The provider-assigned unique ID for this managed resource.

IsDefaultVersion bool

Whether the CloudFormation Type version is the default version.

ProvisioningType string

Provisioning behavior of the CloudFormation Type.

Schema string

JSON document of the CloudFormation Type schema.

SourceUrl string

URL of the source code for the CloudFormation Type.

TypeArn string

(Optional) Amazon Resource Name (ARN) of the CloudFormation Type. See also arn.

VersionId string

(Optional) Identifier of the CloudFormation Type version.

Visibility string

Scope of the CloudFormation Type.

arn String

(Optional) Amazon Resource Name (ARN) of the CloudFormation Type version. See also type_arn.

defaultVersionId String

Identifier of the CloudFormation Type default version.

deprecatedStatus String

Deprecation status of the version.

description String

Description of the version.

documentationUrl String

URL of the documentation for the CloudFormation Type.

id String

The provider-assigned unique ID for this managed resource.

isDefaultVersion Boolean

Whether the CloudFormation Type version is the default version.

provisioningType String

Provisioning behavior of the CloudFormation Type.

schema String

JSON document of the CloudFormation Type schema.

sourceUrl String

URL of the source code for the CloudFormation Type.

typeArn String

(Optional) Amazon Resource Name (ARN) of the CloudFormation Type. See also arn.

versionId String

(Optional) Identifier of the CloudFormation Type version.

visibility String

Scope of the CloudFormation Type.

arn string

(Optional) Amazon Resource Name (ARN) of the CloudFormation Type version. See also type_arn.

defaultVersionId string

Identifier of the CloudFormation Type default version.

deprecatedStatus string

Deprecation status of the version.

description string

Description of the version.

documentationUrl string

URL of the documentation for the CloudFormation Type.

id string

The provider-assigned unique ID for this managed resource.

isDefaultVersion boolean

Whether the CloudFormation Type version is the default version.

provisioningType string

Provisioning behavior of the CloudFormation Type.

schema string

JSON document of the CloudFormation Type schema.

sourceUrl string

URL of the source code for the CloudFormation Type.

typeArn string

(Optional) Amazon Resource Name (ARN) of the CloudFormation Type. See also arn.

versionId string

(Optional) Identifier of the CloudFormation Type version.

visibility string

Scope of the CloudFormation Type.

arn str

(Optional) Amazon Resource Name (ARN) of the CloudFormation Type version. See also type_arn.

default_version_id str

Identifier of the CloudFormation Type default version.

deprecated_status str

Deprecation status of the version.

description str

Description of the version.

documentation_url str

URL of the documentation for the CloudFormation Type.

id str

The provider-assigned unique ID for this managed resource.

is_default_version bool

Whether the CloudFormation Type version is the default version.

provisioning_type str

Provisioning behavior of the CloudFormation Type.

schema str

JSON document of the CloudFormation Type schema.

source_url str

URL of the source code for the CloudFormation Type.

type_arn str

(Optional) Amazon Resource Name (ARN) of the CloudFormation Type. See also arn.

version_id str

(Optional) Identifier of the CloudFormation Type version.

visibility str

Scope of the CloudFormation Type.

arn String

(Optional) Amazon Resource Name (ARN) of the CloudFormation Type version. See also type_arn.

defaultVersionId String

Identifier of the CloudFormation Type default version.

deprecatedStatus String

Deprecation status of the version.

description String

Description of the version.

documentationUrl String

URL of the documentation for the CloudFormation Type.

id String

The provider-assigned unique ID for this managed resource.

isDefaultVersion Boolean

Whether the CloudFormation Type version is the default version.

provisioningType String

Provisioning behavior of the CloudFormation Type.

schema String

JSON document of the CloudFormation Type schema.

sourceUrl String

URL of the source code for the CloudFormation Type.

typeArn String

(Optional) Amazon Resource Name (ARN) of the CloudFormation Type. See also arn.

versionId String

(Optional) Identifier of the CloudFormation Type version.

visibility String

Scope of the CloudFormation Type.

Look up Existing CloudFormationType Resource

Get an existing CloudFormationType 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?: CloudFormationTypeState, opts?: CustomResourceOptions): CloudFormationType
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        arn: Optional[str] = None,
        default_version_id: Optional[str] = None,
        deprecated_status: Optional[str] = None,
        description: Optional[str] = None,
        documentation_url: Optional[str] = None,
        execution_role_arn: Optional[str] = None,
        is_default_version: Optional[bool] = None,
        logging_config: Optional[CloudFormationTypeLoggingConfigArgs] = None,
        provisioning_type: Optional[str] = None,
        schema: Optional[str] = None,
        schema_handler_package: Optional[str] = None,
        source_url: Optional[str] = None,
        type: Optional[str] = None,
        type_arn: Optional[str] = None,
        type_name: Optional[str] = None,
        version_id: Optional[str] = None,
        visibility: Optional[str] = None) -> CloudFormationType
func GetCloudFormationType(ctx *Context, name string, id IDInput, state *CloudFormationTypeState, opts ...ResourceOption) (*CloudFormationType, error)
public static CloudFormationType Get(string name, Input<string> id, CloudFormationTypeState? state, CustomResourceOptions? opts = null)
public static CloudFormationType get(String name, Output<String> id, CloudFormationTypeState 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:
Arn string

(Optional) Amazon Resource Name (ARN) of the CloudFormation Type version. See also type_arn.

DefaultVersionId string

Identifier of the CloudFormation Type default version.

DeprecatedStatus string

Deprecation status of the version.

Description string

Description of the version.

DocumentationUrl string

URL of the documentation for the CloudFormation Type.

ExecutionRoleArn string

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.

IsDefaultVersion bool

Whether the CloudFormation Type version is the default version.

LoggingConfig CloudFormationTypeLoggingConfigArgs

Configuration block containing logging configuration.

ProvisioningType string

Provisioning behavior of the CloudFormation Type.

Schema string

JSON document of the CloudFormation Type schema.

SchemaHandlerPackage string

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.

SourceUrl string

URL of the source code for the CloudFormation Type.

Type string

CloudFormation Registry Type. For example, RESOURCE or MODULE.

TypeArn string

(Optional) Amazon Resource Name (ARN) of the CloudFormation Type. See also arn.

TypeName string

CloudFormation Type name. For example, ExampleCompany::ExampleService::ExampleResource.

VersionId string

(Optional) Identifier of the CloudFormation Type version.

Visibility string

Scope of the CloudFormation Type.

Arn string

(Optional) Amazon Resource Name (ARN) of the CloudFormation Type version. See also type_arn.

DefaultVersionId string

Identifier of the CloudFormation Type default version.

DeprecatedStatus string

Deprecation status of the version.

Description string

Description of the version.

DocumentationUrl string

URL of the documentation for the CloudFormation Type.

ExecutionRoleArn string

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.

IsDefaultVersion bool

Whether the CloudFormation Type version is the default version.

LoggingConfig CloudFormationTypeLoggingConfigArgs

Configuration block containing logging configuration.

ProvisioningType string

Provisioning behavior of the CloudFormation Type.

Schema string

JSON document of the CloudFormation Type schema.

SchemaHandlerPackage string

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.

SourceUrl string

URL of the source code for the CloudFormation Type.

Type string

CloudFormation Registry Type. For example, RESOURCE or MODULE.

TypeArn string

(Optional) Amazon Resource Name (ARN) of the CloudFormation Type. See also arn.

TypeName string

CloudFormation Type name. For example, ExampleCompany::ExampleService::ExampleResource.

VersionId string

(Optional) Identifier of the CloudFormation Type version.

Visibility string

Scope of the CloudFormation Type.

arn String

(Optional) Amazon Resource Name (ARN) of the CloudFormation Type version. See also type_arn.

defaultVersionId String

Identifier of the CloudFormation Type default version.

deprecatedStatus String

Deprecation status of the version.

description String

Description of the version.

documentationUrl String

URL of the documentation for the CloudFormation Type.

executionRoleArn String

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.

isDefaultVersion Boolean

Whether the CloudFormation Type version is the default version.

loggingConfig CloudFormationTypeLoggingConfigArgs

Configuration block containing logging configuration.

provisioningType String

Provisioning behavior of the CloudFormation Type.

schema String

JSON document of the CloudFormation Type schema.

schemaHandlerPackage String

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.

sourceUrl String

URL of the source code for the CloudFormation Type.

type String

CloudFormation Registry Type. For example, RESOURCE or MODULE.

typeArn String

(Optional) Amazon Resource Name (ARN) of the CloudFormation Type. See also arn.

typeName String

CloudFormation Type name. For example, ExampleCompany::ExampleService::ExampleResource.

versionId String

(Optional) Identifier of the CloudFormation Type version.

visibility String

Scope of the CloudFormation Type.

arn string

(Optional) Amazon Resource Name (ARN) of the CloudFormation Type version. See also type_arn.

defaultVersionId string

Identifier of the CloudFormation Type default version.

deprecatedStatus string

Deprecation status of the version.

description string

Description of the version.

documentationUrl string

URL of the documentation for the CloudFormation Type.

executionRoleArn string

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.

isDefaultVersion boolean

Whether the CloudFormation Type version is the default version.

loggingConfig CloudFormationTypeLoggingConfigArgs

Configuration block containing logging configuration.

provisioningType string

Provisioning behavior of the CloudFormation Type.

schema string

JSON document of the CloudFormation Type schema.

schemaHandlerPackage string

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.

sourceUrl string

URL of the source code for the CloudFormation Type.

type string

CloudFormation Registry Type. For example, RESOURCE or MODULE.

typeArn string

(Optional) Amazon Resource Name (ARN) of the CloudFormation Type. See also arn.

typeName string

CloudFormation Type name. For example, ExampleCompany::ExampleService::ExampleResource.

versionId string

(Optional) Identifier of the CloudFormation Type version.

visibility string

Scope of the CloudFormation Type.

arn str

(Optional) Amazon Resource Name (ARN) of the CloudFormation Type version. See also type_arn.

default_version_id str

Identifier of the CloudFormation Type default version.

deprecated_status str

Deprecation status of the version.

description str

Description of the version.

documentation_url str

URL of the documentation for the CloudFormation Type.

execution_role_arn str

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.

is_default_version bool

Whether the CloudFormation Type version is the default version.

logging_config CloudFormationTypeLoggingConfigArgs

Configuration block containing logging configuration.

provisioning_type str

Provisioning behavior of the CloudFormation Type.

schema str

JSON document of the CloudFormation Type schema.

schema_handler_package str

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.

source_url str

URL of the source code for the CloudFormation Type.

type str

CloudFormation Registry Type. For example, RESOURCE or MODULE.

type_arn str

(Optional) Amazon Resource Name (ARN) of the CloudFormation Type. See also arn.

type_name str

CloudFormation Type name. For example, ExampleCompany::ExampleService::ExampleResource.

version_id str

(Optional) Identifier of the CloudFormation Type version.

visibility str

Scope of the CloudFormation Type.

arn String

(Optional) Amazon Resource Name (ARN) of the CloudFormation Type version. See also type_arn.

defaultVersionId String

Identifier of the CloudFormation Type default version.

deprecatedStatus String

Deprecation status of the version.

description String

Description of the version.

documentationUrl String

URL of the documentation for the CloudFormation Type.

executionRoleArn String

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.

isDefaultVersion Boolean

Whether the CloudFormation Type version is the default version.

loggingConfig Property Map

Configuration block containing logging configuration.

provisioningType String

Provisioning behavior of the CloudFormation Type.

schema String

JSON document of the CloudFormation Type schema.

schemaHandlerPackage String

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.

sourceUrl String

URL of the source code for the CloudFormation Type.

type String

CloudFormation Registry Type. For example, RESOURCE or MODULE.

typeArn String

(Optional) Amazon Resource Name (ARN) of the CloudFormation Type. See also arn.

typeName String

CloudFormation Type name. For example, ExampleCompany::ExampleService::ExampleResource.

versionId String

(Optional) Identifier of the CloudFormation Type version.

visibility String

Scope of the CloudFormation Type.

Supporting Types

CloudFormationTypeLoggingConfig

LogGroupName string

Name of the CloudWatch Log Group where CloudFormation sends error logging information when invoking the type's handlers.

LogRoleArn string

Amazon Resource Name (ARN) of the IAM Role CloudFormation assumes when sending error logging information to CloudWatch Logs.

LogGroupName string

Name of the CloudWatch Log Group where CloudFormation sends error logging information when invoking the type's handlers.

LogRoleArn string

Amazon Resource Name (ARN) of the IAM Role CloudFormation assumes when sending error logging information to CloudWatch Logs.

logGroupName String

Name of the CloudWatch Log Group where CloudFormation sends error logging information when invoking the type's handlers.

logRoleArn String

Amazon Resource Name (ARN) of the IAM Role CloudFormation assumes when sending error logging information to CloudWatch Logs.

logGroupName string

Name of the CloudWatch Log Group where CloudFormation sends error logging information when invoking the type's handlers.

logRoleArn string

Amazon Resource Name (ARN) of the IAM Role CloudFormation assumes when sending error logging information to CloudWatch Logs.

log_group_name str

Name of the CloudWatch Log Group where CloudFormation sends error logging information when invoking the type's handlers.

log_role_arn str

Amazon Resource Name (ARN) of the IAM Role CloudFormation assumes when sending error logging information to CloudWatch Logs.

logGroupName String

Name of the CloudWatch Log Group where CloudFormation sends error logging information when invoking the type's handlers.

logRoleArn String

Amazon Resource Name (ARN) of the IAM Role CloudFormation assumes when sending error logging information to CloudWatch Logs.

Import

aws_cloudformation_type can be imported with their type version Amazon Resource Name (ARN), e.g.,

 $ pulumi import aws:cloudformation/cloudFormationType:CloudFormationType example arn:aws:cloudformation:us-east-1:123456789012:type/resource/ExampleCompany-ExampleService-ExampleType/1

Package Details

Repository
https://github.com/pulumi/pulumi-aws
License
Apache-2.0
Notes

This Pulumi package is based on the aws Terraform Provider.