1. Packages
  2. AWS Native
  3. API Docs
  4. cloudformation
  5. HookTypeConfig

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.107.0 published on Wednesday, May 22, 2024 by Pulumi

aws-native.cloudformation.HookTypeConfig

Explore with Pulumi AI

aws-native logo

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.107.0 published on Wednesday, May 22, 2024 by Pulumi

    Specifies the configuration data for a registered hook in CloudFormation Registry.

    Example Usage

    Example

    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using AwsNative = Pulumi.AwsNative;
    
    return await Deployment.RunAsync(() => 
    {
        var hookTypeConfig = new AwsNative.CloudFormation.HookTypeConfig("hookTypeConfig", new()
        {
            TypeName = "My::Sample::Hook",
            Configuration = "{\"CloudFormationConfiguration\":{\"HookConfiguration\":{\"TargetStacks\":\"ALL\",\"FailureMode\":\"WARN\",\"Properties\":{\"limitSize\": \"1\",\"encryptionAlgorithm\": \"aws:kms\"}}}}",
        });
    
    });
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-aws-native/sdk/go/aws/cloudformation"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := cloudformation.NewHookTypeConfig(ctx, "hookTypeConfig", &cloudformation.HookTypeConfigArgs{
    			TypeName:      pulumi.String("My::Sample::Hook"),
    			Configuration: pulumi.String("{\"CloudFormationConfiguration\":{\"HookConfiguration\":{\"TargetStacks\":\"ALL\",\"FailureMode\":\"WARN\",\"Properties\":{\"limitSize\": \"1\",\"encryptionAlgorithm\": \"aws:kms\"}}}}"),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    

    Coming soon!

    import pulumi
    import pulumi_aws_native as aws_native
    
    hook_type_config = aws_native.cloudformation.HookTypeConfig("hookTypeConfig",
        type_name="My::Sample::Hook",
        configuration="{\"CloudFormationConfiguration\":{\"HookConfiguration\":{\"TargetStacks\":\"ALL\",\"FailureMode\":\"WARN\",\"Properties\":{\"limitSize\": \"1\",\"encryptionAlgorithm\": \"aws:kms\"}}}}")
    
    import * as pulumi from "@pulumi/pulumi";
    import * as aws_native from "@pulumi/aws-native";
    
    const hookTypeConfig = new aws_native.cloudformation.HookTypeConfig("hookTypeConfig", {
        typeName: "My::Sample::Hook",
        configuration: "{\"CloudFormationConfiguration\":{\"HookConfiguration\":{\"TargetStacks\":\"ALL\",\"FailureMode\":\"WARN\",\"Properties\":{\"limitSize\": \"1\",\"encryptionAlgorithm\": \"aws:kms\"}}}}",
    });
    

    Coming soon!

    Example

    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using AwsNative = Pulumi.AwsNative;
    
    return await Deployment.RunAsync(() => 
    {
        var hookTypeConfig = new AwsNative.CloudFormation.HookTypeConfig("hookTypeConfig", new()
        {
            TypeName = "My::Sample::Hook",
            Configuration = "{\"CloudFormationConfiguration\":{\"HookConfiguration\":{\"TargetStacks\":\"ALL\",\"FailureMode\":\"WARN\",\"Properties\":{\"limitSize\": \"1\",\"encryptionAlgorithm\": \"aws:kms\"}}}}",
        });
    
    });
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-aws-native/sdk/go/aws/cloudformation"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := cloudformation.NewHookTypeConfig(ctx, "hookTypeConfig", &cloudformation.HookTypeConfigArgs{
    			TypeName:      pulumi.String("My::Sample::Hook"),
    			Configuration: pulumi.String("{\"CloudFormationConfiguration\":{\"HookConfiguration\":{\"TargetStacks\":\"ALL\",\"FailureMode\":\"WARN\",\"Properties\":{\"limitSize\": \"1\",\"encryptionAlgorithm\": \"aws:kms\"}}}}"),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    

    Coming soon!

    import pulumi
    import pulumi_aws_native as aws_native
    
    hook_type_config = aws_native.cloudformation.HookTypeConfig("hookTypeConfig",
        type_name="My::Sample::Hook",
        configuration="{\"CloudFormationConfiguration\":{\"HookConfiguration\":{\"TargetStacks\":\"ALL\",\"FailureMode\":\"WARN\",\"Properties\":{\"limitSize\": \"1\",\"encryptionAlgorithm\": \"aws:kms\"}}}}")
    
    import * as pulumi from "@pulumi/pulumi";
    import * as aws_native from "@pulumi/aws-native";
    
    const hookTypeConfig = new aws_native.cloudformation.HookTypeConfig("hookTypeConfig", {
        typeName: "My::Sample::Hook",
        configuration: "{\"CloudFormationConfiguration\":{\"HookConfiguration\":{\"TargetStacks\":\"ALL\",\"FailureMode\":\"WARN\",\"Properties\":{\"limitSize\": \"1\",\"encryptionAlgorithm\": \"aws:kms\"}}}}",
    });
    

    Coming soon!

    Example

    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using AwsNative = Pulumi.AwsNative;
    
    return await Deployment.RunAsync(() => 
    {
        var hookTypeConfig = new AwsNative.CloudFormation.HookTypeConfig("hookTypeConfig", new()
        {
            TypeArn = "arn:aws:cloudformation:us-west-2:123456789012:type/hook/My-Sample-Hook",
            Configuration = "{\"CloudFormationConfiguration\":{\"HookConfiguration\":{\"TargetStacks\":\"ALL\",\"FailureMode\":\"WARN\",\"Properties\":{\"limitSize\": \"1\",\"encryptionAlgorithm\": \"aws:kms\"}}}}",
        });
    
    });
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-aws-native/sdk/go/aws/cloudformation"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := cloudformation.NewHookTypeConfig(ctx, "hookTypeConfig", &cloudformation.HookTypeConfigArgs{
    			TypeArn:       pulumi.String("arn:aws:cloudformation:us-west-2:123456789012:type/hook/My-Sample-Hook"),
    			Configuration: pulumi.String("{\"CloudFormationConfiguration\":{\"HookConfiguration\":{\"TargetStacks\":\"ALL\",\"FailureMode\":\"WARN\",\"Properties\":{\"limitSize\": \"1\",\"encryptionAlgorithm\": \"aws:kms\"}}}}"),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    

    Coming soon!

    import pulumi
    import pulumi_aws_native as aws_native
    
    hook_type_config = aws_native.cloudformation.HookTypeConfig("hookTypeConfig",
        type_arn="arn:aws:cloudformation:us-west-2:123456789012:type/hook/My-Sample-Hook",
        configuration="{\"CloudFormationConfiguration\":{\"HookConfiguration\":{\"TargetStacks\":\"ALL\",\"FailureMode\":\"WARN\",\"Properties\":{\"limitSize\": \"1\",\"encryptionAlgorithm\": \"aws:kms\"}}}}")
    
    import * as pulumi from "@pulumi/pulumi";
    import * as aws_native from "@pulumi/aws-native";
    
    const hookTypeConfig = new aws_native.cloudformation.HookTypeConfig("hookTypeConfig", {
        typeArn: "arn:aws:cloudformation:us-west-2:123456789012:type/hook/My-Sample-Hook",
        configuration: "{\"CloudFormationConfiguration\":{\"HookConfiguration\":{\"TargetStacks\":\"ALL\",\"FailureMode\":\"WARN\",\"Properties\":{\"limitSize\": \"1\",\"encryptionAlgorithm\": \"aws:kms\"}}}}",
    });
    

    Coming soon!

    Example

    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using AwsNative = Pulumi.AwsNative;
    
    return await Deployment.RunAsync(() => 
    {
        var hookTypeConfig = new AwsNative.CloudFormation.HookTypeConfig("hookTypeConfig", new()
        {
            TypeArn = "arn:aws:cloudformation:us-west-2:123456789012:type/hook/My-Sample-Hook",
            Configuration = "{\"CloudFormationConfiguration\":{\"HookConfiguration\":{\"TargetStacks\":\"ALL\",\"FailureMode\":\"WARN\",\"Properties\":{\"limitSize\": \"1\",\"encryptionAlgorithm\": \"aws:kms\"}}}}",
        });
    
    });
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-aws-native/sdk/go/aws/cloudformation"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := cloudformation.NewHookTypeConfig(ctx, "hookTypeConfig", &cloudformation.HookTypeConfigArgs{
    			TypeArn:       pulumi.String("arn:aws:cloudformation:us-west-2:123456789012:type/hook/My-Sample-Hook"),
    			Configuration: pulumi.String("{\"CloudFormationConfiguration\":{\"HookConfiguration\":{\"TargetStacks\":\"ALL\",\"FailureMode\":\"WARN\",\"Properties\":{\"limitSize\": \"1\",\"encryptionAlgorithm\": \"aws:kms\"}}}}"),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    

    Coming soon!

    import pulumi
    import pulumi_aws_native as aws_native
    
    hook_type_config = aws_native.cloudformation.HookTypeConfig("hookTypeConfig",
        type_arn="arn:aws:cloudformation:us-west-2:123456789012:type/hook/My-Sample-Hook",
        configuration="{\"CloudFormationConfiguration\":{\"HookConfiguration\":{\"TargetStacks\":\"ALL\",\"FailureMode\":\"WARN\",\"Properties\":{\"limitSize\": \"1\",\"encryptionAlgorithm\": \"aws:kms\"}}}}")
    
    import * as pulumi from "@pulumi/pulumi";
    import * as aws_native from "@pulumi/aws-native";
    
    const hookTypeConfig = new aws_native.cloudformation.HookTypeConfig("hookTypeConfig", {
        typeArn: "arn:aws:cloudformation:us-west-2:123456789012:type/hook/My-Sample-Hook",
        configuration: "{\"CloudFormationConfiguration\":{\"HookConfiguration\":{\"TargetStacks\":\"ALL\",\"FailureMode\":\"WARN\",\"Properties\":{\"limitSize\": \"1\",\"encryptionAlgorithm\": \"aws:kms\"}}}}",
    });
    

    Coming soon!

    Create HookTypeConfig Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new HookTypeConfig(name: string, args?: HookTypeConfigArgs, opts?: CustomResourceOptions);
    @overload
    def HookTypeConfig(resource_name: str,
                       args: Optional[HookTypeConfigArgs] = None,
                       opts: Optional[ResourceOptions] = None)
    
    @overload
    def HookTypeConfig(resource_name: str,
                       opts: Optional[ResourceOptions] = None,
                       configuration: Optional[str] = None,
                       configuration_alias: Optional[HookTypeConfigConfigurationAlias] = None,
                       type_arn: Optional[str] = None,
                       type_name: Optional[str] = None)
    func NewHookTypeConfig(ctx *Context, name string, args *HookTypeConfigArgs, opts ...ResourceOption) (*HookTypeConfig, error)
    public HookTypeConfig(string name, HookTypeConfigArgs? args = null, CustomResourceOptions? opts = null)
    public HookTypeConfig(String name, HookTypeConfigArgs args)
    public HookTypeConfig(String name, HookTypeConfigArgs args, CustomResourceOptions options)
    
    type: aws-native:cloudformation:HookTypeConfig
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

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

    Example

    The following reference example uses placeholder values for all input properties.

    Coming soon!
    
    Coming soon!
    
    Coming soon!
    
    Coming soon!
    
    const hookTypeConfigResource = new aws_native.cloudformation.HookTypeConfig("hookTypeConfigResource", {
        configuration: "string",
        configurationAlias: aws_native.cloudformation.HookTypeConfigConfigurationAlias.Default,
        typeArn: "string",
        typeName: "string",
    });
    
    Coming soon!
    

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

    Configuration string
    The configuration data for the extension, in this account and region.
    ConfigurationAlias Pulumi.AwsNative.CloudFormation.HookTypeConfigConfigurationAlias
    An alias by which to refer to this extension configuration data.
    TypeArn string
    The Amazon Resource Name (ARN) of the type without version number.
    TypeName string

    The name of the type being registered.

    We recommend that type names adhere to the following pattern: company_or_organization::service::type.

    Configuration string
    The configuration data for the extension, in this account and region.
    ConfigurationAlias HookTypeConfigConfigurationAlias
    An alias by which to refer to this extension configuration data.
    TypeArn string
    The Amazon Resource Name (ARN) of the type without version number.
    TypeName string

    The name of the type being registered.

    We recommend that type names adhere to the following pattern: company_or_organization::service::type.

    configuration String
    The configuration data for the extension, in this account and region.
    configurationAlias HookTypeConfigConfigurationAlias
    An alias by which to refer to this extension configuration data.
    typeArn String
    The Amazon Resource Name (ARN) of the type without version number.
    typeName String

    The name of the type being registered.

    We recommend that type names adhere to the following pattern: company_or_organization::service::type.

    configuration string
    The configuration data for the extension, in this account and region.
    configurationAlias HookTypeConfigConfigurationAlias
    An alias by which to refer to this extension configuration data.
    typeArn string
    The Amazon Resource Name (ARN) of the type without version number.
    typeName string

    The name of the type being registered.

    We recommend that type names adhere to the following pattern: company_or_organization::service::type.

    configuration str
    The configuration data for the extension, in this account and region.
    configuration_alias HookTypeConfigConfigurationAlias
    An alias by which to refer to this extension configuration data.
    type_arn str
    The Amazon Resource Name (ARN) of the type without version number.
    type_name str

    The name of the type being registered.

    We recommend that type names adhere to the following pattern: company_or_organization::service::type.

    configuration String
    The configuration data for the extension, in this account and region.
    configurationAlias "default"
    An alias by which to refer to this extension configuration data.
    typeArn String
    The Amazon Resource Name (ARN) of the type without version number.
    typeName String

    The name of the type being registered.

    We recommend that type names adhere to the following pattern: company_or_organization::service::type.

    Outputs

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

    ConfigurationArn string
    The Amazon Resource Name (ARN) for the configuration data, in this account and region.
    Id string
    The provider-assigned unique ID for this managed resource.
    ConfigurationArn string
    The Amazon Resource Name (ARN) for the configuration data, in this account and region.
    Id string
    The provider-assigned unique ID for this managed resource.
    configurationArn String
    The Amazon Resource Name (ARN) for the configuration data, in this account and region.
    id String
    The provider-assigned unique ID for this managed resource.
    configurationArn string
    The Amazon Resource Name (ARN) for the configuration data, in this account and region.
    id string
    The provider-assigned unique ID for this managed resource.
    configuration_arn str
    The Amazon Resource Name (ARN) for the configuration data, in this account and region.
    id str
    The provider-assigned unique ID for this managed resource.
    configurationArn String
    The Amazon Resource Name (ARN) for the configuration data, in this account and region.
    id String
    The provider-assigned unique ID for this managed resource.

    Supporting Types

    HookTypeConfigConfigurationAlias, HookTypeConfigConfigurationAliasArgs

    Default
    default
    HookTypeConfigConfigurationAliasDefault
    default
    Default
    default
    Default
    default
    DEFAULT
    default
    "default"
    default

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    AWS Native is in preview. AWS Classic is fully supported.

    AWS Native v0.107.0 published on Wednesday, May 22, 2024 by Pulumi