Class CfnTypeActivationProps

Properties for defining a CfnTypeActivation.

Inheritance

object

CfnTypeActivationProps

Implements

ICfnTypeActivationProps

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Amazon.CDK

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnTypeActivationProps : ICfnTypeActivationProps

Syntax (vb)

Public Class CfnTypeActivationProps Implements ICfnTypeActivationProps

Remarks

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

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 cfnTypeActivationProps = 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

CfnTypeActivationProps()

Properties for defining a CfnTypeActivation.

Properties

AutoUpdate	Whether to automatically update the extension in this account and Region when a new minor version is published by the extension publisher.
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.

Constructors

CfnTypeActivationProps()

Properties for defining a CfnTypeActivation.

public CfnTypeActivationProps()

Remarks

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

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 cfnTypeActivationProps = 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"
             };

Properties

AutoUpdate

Whether to automatically update the extension in this account and Region when a new minor version is published by the extension publisher.

public object? AutoUpdate { get; set; }

Property Value

object

Remarks

Major versions released by the publisher must be manually updated.

The default is true .

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

Type union: either bool or IResolvable

ExecutionRoleArn

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

public string? ExecutionRoleArn { get; set; }

Property Value

string

Remarks

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

LoggingConfig

Specifies logging configuration information for an extension.

public object? LoggingConfig { get; set; }

Property Value

object

Remarks

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

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 string? MajorVersion { get; set; }

Property Value

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.

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

PublicTypeArn

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

public string? PublicTypeArn { get; set; }

Property Value

string

Remarks

Conditional: You must specify PublicTypeArn , or TypeName , Type , and PublisherId .

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

PublisherId

The ID of the extension publisher.

public string? PublisherId { get; set; }

Property Value

string

Remarks

Conditional: You must specify PublicTypeArn , or TypeName , Type , and PublisherId .

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

Type

The extension type.

public string? Type { get; set; }

Property Value

string

Remarks

Conditional: You must specify PublicTypeArn , or TypeName , Type , and PublisherId .

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

TypeName

The name of the extension.

public string? TypeName { get; set; }

Property Value

string

Remarks

Conditional: You must specify PublicTypeArn , or TypeName , Type , and PublisherId .

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

TypeNameAlias

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

public string? TypeNameAlias { get; set; }

Property Value

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.

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

VersionBump

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

public string? VersionBump { get; set; }

Property Value

string

Remarks

You can also use this parameter to update the value of AutoUpdate .

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

Implements

ICfnTypeActivationProps