Class CfnTypeActivation
The AWS::CloudFormation::TypeActivation
resource activates a public third-party extension, making it available for use in stack templates.
Implements
Inherited Members
Namespace: Amazon.CDK
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnTypeActivation : CfnResource, IInspectable
Syntax (vb)
Public Class CfnTypeActivation
Inherits CfnResource
Implements IInspectable
Remarks
For information about the CloudFormation registry, see Managing extensions with the CloudFormation registry in the AWS 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;
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(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 |
CfnTypeActivation(Construct, String, ICfnTypeActivationProps) |
Properties
AttrArn | The Amazon Resource Name (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(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
CfnTypeActivation(Construct, String, ICfnTypeActivationProps)
public CfnTypeActivation(Construct scope, string id, ICfnTypeActivationProps props = null)
Parameters
- scope Constructs.Construct
Scope in which this resource is defined.
- id System.String
Construct identifier for this resource (unique in its scope).
- props ICfnTypeActivationProps
Resource properties.
Properties
AttrArn
The Amazon Resource Name (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
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
LoggingConfig
Specifies logging configuration information for an extension.
public virtual object LoggingConfig { get; set; }
Property Value
System.Object
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
PublicTypeArn
The Amazon Resource Number (ARN) of the public extension.
public virtual string PublicTypeArn { get; set; }
Property Value
System.String
PublisherId
The ID of the extension publisher.
public virtual string PublisherId { get; set; }
Property Value
System.String
Type
The extension type.
public virtual string Type { get; set; }
Property Value
System.String
TypeName
The name of the extension.
public virtual string TypeName { get; set; }
Property Value
System.String
TypeNameAlias
An alias to assign to the public extension, in this account and Region.
public virtual string TypeNameAlias { get; set; }
Property Value
System.String
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
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>