AWS v6.54.2 published on Wednesday, Oct 2, 2024 by Pulumi
aws.cloudformation.getCloudFormationType
Explore with Pulumi AI
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",
});
import pulumi
import pulumi_aws as aws
example = aws.cloudformation.get_cloud_formation_type(type="RESOURCE",
type_name="AWS::Athena::WorkGroup")
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
})
}
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",
});
});
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());
}
}
variables:
example:
fn::invoke:
Function: aws:cloudformation:getCloudFormationType
Arguments:
type: RESOURCE
typeName: AWS::Athena::WorkGroup
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>
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]
func LookupCloudFormationType(ctx *Context, args *LookupCloudFormationTypeArgs, opts ...InvokeOption) (*LookupCloudFormationTypeResult, error)
func LookupCloudFormationTypeOutput(ctx *Context, args *LookupCloudFormationTypeOutputArgs, opts ...InvokeOption) LookupCloudFormationTypeResultOutput
> 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)
}
public static CompletableFuture<GetCloudFormationTypeResult> getCloudFormationType(GetCloudFormationTypeArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
fn::invoke:
function: aws:cloudformation/getCloudFormationType:getCloudFormationType
arguments:
# arguments dictionary
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
. - Type
Name string - CloudFormation Type name. For example,
AWS::EC2::VPC
. - Version
Id 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
. - Type
Name string - CloudFormation Type name. For example,
AWS::EC2::VPC
. - Version
Id 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
. - type
Name String - CloudFormation Type name. For example,
AWS::EC2::VPC
. - version
Id 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
. - type
Name string - CloudFormation Type name. For example,
AWS::EC2::VPC
. - version
Id 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
. - type
Name String - CloudFormation Type name. For example,
AWS::EC2::VPC
. - version
Id String - Identifier of the CloudFormation Type version.
getCloudFormationType Result
The following output properties are available:
- Arn string
- Default
Version stringId - Identifier of the CloudFormation Type default version.
- Deprecated
Status string - Deprecation status of the CloudFormation Type.
- Description string
- Description of the CloudFormation Type.
- Documentation
Url string - URL of the documentation for the CloudFormation Type.
- Execution
Role stringArn - ARN of the IAM Role used to register the CloudFormation Type.
- Id string
- The provider-assigned unique ID for this managed resource.
- Is
Default boolVersion - Whether the CloudFormation Type version is the default version.
- Logging
Configs List<GetCloud Formation Type Logging Config> - List of objects containing logging configuration.
- Provisioning
Type string - Provisioning behavior of the CloudFormation Type.
- Schema string
- JSON document of the CloudFormation Type schema.
- Source
Url string - URL of the source code for the CloudFormation Type.
- Type string
- Type
Arn string - Type
Name string - Visibility string
- Scope of the CloudFormation Type.
- Version
Id string
- Arn string
- Default
Version stringId - Identifier of the CloudFormation Type default version.
- Deprecated
Status string - Deprecation status of the CloudFormation Type.
- Description string
- Description of the CloudFormation Type.
- Documentation
Url string - URL of the documentation for the CloudFormation Type.
- Execution
Role stringArn - ARN of the IAM Role used to register the CloudFormation Type.
- Id string
- The provider-assigned unique ID for this managed resource.
- Is
Default boolVersion - Whether the CloudFormation Type version is the default version.
- Logging
Configs []GetCloud Formation Type Logging Config - List of objects containing logging configuration.
- Provisioning
Type string - Provisioning behavior of the CloudFormation Type.
- Schema string
- JSON document of the CloudFormation Type schema.
- Source
Url string - URL of the source code for the CloudFormation Type.
- Type string
- Type
Arn string - Type
Name string - Visibility string
- Scope of the CloudFormation Type.
- Version
Id string
- arn String
- default
Version StringId - Identifier of the CloudFormation Type default version.
- deprecated
Status String - Deprecation status of the CloudFormation Type.
- description String
- Description of the CloudFormation Type.
- documentation
Url String - URL of the documentation for the CloudFormation Type.
- execution
Role StringArn - ARN of the IAM Role used to register the CloudFormation Type.
- id String
- The provider-assigned unique ID for this managed resource.
- is
Default BooleanVersion - Whether the CloudFormation Type version is the default version.
- logging
Configs List<GetCloud Formation Type Logging Config> - List of objects containing logging configuration.
- provisioning
Type String - Provisioning behavior of the CloudFormation Type.
- schema String
- JSON document of the CloudFormation Type schema.
- source
Url String - URL of the source code for the CloudFormation Type.
- type String
- type
Arn String - type
Name String - visibility String
- Scope of the CloudFormation Type.
- version
Id String
- arn string
- default
Version stringId - Identifier of the CloudFormation Type default version.
- deprecated
Status string - Deprecation status of the CloudFormation Type.
- description string
- Description of the CloudFormation Type.
- documentation
Url string - URL of the documentation for the CloudFormation Type.
- execution
Role stringArn - ARN of the IAM Role used to register the CloudFormation Type.
- id string
- The provider-assigned unique ID for this managed resource.
- is
Default booleanVersion - Whether the CloudFormation Type version is the default version.
- logging
Configs GetCloud Formation Type Logging Config[] - List of objects containing logging configuration.
- provisioning
Type string - Provisioning behavior of the CloudFormation Type.
- schema string
- JSON document of the CloudFormation Type schema.
- source
Url string - URL of the source code for the CloudFormation Type.
- type string
- type
Arn string - type
Name string - visibility string
- Scope of the CloudFormation Type.
- version
Id string
- arn str
- default_
version_ strid - 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_ strarn - ARN of the IAM Role used to register the CloudFormation Type.
- id str
- The provider-assigned unique ID for this managed resource.
- is_
default_ boolversion - Whether the CloudFormation Type version is the default version.
- logging_
configs Sequence[GetCloud Formation Type Logging Config] - 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
- default
Version StringId - Identifier of the CloudFormation Type default version.
- deprecated
Status String - Deprecation status of the CloudFormation Type.
- description String
- Description of the CloudFormation Type.
- documentation
Url String - URL of the documentation for the CloudFormation Type.
- execution
Role StringArn - ARN of the IAM Role used to register the CloudFormation Type.
- id String
- The provider-assigned unique ID for this managed resource.
- is
Default BooleanVersion - Whether the CloudFormation Type version is the default version.
- logging
Configs List<Property Map> - List of objects containing logging configuration.
- provisioning
Type String - Provisioning behavior of the CloudFormation Type.
- schema String
- JSON document of the CloudFormation Type schema.
- source
Url String - URL of the source code for the CloudFormation Type.
- type String
- type
Arn String - type
Name String - visibility String
- Scope of the CloudFormation Type.
- version
Id String
Supporting Types
GetCloudFormationTypeLoggingConfig
- Log
Group stringName - Name of the CloudWatch Log Group where CloudFormation sends error logging information when invoking the type's handlers.
- Log
Role stringArn - ARN of the IAM Role CloudFormation assumes when sending error logging information to CloudWatch Logs.
- Log
Group stringName - Name of the CloudWatch Log Group where CloudFormation sends error logging information when invoking the type's handlers.
- Log
Role stringArn - ARN of the IAM Role CloudFormation assumes when sending error logging information to CloudWatch Logs.
- log
Group StringName - Name of the CloudWatch Log Group where CloudFormation sends error logging information when invoking the type's handlers.
- log
Role StringArn - ARN of the IAM Role CloudFormation assumes when sending error logging information to CloudWatch Logs.
- log
Group stringName - Name of the CloudWatch Log Group where CloudFormation sends error logging information when invoking the type's handlers.
- log
Role stringArn - ARN of the IAM Role CloudFormation assumes when sending error logging information to CloudWatch Logs.
- log_
group_ strname - Name of the CloudWatch Log Group where CloudFormation sends error logging information when invoking the type's handlers.
- log_
role_ strarn - ARN of the IAM Role CloudFormation assumes when sending error logging information to CloudWatch Logs.
- log
Group StringName - Name of the CloudWatch Log Group where CloudFormation sends error logging information when invoking the type's handlers.
- log
Role StringArn - 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.