Class CfnPublicTypeVersion
- All Implemented Interfaces:
IConstruct
,IDependable
,IInspectable
,software.amazon.jsii.JsiiSerializable
,software.constructs.IConstruct
AWS::CloudFormation::PublicTypeVersion
.
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 resource types, testing includes passing all contracts tests defined for the type.
- For modules, testing includes determining if the module's model meets all necessary requirements.
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 .
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import software.amazon.awscdk.core.*; CfnPublicTypeVersion cfnPublicTypeVersion = CfnPublicTypeVersion.Builder.create(this, "MyCfnPublicTypeVersion") .arn("arn") .logDeliveryBucket("logDeliveryBucket") .publicVersionNumber("publicVersionNumber") .type("type") .typeName("typeName") .build();
-
Nested Class Summary
Nested ClassesNested classes/interfaces inherited from class software.amazon.jsii.JsiiObject
software.amazon.jsii.JsiiObject.InitializationMode
Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct
IConstruct.Jsii$Default
Nested classes/interfaces inherited from interface software.constructs.IConstruct
software.constructs.IConstruct.Jsii$Default
Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IInspectable
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final String
The CloudFormation resource type name for this resource class. -
Constructor Summary
ConstructorsModifierConstructorDescriptionCfnPublicTypeVersion
(Construct scope, String id) Create a newAWS::CloudFormation::PublicTypeVersion
.CfnPublicTypeVersion
(Construct scope, String id, CfnPublicTypeVersionProps props) Create a newAWS::CloudFormation::PublicTypeVersion
.protected
CfnPublicTypeVersion
(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) protected
CfnPublicTypeVersion
(software.amazon.jsii.JsiiObjectRef objRef) -
Method Summary
Modifier and TypeMethodDescriptiongetArn()
The Amazon Resource Number (ARN) of the extension.The Amazon Resource Number (ARN) assigned to the public extension upon publication.The publisher ID of the extension publisher.The Amazon Resource Number (ARN) assigned to this version of the extension.The S3 bucket to which CloudFormation delivers the contract test execution logs.The version number to assign to this version of the extension.getType()
The type of the extension to test.The name of the extension to test.void
inspect
(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.renderProperties
(Map<String, Object> props) void
The Amazon Resource Number (ARN) of the extension.void
setLogDeliveryBucket
(String value) The S3 bucket to which CloudFormation delivers the contract test execution logs.void
setPublicVersionNumber
(String value) The version number to assign to this version of the extension.void
The type of the extension to test.void
setTypeName
(String value) The name of the extension to test.Methods inherited from class software.amazon.awscdk.core.CfnResource
addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties
Methods inherited from class software.amazon.awscdk.core.CfnRefElement
getRef
Methods inherited from class software.amazon.awscdk.core.CfnElement
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId
Methods inherited from class software.amazon.awscdk.core.Construct
getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate
Methods inherited from class software.amazon.jsii.JsiiObject
jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Field Details
-
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
-
-
Constructor Details
-
CfnPublicTypeVersion
protected CfnPublicTypeVersion(software.amazon.jsii.JsiiObjectRef objRef) -
CfnPublicTypeVersion
protected CfnPublicTypeVersion(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) -
CfnPublicTypeVersion
@Stability(Stable) public CfnPublicTypeVersion(@NotNull Construct scope, @NotNull String id, @Nullable CfnPublicTypeVersionProps props) Create a newAWS::CloudFormation::PublicTypeVersion
.- Parameters:
scope
-- scope in which this resource is defined.
id
-- scoped id of the resource.
props
-- resource properties.
-
CfnPublicTypeVersion
Create a newAWS::CloudFormation::PublicTypeVersion
.- Parameters:
scope
-- scope in which this resource is defined.
id
-- scoped id of the resource.
-
-
Method Details
-
inspect
Examines the CloudFormation resource and discloses attributes.- Specified by:
inspect
in interfaceIInspectable
- Parameters:
inspector
-- tree inspector to collect and process attributes.
-
renderProperties
@Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String, Object> props) - Overrides:
renderProperties
in classCfnResource
- Parameters:
props
- This parameter is required.
-
getAttrPublicTypeArn
The Amazon Resource Number (ARN) assigned to the public extension upon publication. -
getAttrPublisherId
The publisher ID of the extension publisher. -
getAttrTypeVersionArn
The Amazon Resource Number (ARN) assigned to this version of the extension. -
getCfnProperties
- Overrides:
getCfnProperties
in classCfnResource
-
getArn
The Amazon Resource Number (ARN) of the extension.Conditional: You must specify
Arn
, orTypeName
andType
. -
setArn
The Amazon Resource Number (ARN) of the extension.Conditional: You must specify
Arn
, orTypeName
andType
. -
getLogDeliveryBucket
The S3 bucket to which CloudFormation delivers the contract test execution logs.CloudFormation delivers the logs by the time contract testing has completed and the extension has been assigned a test type status of
PASSED
orFAILED
.The user initiating the stack operation must be able to access items in the specified S3 bucket. Specifically, the user needs the following permissions:
- GetObject
- PutObject
For more information, see Actions, Resources, and Condition Keys for Amazon S3 in the AWS Identity and Access Management User Guide .
-
setLogDeliveryBucket
The S3 bucket to which CloudFormation delivers the contract test execution logs.CloudFormation delivers the logs by the time contract testing has completed and the extension has been assigned a test type status of
PASSED
orFAILED
.The user initiating the stack operation must be able to access items in the specified S3 bucket. Specifically, the user needs the following permissions:
- GetObject
- PutObject
For more information, see Actions, Resources, and Condition Keys for Amazon S3 in the AWS Identity and Access Management User Guide .
-
getPublicVersionNumber
The version number to assign to this version of the extension.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
. -
setPublicVersionNumber
The version number to assign to this version of the extension.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
. -
getType
The type of the extension to test.Conditional: You must specify
Arn
, orTypeName
andType
. -
setType
The type of the extension to test.Conditional: You must specify
Arn
, orTypeName
andType
. -
getTypeName
The name of the extension to test.Conditional: You must specify
Arn
, orTypeName
andType
. -
setTypeName
The name of the extension to test.Conditional: You must specify
Arn
, orTypeName
andType
.
-