Class CfnPublicTypeVersion

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

Inheritance
object
CfnElement
CfnRefElement
CfnResource
CfnPublicTypeVersion
Implements
IConstruct
IDependable
Inherited Members
Namespace: Amazon.CDK
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnPublicTypeVersion : CfnResource, IInspectable, IPublicTypeVersionRef, IConstruct, IDependable, IEnvironmentAware
Syntax (vb)
Public Class CfnPublicTypeVersion Inherits CfnResource Implements IInspectable, IPublicTypeVersionRef, IConstruct, IDependable, IEnvironmentAware
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 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 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(Construct, string, ICfnPublicTypeVersionProps?)

    Create a new AWS::CloudFormation::PublicTypeVersion.

    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

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

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

    A reference to a PublicTypeVersion resource.
    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.
    IsCfnPublicTypeVersion(object)

    Checks whether the given object is a CfnPublicTypeVersion.
    RenderProperties(IDictionary<string, object>)

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

    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

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

    props ICfnPublicTypeVersionProps

    Resource properties.

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

      Properties

      Arn

      The Amazon Resource Number (ARN) of the extension.

      public virtual string? Arn { get; set; }
      Property Value

      string

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

        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

        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

        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

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

          CfnProperties

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

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

          IDictionary<string, object>

          Overrides
          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 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 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

            LogDeliveryBucket

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

            public virtual string? LogDeliveryBucket { get; set; }
            Property Value

            string

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

              PublicTypeVersionRef

              A reference to a PublicTypeVersion resource.

              public virtual IPublicTypeVersionReference PublicTypeVersionRef { get; }
              Property Value

              IPublicTypeVersionReference

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

                PublicVersionNumber

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

                public virtual string? PublicVersionNumber { get; set; }
                Property Value

                string

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

                  Type

                  The type of the extension to test.

                  public virtual string? Type { get; set; }
                  Property Value

                  string

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

                    TypeName

                    The name of the extension to test.

                    public virtual string? TypeName { get; set; }
                    Property Value

                    string

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

                      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.

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

                        IsCfnPublicTypeVersion(object)

                        Checks whether the given object is a CfnPublicTypeVersion.

                        public static bool IsCfnPublicTypeVersion(object x)
                        Parameters
                        x object
                        Returns

                        bool

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

                          RenderProperties(IDictionary<string, object>)

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

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

                          IDictionary<string, object>

                          Overrides
                          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 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 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

                            Implements

                            Constructs.IConstruct
                            Constructs.IDependable