@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)", date="2023-03-22T19:35:44.797Z") public class CfnPublicTypeVersion extends CfnResource implements IInspectable
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 .
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import software.amazon.awscdk.services.cloudformation.*; CfnPublicTypeVersion cfnPublicTypeVersion = CfnPublicTypeVersion.Builder.create(this, "MyCfnPublicTypeVersion") .arn("arn") .logDeliveryBucket("logDeliveryBucket") .publicVersionNumber("publicVersionNumber") .type("type") .typeName("typeName") .build();
Modifier and Type | Class and Description |
---|---|
static class |
CfnPublicTypeVersion.Builder
A fluent builder for
CfnPublicTypeVersion . |
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
IConstruct.Jsii$Default
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
|
Modifier | Constructor and Description |
---|---|
|
CfnPublicTypeVersion(Construct scope,
java.lang.String id)
Create a new `AWS::CloudFormation::PublicTypeVersion`.
|
|
CfnPublicTypeVersion(Construct scope,
java.lang.String id,
CfnPublicTypeVersionProps props)
Create a new `AWS::CloudFormation::PublicTypeVersion`.
|
protected |
CfnPublicTypeVersion(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) |
protected |
CfnPublicTypeVersion(software.amazon.jsii.JsiiObjectRef objRef) |
Modifier and Type | Method and Description |
---|---|
java.lang.String |
getArn()
The Amazon Resource Number (ARN) of the extension.
|
java.lang.String |
getAttrPublicTypeArn()
The Amazon Resource Number (ARN) assigned to the public extension upon publication.
|
java.lang.String |
getAttrPublisherId()
The publisher ID of the extension publisher.
|
java.lang.String |
getAttrTypeVersionArn()
The Amazon Resource Number (ARN) assigned to this version of the extension.
|
protected java.util.Map<java.lang.String,java.lang.Object> |
getCfnProperties() |
java.lang.String |
getLogDeliveryBucket()
The S3 bucket to which CloudFormation delivers the contract test execution logs.
|
java.lang.String |
getPublicVersionNumber()
The version number to assign to this version of the extension.
|
java.lang.String |
getType()
The type of the extension to test.
|
java.lang.String |
getTypeName()
The name of the extension to test.
|
void |
inspect(TreeInspector inspector)
Examines the CloudFormation resource and discloses attributes.
|
protected java.util.Map<java.lang.String,java.lang.Object> |
renderProperties(java.util.Map<java.lang.String,java.lang.Object> props) |
void |
setArn(java.lang.String value)
The Amazon Resource Number (ARN) of the extension.
|
void |
setLogDeliveryBucket(java.lang.String value)
The S3 bucket to which CloudFormation delivers the contract test execution logs.
|
void |
setPublicVersionNumber(java.lang.String value)
The version number to assign to this version of the extension.
|
void |
setType(java.lang.String value)
The type of the extension to test.
|
void |
setTypeName(java.lang.String value)
The name of the extension to test.
|
addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties
getRef
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId
getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate
public static final java.lang.String CFN_RESOURCE_TYPE_NAME
protected CfnPublicTypeVersion(software.amazon.jsii.JsiiObjectRef objRef)
protected CfnPublicTypeVersion(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
public CfnPublicTypeVersion(Construct scope, java.lang.String id, CfnPublicTypeVersionProps props)
scope
- - scope in which this resource is defined. This parameter is required.id
- - scoped id of the resource. This parameter is required.props
- - resource properties.public CfnPublicTypeVersion(Construct scope, java.lang.String id)
scope
- - scope in which this resource is defined. This parameter is required.id
- - scoped id of the resource. This parameter is required.public void inspect(TreeInspector inspector)
inspect
in interface IInspectable
inspector
- - tree inspector to collect and process attributes. This parameter is required.protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
renderProperties
in class CfnResource
props
- This parameter is required.public java.lang.String getAttrPublicTypeArn()
public java.lang.String getAttrPublisherId()
public java.lang.String getAttrTypeVersionArn()
protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()
getCfnProperties
in class CfnResource
public java.lang.String getArn()
Conditional: You must specify Arn
, or TypeName
and Type
.
public void setArn(java.lang.String value)
Conditional: You must specify Arn
, or TypeName
and Type
.
public java.lang.String getLogDeliveryBucket()
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 .
public void setLogDeliveryBucket(java.lang.String value)
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 .
public java.lang.String getPublicVersionNumber()
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
.
public void setPublicVersionNumber(java.lang.String value)
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
.
public java.lang.String getType()
Conditional: You must specify Arn
, or TypeName
and Type
.
public void setType(java.lang.String value)
Conditional: You must specify Arn
, or TypeName
and Type
.
public java.lang.String getTypeName()
Conditional: You must specify Arn
, or TypeName
and Type
.
public void setTypeName(java.lang.String value)
Conditional: You must specify Arn
, or TypeName
and Type
.