Interface AssemblyManifest

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
AssemblyManifest.Jsii$Proxy

@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:29:54.663Z") @Stability(Stable) public interface AssemblyManifest extends software.amazon.jsii.JsiiSerializable
A manifest which describes the cloud assembly.

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.*;
 AssemblyManifest assemblyManifest = AssemblyManifest.builder()
         .version("version")
         // the properties below are optional
         .artifacts(Map.of(
                 "artifactsKey", ArtifactManifest.builder()
                         .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()))
         .missing(List.of(MissingContext.builder()
                 .key("key")
                 .props(AmiContextQuery.builder()
                         .account("account")
                         .filters(Map.of(
                                 "filtersKey", List.of("filters")))
                         .region("region")
                         // the properties below are optional
                         .lookupRoleArn("lookupRoleArn")
                         .owners(List.of("owners"))
                         .build())
                 .provider(ContextProvider.AMI_PROVIDER)
                 .build()))
         .runtime(RuntimeInfo.builder()
                 .libraries(Map.of(
                         "librariesKey", "libraries"))
                 .build())
         .build();
 
  • Method Details

    • getVersion

      @Stability(Stable) @NotNull String getVersion()
      Protocol version.
    • getArtifacts

      @Stability(Stable) @Nullable default Map<String,ArtifactManifest> getArtifacts()
      The set of artifacts in this assembly.

      Default: - no artifacts.

    • getMissing

      @Stability(Stable) @Nullable default List<MissingContext> getMissing()
      Missing context information.

      If this field has values, it means that the cloud assembly is not complete and should not be deployed.

      Default: - no missing context.

    • getRuntime

      @Stability(Stable) @Nullable default RuntimeInfo getRuntime()
      Runtime information.

      Default: - no info.

    • builder

      @Stability(Stable) static AssemblyManifest.Builder builder()
      Returns:
      a AssemblyManifest.Builder of AssemblyManifest