@pulumi/aws-native
Version:
The Pulumi AWS Cloud Control Provider enables you to build, deploy, and manage [any AWS resource that's supported by the AWS Cloud Control API](https://github.com/pulumi/pulumi-aws-native/blob/master/provider/cmd/pulumi-gen-aws-native/supported-types.txt)
154 lines (153 loc) • 7.5 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
import * as enums from "../types/enums";
/**
* Definition of AWS::Omics::WorkflowVersion Resource Type.
*/
export declare class WorkflowVersion extends pulumi.CustomResource {
/**
* Get an existing WorkflowVersion resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, opts?: pulumi.CustomResourceOptions): WorkflowVersion;
/**
* Returns true if the given object is an instance of WorkflowVersion. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj: any): obj is WorkflowVersion;
readonly accelerators: pulumi.Output<enums.omics.WorkflowVersionAccelerators | undefined>;
/**
* ARN of the workflow version.
*/
readonly arn: pulumi.Output<string>;
/**
* Use a container registry map to specify mappings between the ECR private repository and one or more upstream registries. For more information, see [Container images](https://docs.aws.amazon.com/omics/latest/dev/workflows-ecr.html) in the *AWS HealthOmics User Guide* .
*/
readonly containerRegistryMap: pulumi.Output<outputs.omics.WorkflowVersionContainerRegistryMap | undefined>;
readonly containerRegistryMapUri: pulumi.Output<string | undefined>;
/**
* The creation time of the workflow version.
*/
readonly creationTime: pulumi.Output<string>;
/**
* Contains information about a source code repository that hosts the workflow definition files.
*/
readonly definitionRepository: pulumi.Output<outputs.omics.WorkflowVersionDefinitionRepository | undefined>;
readonly definitionUri: pulumi.Output<string | undefined>;
/**
* The description of the workflow version.
*/
readonly description: pulumi.Output<string | undefined>;
readonly engine: pulumi.Output<enums.omics.WorkflowVersionWorkflowEngine | undefined>;
readonly main: pulumi.Output<string | undefined>;
readonly parameterTemplate: pulumi.Output<{
[key: string]: outputs.omics.WorkflowVersionWorkflowParameter;
} | undefined>;
/**
* Path to the primary workflow parameter template JSON file inside the repository
*/
readonly parameterTemplatePath: pulumi.Output<string | undefined>;
/**
* The markdown content for the workflow's README file. This provides documentation and usage information for users of the workflow.
*/
readonly readmeMarkdown: pulumi.Output<string | undefined>;
/**
* The path to the workflow README markdown file within the repository. This file provides documentation and usage information for the workflow. If not specified, the README.md file from the root directory of the repository will be used.
*/
readonly readmePath: pulumi.Output<string | undefined>;
/**
* The S3 URI of the README file for the workflow. This file provides documentation and usage information for the workflow. The S3 URI must begin with s3://USER-OWNED-BUCKET/. The requester must have access to the S3 bucket and object. The max README content length is 500 KiB.
*/
readonly readmeUri: pulumi.Output<string | undefined>;
/**
* The status of the workflow version.
*/
readonly status: pulumi.Output<enums.omics.WorkflowVersionWorkflowStatus>;
readonly storageCapacity: pulumi.Output<number | undefined>;
readonly storageType: pulumi.Output<enums.omics.WorkflowVersionStorageType | undefined>;
readonly tags: pulumi.Output<{
[key: string]: string;
} | undefined>;
/**
* The type of the workflow version.
*/
readonly type: pulumi.Output<enums.omics.WorkflowVersionWorkflowType>;
readonly uuid: pulumi.Output<string>;
/**
* The name of the workflow version.
*/
readonly versionName: pulumi.Output<string>;
readonly workflowBucketOwnerId: pulumi.Output<string | undefined>;
/**
* The workflow's ID.
*/
readonly workflowId: pulumi.Output<string>;
/**
* Create a WorkflowVersion resource with the given unique name, arguments, and options.
*
* @param name The _unique_ name of the resource.
* @param args The arguments to use to populate this resource's properties.
* @param opts A bag of options that control this resource's behavior.
*/
constructor(name: string, args: WorkflowVersionArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* The set of arguments for constructing a WorkflowVersion resource.
*/
export interface WorkflowVersionArgs {
accelerators?: pulumi.Input<enums.omics.WorkflowVersionAccelerators>;
/**
* Use a container registry map to specify mappings between the ECR private repository and one or more upstream registries. For more information, see [Container images](https://docs.aws.amazon.com/omics/latest/dev/workflows-ecr.html) in the *AWS HealthOmics User Guide* .
*/
containerRegistryMap?: pulumi.Input<inputs.omics.WorkflowVersionContainerRegistryMapArgs>;
containerRegistryMapUri?: pulumi.Input<string>;
/**
* Contains information about a source code repository that hosts the workflow definition files.
*/
definitionRepository?: pulumi.Input<inputs.omics.WorkflowVersionDefinitionRepositoryArgs>;
definitionUri?: pulumi.Input<string>;
/**
* The description of the workflow version.
*/
description?: pulumi.Input<string>;
engine?: pulumi.Input<enums.omics.WorkflowVersionWorkflowEngine>;
main?: pulumi.Input<string>;
parameterTemplate?: pulumi.Input<{
[key: string]: pulumi.Input<inputs.omics.WorkflowVersionWorkflowParameterArgs>;
}>;
/**
* Path to the primary workflow parameter template JSON file inside the repository
*/
parameterTemplatePath?: pulumi.Input<string>;
/**
* The markdown content for the workflow's README file. This provides documentation and usage information for users of the workflow.
*/
readmeMarkdown?: pulumi.Input<string>;
/**
* The path to the workflow README markdown file within the repository. This file provides documentation and usage information for the workflow. If not specified, the README.md file from the root directory of the repository will be used.
*/
readmePath?: pulumi.Input<string>;
/**
* The S3 URI of the README file for the workflow. This file provides documentation and usage information for the workflow. The S3 URI must begin with s3://USER-OWNED-BUCKET/. The requester must have access to the S3 bucket and object. The max README content length is 500 KiB.
*/
readmeUri?: pulumi.Input<string>;
storageCapacity?: pulumi.Input<number>;
storageType?: pulumi.Input<enums.omics.WorkflowVersionStorageType>;
tags?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
/**
* The name of the workflow version.
*/
versionName?: pulumi.Input<string>;
workflowBucketOwnerId?: pulumi.Input<string>;
/**
* The workflow's ID.
*/
workflowId: pulumi.Input<string>;
}