We recommend new projects start with resources from the AWS provider.
aws-native.cloudformation.TypeActivation
Explore with Pulumi AI
We recommend new projects start with resources from the AWS provider.
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.
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
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
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.
- ExecutionRole stringArn 
- 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.Aws Native. Cloud Formation. Inputs. Type Activation Logging Config 
- Specifies logging configuration information for a type.
- MajorVersion string
- The Major Version of the type you want to enable
- PublicType stringArn 
- The Amazon Resource Number (ARN) assigned to the public extension upon publication
- PublisherId string
- The reserved publisher id for this type, or the publisher id assigned by CloudFormation for publishing in this region.
- Type
Pulumi.Aws Native. Cloud Formation. Type Activation Type 
- 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. 
- TypeName stringAlias 
- 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.Aws Native. Cloud Formation. Type Activation Version Bump 
- 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.
- ExecutionRole stringArn 
- 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 TypeActivation Logging Config Args 
- Specifies logging configuration information for a type.
- MajorVersion string
- The Major Version of the type you want to enable
- PublicType stringArn 
- The Amazon Resource Number (ARN) assigned to the public extension upon publication
- PublisherId string
- The reserved publisher id for this type, or the publisher id assigned by CloudFormation for publishing in this region.
- Type
TypeActivation Type 
- 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. 
- TypeName stringAlias 
- 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 TypeActivation Version Bump 
- 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.
- executionRole StringArn 
- 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 TypeActivation Logging Config 
- Specifies logging configuration information for a type.
- majorVersion String
- The Major Version of the type you want to enable
- publicType StringArn 
- The Amazon Resource Number (ARN) assigned to the public extension upon publication
- publisherId String
- The reserved publisher id for this type, or the publisher id assigned by CloudFormation for publishing in this region.
- type
TypeActivation Type 
- 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. 
- typeName StringAlias 
- 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 TypeActivation Version Bump 
- 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.
- executionRole stringArn 
- 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 TypeActivation Logging Config 
- Specifies logging configuration information for a type.
- majorVersion string
- The Major Version of the type you want to enable
- publicType stringArn 
- The Amazon Resource Number (ARN) assigned to the public extension upon publication
- publisherId string
- The reserved publisher id for this type, or the publisher id assigned by CloudFormation for publishing in this region.
- type
TypeActivation Type 
- 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. 
- typeName stringAlias 
- 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 TypeActivation Version Bump 
- 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_ strarn 
- 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 TypeActivation Logging Config Args 
- Specifies logging configuration information for a type.
- major_version str
- The Major Version of the type you want to enable
- public_type_ strarn 
- The Amazon Resource Number (ARN) assigned to the public extension upon publication
- publisher_id str
- The reserved publisher id for this type, or the publisher id assigned by CloudFormation for publishing in this region.
- type
TypeActivation Type 
- 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_ stralias 
- 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 TypeActivation Version Bump 
- 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.
- executionRole StringArn 
- 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
- publicType StringArn 
- The Amazon Resource Number (ARN) assigned to the public extension upon publication
- publisherId String
- The reserved publisher id for this type, or 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. 
- typeName StringAlias 
- 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:
Supporting Types
TypeActivationLoggingConfig, TypeActivationLoggingConfigArgs        
- LogGroup stringName 
- The Amazon CloudWatch log group to which CloudFormation sends error logging information when invoking the type's handlers.
- LogRole stringArn 
- The ARN of the role that CloudFormation should assume when sending log entries to CloudWatch logs.
- LogGroup stringName 
- The Amazon CloudWatch log group to which CloudFormation sends error logging information when invoking the type's handlers.
- LogRole stringArn 
- The ARN of the role that CloudFormation should assume when sending log entries to CloudWatch logs.
- logGroup StringName 
- The Amazon CloudWatch log group to which CloudFormation sends error logging information when invoking the type's handlers.
- logRole StringArn 
- The ARN of the role that CloudFormation should assume when sending log entries to CloudWatch logs.
- logGroup stringName 
- The Amazon CloudWatch log group to which CloudFormation sends error logging information when invoking the type's handlers.
- logRole stringArn 
- The ARN of the role that CloudFormation should assume when sending log entries to CloudWatch logs.
- log_group_ strname 
- The Amazon CloudWatch log group to which CloudFormation sends error logging information when invoking the type's handlers.
- log_role_ strarn 
- The ARN of the role that CloudFormation should assume when sending log entries to CloudWatch logs.
- logGroup StringName 
- The Amazon CloudWatch log group to which CloudFormation sends error logging information when invoking the type's handlers.
- logRole StringArn 
- The ARN of the role that CloudFormation should assume when sending log entries to CloudWatch logs.
TypeActivationType, TypeActivationTypeArgs      
- Resource
- RESOURCE
- Module
- MODULE
- Hook
- HOOK
- TypeActivation Type Resource 
- RESOURCE
- TypeActivation Type Module 
- MODULE
- TypeActivation Type Hook 
- 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
- TypeActivation Version Bump Major 
- MAJOR
- TypeActivation Version Bump Minor 
- 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
We recommend new projects start with resources from the AWS provider.