AWS Tools for Windows PowerShell
Command Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Synopsis

Calls the AWS CloudFormation ActivateType API operation.

Syntax

Enable-CFNType
-AutoUpdate <Boolean>
-ExecutionRoleArn <String>
-LoggingConfig_LogGroupName <String>
-LoggingConfig_LogRoleArn <String>
-MajorVersion <Int64>
-PublicTypeArn <String>
-PublisherId <String>
-Type <ThirdPartyType>
-TypeName <String>
-TypeNameAlias <String>
-VersionBump <VersionBump>
-Select <String>

Description

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.

Parameters

-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.The default is true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ExecutionRoleArn <String>
The name of the IAM execution role to use to activate the extension.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-LoggingConfig_LogGroupName <String>
The Amazon CloudWatch Logs group to which CloudFormation sends error logging information when invoking the extension's handlers.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-LoggingConfig_LogRoleArn <String>
The Amazon Resource Name (ARN) of the role that CloudFormation should assume when sending log entries to CloudWatch Logs.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-MajorVersion <Int64>
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 MajorVersion or VersionBump, but not both.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-PublicTypeArn <String>
The Amazon Resource Number (ARN) of the public extension.Conditional: You must specify PublicTypeArn, or TypeName, Type, and PublisherId.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-PublisherId <String>
The ID of the extension publisher.Conditional: You must specify PublicTypeArn, or TypeName, Type, and PublisherId.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Select <String>
Use the -Select parameter to control the cmdlet output. The default value is 'Arn'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudFormation.Model.ActivateTypeResponse). Specifying the name of a property of type Amazon.CloudFormation.Model.ActivateTypeResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
The extension type.Conditional: You must specify PublicTypeArn, or TypeName, Type, and PublisherId.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-TypeName <String>
The name of the extension.Conditional: You must specify PublicTypeArn, or TypeName, Type, and PublisherId.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-TypeNameAlias <String>
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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-VersionBump <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 AutoUpdate.
  • MAJOR: CloudFormation updates the extension to the newest major version, if one is available.
  • MINOR: CloudFormation updates the extension to the newest minor version, if one is available.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)

Common Credential and Region Parameters

-AccessKey <String>
The AWS access key for the user account. This can be a temporary access key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAK
-Credential <AWSCredentials>
An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-EndpointUrl <String>
The endpoint to make the call against.Note: This parameter is primarily for internal AWS use and is not required/should not be specified for normal usage. The cmdlets normally determine which endpoint to call based on the region specified to the -Region parameter or set as default in the shell (via Set-DefaultAWSRegion). Only specify this parameter if you must direct the call to a specific custom endpoint.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-NetworkCredential <PSCredential>
Used with SAML-based authentication when ProfileName references a SAML role profile. Contains the network credentials to be supplied during authentication with the configured identity provider's endpoint. This parameter is not required if the user's default network identity can or should be used during authentication.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-ProfileLocation <String>
Used to specify the name and location of the ini-format credential file (shared with the AWS CLI and other AWS SDKs)If this optional parameter is omitted this cmdlet will search the encrypted credential file used by the AWS SDK for .NET and AWS Toolkit for Visual Studio first. If the profile is not found then the cmdlet will search in the ini-format credential file at the default location: (user's home directory)\.aws\credentials.If this parameter is specified then this cmdlet will only search the ini-format credential file at the location given.As the current folder can vary in a shell or during script execution it is advised that you use specify a fully qualified path instead of a relative path.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAWSProfilesLocation, ProfilesLocation
-ProfileName <String>
The user-defined name of an AWS credentials or SAML-based role profile containing credential information. The profile is expected to be found in the secure credential file shared with the AWS SDK for .NET and AWS Toolkit for Visual Studio. You can also specify the name of a profile stored in the .ini-format credential file used with the AWS CLI and other AWS SDKs.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesStoredCredentials, AWSProfileName
-Region <Object>
The system name of an AWS region or an AWSRegion instance. This governs the endpoint that will be used when calling service operations. Note that the AWS resources referenced in a call are usually region-specific.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesRegionToCall
-SecretKey <String>
The AWS secret key for the user account. This can be a temporary secret key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSK, SecretAccessKey
-SessionToken <String>
The session token if the access and secret keys are temporary session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesST

Outputs

This cmdlet returns a System.String object. The service call response (type Amazon.CloudFormation.Model.ActivateTypeResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.

Supported Version

AWS Tools for PowerShell: 2.x.y.z