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

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.TypeActivation

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

    Enable a resource that has been published in the CloudFormation Registry.

    Create TypeActivation Resource

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

    Constructor syntax

    new TypeActivation(name: string, args?: TypeActivationArgs, opts?: CustomResourceOptions);
    @overload
    def TypeActivation(resource_name: str,
                       args: Optional[TypeActivationArgs] = None,
                       opts: Optional[ResourceOptions] = None)
    
    @overload
    def TypeActivation(resource_name: str,
                       opts: Optional[ResourceOptions] = None,
                       auto_update: Optional[bool] = None,
                       execution_role_arn: Optional[str] = None,
                       logging_config: Optional[TypeActivationLoggingConfigArgs] = None,
                       major_version: Optional[str] = None,
                       public_type_arn: Optional[str] = None,
                       publisher_id: Optional[str] = None,
                       type: Optional[TypeActivationType] = None,
                       type_name: Optional[str] = None,
                       type_name_alias: Optional[str] = None,
                       version_bump: Optional[TypeActivationVersionBump] = None)
    func NewTypeActivation(ctx *Context, name string, args *TypeActivationArgs, opts ...ResourceOption) (*TypeActivation, error)
    public TypeActivation(string name, TypeActivationArgs? args = null, CustomResourceOptions? opts = null)
    public TypeActivation(String name, TypeActivationArgs args)
    public TypeActivation(String name, TypeActivationArgs args, CustomResourceOptions options)
    
    type: aws-native:cloudformation:TypeActivation
    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 TypeActivationArgs
    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 TypeActivationArgs
    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 TypeActivationArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args TypeActivationArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args TypeActivationArgs
    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 typeActivationResource = new aws_native.cloudformation.TypeActivation("typeActivationResource", {
        autoUpdate: false,
        executionRoleArn: "string",
        loggingConfig: {
            logGroupName: "string",
            logRoleArn: "string",
        },
        majorVersion: "string",
        publicTypeArn: "string",
        publisherId: "string",
        type: aws_native.cloudformation.TypeActivationType.Resource,
        typeName: "string",
        typeNameAlias: "string",
        versionBump: aws_native.cloudformation.TypeActivationVersionBump.Major,
    });
    
    Coming soon!
    

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

    AutoUpdate bool
    Whether to automatically update the extension in this account and region when a new minor version is published by the extension publisher. Major versions released by the publisher must be manually updated.
    ExecutionRoleArn string
    The Amazon Resource Name (ARN) of the IAM execution role to use to register the type. If your resource type 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. CloudFormation then assumes that execution role to provide your resource type with the appropriate credentials.
    LoggingConfig Pulumi.AwsNative.CloudFormation.Inputs.TypeActivationLoggingConfig
    Specifies logging configuration information for a type.
    MajorVersion string
    The Major Version of the type you want to enable
    PublicTypeArn string
    The Amazon Resource Number (ARN) assigned to the public extension upon publication
    PublisherId string
    The publisher id assigned by CloudFormation for publishing in this region.
    Type Pulumi.AwsNative.CloudFormation.TypeActivationType
    The kind of extension
    TypeName string

    The name of the type being registered.

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

    TypeNameAlias string
    An alias to assign to the public extension in this account and region. If you specify an alias for the extension, you must then use the alias to refer to the extension in your templates.
    VersionBump Pulumi.AwsNative.CloudFormation.TypeActivationVersionBump
    Manually updates a previously-enabled type to a new major or minor version, if available. You can also use this parameter to update the value of AutoUpdateEnabled
    AutoUpdate bool
    Whether to automatically update the extension in this account and region when a new minor version is published by the extension publisher. Major versions released by the publisher must be manually updated.
    ExecutionRoleArn string
    The Amazon Resource Name (ARN) of the IAM execution role to use to register the type. If your resource type 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. CloudFormation then assumes that execution role to provide your resource type with the appropriate credentials.
    LoggingConfig TypeActivationLoggingConfigArgs
    Specifies logging configuration information for a type.
    MajorVersion string
    The Major Version of the type you want to enable
    PublicTypeArn string
    The Amazon Resource Number (ARN) assigned to the public extension upon publication
    PublisherId string
    The publisher id assigned by CloudFormation for publishing in this region.
    Type TypeActivationType
    The kind of extension
    TypeName string

    The name of the type being registered.

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

    TypeNameAlias string
    An alias to assign to the public extension in this account and region. If you specify an alias for the extension, you must then use the alias to refer to the extension in your templates.
    VersionBump TypeActivationVersionBump
    Manually updates a previously-enabled type to a new major or minor version, if available. You can also use this parameter to update the value of AutoUpdateEnabled
    autoUpdate Boolean
    Whether to automatically update the extension in this account and region when a new minor version is published by the extension publisher. Major versions released by the publisher must be manually updated.
    executionRoleArn String
    The Amazon Resource Name (ARN) of the IAM execution role to use to register the type. If your resource type 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. CloudFormation then assumes that execution role to provide your resource type with the appropriate credentials.
    loggingConfig TypeActivationLoggingConfig
    Specifies logging configuration information for a type.
    majorVersion String
    The Major Version of the type you want to enable
    publicTypeArn String
    The Amazon Resource Number (ARN) assigned to the public extension upon publication
    publisherId String
    The publisher id assigned by CloudFormation for publishing in this region.
    type TypeActivationType
    The kind of extension
    typeName String

    The name of the type being registered.

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

    typeNameAlias String
    An alias to assign to the public extension in this account and region. If you specify an alias for the extension, you must then use the alias to refer to the extension in your templates.
    versionBump TypeActivationVersionBump
    Manually updates a previously-enabled type to a new major or minor version, if available. You can also use this parameter to update the value of AutoUpdateEnabled
    autoUpdate boolean
    Whether to automatically update the extension in this account and region when a new minor version is published by the extension publisher. Major versions released by the publisher must be manually updated.
    executionRoleArn string
    The Amazon Resource Name (ARN) of the IAM execution role to use to register the type. If your resource type 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. CloudFormation then assumes that execution role to provide your resource type with the appropriate credentials.
    loggingConfig TypeActivationLoggingConfig
    Specifies logging configuration information for a type.
    majorVersion string
    The Major Version of the type you want to enable
    publicTypeArn string
    The Amazon Resource Number (ARN) assigned to the public extension upon publication
    publisherId string
    The publisher id assigned by CloudFormation for publishing in this region.
    type TypeActivationType
    The kind of extension
    typeName string

    The name of the type being registered.

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

    typeNameAlias string
    An alias to assign to the public extension in this account and region. If you specify an alias for the extension, you must then use the alias to refer to the extension in your templates.
    versionBump TypeActivationVersionBump
    Manually updates a previously-enabled type to a new major or minor version, if available. You can also use this parameter to update the value of AutoUpdateEnabled
    auto_update bool
    Whether to automatically update the extension in this account and region when a new minor version is published by the extension publisher. Major versions released by the publisher must be manually updated.
    execution_role_arn str
    The Amazon Resource Name (ARN) of the IAM execution role to use to register the type. If your resource type 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. CloudFormation then assumes that execution role to provide your resource type with the appropriate credentials.
    logging_config TypeActivationLoggingConfigArgs
    Specifies logging configuration information for a type.
    major_version str
    The Major Version of the type you want to enable
    public_type_arn str
    The Amazon Resource Number (ARN) assigned to the public extension upon publication
    publisher_id str
    The publisher id assigned by CloudFormation for publishing in this region.
    type TypeActivationType
    The kind of extension
    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.

    type_name_alias str
    An alias to assign to the public extension in this account and region. If you specify an alias for the extension, you must then use the alias to refer to the extension in your templates.
    version_bump TypeActivationVersionBump
    Manually updates a previously-enabled type to a new major or minor version, if available. You can also use this parameter to update the value of AutoUpdateEnabled
    autoUpdate Boolean
    Whether to automatically update the extension in this account and region when a new minor version is published by the extension publisher. Major versions released by the publisher must be manually updated.
    executionRoleArn String
    The Amazon Resource Name (ARN) of the IAM execution role to use to register the type. If your resource type 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. CloudFormation then assumes that execution role to provide your resource type with the appropriate credentials.
    loggingConfig Property Map
    Specifies logging configuration information for a type.
    majorVersion String
    The Major Version of the type you want to enable
    publicTypeArn String
    The Amazon Resource Number (ARN) assigned to the public extension upon publication
    publisherId String
    The publisher id assigned by CloudFormation for publishing in this region.
    type "RESOURCE" | "MODULE" | "HOOK"
    The kind of extension
    typeName String

    The name of the type being registered.

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

    typeNameAlias String
    An alias to assign to the public extension in this account and region. If you specify an alias for the extension, you must then use the alias to refer to the extension in your templates.
    versionBump "MAJOR" | "MINOR"
    Manually updates a previously-enabled type to a new major or minor version, if available. You can also use this parameter to update the value of AutoUpdateEnabled

    Outputs

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

    Arn string
    The Amazon Resource Name (ARN) of the extension.
    Id string
    The provider-assigned unique ID for this managed resource.
    Arn string
    The Amazon Resource Name (ARN) of the extension.
    Id string
    The provider-assigned unique ID for this managed resource.
    arn String
    The Amazon Resource Name (ARN) of the extension.
    id String
    The provider-assigned unique ID for this managed resource.
    arn string
    The Amazon Resource Name (ARN) of the extension.
    id string
    The provider-assigned unique ID for this managed resource.
    arn str
    The Amazon Resource Name (ARN) of the extension.
    id str
    The provider-assigned unique ID for this managed resource.
    arn String
    The Amazon Resource Name (ARN) of the extension.
    id String
    The provider-assigned unique ID for this managed resource.

    Supporting Types

    TypeActivationLoggingConfig, TypeActivationLoggingConfigArgs

    LogGroupName string
    The Amazon CloudWatch log group to which CloudFormation sends error logging information when invoking the type's handlers.
    LogRoleArn string
    The ARN of the role that CloudFormation should assume when sending log entries to CloudWatch logs.
    LogGroupName string
    The Amazon CloudWatch log group to which CloudFormation sends error logging information when invoking the type's handlers.
    LogRoleArn string
    The ARN of the role that CloudFormation should assume when sending log entries to CloudWatch logs.
    logGroupName String
    The Amazon CloudWatch log group to which CloudFormation sends error logging information when invoking the type's handlers.
    logRoleArn String
    The ARN of the role that CloudFormation should assume when sending log entries to CloudWatch logs.
    logGroupName string
    The Amazon CloudWatch log group to which CloudFormation sends error logging information when invoking the type's handlers.
    logRoleArn string
    The ARN of the role that CloudFormation should assume when sending log entries to CloudWatch logs.
    log_group_name str
    The Amazon CloudWatch log group to which CloudFormation sends error logging information when invoking the type's handlers.
    log_role_arn str
    The ARN of the role that CloudFormation should assume when sending log entries to CloudWatch logs.
    logGroupName String
    The Amazon CloudWatch log group to which CloudFormation sends error logging information when invoking the type's handlers.
    logRoleArn String
    The ARN of the role that CloudFormation should assume when sending log entries to CloudWatch logs.

    TypeActivationType, TypeActivationTypeArgs

    Resource
    RESOURCE
    Module
    MODULE
    Hook
    HOOK
    TypeActivationTypeResource
    RESOURCE
    TypeActivationTypeModule
    MODULE
    TypeActivationTypeHook
    HOOK
    Resource
    RESOURCE
    Module
    MODULE
    Hook
    HOOK
    Resource
    RESOURCE
    Module
    MODULE
    Hook
    HOOK
    RESOURCE
    RESOURCE
    MODULE
    MODULE
    HOOK
    HOOK
    "RESOURCE"
    RESOURCE
    "MODULE"
    MODULE
    "HOOK"
    HOOK

    TypeActivationVersionBump, TypeActivationVersionBumpArgs

    Major
    MAJOR
    Minor
    MINOR
    TypeActivationVersionBumpMajor
    MAJOR
    TypeActivationVersionBumpMinor
    MINOR
    Major
    MAJOR
    Minor
    MINOR
    Major
    MAJOR
    Minor
    MINOR
    MAJOR
    MAJOR
    MINOR
    MINOR
    "MAJOR"
    MAJOR
    "MINOR"
    MINOR

    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