Class CfnTypeActivation

The AWS::CloudFormation::TypeActivation resource activates a public third-party extension, making it available for use in stack templates.

Inheritance

object

CfnElement

CfnRefElement

CfnResource

CfnTypeActivation

Implements

IInspectable

ITypeActivationRef

IConstruct

IDependable

IEnvironmentAware

Inherited Members

CfnResource.IsCfnResource(object)

CfnResource.AddDeletionOverride(string)

CfnResource.AddDependency(CfnResource)

CfnResource.AddDependsOn(CfnResource)

CfnResource.AddMetadata(string, object)

CfnResource.AddOverride(string, object)

CfnResource.AddPropertyDeletionOverride(string)

CfnResource.AddPropertyOverride(string, object)

CfnResource.ApplyRemovalPolicy(RemovalPolicy?, IRemovalPolicyOptions)

CfnResource.GetAtt(string, ResolutionTypeHint?)

CfnResource.GetMetadata(string)

CfnResource.ObtainDependencies()

CfnResource.ObtainResourceDependencies()

CfnResource.RemoveDependency(CfnResource)

CfnResource.ReplaceDependency(CfnResource, CfnResource)

CfnResource.ShouldSynthesize()

CfnResource.ToString()

CfnResource.ValidateProperties(object)

CfnResource.CfnOptions

CfnResource.CfnResourceType

CfnResource.Env

CfnResource.UpdatedProperites

CfnResource.UpdatedProperties

CfnRefElement.Ref

CfnElement.IsCfnElement(object)

CfnElement.OverrideLogicalId(string)

CfnElement.CreationStack

CfnElement.LogicalId

CfnElement.Stack

Namespace: Amazon.CDK.AWS.CloudFormation

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnTypeActivation : CfnResource, IInspectable, ITypeActivationRef, IConstruct, IDependable, IEnvironmentAware

Syntax (vb)

Public Class CfnTypeActivation Inherits CfnResource Implements IInspectable, ITypeActivationRef, IConstruct, IDependable, IEnvironmentAware

Remarks

For information about the CloudFormation registry, see Managing extensions with the CloudFormation registry in the CloudFormation User Guide .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-typeactivation.html

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 AWS::CloudFormation::TypeActivation.

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	The AWS::CloudFormation::TypeActivation resource activates a public third-party extension, making it available for use in stack templates.
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.
TypeActivationRef	A reference to a TypeActivation resource.
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

ArnForTypeActivation(ITypeActivationRef)	The AWS::CloudFormation::TypeActivation resource activates a public third-party extension, making it available for use in stack templates.
Inspect(TreeInspector)	Examines the CloudFormation resource and discloses attributes.
IsCfnTypeActivation(object)	Checks whether the given object is a CfnTypeActivation.
RenderProperties(IDictionary<string, object>)	The AWS::CloudFormation::TypeActivation resource activates a public third-party extension, making it available for use in stack templates.

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 string

Construct identifier for this resource (unique in its scope).

props ICfnTypeActivationProps

Resource properties.

Remarks

For information about the CloudFormation registry, see Managing extensions with the CloudFormation registry in the CloudFormation User Guide .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-typeactivation.html

CloudformationResource: AWS::CloudFormation::TypeActivation

ExampleMetadata: fixture=_generated

Properties

AttrArn

The Amazon Resource Name (ARN) of the activated extension in this account and Region.

public virtual string AttrArn { get; }

Property Value

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

object

Remarks

Type union: either bool or IResolvable

CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

public static string CFN_RESOURCE_TYPE_NAME { get; }

Property Value

string

Remarks

For information about the CloudFormation registry, see Managing extensions with the CloudFormation registry in the CloudFormation User Guide .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-typeactivation.html

CloudformationResource: AWS::CloudFormation::TypeActivation

ExampleMetadata: fixture=_generated

CfnProperties

The AWS::CloudFormation::TypeActivation resource activates a public third-party extension, making it available for use in stack templates.

protected override IDictionary<string, object> CfnProperties { get; }

Property Value

IDictionary<string, object>

Overrides

CfnResource.CfnProperties

Remarks

For information about the CloudFormation registry, see Managing extensions with the CloudFormation registry in the CloudFormation User Guide .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-typeactivation.html

CloudformationResource: AWS::CloudFormation::TypeActivation

ExampleMetadata: fixture=_generated

ExecutionRoleArn

The name of the IAM execution role to use to activate the extension.

public virtual string? ExecutionRoleArn { get; set; }

Property Value

string

Remarks

For information about the CloudFormation registry, see Managing extensions with the CloudFormation registry in the CloudFormation User Guide .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-typeactivation.html

CloudformationResource: AWS::CloudFormation::TypeActivation

ExampleMetadata: fixture=_generated

LoggingConfig

Specifies logging configuration information for an extension.

public virtual object? LoggingConfig { get; set; }

Property Value

object

Remarks

Type union: either IResolvable or CfnTypeActivation.ILoggingConfigProperty

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

string

Remarks

For information about the CloudFormation registry, see Managing extensions with the CloudFormation registry in the CloudFormation User Guide .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-typeactivation.html

CloudformationResource: AWS::CloudFormation::TypeActivation

ExampleMetadata: fixture=_generated

PublicTypeArn

The Amazon Resource Number (ARN) of the public extension.

public virtual string? PublicTypeArn { get; set; }

Property Value

string

Remarks

For information about the CloudFormation registry, see Managing extensions with the CloudFormation registry in the CloudFormation User Guide .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-typeactivation.html

CloudformationResource: AWS::CloudFormation::TypeActivation

ExampleMetadata: fixture=_generated

PublisherId

The ID of the extension publisher.

public virtual string? PublisherId { get; set; }

Property Value

string

Remarks

For information about the CloudFormation registry, see Managing extensions with the CloudFormation registry in the CloudFormation User Guide .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-typeactivation.html

CloudformationResource: AWS::CloudFormation::TypeActivation

ExampleMetadata: fixture=_generated

Type

The extension type.

public virtual string? Type { get; set; }

Property Value

string

Remarks

For information about the CloudFormation registry, see Managing extensions with the CloudFormation registry in the CloudFormation User Guide .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-typeactivation.html

CloudformationResource: AWS::CloudFormation::TypeActivation

ExampleMetadata: fixture=_generated

TypeActivationRef

A reference to a TypeActivation resource.

public virtual ITypeActivationReference TypeActivationRef { get; }

Property Value

ITypeActivationReference

Remarks

For information about the CloudFormation registry, see Managing extensions with the CloudFormation registry in the CloudFormation User Guide .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-typeactivation.html

CloudformationResource: AWS::CloudFormation::TypeActivation

ExampleMetadata: fixture=_generated

TypeName

The name of the extension.

public virtual string? TypeName { get; set; }

Property Value

string

Remarks

For information about the CloudFormation registry, see Managing extensions with the CloudFormation registry in the CloudFormation User Guide .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-typeactivation.html

CloudformationResource: AWS::CloudFormation::TypeActivation

ExampleMetadata: fixture=_generated

TypeNameAlias

An alias to assign to the public extension in this account and Region.

public virtual string? TypeNameAlias { get; set; }

Property Value

string

Remarks

For information about the CloudFormation registry, see Managing extensions with the CloudFormation registry in the CloudFormation User Guide .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-typeactivation.html

CloudformationResource: AWS::CloudFormation::TypeActivation

ExampleMetadata: fixture=_generated

VersionBump

Manually updates a previously-activated type to a new major or minor version, if available.

public virtual string? VersionBump { get; set; }

Property Value

string

Remarks

For information about the CloudFormation registry, see Managing extensions with the CloudFormation registry in the CloudFormation User Guide .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-typeactivation.html

CloudformationResource: AWS::CloudFormation::TypeActivation

ExampleMetadata: fixture=_generated

Methods

ArnForTypeActivation(ITypeActivationRef)

The AWS::CloudFormation::TypeActivation resource activates a public third-party extension, making it available for use in stack templates.

public static string ArnForTypeActivation(ITypeActivationRef resource)

Parameters

resource ITypeActivationRef

Returns

string

Remarks

For information about the CloudFormation registry, see Managing extensions with the CloudFormation registry in the CloudFormation User Guide .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-typeactivation.html

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"
             });

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.

Remarks

For information about the CloudFormation registry, see Managing extensions with the CloudFormation registry in the CloudFormation User Guide .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-typeactivation.html

CloudformationResource: AWS::CloudFormation::TypeActivation

ExampleMetadata: fixture=_generated

IsCfnTypeActivation(object)

Checks whether the given object is a CfnTypeActivation.

public static bool IsCfnTypeActivation(object x)

Parameters

x object

Returns

bool

Remarks

For information about the CloudFormation registry, see Managing extensions with the CloudFormation registry in the CloudFormation User Guide .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-typeactivation.html

CloudformationResource: AWS::CloudFormation::TypeActivation

ExampleMetadata: fixture=_generated

RenderProperties(IDictionary<string, object>)

The AWS::CloudFormation::TypeActivation resource activates a public third-party extension, making it available for use in stack templates.

protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)

Parameters

props IDictionary<string, object>

Returns

IDictionary<string, object>

Overrides

CfnResource.RenderProperties(IDictionary<string, object>)

Remarks

For information about the CloudFormation registry, see Managing extensions with the CloudFormation registry in the CloudFormation User Guide .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-typeactivation.html

CloudformationResource: AWS::CloudFormation::TypeActivation

ExampleMetadata: fixture=_generated

Implements

IInspectable

ITypeActivationRef

Constructs.IConstruct

Constructs.IDependable

IEnvironmentAware