Class CfnPublicTypeVersion

The AWS::CloudFormation::PublicTypeVersion resource tests and publishes a registered extension as a public, third-party extension.

Inheritance

System.Object

CfnElement

CfnRefElement

CfnResource

CfnPublicTypeVersion

Implements

IInspectable

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(Nullable<RemovalPolicy>, IRemovalPolicyOptions)

CfnResource.GetAtt(String, Nullable<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.UpdatedProperites

CfnResource.UpdatedProperties

CfnRefElement.Ref

CfnElement.IsCfnElement(Object)

CfnElement.OverrideLogicalId(String)

CfnElement.CreationStack

CfnElement.LogicalId

CfnElement.Stack

Namespace: Amazon.CDK

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnPublicTypeVersion : CfnResource, IInspectable

Syntax (vb)

Public Class CfnPublicTypeVersion
    Inherits CfnResource
    Implements IInspectable

Remarks

CloudFormation first tests the extension to make sure it meets all necessary requirements for being published in the CloudFormation registry. If it does, CloudFormation then publishes it to the registry as a public third-party extension in this Region. Public extensions are available for use by all CloudFormation users.

For more information, see Testing your public extension prior to publishing in the AWS CloudFormation Command Line Interface (CLI) User Guide .

If you don't specify a version, CloudFormation uses the default version of the extension in your account and Region for testing.

To perform testing, CloudFormation assumes the execution role specified when the type was registered.

An extension must have a test status of PASSED before it can be published. For more information, see Publishing extensions to make them available for public use in the AWS CloudFormation Command Line Interface (CLI) User Guide .

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

CloudformationResource: AWS::CloudFormation::PublicTypeVersion

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 cfnPublicTypeVersion = new CfnPublicTypeVersion(this, "MyCfnPublicTypeVersion", new CfnPublicTypeVersionProps {
    Arn = "arn",
    LogDeliveryBucket = "logDeliveryBucket",
    PublicVersionNumber = "publicVersionNumber",
    Type = "type",
    TypeName = "typeName"
});

Synopsis

Constructors

CfnPublicTypeVersion(ByRefValue)	Used by jsii to construct an instance of this class from a Javascript-owned object reference
CfnPublicTypeVersion(DeputyBase.DeputyProps)	Used by jsii to construct an instance of this class from DeputyProps
CfnPublicTypeVersion(Construct, String, ICfnPublicTypeVersionProps)

Properties

Arn	The Amazon Resource Number (ARN) of the extension.
AttrPublicTypeArn	The Amazon Resource Number (ARN) assigned to the public extension upon publication.
AttrPublisherId	The publisher ID of the extension publisher.
AttrTypeVersionArn	The Amazon Resource Number (ARN) assigned to this version of the extension.
CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.
CfnProperties
LogDeliveryBucket	The S3 bucket to which CloudFormation delivers the contract test execution logs.
PublicVersionNumber	The version number to assign to this version of the extension.
Type	The type of the extension to test.
TypeName	The name of the extension to test.

Methods

Inspect(TreeInspector)	Examines the CloudFormation resource and discloses attributes.
RenderProperties(IDictionary<String, Object>)

Constructors

CfnPublicTypeVersion(ByRefValue)

Used by jsii to construct an instance of this class from a Javascript-owned object reference

protected CfnPublicTypeVersion(ByRefValue reference)

Parameters

reference Amazon.JSII.Runtime.Deputy.ByRefValue: The Javascript-owned object reference

CfnPublicTypeVersion(DeputyBase.DeputyProps)

Used by jsii to construct an instance of this class from DeputyProps

protected CfnPublicTypeVersion(DeputyBase.DeputyProps props)

Parameters

props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps: The deputy props

CfnPublicTypeVersion(Construct, String, ICfnPublicTypeVersionProps)

public CfnPublicTypeVersion(Construct scope, string id, ICfnPublicTypeVersionProps 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 ICfnPublicTypeVersionProps: Resource properties.

Properties

Arn

The Amazon Resource Number (ARN) of the extension.

public virtual string Arn { get; set; }

Property Value

System.String

AttrPublicTypeArn

The Amazon Resource Number (ARN) assigned to the public extension upon publication.

public virtual string AttrPublicTypeArn { get; }

Property Value

System.String

Remarks

CloudformationAttribute: PublicTypeArn

AttrPublisherId

The publisher ID of the extension publisher.

public virtual string AttrPublisherId { get; }

Property Value

System.String

Remarks

This applies only to public third-party extensions. For private registered extensions, and extensions provided by AWS , CloudFormation returns null .

CloudformationAttribute: PublisherId

AttrTypeVersionArn

The Amazon Resource Number (ARN) assigned to this version of the extension.

public virtual string AttrTypeVersionArn { get; }

Property Value

System.String

Remarks

CloudformationAttribute: TypeVersionArn

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

CfnResource.CfnProperties

LogDeliveryBucket

The S3 bucket to which CloudFormation delivers the contract test execution logs.

public virtual string LogDeliveryBucket { get; set; }

Property Value

System.String

PublicVersionNumber

The version number to assign to this version of the extension.

public virtual string PublicVersionNumber { get; set; }

Property Value

System.String

Type

The type of the extension to test.

public virtual string Type { get; set; }

Property Value

System.String

TypeName

The name of the extension to test.

public virtual string TypeName { 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>

Overrides

CfnResource.RenderProperties(IDictionary<String, Object>)

Implements

IInspectable