Documentation ¶
Index ¶
- func CfnAnnotationStore_CFN_RESOURCE_TYPE_NAME() *string
- func CfnAnnotationStore_IsCfnElement(x interface{}) *bool
- func CfnAnnotationStore_IsCfnResource(x interface{}) *bool
- func CfnAnnotationStore_IsConstruct(x interface{}) *bool
- func CfnReferenceStore_CFN_RESOURCE_TYPE_NAME() *string
- func CfnReferenceStore_IsCfnElement(x interface{}) *bool
- func CfnReferenceStore_IsCfnResource(x interface{}) *bool
- func CfnReferenceStore_IsConstruct(x interface{}) *bool
- func CfnRunGroup_CFN_RESOURCE_TYPE_NAME() *string
- func CfnRunGroup_IsCfnElement(x interface{}) *bool
- func CfnRunGroup_IsCfnResource(x interface{}) *bool
- func CfnRunGroup_IsConstruct(x interface{}) *bool
- func CfnSequenceStore_CFN_RESOURCE_TYPE_NAME() *string
- func CfnSequenceStore_IsCfnElement(x interface{}) *bool
- func CfnSequenceStore_IsCfnResource(x interface{}) *bool
- func CfnSequenceStore_IsConstruct(x interface{}) *bool
- func CfnVariantStore_CFN_RESOURCE_TYPE_NAME() *string
- func CfnVariantStore_IsCfnElement(x interface{}) *bool
- func CfnVariantStore_IsCfnResource(x interface{}) *bool
- func CfnVariantStore_IsConstruct(x interface{}) *bool
- func CfnWorkflow_CFN_RESOURCE_TYPE_NAME() *string
- func CfnWorkflow_IsCfnElement(x interface{}) *bool
- func CfnWorkflow_IsCfnResource(x interface{}) *bool
- func CfnWorkflow_IsConstruct(x interface{}) *bool
- func NewCfnAnnotationStore_Override(c CfnAnnotationStore, scope constructs.Construct, id *string, ...)
- func NewCfnReferenceStore_Override(c CfnReferenceStore, scope constructs.Construct, id *string, ...)
- func NewCfnRunGroup_Override(c CfnRunGroup, scope constructs.Construct, id *string, props *CfnRunGroupProps)
- func NewCfnSequenceStore_Override(c CfnSequenceStore, scope constructs.Construct, id *string, ...)
- func NewCfnVariantStore_Override(c CfnVariantStore, scope constructs.Construct, id *string, ...)
- func NewCfnWorkflow_Override(c CfnWorkflow, scope constructs.Construct, id *string, props *CfnWorkflowProps)
- type CfnAnnotationStore
- type CfnAnnotationStoreProps
- type CfnAnnotationStore_ReferenceItemProperty
- type CfnAnnotationStore_SseConfigProperty
- type CfnAnnotationStore_StoreOptionsProperty
- type CfnAnnotationStore_TsvStoreOptionsProperty
- type CfnReferenceStore
- type CfnReferenceStoreProps
- type CfnReferenceStore_SseConfigProperty
- type CfnRunGroup
- type CfnRunGroupProps
- type CfnSequenceStore
- type CfnSequenceStoreProps
- type CfnSequenceStore_SseConfigProperty
- type CfnVariantStore
- type CfnVariantStoreProps
- type CfnVariantStore_ReferenceItemProperty
- type CfnVariantStore_SseConfigProperty
- type CfnWorkflow
- type CfnWorkflowProps
- type CfnWorkflow_WorkflowParameterProperty
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func CfnAnnotationStore_CFN_RESOURCE_TYPE_NAME ¶
func CfnAnnotationStore_CFN_RESOURCE_TYPE_NAME() *string
func CfnAnnotationStore_IsCfnElement ¶
func CfnAnnotationStore_IsCfnElement(x interface{}) *bool
Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).
Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.
Returns: The construct as a stack element or undefined if it is not a stack element.
func CfnAnnotationStore_IsCfnResource ¶
func CfnAnnotationStore_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnAnnotationStore_IsConstruct ¶
func CfnAnnotationStore_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` 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 `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.
Returns: true if `x` is an object created from a class which extends `Construct`.
func CfnReferenceStore_CFN_RESOURCE_TYPE_NAME ¶
func CfnReferenceStore_CFN_RESOURCE_TYPE_NAME() *string
func CfnReferenceStore_IsCfnElement ¶
func CfnReferenceStore_IsCfnElement(x interface{}) *bool
Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).
Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.
Returns: The construct as a stack element or undefined if it is not a stack element.
func CfnReferenceStore_IsCfnResource ¶
func CfnReferenceStore_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnReferenceStore_IsConstruct ¶
func CfnReferenceStore_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` 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 `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.
Returns: true if `x` is an object created from a class which extends `Construct`.
func CfnRunGroup_CFN_RESOURCE_TYPE_NAME ¶
func CfnRunGroup_CFN_RESOURCE_TYPE_NAME() *string
func CfnRunGroup_IsCfnElement ¶
func CfnRunGroup_IsCfnElement(x interface{}) *bool
Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).
Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.
Returns: The construct as a stack element or undefined if it is not a stack element.
func CfnRunGroup_IsCfnResource ¶
func CfnRunGroup_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnRunGroup_IsConstruct ¶
func CfnRunGroup_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` 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 `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.
Returns: true if `x` is an object created from a class which extends `Construct`.
func CfnSequenceStore_CFN_RESOURCE_TYPE_NAME ¶
func CfnSequenceStore_CFN_RESOURCE_TYPE_NAME() *string
func CfnSequenceStore_IsCfnElement ¶
func CfnSequenceStore_IsCfnElement(x interface{}) *bool
Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).
Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.
Returns: The construct as a stack element or undefined if it is not a stack element.
func CfnSequenceStore_IsCfnResource ¶
func CfnSequenceStore_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnSequenceStore_IsConstruct ¶
func CfnSequenceStore_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` 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 `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.
Returns: true if `x` is an object created from a class which extends `Construct`.
func CfnVariantStore_CFN_RESOURCE_TYPE_NAME ¶
func CfnVariantStore_CFN_RESOURCE_TYPE_NAME() *string
func CfnVariantStore_IsCfnElement ¶
func CfnVariantStore_IsCfnElement(x interface{}) *bool
Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).
Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.
Returns: The construct as a stack element or undefined if it is not a stack element.
func CfnVariantStore_IsCfnResource ¶
func CfnVariantStore_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnVariantStore_IsConstruct ¶
func CfnVariantStore_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` 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 `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.
Returns: true if `x` is an object created from a class which extends `Construct`.
func CfnWorkflow_CFN_RESOURCE_TYPE_NAME ¶
func CfnWorkflow_CFN_RESOURCE_TYPE_NAME() *string
func CfnWorkflow_IsCfnElement ¶
func CfnWorkflow_IsCfnElement(x interface{}) *bool
Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).
Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.
Returns: The construct as a stack element or undefined if it is not a stack element.
func CfnWorkflow_IsCfnResource ¶
func CfnWorkflow_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnWorkflow_IsConstruct ¶
func CfnWorkflow_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` 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 `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.
Returns: true if `x` is an object created from a class which extends `Construct`.
func NewCfnAnnotationStore_Override ¶
func NewCfnAnnotationStore_Override(c CfnAnnotationStore, scope constructs.Construct, id *string, props *CfnAnnotationStoreProps)
func NewCfnReferenceStore_Override ¶
func NewCfnReferenceStore_Override(c CfnReferenceStore, scope constructs.Construct, id *string, props *CfnReferenceStoreProps)
func NewCfnRunGroup_Override ¶
func NewCfnRunGroup_Override(c CfnRunGroup, scope constructs.Construct, id *string, props *CfnRunGroupProps)
func NewCfnSequenceStore_Override ¶
func NewCfnSequenceStore_Override(c CfnSequenceStore, scope constructs.Construct, id *string, props *CfnSequenceStoreProps)
func NewCfnVariantStore_Override ¶
func NewCfnVariantStore_Override(c CfnVariantStore, scope constructs.Construct, id *string, props *CfnVariantStoreProps)
func NewCfnWorkflow_Override ¶
func NewCfnWorkflow_Override(c CfnWorkflow, scope constructs.Construct, id *string, props *CfnWorkflowProps)
Types ¶
type CfnAnnotationStore ¶
type CfnAnnotationStore interface { awscdk.CfnResource awscdk.IInspectable awscdk.ITaggable // When the store was created. AttrCreationTime() *string // The store's ID. AttrId() *string // The store's status. AttrStatus() *string // The store's status message. AttrStatusMessage() *string // The store's ARN. AttrStoreArn() *string // The store's size in bytes. AttrStoreSizeBytes() awscdk.IResolvable // When the store was updated. AttrUpdateTime() *string // Options for this resource, such as condition, update policy etc. CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} // AWS resource type. CfnResourceType() *string // Returns: the stack trace of the point where this Resource was created from, sourced // from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most // node +internal+ entries filtered. CreationStack() *[]*string // A description for the store. Description() *string SetDescription(val *string) // The logical ID for this CloudFormation stack element. // // The logical ID of the element // is calculated from the path of the resource node in the construct tree. // // To override this value, use `overrideLogicalId(newLogicalId)`. // // Returns: the logical ID as a stringified token. This value will only get // resolved during synthesis. LogicalId() *string // The name of the Annotation Store. Name() *string SetName(val *string) // The tree node. Node() constructs.Node // Return a string that will be resolved to a CloudFormation `{ Ref }` for this element. // // If, by any chance, the intrinsic reference of a resource is not a string, you could // coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`. Ref() *string // The genome reference for the store's annotations. Reference() interface{} SetReference(val interface{}) // The store's server-side encryption (SSE) settings. SseConfig() interface{} SetSseConfig(val interface{}) // The stack in which this element is defined. // // CfnElements must be defined within a stack scope (directly or indirectly). Stack() awscdk.Stack // The annotation file format of the store. StoreFormat() *string SetStoreFormat(val *string) // File parsing options for the annotation store. StoreOptions() interface{} SetStoreOptions(val interface{}) // Tag Manager which manages the tags for this resource. Tags() awscdk.TagManager // Tags for the store. TagsRaw() *map[string]*string SetTagsRaw(val *map[string]*string) // Deprecated. // Deprecated: use `updatedProperties` // // Return properties modified after initiation // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperites() *map[string]interface{} // Return properties modified after initiation. // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperties() *map[string]interface{} // Syntactic sugar for `addOverride(path, undefined)`. AddDeletionOverride(path *string) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // // This can be used for resources across stacks (or nested stack) boundaries // and the dependency will automatically be transferred to the relevant scope. AddDependency(target awscdk.CfnResource) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // Deprecated: use addDependency. AddDependsOn(target awscdk.CfnResource) // Add a value to the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // AddMetadata(key *string, value interface{}) // Adds an override to the synthesized CloudFormation resource. // // To add a // property override, either use `addPropertyOverride` or prefix `path` with // "Properties." (i.e. `Properties.TopicName`). // // If the override is nested, separate each nested level using a dot (.) in the path parameter. // If there is an array as part of the nesting, specify the index in the path. // // To include a literal `.` in the property name, prefix with a `\`. In most // programming languages you will need to write this as `"\\."` because the // `\` itself will need to be escaped. // // For example, // “`typescript // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']); // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE'); // “` // would add the overrides // “`json // "Properties": { // "GlobalSecondaryIndexes": [ // { // "Projection": { // "NonKeyAttributes": [ "myattribute" ] // ... // } // ... // }, // { // "ProjectionType": "INCLUDE" // ... // }, // ] // ... // } // “` // // The `value` argument to `addOverride` will not be processed or translated // in any way. Pass raw JSON values in here with the correct capitalization // for CloudFormation. If you pass CDK classes or structs, they will be // rendered with lowercased key names, and CloudFormation will reject the // template. AddOverride(path *string, value interface{}) // Adds an override that deletes the value of a property from the resource definition. AddPropertyDeletionOverride(propertyPath *string) // Adds an override to a resource property. // // Syntactic sugar for `addOverride("Properties.<...>", value)`. AddPropertyOverride(propertyPath *string, value interface{}) // Sets the deletion policy of the resource based on the removal policy specified. // // The Removal Policy controls what happens to this resource when it stops // being managed by CloudFormation, either because you've removed it from the // CDK application or because you've made a change that requires the resource // to be replaced. // // The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS // account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some // cases, a snapshot can be taken of the resource prior to deletion // (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy // can be found in the following link:. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options // ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions) // Returns a token for an runtime attribute of this resource. // // Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility // in case there is no generated attribute. GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference // Retrieve a value value from the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // GetMetadata(key *string) interface{} // Examines the CloudFormation resource and discloses attributes. Inspect(inspector awscdk.TreeInspector) // Retrieves an array of resources this resource depends on. // // This assembles dependencies on resources across stacks (including nested stacks) // automatically. ObtainDependencies() *[]interface{} // Get a shallow copy of dependencies between this resource and other resources in the same stack. ObtainResourceDependencies() *[]awscdk.CfnResource // Overrides the auto-generated logical ID with a specific ID. OverrideLogicalId(newLogicalId *string) // Indicates that this resource no longer depends on another resource. // // This can be used for resources across stacks (including nested stacks) // and the dependency will automatically be removed from the relevant scope. RemoveDependency(target awscdk.CfnResource) RenderProperties(props *map[string]interface{}) *map[string]interface{} // Replaces one dependency with another. ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource) // Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template. // // Returns: `true` if the resource should be included or `false` is the resource // should be omitted. ShouldSynthesize() *bool // Returns a string representation of this construct. // // Returns: a string representation of this resource. ToString() *string ValidateProperties(_properties interface{}) }
Creates an annotation store.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" var schema interface{} cfnAnnotationStore := awscdk.Aws_omics.NewCfnAnnotationStore(this, jsii.String("MyCfnAnnotationStore"), &CfnAnnotationStoreProps{ Name: jsii.String("name"), StoreFormat: jsii.String("storeFormat"), // the properties below are optional Description: jsii.String("description"), Reference: &ReferenceItemProperty{ ReferenceArn: jsii.String("referenceArn"), }, SseConfig: &SseConfigProperty{ Type: jsii.String("type"), // the properties below are optional KeyArn: jsii.String("keyArn"), }, StoreOptions: &StoreOptionsProperty{ TsvStoreOptions: &TsvStoreOptionsProperty{ AnnotationType: jsii.String("annotationType"), FormatToHeader: map[string]*string{ "formatToHeaderKey": jsii.String("formatToHeader"), }, Schema: schema, }, }, Tags: map[string]*string{ "tagsKey": jsii.String("tags"), }, })
func NewCfnAnnotationStore ¶
func NewCfnAnnotationStore(scope constructs.Construct, id *string, props *CfnAnnotationStoreProps) CfnAnnotationStore
type CfnAnnotationStoreProps ¶
type CfnAnnotationStoreProps struct { // The name of the Annotation Store. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-omics-annotationstore.html#cfn-omics-annotationstore-name // Name *string `field:"required" json:"name" yaml:"name"` // The annotation file format of the store. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-omics-annotationstore.html#cfn-omics-annotationstore-storeformat // StoreFormat *string `field:"required" json:"storeFormat" yaml:"storeFormat"` // A description for the store. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-omics-annotationstore.html#cfn-omics-annotationstore-description // Description *string `field:"optional" json:"description" yaml:"description"` // The genome reference for the store's annotations. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-omics-annotationstore.html#cfn-omics-annotationstore-reference // Reference interface{} `field:"optional" json:"reference" yaml:"reference"` // The store's server-side encryption (SSE) settings. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-omics-annotationstore.html#cfn-omics-annotationstore-sseconfig // SseConfig interface{} `field:"optional" json:"sseConfig" yaml:"sseConfig"` // File parsing options for the annotation store. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-omics-annotationstore.html#cfn-omics-annotationstore-storeoptions // StoreOptions interface{} `field:"optional" json:"storeOptions" yaml:"storeOptions"` // Tags for the store. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-omics-annotationstore.html#cfn-omics-annotationstore-tags // Tags *map[string]*string `field:"optional" json:"tags" yaml:"tags"` }
Properties for defining a `CfnAnnotationStore`.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" var schema interface{} cfnAnnotationStoreProps := &CfnAnnotationStoreProps{ Name: jsii.String("name"), StoreFormat: jsii.String("storeFormat"), // the properties below are optional Description: jsii.String("description"), Reference: &ReferenceItemProperty{ ReferenceArn: jsii.String("referenceArn"), }, SseConfig: &SseConfigProperty{ Type: jsii.String("type"), // the properties below are optional KeyArn: jsii.String("keyArn"), }, StoreOptions: &StoreOptionsProperty{ TsvStoreOptions: &TsvStoreOptionsProperty{ AnnotationType: jsii.String("annotationType"), FormatToHeader: map[string]*string{ "formatToHeaderKey": jsii.String("formatToHeader"), }, Schema: schema, }, }, Tags: map[string]*string{ "tagsKey": jsii.String("tags"), }, }
type CfnAnnotationStore_ReferenceItemProperty ¶
type CfnAnnotationStore_ReferenceItemProperty struct { // The reference's ARN. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-omics-annotationstore-referenceitem.html#cfn-omics-annotationstore-referenceitem-referencearn // ReferenceArn *string `field:"required" json:"referenceArn" yaml:"referenceArn"` }
A genome reference.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" referenceItemProperty := &ReferenceItemProperty{ ReferenceArn: jsii.String("referenceArn"), }
type CfnAnnotationStore_SseConfigProperty ¶
type CfnAnnotationStore_SseConfigProperty struct { // The encryption type. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-omics-annotationstore-sseconfig.html#cfn-omics-annotationstore-sseconfig-type // Type *string `field:"required" json:"type" yaml:"type"` // An encryption key ARN. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-omics-annotationstore-sseconfig.html#cfn-omics-annotationstore-sseconfig-keyarn // KeyArn *string `field:"optional" json:"keyArn" yaml:"keyArn"` }
Server-side encryption (SSE) settings for a store.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" sseConfigProperty := &SseConfigProperty{ Type: jsii.String("type"), // the properties below are optional KeyArn: jsii.String("keyArn"), }
type CfnAnnotationStore_StoreOptionsProperty ¶
type CfnAnnotationStore_StoreOptionsProperty struct { // Formatting options for a TSV file. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-omics-annotationstore-storeoptions.html#cfn-omics-annotationstore-storeoptions-tsvstoreoptions // TsvStoreOptions interface{} `field:"required" json:"tsvStoreOptions" yaml:"tsvStoreOptions"` }
The store's file parsing options.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" var schema interface{} storeOptionsProperty := &StoreOptionsProperty{ TsvStoreOptions: &TsvStoreOptionsProperty{ AnnotationType: jsii.String("annotationType"), FormatToHeader: map[string]*string{ "formatToHeaderKey": jsii.String("formatToHeader"), }, Schema: schema, }, }
type CfnAnnotationStore_TsvStoreOptionsProperty ¶
type CfnAnnotationStore_TsvStoreOptionsProperty struct { // The store's annotation type. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-omics-annotationstore-tsvstoreoptions.html#cfn-omics-annotationstore-tsvstoreoptions-annotationtype // AnnotationType *string `field:"optional" json:"annotationType" yaml:"annotationType"` // The store's header key to column name mapping. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-omics-annotationstore-tsvstoreoptions.html#cfn-omics-annotationstore-tsvstoreoptions-formattoheader // FormatToHeader interface{} `field:"optional" json:"formatToHeader" yaml:"formatToHeader"` // The schema of an annotation store. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-omics-annotationstore-tsvstoreoptions.html#cfn-omics-annotationstore-tsvstoreoptions-schema // Schema interface{} `field:"optional" json:"schema" yaml:"schema"` }
The store's parsing options.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" var schema interface{} tsvStoreOptionsProperty := &TsvStoreOptionsProperty{ AnnotationType: jsii.String("annotationType"), FormatToHeader: map[string]*string{ "formatToHeaderKey": jsii.String("formatToHeader"), }, Schema: schema, }
type CfnReferenceStore ¶
type CfnReferenceStore interface { awscdk.CfnResource awscdk.IInspectable awscdk.ITaggable // The store's ARN. AttrArn() *string // When the store was created. AttrCreationTime() *string // The store's ID. AttrReferenceStoreId() *string // Options for this resource, such as condition, update policy etc. CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} // AWS resource type. CfnResourceType() *string // Returns: the stack trace of the point where this Resource was created from, sourced // from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most // node +internal+ entries filtered. CreationStack() *[]*string // A description for the store. Description() *string SetDescription(val *string) // The logical ID for this CloudFormation stack element. // // The logical ID of the element // is calculated from the path of the resource node in the construct tree. // // To override this value, use `overrideLogicalId(newLogicalId)`. // // Returns: the logical ID as a stringified token. This value will only get // resolved during synthesis. LogicalId() *string // A name for the store. Name() *string SetName(val *string) // The tree node. Node() constructs.Node // Return a string that will be resolved to a CloudFormation `{ Ref }` for this element. // // If, by any chance, the intrinsic reference of a resource is not a string, you could // coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`. Ref() *string // Server-side encryption (SSE) settings for the store. SseConfig() interface{} SetSseConfig(val interface{}) // The stack in which this element is defined. // // CfnElements must be defined within a stack scope (directly or indirectly). Stack() awscdk.Stack // Tag Manager which manages the tags for this resource. Tags() awscdk.TagManager // Tags for the store. TagsRaw() *map[string]*string SetTagsRaw(val *map[string]*string) // Deprecated. // Deprecated: use `updatedProperties` // // Return properties modified after initiation // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperites() *map[string]interface{} // Return properties modified after initiation. // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperties() *map[string]interface{} // Syntactic sugar for `addOverride(path, undefined)`. AddDeletionOverride(path *string) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // // This can be used for resources across stacks (or nested stack) boundaries // and the dependency will automatically be transferred to the relevant scope. AddDependency(target awscdk.CfnResource) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // Deprecated: use addDependency. AddDependsOn(target awscdk.CfnResource) // Add a value to the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // AddMetadata(key *string, value interface{}) // Adds an override to the synthesized CloudFormation resource. // // To add a // property override, either use `addPropertyOverride` or prefix `path` with // "Properties." (i.e. `Properties.TopicName`). // // If the override is nested, separate each nested level using a dot (.) in the path parameter. // If there is an array as part of the nesting, specify the index in the path. // // To include a literal `.` in the property name, prefix with a `\`. In most // programming languages you will need to write this as `"\\."` because the // `\` itself will need to be escaped. // // For example, // “`typescript // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']); // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE'); // “` // would add the overrides // “`json // "Properties": { // "GlobalSecondaryIndexes": [ // { // "Projection": { // "NonKeyAttributes": [ "myattribute" ] // ... // } // ... // }, // { // "ProjectionType": "INCLUDE" // ... // }, // ] // ... // } // “` // // The `value` argument to `addOverride` will not be processed or translated // in any way. Pass raw JSON values in here with the correct capitalization // for CloudFormation. If you pass CDK classes or structs, they will be // rendered with lowercased key names, and CloudFormation will reject the // template. AddOverride(path *string, value interface{}) // Adds an override that deletes the value of a property from the resource definition. AddPropertyDeletionOverride(propertyPath *string) // Adds an override to a resource property. // // Syntactic sugar for `addOverride("Properties.<...>", value)`. AddPropertyOverride(propertyPath *string, value interface{}) // Sets the deletion policy of the resource based on the removal policy specified. // // The Removal Policy controls what happens to this resource when it stops // being managed by CloudFormation, either because you've removed it from the // CDK application or because you've made a change that requires the resource // to be replaced. // // The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS // account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some // cases, a snapshot can be taken of the resource prior to deletion // (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy // can be found in the following link:. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options // ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions) // Returns a token for an runtime attribute of this resource. // // Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility // in case there is no generated attribute. GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference // Retrieve a value value from the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // GetMetadata(key *string) interface{} // Examines the CloudFormation resource and discloses attributes. Inspect(inspector awscdk.TreeInspector) // Retrieves an array of resources this resource depends on. // // This assembles dependencies on resources across stacks (including nested stacks) // automatically. ObtainDependencies() *[]interface{} // Get a shallow copy of dependencies between this resource and other resources in the same stack. ObtainResourceDependencies() *[]awscdk.CfnResource // Overrides the auto-generated logical ID with a specific ID. OverrideLogicalId(newLogicalId *string) // Indicates that this resource no longer depends on another resource. // // This can be used for resources across stacks (including nested stacks) // and the dependency will automatically be removed from the relevant scope. RemoveDependency(target awscdk.CfnResource) RenderProperties(props *map[string]interface{}) *map[string]interface{} // Replaces one dependency with another. ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource) // Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template. // // Returns: `true` if the resource should be included or `false` is the resource // should be omitted. ShouldSynthesize() *bool // Returns a string representation of this construct. // // Returns: a string representation of this resource. ToString() *string ValidateProperties(_properties interface{}) }
Creates a reference store.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cfnReferenceStore := awscdk.Aws_omics.NewCfnReferenceStore(this, jsii.String("MyCfnReferenceStore"), &CfnReferenceStoreProps{ Name: jsii.String("name"), // the properties below are optional Description: jsii.String("description"), SseConfig: &SseConfigProperty{ Type: jsii.String("type"), // the properties below are optional KeyArn: jsii.String("keyArn"), }, Tags: map[string]*string{ "tagsKey": jsii.String("tags"), }, })
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-omics-referencestore.html
func NewCfnReferenceStore ¶
func NewCfnReferenceStore(scope constructs.Construct, id *string, props *CfnReferenceStoreProps) CfnReferenceStore
type CfnReferenceStoreProps ¶
type CfnReferenceStoreProps struct { // A name for the store. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-omics-referencestore.html#cfn-omics-referencestore-name // Name *string `field:"required" json:"name" yaml:"name"` // A description for the store. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-omics-referencestore.html#cfn-omics-referencestore-description // Description *string `field:"optional" json:"description" yaml:"description"` // Server-side encryption (SSE) settings for the store. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-omics-referencestore.html#cfn-omics-referencestore-sseconfig // SseConfig interface{} `field:"optional" json:"sseConfig" yaml:"sseConfig"` // Tags for the store. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-omics-referencestore.html#cfn-omics-referencestore-tags // Tags *map[string]*string `field:"optional" json:"tags" yaml:"tags"` }
Properties for defining a `CfnReferenceStore`.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cfnReferenceStoreProps := &CfnReferenceStoreProps{ Name: jsii.String("name"), // the properties below are optional Description: jsii.String("description"), SseConfig: &SseConfigProperty{ Type: jsii.String("type"), // the properties below are optional KeyArn: jsii.String("keyArn"), }, Tags: map[string]*string{ "tagsKey": jsii.String("tags"), }, }
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-omics-referencestore.html
type CfnReferenceStore_SseConfigProperty ¶
type CfnReferenceStore_SseConfigProperty struct { // The encryption type. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-omics-referencestore-sseconfig.html#cfn-omics-referencestore-sseconfig-type // Type *string `field:"required" json:"type" yaml:"type"` // An encryption key ARN. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-omics-referencestore-sseconfig.html#cfn-omics-referencestore-sseconfig-keyarn // KeyArn *string `field:"optional" json:"keyArn" yaml:"keyArn"` }
Server-side encryption (SSE) settings for a store.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" sseConfigProperty := &SseConfigProperty{ Type: jsii.String("type"), // the properties below are optional KeyArn: jsii.String("keyArn"), }
type CfnRunGroup ¶
type CfnRunGroup interface { awscdk.CfnResource awscdk.IInspectable awscdk.ITaggable // The run group's ARN. AttrArn() *string // When the run group was created. AttrCreationTime() *string // The run group's ID. AttrId() *string // Options for this resource, such as condition, update policy etc. CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} // AWS resource type. CfnResourceType() *string // Returns: the stack trace of the point where this Resource was created from, sourced // from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most // node +internal+ entries filtered. CreationStack() *[]*string // The logical ID for this CloudFormation stack element. // // The logical ID of the element // is calculated from the path of the resource node in the construct tree. // // To override this value, use `overrideLogicalId(newLogicalId)`. // // Returns: the logical ID as a stringified token. This value will only get // resolved during synthesis. LogicalId() *string // The group's maximum CPU count setting. MaxCpus() *float64 SetMaxCpus(val *float64) // The group's maximum duration setting in minutes. MaxDuration() *float64 SetMaxDuration(val *float64) // The maximum GPUs that can be used by a run group. MaxGpus() *float64 SetMaxGpus(val *float64) // The group's maximum concurrent run setting. MaxRuns() *float64 SetMaxRuns(val *float64) // The group's name. Name() *string SetName(val *string) // The tree node. Node() constructs.Node // Return a string that will be resolved to a CloudFormation `{ Ref }` for this element. // // If, by any chance, the intrinsic reference of a resource is not a string, you could // coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`. Ref() *string // The stack in which this element is defined. // // CfnElements must be defined within a stack scope (directly or indirectly). Stack() awscdk.Stack // Tag Manager which manages the tags for this resource. Tags() awscdk.TagManager // Tags for the group. TagsRaw() *map[string]*string SetTagsRaw(val *map[string]*string) // Deprecated. // Deprecated: use `updatedProperties` // // Return properties modified after initiation // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperites() *map[string]interface{} // Return properties modified after initiation. // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperties() *map[string]interface{} // Syntactic sugar for `addOverride(path, undefined)`. AddDeletionOverride(path *string) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // // This can be used for resources across stacks (or nested stack) boundaries // and the dependency will automatically be transferred to the relevant scope. AddDependency(target awscdk.CfnResource) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // Deprecated: use addDependency. AddDependsOn(target awscdk.CfnResource) // Add a value to the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // AddMetadata(key *string, value interface{}) // Adds an override to the synthesized CloudFormation resource. // // To add a // property override, either use `addPropertyOverride` or prefix `path` with // "Properties." (i.e. `Properties.TopicName`). // // If the override is nested, separate each nested level using a dot (.) in the path parameter. // If there is an array as part of the nesting, specify the index in the path. // // To include a literal `.` in the property name, prefix with a `\`. In most // programming languages you will need to write this as `"\\."` because the // `\` itself will need to be escaped. // // For example, // “`typescript // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']); // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE'); // “` // would add the overrides // “`json // "Properties": { // "GlobalSecondaryIndexes": [ // { // "Projection": { // "NonKeyAttributes": [ "myattribute" ] // ... // } // ... // }, // { // "ProjectionType": "INCLUDE" // ... // }, // ] // ... // } // “` // // The `value` argument to `addOverride` will not be processed or translated // in any way. Pass raw JSON values in here with the correct capitalization // for CloudFormation. If you pass CDK classes or structs, they will be // rendered with lowercased key names, and CloudFormation will reject the // template. AddOverride(path *string, value interface{}) // Adds an override that deletes the value of a property from the resource definition. AddPropertyDeletionOverride(propertyPath *string) // Adds an override to a resource property. // // Syntactic sugar for `addOverride("Properties.<...>", value)`. AddPropertyOverride(propertyPath *string, value interface{}) // Sets the deletion policy of the resource based on the removal policy specified. // // The Removal Policy controls what happens to this resource when it stops // being managed by CloudFormation, either because you've removed it from the // CDK application or because you've made a change that requires the resource // to be replaced. // // The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS // account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some // cases, a snapshot can be taken of the resource prior to deletion // (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy // can be found in the following link:. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options // ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions) // Returns a token for an runtime attribute of this resource. // // Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility // in case there is no generated attribute. GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference // Retrieve a value value from the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // GetMetadata(key *string) interface{} // Examines the CloudFormation resource and discloses attributes. Inspect(inspector awscdk.TreeInspector) // Retrieves an array of resources this resource depends on. // // This assembles dependencies on resources across stacks (including nested stacks) // automatically. ObtainDependencies() *[]interface{} // Get a shallow copy of dependencies between this resource and other resources in the same stack. ObtainResourceDependencies() *[]awscdk.CfnResource // Overrides the auto-generated logical ID with a specific ID. OverrideLogicalId(newLogicalId *string) // Indicates that this resource no longer depends on another resource. // // This can be used for resources across stacks (including nested stacks) // and the dependency will automatically be removed from the relevant scope. RemoveDependency(target awscdk.CfnResource) RenderProperties(props *map[string]interface{}) *map[string]interface{} // Replaces one dependency with another. ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource) // Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template. // // Returns: `true` if the resource should be included or `false` is the resource // should be omitted. ShouldSynthesize() *bool // Returns a string representation of this construct. // // Returns: a string representation of this resource. ToString() *string ValidateProperties(_properties interface{}) }
You can optionally create a run group to limit the compute resources for the runs that you add to the group.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cfnRunGroup := awscdk.Aws_omics.NewCfnRunGroup(this, jsii.String("MyCfnRunGroup"), &CfnRunGroupProps{ MaxCpus: jsii.Number(123), MaxDuration: jsii.Number(123), MaxGpus: jsii.Number(123), MaxRuns: jsii.Number(123), Name: jsii.String("name"), Tags: map[string]*string{ "tagsKey": jsii.String("tags"), }, })
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-omics-rungroup.html
func NewCfnRunGroup ¶
func NewCfnRunGroup(scope constructs.Construct, id *string, props *CfnRunGroupProps) CfnRunGroup
type CfnRunGroupProps ¶
type CfnRunGroupProps struct { // The group's maximum CPU count setting. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-omics-rungroup.html#cfn-omics-rungroup-maxcpus // MaxCpus *float64 `field:"optional" json:"maxCpus" yaml:"maxCpus"` // The group's maximum duration setting in minutes. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-omics-rungroup.html#cfn-omics-rungroup-maxduration // MaxDuration *float64 `field:"optional" json:"maxDuration" yaml:"maxDuration"` // The maximum GPUs that can be used by a run group. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-omics-rungroup.html#cfn-omics-rungroup-maxgpus // MaxGpus *float64 `field:"optional" json:"maxGpus" yaml:"maxGpus"` // The group's maximum concurrent run setting. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-omics-rungroup.html#cfn-omics-rungroup-maxruns // MaxRuns *float64 `field:"optional" json:"maxRuns" yaml:"maxRuns"` // The group's name. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-omics-rungroup.html#cfn-omics-rungroup-name // Name *string `field:"optional" json:"name" yaml:"name"` // Tags for the group. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-omics-rungroup.html#cfn-omics-rungroup-tags // Tags *map[string]*string `field:"optional" json:"tags" yaml:"tags"` }
Properties for defining a `CfnRunGroup`.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cfnRunGroupProps := &CfnRunGroupProps{ MaxCpus: jsii.Number(123), MaxDuration: jsii.Number(123), MaxGpus: jsii.Number(123), MaxRuns: jsii.Number(123), Name: jsii.String("name"), Tags: map[string]*string{ "tagsKey": jsii.String("tags"), }, }
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-omics-rungroup.html
type CfnSequenceStore ¶
type CfnSequenceStore interface { awscdk.CfnResource awscdk.IInspectable awscdk.ITaggable // The store's ARN. AttrArn() *string // When the store was created. AttrCreationTime() *string // The store's ID. AttrSequenceStoreId() *string // Options for this resource, such as condition, update policy etc. CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} // AWS resource type. CfnResourceType() *string // Returns: the stack trace of the point where this Resource was created from, sourced // from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most // node +internal+ entries filtered. CreationStack() *[]*string // A description for the store. Description() *string SetDescription(val *string) // An S3 location that is used to store files that have failed a direct upload. FallbackLocation() *string SetFallbackLocation(val *string) // The logical ID for this CloudFormation stack element. // // The logical ID of the element // is calculated from the path of the resource node in the construct tree. // // To override this value, use `overrideLogicalId(newLogicalId)`. // // Returns: the logical ID as a stringified token. This value will only get // resolved during synthesis. LogicalId() *string // A name for the store. Name() *string SetName(val *string) // The tree node. Node() constructs.Node // Return a string that will be resolved to a CloudFormation `{ Ref }` for this element. // // If, by any chance, the intrinsic reference of a resource is not a string, you could // coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`. Ref() *string // Server-side encryption (SSE) settings for the store. SseConfig() interface{} SetSseConfig(val interface{}) // The stack in which this element is defined. // // CfnElements must be defined within a stack scope (directly or indirectly). Stack() awscdk.Stack // Tag Manager which manages the tags for this resource. Tags() awscdk.TagManager // Tags for the store. TagsRaw() *map[string]*string SetTagsRaw(val *map[string]*string) // Deprecated. // Deprecated: use `updatedProperties` // // Return properties modified after initiation // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperites() *map[string]interface{} // Return properties modified after initiation. // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperties() *map[string]interface{} // Syntactic sugar for `addOverride(path, undefined)`. AddDeletionOverride(path *string) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // // This can be used for resources across stacks (or nested stack) boundaries // and the dependency will automatically be transferred to the relevant scope. AddDependency(target awscdk.CfnResource) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // Deprecated: use addDependency. AddDependsOn(target awscdk.CfnResource) // Add a value to the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // AddMetadata(key *string, value interface{}) // Adds an override to the synthesized CloudFormation resource. // // To add a // property override, either use `addPropertyOverride` or prefix `path` with // "Properties." (i.e. `Properties.TopicName`). // // If the override is nested, separate each nested level using a dot (.) in the path parameter. // If there is an array as part of the nesting, specify the index in the path. // // To include a literal `.` in the property name, prefix with a `\`. In most // programming languages you will need to write this as `"\\."` because the // `\` itself will need to be escaped. // // For example, // “`typescript // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']); // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE'); // “` // would add the overrides // “`json // "Properties": { // "GlobalSecondaryIndexes": [ // { // "Projection": { // "NonKeyAttributes": [ "myattribute" ] // ... // } // ... // }, // { // "ProjectionType": "INCLUDE" // ... // }, // ] // ... // } // “` // // The `value` argument to `addOverride` will not be processed or translated // in any way. Pass raw JSON values in here with the correct capitalization // for CloudFormation. If you pass CDK classes or structs, they will be // rendered with lowercased key names, and CloudFormation will reject the // template. AddOverride(path *string, value interface{}) // Adds an override that deletes the value of a property from the resource definition. AddPropertyDeletionOverride(propertyPath *string) // Adds an override to a resource property. // // Syntactic sugar for `addOverride("Properties.<...>", value)`. AddPropertyOverride(propertyPath *string, value interface{}) // Sets the deletion policy of the resource based on the removal policy specified. // // The Removal Policy controls what happens to this resource when it stops // being managed by CloudFormation, either because you've removed it from the // CDK application or because you've made a change that requires the resource // to be replaced. // // The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS // account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some // cases, a snapshot can be taken of the resource prior to deletion // (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy // can be found in the following link:. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options // ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions) // Returns a token for an runtime attribute of this resource. // // Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility // in case there is no generated attribute. GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference // Retrieve a value value from the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // GetMetadata(key *string) interface{} // Examines the CloudFormation resource and discloses attributes. Inspect(inspector awscdk.TreeInspector) // Retrieves an array of resources this resource depends on. // // This assembles dependencies on resources across stacks (including nested stacks) // automatically. ObtainDependencies() *[]interface{} // Get a shallow copy of dependencies between this resource and other resources in the same stack. ObtainResourceDependencies() *[]awscdk.CfnResource // Overrides the auto-generated logical ID with a specific ID. OverrideLogicalId(newLogicalId *string) // Indicates that this resource no longer depends on another resource. // // This can be used for resources across stacks (including nested stacks) // and the dependency will automatically be removed from the relevant scope. RemoveDependency(target awscdk.CfnResource) RenderProperties(props *map[string]interface{}) *map[string]interface{} // Replaces one dependency with another. ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource) // Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template. // // Returns: `true` if the resource should be included or `false` is the resource // should be omitted. ShouldSynthesize() *bool // Returns a string representation of this construct. // // Returns: a string representation of this resource. ToString() *string ValidateProperties(_properties interface{}) }
Creates a sequence store.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cfnSequenceStore := awscdk.Aws_omics.NewCfnSequenceStore(this, jsii.String("MyCfnSequenceStore"), &CfnSequenceStoreProps{ Name: jsii.String("name"), // the properties below are optional Description: jsii.String("description"), FallbackLocation: jsii.String("fallbackLocation"), SseConfig: &SseConfigProperty{ Type: jsii.String("type"), // the properties below are optional KeyArn: jsii.String("keyArn"), }, Tags: map[string]*string{ "tagsKey": jsii.String("tags"), }, })
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-omics-sequencestore.html
func NewCfnSequenceStore ¶
func NewCfnSequenceStore(scope constructs.Construct, id *string, props *CfnSequenceStoreProps) CfnSequenceStore
type CfnSequenceStoreProps ¶
type CfnSequenceStoreProps struct { // A name for the store. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-omics-sequencestore.html#cfn-omics-sequencestore-name // Name *string `field:"required" json:"name" yaml:"name"` // A description for the store. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-omics-sequencestore.html#cfn-omics-sequencestore-description // Description *string `field:"optional" json:"description" yaml:"description"` // An S3 location that is used to store files that have failed a direct upload. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-omics-sequencestore.html#cfn-omics-sequencestore-fallbacklocation // FallbackLocation *string `field:"optional" json:"fallbackLocation" yaml:"fallbackLocation"` // Server-side encryption (SSE) settings for the store. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-omics-sequencestore.html#cfn-omics-sequencestore-sseconfig // SseConfig interface{} `field:"optional" json:"sseConfig" yaml:"sseConfig"` // Tags for the store. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-omics-sequencestore.html#cfn-omics-sequencestore-tags // Tags *map[string]*string `field:"optional" json:"tags" yaml:"tags"` }
Properties for defining a `CfnSequenceStore`.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cfnSequenceStoreProps := &CfnSequenceStoreProps{ Name: jsii.String("name"), // the properties below are optional Description: jsii.String("description"), FallbackLocation: jsii.String("fallbackLocation"), SseConfig: &SseConfigProperty{ Type: jsii.String("type"), // the properties below are optional KeyArn: jsii.String("keyArn"), }, Tags: map[string]*string{ "tagsKey": jsii.String("tags"), }, }
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-omics-sequencestore.html
type CfnSequenceStore_SseConfigProperty ¶
type CfnSequenceStore_SseConfigProperty struct { // The encryption type. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-omics-sequencestore-sseconfig.html#cfn-omics-sequencestore-sseconfig-type // Type *string `field:"required" json:"type" yaml:"type"` // An encryption key ARN. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-omics-sequencestore-sseconfig.html#cfn-omics-sequencestore-sseconfig-keyarn // KeyArn *string `field:"optional" json:"keyArn" yaml:"keyArn"` }
Server-side encryption (SSE) settings for a store.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" sseConfigProperty := &SseConfigProperty{ Type: jsii.String("type"), // the properties below are optional KeyArn: jsii.String("keyArn"), }
type CfnVariantStore ¶
type CfnVariantStore interface { awscdk.CfnResource awscdk.IInspectable awscdk.ITaggable // When the store was created. AttrCreationTime() *string // The store's ID. AttrId() *string // The store's status. AttrStatus() *string // The store's status message. AttrStatusMessage() *string // The store's ARN. AttrStoreArn() *string // The store's size in bytes. AttrStoreSizeBytes() awscdk.IResolvable // When the store was updated. AttrUpdateTime() *string // Options for this resource, such as condition, update policy etc. CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} // AWS resource type. CfnResourceType() *string // Returns: the stack trace of the point where this Resource was created from, sourced // from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most // node +internal+ entries filtered. CreationStack() *[]*string // A description for the store. Description() *string SetDescription(val *string) // The logical ID for this CloudFormation stack element. // // The logical ID of the element // is calculated from the path of the resource node in the construct tree. // // To override this value, use `overrideLogicalId(newLogicalId)`. // // Returns: the logical ID as a stringified token. This value will only get // resolved during synthesis. LogicalId() *string // A name for the store. Name() *string SetName(val *string) // The tree node. Node() constructs.Node // Return a string that will be resolved to a CloudFormation `{ Ref }` for this element. // // If, by any chance, the intrinsic reference of a resource is not a string, you could // coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`. Ref() *string // The genome reference for the store's variants. Reference() interface{} SetReference(val interface{}) // Server-side encryption (SSE) settings for the store. SseConfig() interface{} SetSseConfig(val interface{}) // The stack in which this element is defined. // // CfnElements must be defined within a stack scope (directly or indirectly). Stack() awscdk.Stack // Tag Manager which manages the tags for this resource. Tags() awscdk.TagManager // Tags for the store. TagsRaw() *map[string]*string SetTagsRaw(val *map[string]*string) // Deprecated. // Deprecated: use `updatedProperties` // // Return properties modified after initiation // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperites() *map[string]interface{} // Return properties modified after initiation. // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperties() *map[string]interface{} // Syntactic sugar for `addOverride(path, undefined)`. AddDeletionOverride(path *string) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // // This can be used for resources across stacks (or nested stack) boundaries // and the dependency will automatically be transferred to the relevant scope. AddDependency(target awscdk.CfnResource) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // Deprecated: use addDependency. AddDependsOn(target awscdk.CfnResource) // Add a value to the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // AddMetadata(key *string, value interface{}) // Adds an override to the synthesized CloudFormation resource. // // To add a // property override, either use `addPropertyOverride` or prefix `path` with // "Properties." (i.e. `Properties.TopicName`). // // If the override is nested, separate each nested level using a dot (.) in the path parameter. // If there is an array as part of the nesting, specify the index in the path. // // To include a literal `.` in the property name, prefix with a `\`. In most // programming languages you will need to write this as `"\\."` because the // `\` itself will need to be escaped. // // For example, // “`typescript // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']); // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE'); // “` // would add the overrides // “`json // "Properties": { // "GlobalSecondaryIndexes": [ // { // "Projection": { // "NonKeyAttributes": [ "myattribute" ] // ... // } // ... // }, // { // "ProjectionType": "INCLUDE" // ... // }, // ] // ... // } // “` // // The `value` argument to `addOverride` will not be processed or translated // in any way. Pass raw JSON values in here with the correct capitalization // for CloudFormation. If you pass CDK classes or structs, they will be // rendered with lowercased key names, and CloudFormation will reject the // template. AddOverride(path *string, value interface{}) // Adds an override that deletes the value of a property from the resource definition. AddPropertyDeletionOverride(propertyPath *string) // Adds an override to a resource property. // // Syntactic sugar for `addOverride("Properties.<...>", value)`. AddPropertyOverride(propertyPath *string, value interface{}) // Sets the deletion policy of the resource based on the removal policy specified. // // The Removal Policy controls what happens to this resource when it stops // being managed by CloudFormation, either because you've removed it from the // CDK application or because you've made a change that requires the resource // to be replaced. // // The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS // account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some // cases, a snapshot can be taken of the resource prior to deletion // (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy // can be found in the following link:. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options // ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions) // Returns a token for an runtime attribute of this resource. // // Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility // in case there is no generated attribute. GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference // Retrieve a value value from the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // GetMetadata(key *string) interface{} // Examines the CloudFormation resource and discloses attributes. Inspect(inspector awscdk.TreeInspector) // Retrieves an array of resources this resource depends on. // // This assembles dependencies on resources across stacks (including nested stacks) // automatically. ObtainDependencies() *[]interface{} // Get a shallow copy of dependencies between this resource and other resources in the same stack. ObtainResourceDependencies() *[]awscdk.CfnResource // Overrides the auto-generated logical ID with a specific ID. OverrideLogicalId(newLogicalId *string) // Indicates that this resource no longer depends on another resource. // // This can be used for resources across stacks (including nested stacks) // and the dependency will automatically be removed from the relevant scope. RemoveDependency(target awscdk.CfnResource) RenderProperties(props *map[string]interface{}) *map[string]interface{} // Replaces one dependency with another. ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource) // Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template. // // Returns: `true` if the resource should be included or `false` is the resource // should be omitted. ShouldSynthesize() *bool // Returns a string representation of this construct. // // Returns: a string representation of this resource. ToString() *string ValidateProperties(_properties interface{}) }
Create a store for variant data.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cfnVariantStore := awscdk.Aws_omics.NewCfnVariantStore(this, jsii.String("MyCfnVariantStore"), &CfnVariantStoreProps{ Name: jsii.String("name"), Reference: &ReferenceItemProperty{ ReferenceArn: jsii.String("referenceArn"), }, // the properties below are optional Description: jsii.String("description"), SseConfig: &SseConfigProperty{ Type: jsii.String("type"), // the properties below are optional KeyArn: jsii.String("keyArn"), }, Tags: map[string]*string{ "tagsKey": jsii.String("tags"), }, })
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-omics-variantstore.html
func NewCfnVariantStore ¶
func NewCfnVariantStore(scope constructs.Construct, id *string, props *CfnVariantStoreProps) CfnVariantStore
type CfnVariantStoreProps ¶
type CfnVariantStoreProps struct { // A name for the store. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-omics-variantstore.html#cfn-omics-variantstore-name // Name *string `field:"required" json:"name" yaml:"name"` // The genome reference for the store's variants. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-omics-variantstore.html#cfn-omics-variantstore-reference // Reference interface{} `field:"required" json:"reference" yaml:"reference"` // A description for the store. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-omics-variantstore.html#cfn-omics-variantstore-description // Description *string `field:"optional" json:"description" yaml:"description"` // Server-side encryption (SSE) settings for the store. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-omics-variantstore.html#cfn-omics-variantstore-sseconfig // SseConfig interface{} `field:"optional" json:"sseConfig" yaml:"sseConfig"` // Tags for the store. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-omics-variantstore.html#cfn-omics-variantstore-tags // Tags *map[string]*string `field:"optional" json:"tags" yaml:"tags"` }
Properties for defining a `CfnVariantStore`.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cfnVariantStoreProps := &CfnVariantStoreProps{ Name: jsii.String("name"), Reference: &ReferenceItemProperty{ ReferenceArn: jsii.String("referenceArn"), }, // the properties below are optional Description: jsii.String("description"), SseConfig: &SseConfigProperty{ Type: jsii.String("type"), // the properties below are optional KeyArn: jsii.String("keyArn"), }, Tags: map[string]*string{ "tagsKey": jsii.String("tags"), }, }
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-omics-variantstore.html
type CfnVariantStore_ReferenceItemProperty ¶
type CfnVariantStore_ReferenceItemProperty struct { // The reference's ARN. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-omics-variantstore-referenceitem.html#cfn-omics-variantstore-referenceitem-referencearn // ReferenceArn *string `field:"required" json:"referenceArn" yaml:"referenceArn"` }
The read set's genome reference ARN.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" referenceItemProperty := &ReferenceItemProperty{ ReferenceArn: jsii.String("referenceArn"), }
type CfnVariantStore_SseConfigProperty ¶
type CfnVariantStore_SseConfigProperty struct { // The encryption type. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-omics-variantstore-sseconfig.html#cfn-omics-variantstore-sseconfig-type // Type *string `field:"required" json:"type" yaml:"type"` // An encryption key ARN. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-omics-variantstore-sseconfig.html#cfn-omics-variantstore-sseconfig-keyarn // KeyArn *string `field:"optional" json:"keyArn" yaml:"keyArn"` }
Server-side encryption (SSE) settings for a store.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" sseConfigProperty := &SseConfigProperty{ Type: jsii.String("type"), // the properties below are optional KeyArn: jsii.String("keyArn"), }
type CfnWorkflow ¶
type CfnWorkflow interface { awscdk.CfnResource awscdk.IInspectable awscdk.ITaggable Accelerators() *string SetAccelerators(val *string) // The ARN for the workflow. AttrArn() *string // When the workflow was created. AttrCreationTime() *string // The workflow's ID. AttrId() *string // The workflow's status. AttrStatus() *string // The workflow's type. AttrType() *string // Options for this resource, such as condition, update policy etc. CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} // AWS resource type. CfnResourceType() *string // Returns: the stack trace of the point where this Resource was created from, sourced // from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most // node +internal+ entries filtered. CreationStack() *[]*string // The URI of a definition for the workflow. DefinitionUri() *string SetDefinitionUri(val *string) // The parameter's description. Description() *string SetDescription(val *string) // An engine for the workflow. Engine() *string SetEngine(val *string) // The logical ID for this CloudFormation stack element. // // The logical ID of the element // is calculated from the path of the resource node in the construct tree. // // To override this value, use `overrideLogicalId(newLogicalId)`. // // Returns: the logical ID as a stringified token. This value will only get // resolved during synthesis. LogicalId() *string // The path of the main definition file for the workflow. Main() *string SetMain(val *string) // The workflow's name. Name() *string SetName(val *string) // The tree node. Node() constructs.Node // The workflow's parameter template. ParameterTemplate() interface{} SetParameterTemplate(val interface{}) // Return a string that will be resolved to a CloudFormation `{ Ref }` for this element. // // If, by any chance, the intrinsic reference of a resource is not a string, you could // coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`. Ref() *string // The stack in which this element is defined. // // CfnElements must be defined within a stack scope (directly or indirectly). Stack() awscdk.Stack // The default storage capacity for the workflow runs, in gibibytes. StorageCapacity() *float64 SetStorageCapacity(val *float64) // Tag Manager which manages the tags for this resource. Tags() awscdk.TagManager // Tags for the workflow. TagsRaw() *map[string]*string SetTagsRaw(val *map[string]*string) // Deprecated. // Deprecated: use `updatedProperties` // // Return properties modified after initiation // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperites() *map[string]interface{} // Return properties modified after initiation. // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperties() *map[string]interface{} // Syntactic sugar for `addOverride(path, undefined)`. AddDeletionOverride(path *string) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // // This can be used for resources across stacks (or nested stack) boundaries // and the dependency will automatically be transferred to the relevant scope. AddDependency(target awscdk.CfnResource) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // Deprecated: use addDependency. AddDependsOn(target awscdk.CfnResource) // Add a value to the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // AddMetadata(key *string, value interface{}) // Adds an override to the synthesized CloudFormation resource. // // To add a // property override, either use `addPropertyOverride` or prefix `path` with // "Properties." (i.e. `Properties.TopicName`). // // If the override is nested, separate each nested level using a dot (.) in the path parameter. // If there is an array as part of the nesting, specify the index in the path. // // To include a literal `.` in the property name, prefix with a `\`. In most // programming languages you will need to write this as `"\\."` because the // `\` itself will need to be escaped. // // For example, // “`typescript // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']); // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE'); // “` // would add the overrides // “`json // "Properties": { // "GlobalSecondaryIndexes": [ // { // "Projection": { // "NonKeyAttributes": [ "myattribute" ] // ... // } // ... // }, // { // "ProjectionType": "INCLUDE" // ... // }, // ] // ... // } // “` // // The `value` argument to `addOverride` will not be processed or translated // in any way. Pass raw JSON values in here with the correct capitalization // for CloudFormation. If you pass CDK classes or structs, they will be // rendered with lowercased key names, and CloudFormation will reject the // template. AddOverride(path *string, value interface{}) // Adds an override that deletes the value of a property from the resource definition. AddPropertyDeletionOverride(propertyPath *string) // Adds an override to a resource property. // // Syntactic sugar for `addOverride("Properties.<...>", value)`. AddPropertyOverride(propertyPath *string, value interface{}) // Sets the deletion policy of the resource based on the removal policy specified. // // The Removal Policy controls what happens to this resource when it stops // being managed by CloudFormation, either because you've removed it from the // CDK application or because you've made a change that requires the resource // to be replaced. // // The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS // account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some // cases, a snapshot can be taken of the resource prior to deletion // (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy // can be found in the following link:. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options // ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions) // Returns a token for an runtime attribute of this resource. // // Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility // in case there is no generated attribute. GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference // Retrieve a value value from the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // GetMetadata(key *string) interface{} // Examines the CloudFormation resource and discloses attributes. Inspect(inspector awscdk.TreeInspector) // Retrieves an array of resources this resource depends on. // // This assembles dependencies on resources across stacks (including nested stacks) // automatically. ObtainDependencies() *[]interface{} // Get a shallow copy of dependencies between this resource and other resources in the same stack. ObtainResourceDependencies() *[]awscdk.CfnResource // Overrides the auto-generated logical ID with a specific ID. OverrideLogicalId(newLogicalId *string) // Indicates that this resource no longer depends on another resource. // // This can be used for resources across stacks (including nested stacks) // and the dependency will automatically be removed from the relevant scope. RemoveDependency(target awscdk.CfnResource) RenderProperties(props *map[string]interface{}) *map[string]interface{} // Replaces one dependency with another. ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource) // Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template. // // Returns: `true` if the resource should be included or `false` is the resource // should be omitted. ShouldSynthesize() *bool // Returns a string representation of this construct. // // Returns: a string representation of this resource. ToString() *string ValidateProperties(_properties interface{}) }
Creates a workflow.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cfnWorkflow := awscdk.Aws_omics.NewCfnWorkflow(this, jsii.String("MyCfnWorkflow"), &CfnWorkflowProps{ Accelerators: jsii.String("accelerators"), DefinitionUri: jsii.String("definitionUri"), Description: jsii.String("description"), Engine: jsii.String("engine"), Main: jsii.String("main"), Name: jsii.String("name"), ParameterTemplate: map[string]interface{}{ "parameterTemplateKey": &WorkflowParameterProperty{ "description": jsii.String("description"), "optional": jsii.Boolean(false), }, }, StorageCapacity: jsii.Number(123), Tags: map[string]*string{ "tagsKey": jsii.String("tags"), }, })
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-omics-workflow.html
func NewCfnWorkflow ¶
func NewCfnWorkflow(scope constructs.Construct, id *string, props *CfnWorkflowProps) CfnWorkflow
type CfnWorkflowProps ¶
type CfnWorkflowProps struct { // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-omics-workflow.html#cfn-omics-workflow-accelerators // Accelerators *string `field:"optional" json:"accelerators" yaml:"accelerators"` // The URI of a definition for the workflow. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-omics-workflow.html#cfn-omics-workflow-definitionuri // DefinitionUri *string `field:"optional" json:"definitionUri" yaml:"definitionUri"` // The parameter's description. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-omics-workflow.html#cfn-omics-workflow-description // Description *string `field:"optional" json:"description" yaml:"description"` // An engine for the workflow. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-omics-workflow.html#cfn-omics-workflow-engine // Engine *string `field:"optional" json:"engine" yaml:"engine"` // The path of the main definition file for the workflow. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-omics-workflow.html#cfn-omics-workflow-main // Main *string `field:"optional" json:"main" yaml:"main"` // The workflow's name. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-omics-workflow.html#cfn-omics-workflow-name // Name *string `field:"optional" json:"name" yaml:"name"` // The workflow's parameter template. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-omics-workflow.html#cfn-omics-workflow-parametertemplate // ParameterTemplate interface{} `field:"optional" json:"parameterTemplate" yaml:"parameterTemplate"` // The default storage capacity for the workflow runs, in gibibytes. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-omics-workflow.html#cfn-omics-workflow-storagecapacity // StorageCapacity *float64 `field:"optional" json:"storageCapacity" yaml:"storageCapacity"` // Tags for the workflow. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-omics-workflow.html#cfn-omics-workflow-tags // Tags *map[string]*string `field:"optional" json:"tags" yaml:"tags"` }
Properties for defining a `CfnWorkflow`.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cfnWorkflowProps := &CfnWorkflowProps{ Accelerators: jsii.String("accelerators"), DefinitionUri: jsii.String("definitionUri"), Description: jsii.String("description"), Engine: jsii.String("engine"), Main: jsii.String("main"), Name: jsii.String("name"), ParameterTemplate: map[string]interface{}{ "parameterTemplateKey": &WorkflowParameterProperty{ "description": jsii.String("description"), "optional": jsii.Boolean(false), }, }, StorageCapacity: jsii.Number(123), Tags: map[string]*string{ "tagsKey": jsii.String("tags"), }, }
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-omics-workflow.html
type CfnWorkflow_WorkflowParameterProperty ¶
type CfnWorkflow_WorkflowParameterProperty struct { // The parameter's description. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-omics-workflow-workflowparameter.html#cfn-omics-workflow-workflowparameter-description // Description *string `field:"optional" json:"description" yaml:"description"` // Whether the parameter is optional. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-omics-workflow-workflowparameter.html#cfn-omics-workflow-workflowparameter-optional // Optional interface{} `field:"optional" json:"optional" yaml:"optional"` }
A workflow parameter.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" workflowParameterProperty := &WorkflowParameterProperty{ Description: jsii.String("description"), Optional: jsii.Boolean(false), }
Source Files ¶
- CfnAnnotationStore.go
- CfnAnnotationStoreProps.go
- CfnAnnotationStore_ReferenceItemProperty.go
- CfnAnnotationStore_SseConfigProperty.go
- CfnAnnotationStore_StoreOptionsProperty.go
- CfnAnnotationStore_TsvStoreOptionsProperty.go
- CfnAnnotationStore__checks.go
- CfnReferenceStore.go
- CfnReferenceStoreProps.go
- CfnReferenceStore_SseConfigProperty.go
- CfnReferenceStore__checks.go
- CfnRunGroup.go
- CfnRunGroupProps.go
- CfnRunGroup__checks.go
- CfnSequenceStore.go
- CfnSequenceStoreProps.go
- CfnSequenceStore_SseConfigProperty.go
- CfnSequenceStore__checks.go
- CfnVariantStore.go
- CfnVariantStoreProps.go
- CfnVariantStore_ReferenceItemProperty.go
- CfnVariantStore_SseConfigProperty.go
- CfnVariantStore__checks.go
- CfnWorkflow.go
- CfnWorkflowProps.go
- CfnWorkflow_WorkflowParameterProperty.go
- CfnWorkflow__checks.go
- main.go