Class CfnTypeActivation
A CloudFormation AWS::CloudFormation::TypeActivation
.
Inherited Members
Namespace: Amazon.CDK.AWS.CloudFormation
Assembly: Amazon.CDK.AWS.CloudFormation.dll
Syntax (csharp)
public class CfnTypeActivation : CfnResource, IConstruct, IDependable, IInspectable
Syntax (vb)
Public Class CfnTypeActivation
Inherits CfnResource
Implements IConstruct, IDependable, IInspectable
Remarks
Activates a public third-party extension, making it available for use in stack templates. For more information, see Using public extensions in the AWS 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 .
CloudformationResource: AWS::CloudFormation::TypeActivation
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.CloudFormation;
var cfnTypeActivation = new CfnTypeActivation(this, "MyCfnTypeActivation", new CfnTypeActivationProps {
AutoUpdate = false,
ExecutionRoleArn = "executionRoleArn",
LoggingConfig = new LoggingConfigProperty {
LogGroupName = "logGroupName",
LogRoleArn = "logRoleArn"
},
MajorVersion = "majorVersion",
PublicTypeArn = "publicTypeArn",
PublisherId = "publisherId",
Type = "type",
TypeName = "typeName",
TypeNameAlias = "typeNameAlias",
VersionBump = "versionBump"
});
Synopsis
Constructors
CfnTypeActivation(Construct, String, ICfnTypeActivationProps) | Create a new |
CfnTypeActivation(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnTypeActivation(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
Properties
AttrArn | The Amazon Resource Number (ARN) of the activated extension, in this account and Region. |
AutoUpdate | Whether to automatically update the extension in this account and Region when a new minor version is published by the extension publisher. |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
ExecutionRoleArn | The name of the IAM execution role to use to activate the extension. |
LoggingConfig | Specifies logging configuration information for an extension. |
MajorVersion | The major version of this extension you want to activate, if multiple major versions are available. |
PublicTypeArn | The Amazon Resource Number (ARN) of the public extension. |
PublisherId | The ID of the extension publisher. |
Type | The extension type. |
TypeName | The name of the extension. |
TypeNameAlias | An alias to assign to the public extension, in this account and Region. |
VersionBump | Manually updates a previously-activated type to a new major or minor version, if available. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnTypeActivation(Construct, String, ICfnTypeActivationProps)
Create a new AWS::CloudFormation::TypeActivation
.
public CfnTypeActivation(Construct scope, string id, ICfnTypeActivationProps props = null)
Parameters
- scope Construct
- scope in which this resource is defined.
- id System.String
- scoped id of the resource.
- props ICfnTypeActivationProps
- resource properties.
CfnTypeActivation(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnTypeActivation(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnTypeActivation(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnTypeActivation(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
Properties
AttrArn
The Amazon Resource Number (ARN) of the activated extension, in this account and Region.
public virtual string AttrArn { get; }
Property Value
System.String
Remarks
CloudformationAttribute: Arn
AutoUpdate
Whether to automatically update the extension in this account and Region when a new minor version is published by the extension publisher.
public virtual object AutoUpdate { get; set; }
Property Value
System.Object
Remarks
Major versions released by the publisher must be manually updated.
The default is true
.
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
ExecutionRoleArn
The name of the IAM execution role to use to activate the extension.
public virtual string ExecutionRoleArn { get; set; }
Property Value
System.String
Remarks
LoggingConfig
Specifies logging configuration information for an extension.
public virtual object LoggingConfig { get; set; }
Property Value
System.Object
Remarks
MajorVersion
The major version of this extension you want to activate, if multiple major versions are available.
public virtual string MajorVersion { get; set; }
Property Value
System.String
Remarks
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.
PublicTypeArn
The Amazon Resource Number (ARN) of the public extension.
public virtual string PublicTypeArn { get; set; }
Property Value
System.String
Remarks
Conditional: You must specify PublicTypeArn
, or TypeName
, Type
, and PublisherId
.
PublisherId
The ID of the extension publisher.
public virtual string PublisherId { get; set; }
Property Value
System.String
Remarks
Conditional: You must specify PublicTypeArn
, or TypeName
, Type
, and PublisherId
.
Type
The extension type.
public virtual string Type { get; set; }
Property Value
System.String
Remarks
Conditional: You must specify PublicTypeArn
, or TypeName
, Type
, and PublisherId
.
TypeName
The name of the extension.
public virtual string TypeName { get; set; }
Property Value
System.String
Remarks
Conditional: You must specify PublicTypeArn
, or TypeName
, Type
, and PublisherId
.
TypeNameAlias
An alias to assign to the public extension, in this account and Region.
public virtual string TypeNameAlias { get; set; }
Property Value
System.String
Remarks
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
Manually updates a previously-activated type to a new major or minor version, if available.
public virtual string VersionBump { get; set; }
Property Value
System.String
Remarks
You can also use this parameter to update the value of AutoUpdate
.
Methods
Inspect(TreeInspector)
Examines the CloudFormation resource and discloses attributes.
public virtual void Inspect(TreeInspector inspector)
Parameters
- inspector TreeInspector
- tree inspector to collect and process attributes.
RenderProperties(IDictionary<String, Object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>