Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS
  3. API Docs
  4. cloudformation
  5. getCloudFormationType
AWS v6.77.0 published on Wednesday, Apr 9, 2025 by Pulumi
pulumi/pulumi-aws

aws.cloudformation.getCloudFormationType

Explore with Pulumi AI

AWS v6.77.0 published on Wednesday, Apr 9, 2025 by Pulumi
pulumi/pulumi-aws

Provides details about a CloudFormation Type.

Example Usage

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

const example = aws.cloudformation.getCloudFormationType({
    type: "RESOURCE",
    typeName: "AWS::Athena::WorkGroup",
});
Copy
import pulumi
import pulumi_aws as aws

example = aws.cloudformation.get_cloud_formation_type(type="RESOURCE",
    type_name="AWS::Athena::WorkGroup")
Copy
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := cloudformation.LookupCloudFormationType(ctx, &cloudformation.LookupCloudFormationTypeArgs{
			Type:     pulumi.StringRef("RESOURCE"),
			TypeName: pulumi.StringRef("AWS::Athena::WorkGroup"),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var example = Aws.CloudFormation.GetCloudFormationType.Invoke(new()
    {
        Type = "RESOURCE",
        TypeName = "AWS::Athena::WorkGroup",
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.cloudformation.CloudformationFunctions;
import com.pulumi.aws.cloudformation.inputs.GetCloudFormationTypeArgs;
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) {
        final var example = CloudformationFunctions.getCloudFormationType(GetCloudFormationTypeArgs.builder()
            .type("RESOURCE")
            .typeName("AWS::Athena::WorkGroup")
            .build());

    }
}
Copy
variables:
  example:
    fn::invoke:
      function: aws:cloudformation:getCloudFormationType
      arguments:
        type: RESOURCE
        typeName: AWS::Athena::WorkGroup
Copy

Using getCloudFormationType

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getCloudFormationType(args: GetCloudFormationTypeArgs, opts?: InvokeOptions): Promise<GetCloudFormationTypeResult>
function getCloudFormationTypeOutput(args: GetCloudFormationTypeOutputArgs, opts?: InvokeOptions): Output<GetCloudFormationTypeResult>
Copy
def get_cloud_formation_type(arn: Optional[str] = None,
                             type: Optional[str] = None,
                             type_name: Optional[str] = None,
                             version_id: Optional[str] = None,
                             opts: Optional[InvokeOptions] = None) -> GetCloudFormationTypeResult
def get_cloud_formation_type_output(arn: Optional[pulumi.Input[str]] = None,
                             type: Optional[pulumi.Input[str]] = None,
                             type_name: Optional[pulumi.Input[str]] = None,
                             version_id: Optional[pulumi.Input[str]] = None,
                             opts: Optional[InvokeOptions] = None) -> Output[GetCloudFormationTypeResult]
Copy
func LookupCloudFormationType(ctx *Context, args *LookupCloudFormationTypeArgs, opts ...InvokeOption) (*LookupCloudFormationTypeResult, error)
func LookupCloudFormationTypeOutput(ctx *Context, args *LookupCloudFormationTypeOutputArgs, opts ...InvokeOption) LookupCloudFormationTypeResultOutput
Copy

> Note: This function is named LookupCloudFormationType in the Go SDK.

public static class GetCloudFormationType 
{
    public static Task<GetCloudFormationTypeResult> InvokeAsync(GetCloudFormationTypeArgs args, InvokeOptions? opts = null)
    public static Output<GetCloudFormationTypeResult> Invoke(GetCloudFormationTypeInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetCloudFormationTypeResult> getCloudFormationType(GetCloudFormationTypeArgs args, InvokeOptions options)
public static Output<GetCloudFormationTypeResult> getCloudFormationType(GetCloudFormationTypeArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: aws:cloudformation/getCloudFormationType:getCloudFormationType
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

Arn string
ARN of the CloudFormation Type. For example, arn:aws:cloudformation:us-west-2::type/resource/AWS-EC2-VPC.
Type string
CloudFormation Registry Type. For example, RESOURCE.
TypeName string
CloudFormation Type name. For example, AWS::EC2::VPC.
VersionId string
Identifier of the CloudFormation Type version.
Arn string
ARN of the CloudFormation Type. For example, arn:aws:cloudformation:us-west-2::type/resource/AWS-EC2-VPC.
Type string
CloudFormation Registry Type. For example, RESOURCE.
TypeName string
CloudFormation Type name. For example, AWS::EC2::VPC.
VersionId string
Identifier of the CloudFormation Type version.
arn String
ARN of the CloudFormation Type. For example, arn:aws:cloudformation:us-west-2::type/resource/AWS-EC2-VPC.
type String
CloudFormation Registry Type. For example, RESOURCE.
typeName String
CloudFormation Type name. For example, AWS::EC2::VPC.
versionId String
Identifier of the CloudFormation Type version.
arn string
ARN of the CloudFormation Type. For example, arn:aws:cloudformation:us-west-2::type/resource/AWS-EC2-VPC.
type string
CloudFormation Registry Type. For example, RESOURCE.
typeName string
CloudFormation Type name. For example, AWS::EC2::VPC.
versionId string
Identifier of the CloudFormation Type version.
arn str
ARN of the CloudFormation Type. For example, arn:aws:cloudformation:us-west-2::type/resource/AWS-EC2-VPC.
type str
CloudFormation Registry Type. For example, RESOURCE.
type_name str
CloudFormation Type name. For example, AWS::EC2::VPC.
version_id str
Identifier of the CloudFormation Type version.
arn String
ARN of the CloudFormation Type. For example, arn:aws:cloudformation:us-west-2::type/resource/AWS-EC2-VPC.
type String
CloudFormation Registry Type. For example, RESOURCE.
typeName String
CloudFormation Type name. For example, AWS::EC2::VPC.
versionId String
Identifier of the CloudFormation Type version.

getCloudFormationType Result

The following output properties are available:

Arn string
DefaultVersionId string
Identifier of the CloudFormation Type default version.
DeprecatedStatus string
Deprecation status of the CloudFormation Type.
Description string
Description of the CloudFormation Type.
DocumentationUrl string
URL of the documentation for the CloudFormation Type.
ExecutionRoleArn string
ARN of the IAM Role used to register 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.
LoggingConfigs List<GetCloudFormationTypeLoggingConfig>
List of objects containing logging configuration.
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.
Type string
TypeArn string
TypeName string
Visibility string
Scope of the CloudFormation Type.
VersionId string
Arn string
DefaultVersionId string
Identifier of the CloudFormation Type default version.
DeprecatedStatus string
Deprecation status of the CloudFormation Type.
Description string
Description of the CloudFormation Type.
DocumentationUrl string
URL of the documentation for the CloudFormation Type.
ExecutionRoleArn string
ARN of the IAM Role used to register 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.
LoggingConfigs []GetCloudFormationTypeLoggingConfig
List of objects containing logging configuration.
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.
Type string
TypeArn string
TypeName string
Visibility string
Scope of the CloudFormation Type.
VersionId string
arn String
defaultVersionId String
Identifier of the CloudFormation Type default version.
deprecatedStatus String
Deprecation status of the CloudFormation Type.
description String
Description of the CloudFormation Type.
documentationUrl String
URL of the documentation for the CloudFormation Type.
executionRoleArn String
ARN of the IAM Role used to register 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.
loggingConfigs List<GetCloudFormationTypeLoggingConfig>
List of objects containing logging configuration.
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.
type String
typeArn String
typeName String
visibility String
Scope of the CloudFormation Type.
versionId String
arn string
defaultVersionId string
Identifier of the CloudFormation Type default version.
deprecatedStatus string
Deprecation status of the CloudFormation Type.
description string
Description of the CloudFormation Type.
documentationUrl string
URL of the documentation for the CloudFormation Type.
executionRoleArn string
ARN of the IAM Role used to register 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.
loggingConfigs GetCloudFormationTypeLoggingConfig[]
List of objects containing logging configuration.
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.
type string
typeArn string
typeName string
visibility string
Scope of the CloudFormation Type.
versionId string
arn str
default_version_id str
Identifier of the CloudFormation Type default version.
deprecated_status str
Deprecation status of the CloudFormation Type.
description str
Description of the CloudFormation Type.
documentation_url str
URL of the documentation for the CloudFormation Type.
execution_role_arn str
ARN of the IAM Role used to register 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.
logging_configs Sequence[GetCloudFormationTypeLoggingConfig]
List of objects containing logging configuration.
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 str
type_arn str
type_name str
visibility str
Scope of the CloudFormation Type.
version_id str
arn String
defaultVersionId String
Identifier of the CloudFormation Type default version.
deprecatedStatus String
Deprecation status of the CloudFormation Type.
description String
Description of the CloudFormation Type.
documentationUrl String
URL of the documentation for the CloudFormation Type.
executionRoleArn String
ARN of the IAM Role used to register 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.
loggingConfigs List<Property Map>
List of objects containing logging configuration.
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.
type String
typeArn String
typeName String
visibility String
Scope of the CloudFormation Type.
versionId String

Supporting Types

GetCloudFormationTypeLoggingConfig

LogGroupName This property is required. string
Name of the CloudWatch Log Group where CloudFormation sends error logging information when invoking the type's handlers.
LogRoleArn This property is required. string
ARN of the IAM Role CloudFormation assumes when sending error logging information to CloudWatch Logs.
LogGroupName This property is required. string
Name of the CloudWatch Log Group where CloudFormation sends error logging information when invoking the type's handlers.
LogRoleArn This property is required. string
ARN of the IAM Role CloudFormation assumes when sending error logging information to CloudWatch Logs.
logGroupName This property is required. String
Name of the CloudWatch Log Group where CloudFormation sends error logging information when invoking the type's handlers.
logRoleArn This property is required. String
ARN of the IAM Role CloudFormation assumes when sending error logging information to CloudWatch Logs.
logGroupName This property is required. string
Name of the CloudWatch Log Group where CloudFormation sends error logging information when invoking the type's handlers.
logRoleArn This property is required. string
ARN of the IAM Role CloudFormation assumes when sending error logging information to CloudWatch Logs.
log_group_name This property is required. str
Name of the CloudWatch Log Group where CloudFormation sends error logging information when invoking the type's handlers.
log_role_arn This property is required. str
ARN of the IAM Role CloudFormation assumes when sending error logging information to CloudWatch Logs.
logGroupName This property is required. String
Name of the CloudWatch Log Group where CloudFormation sends error logging information when invoking the type's handlers.
logRoleArn This property is required. String
ARN of the IAM Role CloudFormation assumes when sending error logging information to CloudWatch Logs.

Package Details

Repository
AWS Classic pulumi/pulumi-aws
License
Apache-2.0
Notes
This Pulumi package is based on the aws Terraform Provider.
AWS v6.77.0 published on Wednesday, Apr 9, 2025 by Pulumi
pulumi/pulumi-aws