Class CfnWorkflowVersionMixinProps

Properties for CfnWorkflowVersionPropsMixin.

Inheritance

object

CfnWorkflowVersionMixinProps

Implements

ICfnWorkflowVersionMixinProps

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Amazon.CDK.CfnPropertyMixins.AWS.Omics

Assembly: Amazon.CDK.CfnPropertyMixins.dll

Syntax (csharp)

public class CfnWorkflowVersionMixinProps : ICfnWorkflowVersionMixinProps

Syntax (vb)

Public Class CfnWorkflowVersionMixinProps Implements ICfnWorkflowVersionMixinProps

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-omics-workflowversion.html

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.CfnPropertyMixins.AWS.Omics;

             var cfnWorkflowVersionMixinProps = new CfnWorkflowVersionMixinProps {
                 Accelerators = "accelerators",
                 ContainerRegistryMap = new ContainerRegistryMapProperty {
                     ImageMappings = new [] { new ImageMappingProperty {
                         DestinationImage = "destinationImage",
                         SourceImage = "sourceImage"
                     } },
                     RegistryMappings = new [] { new RegistryMappingProperty {
                         EcrAccountId = "ecrAccountId",
                         EcrRepositoryPrefix = "ecrRepositoryPrefix",
                         UpstreamRegistryUrl = "upstreamRegistryUrl",
                         UpstreamRepositoryPrefix = "upstreamRepositoryPrefix"
                     } }
                 },
                 ContainerRegistryMapUri = "containerRegistryMapUri",
                 DefinitionRepository = new DefinitionRepositoryProperty {
                     ConnectionArn = "connectionArn",
                     ExcludeFilePatterns = new [] { "excludeFilePatterns" },
                     FullRepositoryId = "fullRepositoryId",
                     SourceReference = new SourceReferenceProperty {
                         Type = "type",
                         Value = "value"
                     }
                 },
                 DefinitionUri = "definitionUri",
                 Description = "description",
                 Engine = "engine",
                 Main = "main",
                 ParameterTemplate = new Dictionary<string, object> {
                     { "parameterTemplateKey", new WorkflowParameterProperty {
                         Description = "description",
                         Optional = false
                     } }
                 },
                 ParameterTemplatePath = "parameterTemplatePath",
                 ReadmeMarkdown = "readmeMarkdown",
                 ReadmePath = "readmePath",
                 ReadmeUri = "readmeUri",
                 StorageCapacity = 123,
                 StorageType = "storageType",
                 Tags = new Dictionary<string, string> {
                     { "tagsKey", "tags" }
                 },
                 VersionName = "versionName",
                 WorkflowBucketOwnerId = "workflowBucketOwnerId",
                 WorkflowId = "workflowId"
             };

Synopsis

Constructors

CfnWorkflowVersionMixinProps()

Properties for CfnWorkflowVersionPropsMixin.

Properties

Accelerators	Properties for CfnWorkflowVersionPropsMixin.
ContainerRegistryMap	Use a container registry map to specify mappings between the ECR private repository and one or more upstream registries.
ContainerRegistryMapUri	Properties for CfnWorkflowVersionPropsMixin.
DefinitionRepository	Contains information about a source code repository that hosts the workflow definition files.
DefinitionUri	Properties for CfnWorkflowVersionPropsMixin.
Description	The description of the workflow version.
Engine	Properties for CfnWorkflowVersionPropsMixin.
Main	Properties for CfnWorkflowVersionPropsMixin.
ParameterTemplate	Properties for CfnWorkflowVersionPropsMixin.
ParameterTemplatePath	Path to the primary workflow parameter template JSON file inside the repository.
ReadmeMarkdown	The markdown content for the workflow's README file.
ReadmePath	The path to the workflow README markdown file within the repository.
ReadmeUri	The S3 URI of the README file for the workflow.
StorageCapacity	Properties for CfnWorkflowVersionPropsMixin.
StorageType	Properties for CfnWorkflowVersionPropsMixin.
Tags	A map of resource tags.
VersionName	The name of the workflow version.
WorkflowBucketOwnerId	Properties for CfnWorkflowVersionPropsMixin.
WorkflowId	The workflow's ID.

Constructors

CfnWorkflowVersionMixinProps()

Properties for CfnWorkflowVersionPropsMixin.

public CfnWorkflowVersionMixinProps()

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-omics-workflowversion.html

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.CfnPropertyMixins.AWS.Omics;

             var cfnWorkflowVersionMixinProps = new CfnWorkflowVersionMixinProps {
                 Accelerators = "accelerators",
                 ContainerRegistryMap = new ContainerRegistryMapProperty {
                     ImageMappings = new [] { new ImageMappingProperty {
                         DestinationImage = "destinationImage",
                         SourceImage = "sourceImage"
                     } },
                     RegistryMappings = new [] { new RegistryMappingProperty {
                         EcrAccountId = "ecrAccountId",
                         EcrRepositoryPrefix = "ecrRepositoryPrefix",
                         UpstreamRegistryUrl = "upstreamRegistryUrl",
                         UpstreamRepositoryPrefix = "upstreamRepositoryPrefix"
                     } }
                 },
                 ContainerRegistryMapUri = "containerRegistryMapUri",
                 DefinitionRepository = new DefinitionRepositoryProperty {
                     ConnectionArn = "connectionArn",
                     ExcludeFilePatterns = new [] { "excludeFilePatterns" },
                     FullRepositoryId = "fullRepositoryId",
                     SourceReference = new SourceReferenceProperty {
                         Type = "type",
                         Value = "value"
                     }
                 },
                 DefinitionUri = "definitionUri",
                 Description = "description",
                 Engine = "engine",
                 Main = "main",
                 ParameterTemplate = new Dictionary<string, object> {
                     { "parameterTemplateKey", new WorkflowParameterProperty {
                         Description = "description",
                         Optional = false
                     } }
                 },
                 ParameterTemplatePath = "parameterTemplatePath",
                 ReadmeMarkdown = "readmeMarkdown",
                 ReadmePath = "readmePath",
                 ReadmeUri = "readmeUri",
                 StorageCapacity = 123,
                 StorageType = "storageType",
                 Tags = new Dictionary<string, string> {
                     { "tagsKey", "tags" }
                 },
                 VersionName = "versionName",
                 WorkflowBucketOwnerId = "workflowBucketOwnerId",
                 WorkflowId = "workflowId"
             };

Properties

Accelerators

Properties for CfnWorkflowVersionPropsMixin.

public string? Accelerators { get; set; }

Property Value

string

Remarks

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

ContainerRegistryMap

Use a container registry map to specify mappings between the ECR private repository and one or more upstream registries.

public object? ContainerRegistryMap { get; set; }

Property Value

object

Remarks

For more information, see Container images in the AWS HealthOmics User Guide .

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

Type union: either IResolvable or CfnWorkflowVersionPropsMixin.IContainerRegistryMapProperty

ContainerRegistryMapUri

Properties for CfnWorkflowVersionPropsMixin.

public string? ContainerRegistryMapUri { get; set; }

Property Value

string

Remarks

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

DefinitionRepository

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

public object? DefinitionRepository { get; set; }

Property Value

object

Remarks

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

Type union: either IResolvable or CfnWorkflowVersionPropsMixin.IDefinitionRepositoryProperty

DefinitionUri

Properties for CfnWorkflowVersionPropsMixin.

public string? DefinitionUri { get; set; }

Property Value

string

Remarks

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

Description

The description of the workflow version.

public string? Description { get; set; }

Property Value

string

Remarks

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

Engine

Properties for CfnWorkflowVersionPropsMixin.

public string? Engine { get; set; }

Property Value

string

Remarks

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

Main

Properties for CfnWorkflowVersionPropsMixin.

public string? Main { get; set; }

Property Value

string

Remarks

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

ParameterTemplate

Properties for CfnWorkflowVersionPropsMixin.

public object? ParameterTemplate { get; set; }

Property Value

object

Remarks

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

Type union: either IResolvable or Dictionary<string, either IResolvable or CfnWorkflowVersionPropsMixin.IWorkflowParameterProperty>

ParameterTemplatePath

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

public string? ParameterTemplatePath { get; set; }

Property Value

string

Remarks

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

ReadmeMarkdown

The markdown content for the workflow's README file.

public string? ReadmeMarkdown { get; set; }

Property Value

string

Remarks

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

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

ReadmePath

The path to the workflow README markdown file within the repository.

public string? ReadmePath { get; set; }

Property Value

string

Remarks

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.

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

ReadmeUri

The S3 URI of the README file for the workflow.

public string? ReadmeUri { get; set; }

Property Value

string

Remarks

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.

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

StorageCapacity

Properties for CfnWorkflowVersionPropsMixin.

public double? StorageCapacity { get; set; }

Property Value

double?

Remarks

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

StorageType

Properties for CfnWorkflowVersionPropsMixin.

public string? StorageType { get; set; }

Property Value

string

Remarks

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

Tags

A map of resource tags.

public IDictionary<string, string>? Tags { get; set; }

Property Value

IDictionary<string, string>

Remarks

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

VersionName

The name of the workflow version.

public string? VersionName { get; set; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-omics-workflowversion.html#cfn-omics-workflowversion-versionname

WorkflowBucketOwnerId

Properties for CfnWorkflowVersionPropsMixin.

public string? WorkflowBucketOwnerId { get; set; }

Property Value

string

Remarks

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

WorkflowId

The workflow's ID.

public string? WorkflowId { get; set; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-omics-workflowversion.html#cfn-omics-workflowversion-workflowid

Implements

ICfnWorkflowVersionMixinProps