Package software.amazon.awscdk.cfnpropertymixins.services.omics

Class CfnWorkflowPropsMixin.Builder

java.lang.Object

software.amazon.awscdk.cfnpropertymixins.services.omics.CfnWorkflowPropsMixin.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnWorkflowPropsMixin>

Enclosing class:

CfnWorkflowPropsMixin

@Stability(Stable)
public static final class CfnWorkflowPropsMixin.Builder
extends Object
implements software.amazon.jsii.Builder<CfnWorkflowPropsMixin>

A fluent builder for CfnWorkflowPropsMixin.

Method Summary

Modifier and Type	Method	Description
CfnWorkflowPropsMixin.Builder	accelerators(String accelerators)
CfnWorkflowPropsMixin	build()
CfnWorkflowPropsMixin.Builder	containerRegistryMap(CfnWorkflowPropsMixin.ContainerRegistryMapProperty containerRegistryMap)	Use a container registry map to specify mappings between the ECR private repository and one or more upstream registries.
CfnWorkflowPropsMixin.Builder	containerRegistryMap(IResolvable containerRegistryMap)	Use a container registry map to specify mappings between the ECR private repository and one or more upstream registries.
CfnWorkflowPropsMixin.Builder	containerRegistryMapUri(String containerRegistryMapUri)
static CfnWorkflowPropsMixin.Builder	create()
static CfnWorkflowPropsMixin.Builder	create(CfnPropertyMixinOptions options)
CfnWorkflowPropsMixin.Builder	definitionRepository(CfnWorkflowPropsMixin.DefinitionRepositoryProperty definitionRepository)	Contains information about a source code repository that hosts the workflow definition files.
CfnWorkflowPropsMixin.Builder	definitionRepository(IResolvable definitionRepository)	Contains information about a source code repository that hosts the workflow definition files.
CfnWorkflowPropsMixin.Builder	definitionUri(String definitionUri)	The URI of a definition for the workflow.
CfnWorkflowPropsMixin.Builder	description(String description)	The parameter's description.
CfnWorkflowPropsMixin.Builder	engine(String engine)	An engine for the workflow.
CfnWorkflowPropsMixin.Builder	main(String main)	The path of the main definition file for the workflow.
CfnWorkflowPropsMixin.Builder	name(String name)	The workflow's name.
CfnWorkflowPropsMixin.Builder	parameterTemplate(Map<String,? extends Object> parameterTemplate)	The workflow's parameter template.
CfnWorkflowPropsMixin.Builder	parameterTemplate(IResolvable parameterTemplate)	The workflow's parameter template.
CfnWorkflowPropsMixin.Builder	parameterTemplatePath(String parameterTemplatePath)	Path to the primary workflow parameter template JSON file inside the repository.
CfnWorkflowPropsMixin.Builder	readmeMarkdown(String readmeMarkdown)	The markdown content for the workflow's README file.
CfnWorkflowPropsMixin.Builder	readmePath(String readmePath)	The path to the workflow README markdown file within the repository.
CfnWorkflowPropsMixin.Builder	readmeUri(String readmeUri)	The S3 URI of the README file for the workflow.
CfnWorkflowPropsMixin.Builder	storageCapacity(Number storageCapacity)	The default static storage capacity (in gibibytes) for runs that use this workflow or workflow version.
CfnWorkflowPropsMixin.Builder	storageType(String storageType)
CfnWorkflowPropsMixin.Builder	tags(Map<String,String> tags)	Tags for the workflow.
CfnWorkflowPropsMixin.Builder	workflowBucketOwnerId(String workflowBucketOwnerId)	Optional workflow bucket owner ID to verify the workflow bucket.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

create

@Stability(Stable)
public static CfnWorkflowPropsMixin.Builder create(CfnPropertyMixinOptions options)

Parameters:

options - Mixin options.

Returns:

a new instance of CfnWorkflowPropsMixin.Builder.

create

@Stability(Stable)
public static CfnWorkflowPropsMixin.Builder create()

Returns:

a new instance of CfnWorkflowPropsMixin.Builder.

accelerators

@Stability(Stable)
public CfnWorkflowPropsMixin.Builder accelerators(String accelerators)

Parameters:

accelerators - This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-omics-workflow.html#cfn-omics-workflow-accelerators

containerRegistryMap

@Stability(Stable)
public CfnWorkflowPropsMixin.Builder containerRegistryMap(IResolvable containerRegistryMap)

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 in the AWS HealthOmics User Guide .

Parameters:

containerRegistryMap - Use a container registry map to specify mappings between the ECR private repository and one or more upstream registries. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-omics-workflow.html#cfn-omics-workflow-containerregistrymap

containerRegistryMap

@Stability(Stable)
public CfnWorkflowPropsMixin.Builder containerRegistryMap(CfnWorkflowPropsMixin.ContainerRegistryMapProperty containerRegistryMap)

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 in the AWS HealthOmics User Guide .

Parameters:

containerRegistryMap - Use a container registry map to specify mappings between the ECR private repository and one or more upstream registries. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-omics-workflow.html#cfn-omics-workflow-containerregistrymap

containerRegistryMapUri

@Stability(Stable)
public CfnWorkflowPropsMixin.Builder containerRegistryMapUri(String containerRegistryMapUri)

Parameters:

containerRegistryMapUri - This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-omics-workflow.html#cfn-omics-workflow-containerregistrymapuri

definitionRepository

@Stability(Stable)
public CfnWorkflowPropsMixin.Builder definitionRepository(IResolvable definitionRepository)

Contains information about a source code repository that hosts the workflow definition files.

Parameters:

definitionRepository - Contains information about a source code repository that hosts the workflow definition files. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-omics-workflow.html#cfn-omics-workflow-definitionrepository

definitionRepository

@Stability(Stable)
public CfnWorkflowPropsMixin.Builder definitionRepository(CfnWorkflowPropsMixin.DefinitionRepositoryProperty definitionRepository)

Contains information about a source code repository that hosts the workflow definition files.

Parameters:

definitionRepository - Contains information about a source code repository that hosts the workflow definition files. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-omics-workflow.html#cfn-omics-workflow-definitionrepository

definitionUri

@Stability(Stable)
public CfnWorkflowPropsMixin.Builder definitionUri(String definitionUri)

The URI of a definition for the workflow.

Parameters:

definitionUri - The URI of a definition for the workflow. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-omics-workflow.html#cfn-omics-workflow-definitionuri

description

@Stability(Stable)
public CfnWorkflowPropsMixin.Builder description(String description)

The parameter's description.

Parameters:

description - The parameter's description. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-omics-workflow.html#cfn-omics-workflow-description

engine

@Stability(Stable)
public CfnWorkflowPropsMixin.Builder engine(String engine)

An engine for the workflow.

Parameters:

engine - An engine for the workflow. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-omics-workflow.html#cfn-omics-workflow-engine

main

@Stability(Stable)
public CfnWorkflowPropsMixin.Builder main(String main)

The path of the main definition file for the workflow.

Parameters:

main - The path of the main definition file for the workflow. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-omics-workflow.html#cfn-omics-workflow-main

name

@Stability(Stable)
public CfnWorkflowPropsMixin.Builder name(String name)

The workflow's name.

Parameters:

name - The workflow's name. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-omics-workflow.html#cfn-omics-workflow-name

parameterTemplate

@Stability(Stable)
public CfnWorkflowPropsMixin.Builder parameterTemplate(IResolvable parameterTemplate)

The workflow's parameter template.

Parameters:

parameterTemplate - The workflow's parameter template. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-omics-workflow.html#cfn-omics-workflow-parametertemplate

parameterTemplate

@Stability(Stable)
public CfnWorkflowPropsMixin.Builder parameterTemplate(Map<String,? extends Object> parameterTemplate)

The workflow's parameter template.

Parameters:

parameterTemplate - The workflow's parameter template. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-omics-workflow.html#cfn-omics-workflow-parametertemplate

parameterTemplatePath

@Stability(Stable)
public CfnWorkflowPropsMixin.Builder parameterTemplatePath(String parameterTemplatePath)

Path to the primary workflow parameter template JSON file inside the repository.

Parameters:

parameterTemplatePath - Path to the primary workflow parameter template JSON file inside the repository. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-omics-workflow.html#cfn-omics-workflow-parametertemplatepath

readmeMarkdown

@Stability(Stable)
public CfnWorkflowPropsMixin.Builder readmeMarkdown(String readmeMarkdown)

The markdown content for the workflow's README file.

This provides documentation and usage information for users of the workflow.

Parameters:

readmeMarkdown - The markdown content for the workflow's README file. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-omics-workflow.html#cfn-omics-workflow-readmemarkdown

readmePath

@Stability(Stable)
public CfnWorkflowPropsMixin.Builder readmePath(String readmePath)

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.

Parameters:

readmePath - The path to the workflow README markdown file within the repository. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-omics-workflow.html#cfn-omics-workflow-readmepath

readmeUri

@Stability(Stable)
public CfnWorkflowPropsMixin.Builder readmeUri(String readmeUri)

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.

Parameters:

readmeUri - The S3 URI of the README file for the workflow. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-omics-workflow.html#cfn-omics-workflow-readmeuri

storageCapacity

@Stability(Stable)
public CfnWorkflowPropsMixin.Builder storageCapacity(Number storageCapacity)

The default static storage capacity (in gibibytes) for runs that use this workflow or workflow version.

The storageCapacity can be overwritten at run time. The storage capacity is not required for runs with a DYNAMIC storage type.

Parameters:

storageCapacity - The default static storage capacity (in gibibytes) for runs that use this workflow or workflow version. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-omics-workflow.html#cfn-omics-workflow-storagecapacity

storageType

@Stability(Stable)
public CfnWorkflowPropsMixin.Builder storageType(String storageType)

Parameters:

storageType - This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-omics-workflow.html#cfn-omics-workflow-storagetype

tags

@Stability(Stable)
public CfnWorkflowPropsMixin.Builder tags(Map<String,String> tags)

Tags for the workflow.

Parameters:

tags - Tags for the workflow. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-omics-workflow.html#cfn-omics-workflow-tags

workflowBucketOwnerId

@Stability(Stable)
public CfnWorkflowPropsMixin.Builder workflowBucketOwnerId(String workflowBucketOwnerId)

Optional workflow bucket owner ID to verify the workflow bucket.

Parameters:

workflowBucketOwnerId - Optional workflow bucket owner ID to verify the workflow bucket. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-omics-workflow.html#cfn-omics-workflow-workflowbucketownerid

build

@Stability(Stable)
public CfnWorkflowPropsMixin build()

Specified by:

build in interface software.amazon.jsii.Builder<CfnWorkflowPropsMixin>

Returns:

a newly built instance of CfnWorkflowPropsMixin.