Class CfnPublicTypeVersion
- All Implemented Interfaces:
IInspectable
,software.amazon.jsii.JsiiSerializable
,software.constructs.IConstruct
,software.constructs.IDependable
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.*; CfnPublicTypeVersion cfnPublicTypeVersion = CfnPublicTypeVersion.Builder.create(this, "MyCfnPublicTypeVersion") .arn("arn") .logDeliveryBucket("logDeliveryBucket") .publicVersionNumber("publicVersionNumber") .type("type") .typeName("typeName") .build();
- See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject
software.amazon.jsii.JsiiObject.InitializationMode
Nested classes/interfaces inherited from interface software.constructs.IConstruct
software.constructs.IConstruct.Jsii$Default
Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
The CloudFormation resource type name for this resource class. -
Constructor Summary
ModifierConstructorDescriptionprotected
CfnPublicTypeVersion
(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) protected
CfnPublicTypeVersion
(software.amazon.jsii.JsiiObjectRef objRef) CfnPublicTypeVersion
(software.constructs.Construct scope, String id) CfnPublicTypeVersion
(software.constructs.Construct scope, String id, CfnPublicTypeVersionProps props) -
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.CfnResource
addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, obtainResourceDependencies, removeDependency, replaceDependency, shouldSynthesize, toString, validateProperties
Methods inherited from class software.amazon.awscdk.CfnRefElement
getRef
Methods inherited from class software.amazon.awscdk.CfnElement
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId
Methods inherited from class software.constructs.Construct
getNode, isConstruct
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 software.constructs.Construct scope, @NotNull String id, @Nullable CfnPublicTypeVersionProps props) - Parameters:
scope
- Scope in which this resource is defined. This parameter is required.id
- Construct identifier for this resource (unique in its scope). This parameter is required.props
- Resource properties.
-
CfnPublicTypeVersion
@Stability(Stable) public CfnPublicTypeVersion(@NotNull software.constructs.Construct scope, @NotNull String id) - Parameters:
scope
- Scope in which this resource is defined. This parameter is required.id
- Construct identifier for this resource (unique in its scope). This parameter is required.
-
-
Method Details
-
inspect
Examines the CloudFormation resource and discloses attributes.- Specified by:
inspect
in interfaceIInspectable
- Parameters:
inspector
- tree inspector to collect and process attributes. This parameter is required.
-
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.This applies only to public third-party extensions. For private registered extensions, and extensions provided by AWS , CloudFormation returns
null
. -
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. -
setArn
The Amazon Resource Number (ARN) of the extension. -
getLogDeliveryBucket
The S3 bucket to which CloudFormation delivers the contract test execution logs. -
setLogDeliveryBucket
The S3 bucket to which CloudFormation delivers the contract test execution logs. -
getPublicVersionNumber
The version number to assign to this version of the extension. -
setPublicVersionNumber
The version number to assign to this version of the extension. -
getType
The type of the extension to test. -
setType
The type of the extension to test. -
getTypeName
The name of the extension to test. -
setTypeName
The name of the extension to test.
-