Container for the parameters to the ActivateType operation. Activates a public third-party extension, making it available for use in stack templates. For more information, see Using public extensions in the CloudFormation User Guide.
Once you have activated a public third-party extension in your account and Region, use SetTypeConfiguration to specify configuration properties for the extension. For more information, see Configuring extensions at the account level in the CloudFormation User Guide.
Inheritance Hierarchy
Amazon.Runtime.AmazonWebServiceRequest
Amazon.CloudFormation.AmazonCloudFormationRequest
Amazon.CloudFormation.Model.ActivateTypeRequest
Namespace: Amazon.CloudFormation.Model
Assembly: AWSSDK.CloudFormation.dll
Version: 3.x.y.z
Syntax
public class ActivateTypeRequest : AmazonCloudFormationRequest IAmazonWebServiceRequest
The ActivateTypeRequest type exposes the following members
Constructors
| Name | Description | |
|---|---|---|
|
ActivateTypeRequest() |
Properties
| Name | Type | Description | |
|---|---|---|---|
|
|
AutoUpdate | System.Boolean |
Gets and sets the property AutoUpdate. 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.
The default is |
|
|
ExecutionRoleArn | System.String |
Gets and sets the property ExecutionRoleArn. The name of the IAM execution role to use to activate the extension. |
|
|
LoggingConfig | Amazon.CloudFormation.Model.LoggingConfig |
Gets and sets the property LoggingConfig. Contains logging configuration information for an extension. |
|
|
MajorVersion | System.Int64 |
Gets and sets the property MajorVersion. The major version of this extension you want to activate, if multiple major versions are available. The default is the latest major version. CloudFormation uses the latest available minor version of the major version selected.
You can specify |
|
|
PublicTypeArn | System.String |
Gets and sets the property PublicTypeArn. The Amazon Resource Name (ARN) of the public extension.
Conditional: You must specify |
|
|
PublisherId | System.String |
Gets and sets the property PublisherId. The ID of the extension publisher.
Conditional: You must specify |
|
|
Type | Amazon.CloudFormation.ThirdPartyType |
Gets and sets the property Type. The extension type.
Conditional: You must specify |
|
|
TypeName | System.String |
Gets and sets the property TypeName. The name of the extension.
Conditional: You must specify |
|
|
TypeNameAlias | System.String |
Gets and sets the property TypeNameAlias. An alias to assign to the public extension, in this account and Region. If you specify an alias for the extension, CloudFormation treats the alias as the extension type name within this account and Region. You must use the alias to refer to the extension in your templates, API calls, and CloudFormation console. An extension alias must be unique within a given account and Region. You can activate the same public resource multiple times in the same account and Region, using different type name aliases. |
|
|
VersionBump | Amazon.CloudFormation.VersionBump |
Gets and sets the property VersionBump.
Manually updates a previously-activated type to a new major or minor version, if available.
You can also use this parameter to update the value of
|
Version Information
.NET Core App:
Supported in: 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.5, 4.0, 3.5