software.amazon.awscdk.cxapi.AssetManifestArtifact Maven / Gradle / Ivy
Show all versions of cdk-cx-api Show documentation
package software.amazon.awscdk.cxapi;
/**
* Asset manifest is a description of a set of assets which need to be built and published.
*
* Example:
*
*
* // The code below shows an example of how to instantiate this type.
* // The values are placeholders you should change.
* import software.amazon.awscdk.cloudassembly.schema.*;
* import software.amazon.awscdk.cxapi.*;
* CloudAssembly cloudAssembly;
* AssetManifestArtifact assetManifestArtifact = AssetManifestArtifact.Builder.create(cloudAssembly, "name")
* .type(ArtifactType.NONE)
* // the properties below are optional
* .dependencies(List.of("dependencies"))
* .displayName("displayName")
* .environment("environment")
* .metadata(Map.of(
* "metadataKey", List.of(MetadataEntry.builder()
* .type("type")
* // the properties below are optional
* .data("data")
* .trace(List.of("trace"))
* .build())))
* .properties(AwsCloudFormationStackProperties.builder()
* .templateFile("templateFile")
* // the properties below are optional
* .assumeRoleArn("assumeRoleArn")
* .assumeRoleExternalId("assumeRoleExternalId")
* .bootstrapStackVersionSsmParameter("bootstrapStackVersionSsmParameter")
* .cloudFormationExecutionRoleArn("cloudFormationExecutionRoleArn")
* .lookupRole(BootstrapRole.builder()
* .arn("arn")
* // the properties below are optional
* .assumeRoleExternalId("assumeRoleExternalId")
* .bootstrapStackVersionSsmParameter("bootstrapStackVersionSsmParameter")
* .requiresBootstrapStackVersion(123)
* .build())
* .parameters(Map.of(
* "parametersKey", "parameters"))
* .requiresBootstrapStackVersion(123)
* .stackName("stackName")
* .stackTemplateAssetObjectUrl("stackTemplateAssetObjectUrl")
* .tags(Map.of(
* "tagsKey", "tags"))
* .terminationProtection(false)
* .validateOnSynth(false)
* .build())
* .build();
*
*/
@javax.annotation.Generated(value = "jsii-pacmak/1.103.1 (build bef2dea)", date = "2024-09-18T22:16:50.408Z")
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
@software.amazon.jsii.Jsii(module = software.amazon.awscdk.cxapi.$Module.class, fqn = "@aws-cdk/cx-api.AssetManifestArtifact")
public class AssetManifestArtifact extends software.amazon.awscdk.cxapi.CloudArtifact {
protected AssetManifestArtifact(final software.amazon.jsii.JsiiObjectRef objRef) {
super(objRef);
}
protected AssetManifestArtifact(final software.amazon.jsii.JsiiObject.InitializationMode initializationMode) {
super(initializationMode);
}
/**
* @param assembly This parameter is required.
* @param name This parameter is required.
* @param artifact This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public AssetManifestArtifact(final @org.jetbrains.annotations.NotNull software.amazon.awscdk.cxapi.CloudAssembly assembly, final @org.jetbrains.annotations.NotNull java.lang.String name, final @org.jetbrains.annotations.NotNull software.amazon.awscdk.cloudassembly.schema.ArtifactManifest artifact) {
super(software.amazon.jsii.JsiiObject.InitializationMode.JSII);
software.amazon.jsii.JsiiEngine.getInstance().createNewObject(this, new Object[] { java.util.Objects.requireNonNull(assembly, "assembly is required"), java.util.Objects.requireNonNull(name, "name is required"), java.util.Objects.requireNonNull(artifact, "artifact is required") });
}
/**
* Checks if art is an instance of this class.
*
* Use this method instead of instanceof to properly detect AssetManifestArtifact
* instances, even when the construct library is symlinked.
*
* Explanation: in JavaScript, multiple copies of the cx-api library on
* disk are seen as independent, completely different libraries. As a
* consequence, the class AssetManifestArtifact in each copy of the cx-api library
* is seen as a different class, and an instance of one class will not test as
* instanceof the other class. npm install will not create installations
* like this, but users may manually symlink construct libraries together or
* use a monorepo tool: in those cases, multiple copies of the cx-api
* library can be accidentally installed, and instanceof will behave
* unpredictably. It is safest to avoid using instanceof, and using
* this type-testing method instead.
*
* @param art This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public static @org.jetbrains.annotations.NotNull java.lang.Boolean isAssetManifestArtifact(final @org.jetbrains.annotations.NotNull java.lang.Object art) {
return software.amazon.jsii.JsiiObject.jsiiStaticCall(software.amazon.awscdk.cxapi.AssetManifestArtifact.class, "isAssetManifestArtifact", software.amazon.jsii.NativeType.forClass(java.lang.Boolean.class), new Object[] { art });
}
/**
* The Asset Manifest contents.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public @org.jetbrains.annotations.NotNull software.amazon.awscdk.cloudassembly.schema.AssetManifest getContents() {
return software.amazon.jsii.Kernel.get(this, "contents", software.amazon.jsii.NativeType.forClass(software.amazon.awscdk.cloudassembly.schema.AssetManifest.class));
}
/**
* The file name of the asset manifest.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public @org.jetbrains.annotations.NotNull java.lang.String getFile() {
return software.amazon.jsii.Kernel.get(this, "file", software.amazon.jsii.NativeType.forClass(java.lang.String.class));
}
/**
* Name of SSM parameter with bootstrap stack version.
*
* Default: - Discover SSM parameter by reading stack
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public @org.jetbrains.annotations.Nullable java.lang.String getBootstrapStackVersionSsmParameter() {
return software.amazon.jsii.Kernel.get(this, "bootstrapStackVersionSsmParameter", software.amazon.jsii.NativeType.forClass(java.lang.String.class));
}
/**
* Version of bootstrap stack required to deploy this stack.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public @org.jetbrains.annotations.Nullable java.lang.Number getRequiresBootstrapStackVersion() {
return software.amazon.jsii.Kernel.get(this, "requiresBootstrapStackVersion", software.amazon.jsii.NativeType.forClass(java.lang.Number.class));
}
}