Table of Contents

Class CfnPublicTypeVersion

Namespace
Amazon.CDK
Assembly
Amazon.CDK.dll

A CloudFormation AWS::CloudFormation::PublicTypeVersion.

public class CfnPublicTypeVersion : CfnResource, IConstruct, IConstruct, IDependable, IInspectable
Inheritance
CfnPublicTypeVersion
Implements
IConstruct
Inherited Members

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

Remarks

Tests and publishes a registered extension as a public, third-party extension.

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 CloudFormation 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 CloudFormation CLI User Guide .

    CloudformationResource: AWS::CloudFormation::PublicTypeVersion

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

    ExampleMetadata: fixture=_generated

    Constructors

    CfnPublicTypeVersion(Construct, string, ICfnPublicTypeVersionProps?)

    Create a new AWS::CloudFormation::PublicTypeVersion.

    public CfnPublicTypeVersion(Construct scope, string id, ICfnPublicTypeVersionProps? props = null)

    Parameters

    scope Construct
    • scope in which this resource is defined.
    id string
    • scoped id of the resource.
    props ICfnPublicTypeVersionProps
    • resource properties.

    Properties

    Arn

    The Amazon Resource Number (ARN) of the extension.

    public virtual string? Arn { get; set; }

    Property Value

    string

    Remarks

    Conditional: You must specify Arn , or TypeName and Type .

    Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-publictypeversion.html#cfn-cloudformation-publictypeversion-arn

    AttrPublicTypeArn

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

    public virtual string AttrPublicTypeArn { get; }

    Property Value

    string

    Remarks

    CloudformationAttribute: PublicTypeArn

    AttrPublisherId

    The publisher ID of the extension publisher.

    public virtual string AttrPublisherId { get; }

    Property Value

    string

    Remarks

    CloudformationAttribute: PublisherId

    AttrTypeVersionArn

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

    public virtual string AttrTypeVersionArn { get; }

    Property Value

    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

    string

    CfnProperties 

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

    Property Value

    IDictionary<string, object>

    LogDeliveryBucket

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

    public virtual string? LogDeliveryBucket { get; set; }

    Property Value

    string

    Remarks

    CloudFormation delivers the logs by the time contract testing has completed and the extension has been assigned a test type status of PASSED or FAILED .

    The user initiating the stack operation must be able to access items in the specified S3 bucket. Specifically, the user needs the following permissions:

      For more information, see Actions, Resources, and Condition Keys for Amazon S3 in the AWS Identity and Access Management User Guide .

      Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-publictypeversion.html#cfn-cloudformation-publictypeversion-logdeliverybucket

      PublicVersionNumber

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

      public virtual string? PublicVersionNumber { get; set; }

      Property Value

      string

      Remarks

      Use the following format, and adhere to semantic versioning when assigning a version number to your extension:

      MAJOR.MINOR.PATCH

      For more information, see Semantic Versioning 2.0.0 .

      If you don't specify a version number, CloudFormation increments the version number by one minor version release.

      You cannot specify a version number the first time you publish a type. AWS CloudFormation automatically sets the first version number to be 1.0.0 .

      Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-publictypeversion.html#cfn-cloudformation-publictypeversion-publicversionnumber

      Type

      The type of the extension to test.

      public virtual string? Type { get; set; }

      Property Value

      string

      Remarks

      Conditional: You must specify Arn , or TypeName and Type .

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

      TypeName

      The name of the extension to test.

      public virtual string? TypeName { get; set; }

      Property Value

      string

      Remarks

      Conditional: You must specify Arn , or TypeName and Type .

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

      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 IDictionary<string, object>

      Returns

      IDictionary<string, object>