Documentation
¶
Index ¶
- func CfnAnnotationStore_CFN_RESOURCE_TYPE_NAME() *string
- func CfnAnnotationStore_IsCfnElement(x interface{}) *bool
- func CfnAnnotationStore_IsCfnResource(construct constructs.IConstruct) *bool
- func CfnAnnotationStore_IsConstruct(x interface{}) *bool
- func CfnReferenceStore_CFN_RESOURCE_TYPE_NAME() *string
- func CfnReferenceStore_IsCfnElement(x interface{}) *bool
- func CfnReferenceStore_IsCfnResource(construct constructs.IConstruct) *bool
- func CfnReferenceStore_IsConstruct(x interface{}) *bool
- func CfnRunGroup_CFN_RESOURCE_TYPE_NAME() *string
- func CfnRunGroup_IsCfnElement(x interface{}) *bool
- func CfnRunGroup_IsCfnResource(construct constructs.IConstruct) *bool
- func CfnRunGroup_IsConstruct(x interface{}) *bool
- func CfnSequenceStore_CFN_RESOURCE_TYPE_NAME() *string
- func CfnSequenceStore_IsCfnElement(x interface{}) *bool
- func CfnSequenceStore_IsCfnResource(construct constructs.IConstruct) *bool
- func CfnSequenceStore_IsConstruct(x interface{}) *bool
- func CfnVariantStore_CFN_RESOURCE_TYPE_NAME() *string
- func CfnVariantStore_IsCfnElement(x interface{}) *bool
- func CfnVariantStore_IsCfnResource(construct constructs.IConstruct) *bool
- func CfnVariantStore_IsConstruct(x interface{}) *bool
- func CfnWorkflow_CFN_RESOURCE_TYPE_NAME() *string
- func CfnWorkflow_IsCfnElement(x interface{}) *bool
- func CfnWorkflow_IsCfnResource(construct constructs.IConstruct) *bool
- func CfnWorkflow_IsConstruct(x interface{}) *bool
- func NewCfnAnnotationStore_Override(c CfnAnnotationStore, scope awscdk.Construct, id *string, ...)
- func NewCfnReferenceStore_Override(c CfnReferenceStore, scope awscdk.Construct, id *string, ...)
- func NewCfnRunGroup_Override(c CfnRunGroup, scope awscdk.Construct, id *string, props *CfnRunGroupProps)
- func NewCfnSequenceStore_Override(c CfnSequenceStore, scope awscdk.Construct, id *string, ...)
- func NewCfnVariantStore_Override(c CfnVariantStore, scope awscdk.Construct, id *string, ...)
- func NewCfnWorkflow_Override(c CfnWorkflow, scope awscdk.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. Experimental.
func CfnAnnotationStore_IsCfnResource ¶
func CfnAnnotationStore_IsCfnResource(construct constructs.IConstruct) *bool
Check whether the given construct is a CfnResource. Experimental.
func CfnAnnotationStore_IsConstruct ¶
func CfnAnnotationStore_IsConstruct(x interface{}) *bool
Return whether the given object is a Construct. Experimental.
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. Experimental.
func CfnReferenceStore_IsCfnResource ¶
func CfnReferenceStore_IsCfnResource(construct constructs.IConstruct) *bool
Check whether the given construct is a CfnResource. Experimental.
func CfnReferenceStore_IsConstruct ¶
func CfnReferenceStore_IsConstruct(x interface{}) *bool
Return whether the given object is a Construct. Experimental.
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. Experimental.
func CfnRunGroup_IsCfnResource ¶
func CfnRunGroup_IsCfnResource(construct constructs.IConstruct) *bool
Check whether the given construct is a CfnResource. Experimental.
func CfnRunGroup_IsConstruct ¶
func CfnRunGroup_IsConstruct(x interface{}) *bool
Return whether the given object is a Construct. Experimental.
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. Experimental.
func CfnSequenceStore_IsCfnResource ¶
func CfnSequenceStore_IsCfnResource(construct constructs.IConstruct) *bool
Check whether the given construct is a CfnResource. Experimental.
func CfnSequenceStore_IsConstruct ¶
func CfnSequenceStore_IsConstruct(x interface{}) *bool
Return whether the given object is a Construct. Experimental.
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. Experimental.
func CfnVariantStore_IsCfnResource ¶
func CfnVariantStore_IsCfnResource(construct constructs.IConstruct) *bool
Check whether the given construct is a CfnResource. Experimental.
func CfnVariantStore_IsConstruct ¶
func CfnVariantStore_IsConstruct(x interface{}) *bool
Return whether the given object is a Construct. Experimental.
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. Experimental.
func CfnWorkflow_IsCfnResource ¶
func CfnWorkflow_IsCfnResource(construct constructs.IConstruct) *bool
Check whether the given construct is a CfnResource. Experimental.
func CfnWorkflow_IsConstruct ¶
func CfnWorkflow_IsConstruct(x interface{}) *bool
Return whether the given object is a Construct. Experimental.
func NewCfnAnnotationStore_Override ¶
func NewCfnAnnotationStore_Override(c CfnAnnotationStore, scope awscdk.Construct, id *string, props *CfnAnnotationStoreProps)
Create a new `AWS::Omics::AnnotationStore`.
func NewCfnReferenceStore_Override ¶
func NewCfnReferenceStore_Override(c CfnReferenceStore, scope awscdk.Construct, id *string, props *CfnReferenceStoreProps)
Create a new `AWS::Omics::ReferenceStore`.
func NewCfnRunGroup_Override ¶
func NewCfnRunGroup_Override(c CfnRunGroup, scope awscdk.Construct, id *string, props *CfnRunGroupProps)
Create a new `AWS::Omics::RunGroup`.
func NewCfnSequenceStore_Override ¶
func NewCfnSequenceStore_Override(c CfnSequenceStore, scope awscdk.Construct, id *string, props *CfnSequenceStoreProps)
Create a new `AWS::Omics::SequenceStore`.
func NewCfnVariantStore_Override ¶
func NewCfnVariantStore_Override(c CfnVariantStore, scope awscdk.Construct, id *string, props *CfnVariantStoreProps)
Create a new `AWS::Omics::VariantStore`.
func NewCfnWorkflow_Override ¶
func NewCfnWorkflow_Override(c CfnWorkflow, scope awscdk.Construct, id *string, props *CfnWorkflowProps)
Create a new `AWS::Omics::Workflow`.
Types ¶
type CfnAnnotationStore ¶
type CfnAnnotationStore interface {
awscdk.CfnResource
awscdk.IInspectable
// 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.
// Experimental.
CfnOptions() awscdk.ICfnResourceOptions
CfnProperties() *map[string]interface{}
// AWS resource type.
// Experimental.
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.
// Experimental.
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.
// Experimental.
LogicalId() *string
// The name of the Annotation Store.
Name() *string
SetName(val *string)
// The construct tree node associated with this construct.
// Experimental.
Node() awscdk.ConstructNode
// 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 })`.
// Experimental.
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).
// Experimental.
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{})
// Tags for the store.
Tags() awscdk.TagManager
// Return properties modified after initiation.
//
// Resources that expose mutable properties should override this function to
// collect and return the properties object for this resource.
// Experimental.
UpdatedProperites() *map[string]interface{}
// Syntactic sugar for `addOverride(path, undefined)`.
// Experimental.
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.
// Experimental.
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.
//
// Experimental.
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.
// Experimental.
AddOverride(path *string, value interface{})
// Adds an override that deletes the value of a property from the resource definition.
// Experimental.
AddPropertyDeletionOverride(propertyPath *string)
// Adds an override to a resource property.
//
// Syntactic sugar for `addOverride("Properties.<...>", value)`.
// Experimental.
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`).
// Experimental.
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.
// Experimental.
GetAtt(attributeName *string) 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.
//
// Experimental.
GetMetadata(key *string) interface{}
// Examines the CloudFormation resource and discloses attributes.
Inspect(inspector awscdk.TreeInspector)
// Perform final modifications before synthesis.
//
// This method can be implemented by derived constructs in order to perform
// final changes before synthesis. prepare() will be called after child
// constructs have been prepared.
//
// This is an advanced framework feature. Only use this if you
// understand the implications.
// Experimental.
OnPrepare()
// Allows this construct to emit artifacts into the cloud assembly during synthesis.
//
// This method is usually implemented by framework-level constructs such as `Stack` and `Asset`
// as they participate in synthesizing the cloud assembly.
// Experimental.
OnSynthesize(session constructs.ISynthesisSession)
// Validate the current construct.
//
// This method can be implemented by derived constructs in order to perform
// validation logic. It is called on all constructs before synthesis.
//
// Returns: An array of validation error messages, or an empty array if the construct is valid.
// Experimental.
OnValidate() *[]*string
// Overrides the auto-generated logical ID with a specific ID.
// Experimental.
OverrideLogicalId(newLogicalId *string)
// Perform final modifications before synthesis.
//
// This method can be implemented by derived constructs in order to perform
// final changes before synthesis. prepare() will be called after child
// constructs have been prepared.
//
// This is an advanced framework feature. Only use this if you
// understand the implications.
// Experimental.
Prepare()
RenderProperties(props *map[string]interface{}) *map[string]interface{}
// 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.
// Experimental.
ShouldSynthesize() *bool
// Allows this construct to emit artifacts into the cloud assembly during synthesis.
//
// This method is usually implemented by framework-level constructs such as `Stack` and `Asset`
// as they participate in synthesizing the cloud assembly.
// Experimental.
Synthesize(session awscdk.ISynthesisSession)
// Returns a string representation of this construct.
//
// Returns: a string representation of this resource.
// Experimental.
ToString() *string
// Validate the current construct.
//
// This method can be implemented by derived constructs in order to perform
// validation logic. It is called on all constructs before synthesis.
//
// Returns: An array of validation error messages, or an empty array if the construct is valid.
// Experimental.
Validate() *[]*string
// Experimental.
ValidateProperties(_properties interface{})
}
A CloudFormation `AWS::Omics::AnnotationStore`.
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 awscdk.Construct, id *string, props *CfnAnnotationStoreProps) CfnAnnotationStore
Create a new `AWS::Omics::AnnotationStore`.
type CfnAnnotationStoreProps ¶
type CfnAnnotationStoreProps struct {
// The name of the Annotation Store.
Name *string `field:"required" json:"name" yaml:"name"`
// The annotation file format of the store.
StoreFormat *string `field:"required" json:"storeFormat" yaml:"storeFormat"`
// A description for the store.
Description *string `field:"optional" json:"description" yaml:"description"`
// The genome reference for the store's annotations.
Reference interface{} `field:"optional" json:"reference" yaml:"reference"`
// The store's server-side encryption (SSE) settings.
SseConfig interface{} `field:"optional" json:"sseConfig" yaml:"sseConfig"`
// File parsing options for the annotation store.
StoreOptions interface{} `field:"optional" json:"storeOptions" yaml:"storeOptions"`
// Tags for the store.
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.
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.
Type *string `field:"required" json:"type" yaml:"type"`
// An encryption key ARN.
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.
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.
AnnotationType *string `field:"optional" json:"annotationType" yaml:"annotationType"`
// The store's header key to column name mapping.
FormatToHeader interface{} `field:"optional" json:"formatToHeader" yaml:"formatToHeader"`
// The schema of an annotation store.
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
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.
// Experimental.
CfnOptions() awscdk.ICfnResourceOptions
CfnProperties() *map[string]interface{}
// AWS resource type.
// Experimental.
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.
// Experimental.
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.
// Experimental.
LogicalId() *string
// A name for the store.
Name() *string
SetName(val *string)
// The construct tree node associated with this construct.
// Experimental.
Node() awscdk.ConstructNode
// 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 })`.
// Experimental.
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).
// Experimental.
Stack() awscdk.Stack
// Tags for the store.
Tags() awscdk.TagManager
// Return properties modified after initiation.
//
// Resources that expose mutable properties should override this function to
// collect and return the properties object for this resource.
// Experimental.
UpdatedProperites() *map[string]interface{}
// Syntactic sugar for `addOverride(path, undefined)`.
// Experimental.
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.
// Experimental.
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.
//
// Experimental.
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.
// Experimental.
AddOverride(path *string, value interface{})
// Adds an override that deletes the value of a property from the resource definition.
// Experimental.
AddPropertyDeletionOverride(propertyPath *string)
// Adds an override to a resource property.
//
// Syntactic sugar for `addOverride("Properties.<...>", value)`.
// Experimental.
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`).
// Experimental.
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.
// Experimental.
GetAtt(attributeName *string) 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.
//
// Experimental.
GetMetadata(key *string) interface{}
// Examines the CloudFormation resource and discloses attributes.
Inspect(inspector awscdk.TreeInspector)
// Perform final modifications before synthesis.
//
// This method can be implemented by derived constructs in order to perform
// final changes before synthesis. prepare() will be called after child
// constructs have been prepared.
//
// This is an advanced framework feature. Only use this if you
// understand the implications.
// Experimental.
OnPrepare()
// Allows this construct to emit artifacts into the cloud assembly during synthesis.
//
// This method is usually implemented by framework-level constructs such as `Stack` and `Asset`
// as they participate in synthesizing the cloud assembly.
// Experimental.
OnSynthesize(session constructs.ISynthesisSession)
// Validate the current construct.
//
// This method can be implemented by derived constructs in order to perform
// validation logic. It is called on all constructs before synthesis.
//
// Returns: An array of validation error messages, or an empty array if the construct is valid.
// Experimental.
OnValidate() *[]*string
// Overrides the auto-generated logical ID with a specific ID.
// Experimental.
OverrideLogicalId(newLogicalId *string)
// Perform final modifications before synthesis.
//
// This method can be implemented by derived constructs in order to perform
// final changes before synthesis. prepare() will be called after child
// constructs have been prepared.
//
// This is an advanced framework feature. Only use this if you
// understand the implications.
// Experimental.
Prepare()
RenderProperties(props *map[string]interface{}) *map[string]interface{}
// 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.
// Experimental.
ShouldSynthesize() *bool
// Allows this construct to emit artifacts into the cloud assembly during synthesis.
//
// This method is usually implemented by framework-level constructs such as `Stack` and `Asset`
// as they participate in synthesizing the cloud assembly.
// Experimental.
Synthesize(session awscdk.ISynthesisSession)
// Returns a string representation of this construct.
//
// Returns: a string representation of this resource.
// Experimental.
ToString() *string
// Validate the current construct.
//
// This method can be implemented by derived constructs in order to perform
// validation logic. It is called on all constructs before synthesis.
//
// Returns: An array of validation error messages, or an empty array if the construct is valid.
// Experimental.
Validate() *[]*string
// Experimental.
ValidateProperties(_properties interface{})
}
A CloudFormation `AWS::Omics::ReferenceStore`.
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"),
},
})
func NewCfnReferenceStore ¶
func NewCfnReferenceStore(scope awscdk.Construct, id *string, props *CfnReferenceStoreProps) CfnReferenceStore
Create a new `AWS::Omics::ReferenceStore`.
type CfnReferenceStoreProps ¶
type CfnReferenceStoreProps struct {
// A name for the store.
Name *string `field:"required" json:"name" yaml:"name"`
// A description for the store.
Description *string `field:"optional" json:"description" yaml:"description"`
// Server-side encryption (SSE) settings for the store.
SseConfig interface{} `field:"optional" json:"sseConfig" yaml:"sseConfig"`
// Tags for the store.
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"),
},
}
type CfnReferenceStore_SseConfigProperty ¶
type CfnReferenceStore_SseConfigProperty struct {
// The encryption type.
Type *string `field:"required" json:"type" yaml:"type"`
// An encryption key ARN.
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
// 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.
// Experimental.
CfnOptions() awscdk.ICfnResourceOptions
CfnProperties() *map[string]interface{}
// AWS resource type.
// Experimental.
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.
// Experimental.
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.
// Experimental.
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 group's maximum concurrent run setting.
MaxRuns() *float64
SetMaxRuns(val *float64)
// The group's name.
Name() *string
SetName(val *string)
// The construct tree node associated with this construct.
// Experimental.
Node() awscdk.ConstructNode
// 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 })`.
// Experimental.
Ref() *string
// The stack in which this element is defined.
//
// CfnElements must be defined within a stack scope (directly or indirectly).
// Experimental.
Stack() awscdk.Stack
// Tags for the group.
Tags() awscdk.TagManager
// Return properties modified after initiation.
//
// Resources that expose mutable properties should override this function to
// collect and return the properties object for this resource.
// Experimental.
UpdatedProperites() *map[string]interface{}
// Syntactic sugar for `addOverride(path, undefined)`.
// Experimental.
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.
// Experimental.
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.
//
// Experimental.
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.
// Experimental.
AddOverride(path *string, value interface{})
// Adds an override that deletes the value of a property from the resource definition.
// Experimental.
AddPropertyDeletionOverride(propertyPath *string)
// Adds an override to a resource property.
//
// Syntactic sugar for `addOverride("Properties.<...>", value)`.
// Experimental.
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`).
// Experimental.
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.
// Experimental.
GetAtt(attributeName *string) 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.
//
// Experimental.
GetMetadata(key *string) interface{}
// Examines the CloudFormation resource and discloses attributes.
Inspect(inspector awscdk.TreeInspector)
// Perform final modifications before synthesis.
//
// This method can be implemented by derived constructs in order to perform
// final changes before synthesis. prepare() will be called after child
// constructs have been prepared.
//
// This is an advanced framework feature. Only use this if you
// understand the implications.
// Experimental.
OnPrepare()
// Allows this construct to emit artifacts into the cloud assembly during synthesis.
//
// This method is usually implemented by framework-level constructs such as `Stack` and `Asset`
// as they participate in synthesizing the cloud assembly.
// Experimental.
OnSynthesize(session constructs.ISynthesisSession)
// Validate the current construct.
//
// This method can be implemented by derived constructs in order to perform
// validation logic. It is called on all constructs before synthesis.
//
// Returns: An array of validation error messages, or an empty array if the construct is valid.
// Experimental.
OnValidate() *[]*string
// Overrides the auto-generated logical ID with a specific ID.
// Experimental.
OverrideLogicalId(newLogicalId *string)
// Perform final modifications before synthesis.
//
// This method can be implemented by derived constructs in order to perform
// final changes before synthesis. prepare() will be called after child
// constructs have been prepared.
//
// This is an advanced framework feature. Only use this if you
// understand the implications.
// Experimental.
Prepare()
RenderProperties(props *map[string]interface{}) *map[string]interface{}
// 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.
// Experimental.
ShouldSynthesize() *bool
// Allows this construct to emit artifacts into the cloud assembly during synthesis.
//
// This method is usually implemented by framework-level constructs such as `Stack` and `Asset`
// as they participate in synthesizing the cloud assembly.
// Experimental.
Synthesize(session awscdk.ISynthesisSession)
// Returns a string representation of this construct.
//
// Returns: a string representation of this resource.
// Experimental.
ToString() *string
// Validate the current construct.
//
// This method can be implemented by derived constructs in order to perform
// validation logic. It is called on all constructs before synthesis.
//
// Returns: An array of validation error messages, or an empty array if the construct is valid.
// Experimental.
Validate() *[]*string
// Experimental.
ValidateProperties(_properties interface{})
}
A CloudFormation `AWS::Omics::RunGroup`.
Creates a run 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),
maxRuns: jsii.Number(123),
name: jsii.String("name"),
tags: map[string]*string{
"tagsKey": jsii.String("tags"),
},
})
func NewCfnRunGroup ¶
func NewCfnRunGroup(scope awscdk.Construct, id *string, props *CfnRunGroupProps) CfnRunGroup
Create a new `AWS::Omics::RunGroup`.
type CfnRunGroupProps ¶
type CfnRunGroupProps struct {
// The group's maximum CPU count setting.
MaxCpus *float64 `field:"optional" json:"maxCpus" yaml:"maxCpus"`
// The group's maximum duration setting in minutes.
MaxDuration *float64 `field:"optional" json:"maxDuration" yaml:"maxDuration"`
// The group's maximum concurrent run setting.
MaxRuns *float64 `field:"optional" json:"maxRuns" yaml:"maxRuns"`
// The group's name.
Name *string `field:"optional" json:"name" yaml:"name"`
// Tags for the group.
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),
maxRuns: jsii.Number(123),
name: jsii.String("name"),
tags: map[string]*string{
"tagsKey": jsii.String("tags"),
},
}
type CfnSequenceStore ¶
type CfnSequenceStore interface {
awscdk.CfnResource
awscdk.IInspectable
// 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.
// Experimental.
CfnOptions() awscdk.ICfnResourceOptions
CfnProperties() *map[string]interface{}
// AWS resource type.
// Experimental.
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.
// Experimental.
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.
// Experimental.
LogicalId() *string
// A name for the store.
Name() *string
SetName(val *string)
// The construct tree node associated with this construct.
// Experimental.
Node() awscdk.ConstructNode
// 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 })`.
// Experimental.
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).
// Experimental.
Stack() awscdk.Stack
// Tags for the store.
Tags() awscdk.TagManager
// Return properties modified after initiation.
//
// Resources that expose mutable properties should override this function to
// collect and return the properties object for this resource.
// Experimental.
UpdatedProperites() *map[string]interface{}
// Syntactic sugar for `addOverride(path, undefined)`.
// Experimental.
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.
// Experimental.
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.
//
// Experimental.
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.
// Experimental.
AddOverride(path *string, value interface{})
// Adds an override that deletes the value of a property from the resource definition.
// Experimental.
AddPropertyDeletionOverride(propertyPath *string)
// Adds an override to a resource property.
//
// Syntactic sugar for `addOverride("Properties.<...>", value)`.
// Experimental.
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`).
// Experimental.
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.
// Experimental.
GetAtt(attributeName *string) 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.
//
// Experimental.
GetMetadata(key *string) interface{}
// Examines the CloudFormation resource and discloses attributes.
Inspect(inspector awscdk.TreeInspector)
// Perform final modifications before synthesis.
//
// This method can be implemented by derived constructs in order to perform
// final changes before synthesis. prepare() will be called after child
// constructs have been prepared.
//
// This is an advanced framework feature. Only use this if you
// understand the implications.
// Experimental.
OnPrepare()
// Allows this construct to emit artifacts into the cloud assembly during synthesis.
//
// This method is usually implemented by framework-level constructs such as `Stack` and `Asset`
// as they participate in synthesizing the cloud assembly.
// Experimental.
OnSynthesize(session constructs.ISynthesisSession)
// Validate the current construct.
//
// This method can be implemented by derived constructs in order to perform
// validation logic. It is called on all constructs before synthesis.
//
// Returns: An array of validation error messages, or an empty array if the construct is valid.
// Experimental.
OnValidate() *[]*string
// Overrides the auto-generated logical ID with a specific ID.
// Experimental.
OverrideLogicalId(newLogicalId *string)
// Perform final modifications before synthesis.
//
// This method can be implemented by derived constructs in order to perform
// final changes before synthesis. prepare() will be called after child
// constructs have been prepared.
//
// This is an advanced framework feature. Only use this if you
// understand the implications.
// Experimental.
Prepare()
RenderProperties(props *map[string]interface{}) *map[string]interface{}
// 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.
// Experimental.
ShouldSynthesize() *bool
// Allows this construct to emit artifacts into the cloud assembly during synthesis.
//
// This method is usually implemented by framework-level constructs such as `Stack` and `Asset`
// as they participate in synthesizing the cloud assembly.
// Experimental.
Synthesize(session awscdk.ISynthesisSession)
// Returns a string representation of this construct.
//
// Returns: a string representation of this resource.
// Experimental.
ToString() *string
// Validate the current construct.
//
// This method can be implemented by derived constructs in order to perform
// validation logic. It is called on all constructs before synthesis.
//
// Returns: An array of validation error messages, or an empty array if the construct is valid.
// Experimental.
Validate() *[]*string
// Experimental.
ValidateProperties(_properties interface{})
}
A CloudFormation `AWS::Omics::SequenceStore`.
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"),
sseConfig: &sseConfigProperty{
type: jsii.String("type"),
// the properties below are optional
keyArn: jsii.String("keyArn"),
},
tags: map[string]*string{
"tagsKey": jsii.String("tags"),
},
})
func NewCfnSequenceStore ¶
func NewCfnSequenceStore(scope awscdk.Construct, id *string, props *CfnSequenceStoreProps) CfnSequenceStore
Create a new `AWS::Omics::SequenceStore`.
type CfnSequenceStoreProps ¶
type CfnSequenceStoreProps struct {
// A name for the store.
Name *string `field:"required" json:"name" yaml:"name"`
// A description for the store.
Description *string `field:"optional" json:"description" yaml:"description"`
// Server-side encryption (SSE) settings for the store.
SseConfig interface{} `field:"optional" json:"sseConfig" yaml:"sseConfig"`
// Tags for the store.
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"),
sseConfig: &sseConfigProperty{
type: jsii.String("type"),
// the properties below are optional
keyArn: jsii.String("keyArn"),
},
tags: map[string]*string{
"tagsKey": jsii.String("tags"),
},
}
type CfnSequenceStore_SseConfigProperty ¶
type CfnSequenceStore_SseConfigProperty struct {
// The encryption type.
Type *string `field:"required" json:"type" yaml:"type"`
// An encryption key ARN.
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
// 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.
// Experimental.
CfnOptions() awscdk.ICfnResourceOptions
CfnProperties() *map[string]interface{}
// AWS resource type.
// Experimental.
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.
// Experimental.
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.
// Experimental.
LogicalId() *string
// A name for the store.
Name() *string
SetName(val *string)
// The construct tree node associated with this construct.
// Experimental.
Node() awscdk.ConstructNode
// 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 })`.
// Experimental.
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).
// Experimental.
Stack() awscdk.Stack
// Tags for the store.
Tags() awscdk.TagManager
// Return properties modified after initiation.
//
// Resources that expose mutable properties should override this function to
// collect and return the properties object for this resource.
// Experimental.
UpdatedProperites() *map[string]interface{}
// Syntactic sugar for `addOverride(path, undefined)`.
// Experimental.
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.
// Experimental.
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.
//
// Experimental.
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.
// Experimental.
AddOverride(path *string, value interface{})
// Adds an override that deletes the value of a property from the resource definition.
// Experimental.
AddPropertyDeletionOverride(propertyPath *string)
// Adds an override to a resource property.
//
// Syntactic sugar for `addOverride("Properties.<...>", value)`.
// Experimental.
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`).
// Experimental.
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.
// Experimental.
GetAtt(attributeName *string) 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.
//
// Experimental.
GetMetadata(key *string) interface{}
// Examines the CloudFormation resource and discloses attributes.
Inspect(inspector awscdk.TreeInspector)
// Perform final modifications before synthesis.
//
// This method can be implemented by derived constructs in order to perform
// final changes before synthesis. prepare() will be called after child
// constructs have been prepared.
//
// This is an advanced framework feature. Only use this if you
// understand the implications.
// Experimental.
OnPrepare()
// Allows this construct to emit artifacts into the cloud assembly during synthesis.
//
// This method is usually implemented by framework-level constructs such as `Stack` and `Asset`
// as they participate in synthesizing the cloud assembly.
// Experimental.
OnSynthesize(session constructs.ISynthesisSession)
// Validate the current construct.
//
// This method can be implemented by derived constructs in order to perform
// validation logic. It is called on all constructs before synthesis.
//
// Returns: An array of validation error messages, or an empty array if the construct is valid.
// Experimental.
OnValidate() *[]*string
// Overrides the auto-generated logical ID with a specific ID.
// Experimental.
OverrideLogicalId(newLogicalId *string)
// Perform final modifications before synthesis.
//
// This method can be implemented by derived constructs in order to perform
// final changes before synthesis. prepare() will be called after child
// constructs have been prepared.
//
// This is an advanced framework feature. Only use this if you
// understand the implications.
// Experimental.
Prepare()
RenderProperties(props *map[string]interface{}) *map[string]interface{}
// 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.
// Experimental.
ShouldSynthesize() *bool
// Allows this construct to emit artifacts into the cloud assembly during synthesis.
//
// This method is usually implemented by framework-level constructs such as `Stack` and `Asset`
// as they participate in synthesizing the cloud assembly.
// Experimental.
Synthesize(session awscdk.ISynthesisSession)
// Returns a string representation of this construct.
//
// Returns: a string representation of this resource.
// Experimental.
ToString() *string
// Validate the current construct.
//
// This method can be implemented by derived constructs in order to perform
// validation logic. It is called on all constructs before synthesis.
//
// Returns: An array of validation error messages, or an empty array if the construct is valid.
// Experimental.
Validate() *[]*string
// Experimental.
ValidateProperties(_properties interface{})
}
A CloudFormation `AWS::Omics::VariantStore`.
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"),
},
})
func NewCfnVariantStore ¶
func NewCfnVariantStore(scope awscdk.Construct, id *string, props *CfnVariantStoreProps) CfnVariantStore
Create a new `AWS::Omics::VariantStore`.
type CfnVariantStoreProps ¶
type CfnVariantStoreProps struct {
// A name for the store.
Name *string `field:"required" json:"name" yaml:"name"`
// The genome reference for the store's variants.
Reference interface{} `field:"required" json:"reference" yaml:"reference"`
// A description for the store.
Description *string `field:"optional" json:"description" yaml:"description"`
// Server-side encryption (SSE) settings for the store.
SseConfig interface{} `field:"optional" json:"sseConfig" yaml:"sseConfig"`
// Tags for the store.
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"),
},
}
type CfnVariantStore_ReferenceItemProperty ¶
type CfnVariantStore_ReferenceItemProperty struct {
// The reference's ARN.
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.
Type *string `field:"required" json:"type" yaml:"type"`
// An encryption key ARN.
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
// 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.
// Experimental.
CfnOptions() awscdk.ICfnResourceOptions
CfnProperties() *map[string]interface{}
// AWS resource type.
// Experimental.
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.
// Experimental.
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.
// Experimental.
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 construct tree node associated with this construct.
// Experimental.
Node() awscdk.ConstructNode
// 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 })`.
// Experimental.
Ref() *string
// The stack in which this element is defined.
//
// CfnElements must be defined within a stack scope (directly or indirectly).
// Experimental.
Stack() awscdk.Stack
// A storage capacity for the workflow in gigabytes.
StorageCapacity() *float64
SetStorageCapacity(val *float64)
// Tags for the workflow.
Tags() awscdk.TagManager
// Return properties modified after initiation.
//
// Resources that expose mutable properties should override this function to
// collect and return the properties object for this resource.
// Experimental.
UpdatedProperites() *map[string]interface{}
// Syntactic sugar for `addOverride(path, undefined)`.
// Experimental.
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.
// Experimental.
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.
//
// Experimental.
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.
// Experimental.
AddOverride(path *string, value interface{})
// Adds an override that deletes the value of a property from the resource definition.
// Experimental.
AddPropertyDeletionOverride(propertyPath *string)
// Adds an override to a resource property.
//
// Syntactic sugar for `addOverride("Properties.<...>", value)`.
// Experimental.
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`).
// Experimental.
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.
// Experimental.
GetAtt(attributeName *string) 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.
//
// Experimental.
GetMetadata(key *string) interface{}
// Examines the CloudFormation resource and discloses attributes.
Inspect(inspector awscdk.TreeInspector)
// Perform final modifications before synthesis.
//
// This method can be implemented by derived constructs in order to perform
// final changes before synthesis. prepare() will be called after child
// constructs have been prepared.
//
// This is an advanced framework feature. Only use this if you
// understand the implications.
// Experimental.
OnPrepare()
// Allows this construct to emit artifacts into the cloud assembly during synthesis.
//
// This method is usually implemented by framework-level constructs such as `Stack` and `Asset`
// as they participate in synthesizing the cloud assembly.
// Experimental.
OnSynthesize(session constructs.ISynthesisSession)
// Validate the current construct.
//
// This method can be implemented by derived constructs in order to perform
// validation logic. It is called on all constructs before synthesis.
//
// Returns: An array of validation error messages, or an empty array if the construct is valid.
// Experimental.
OnValidate() *[]*string
// Overrides the auto-generated logical ID with a specific ID.
// Experimental.
OverrideLogicalId(newLogicalId *string)
// Perform final modifications before synthesis.
//
// This method can be implemented by derived constructs in order to perform
// final changes before synthesis. prepare() will be called after child
// constructs have been prepared.
//
// This is an advanced framework feature. Only use this if you
// understand the implications.
// Experimental.
Prepare()
RenderProperties(props *map[string]interface{}) *map[string]interface{}
// 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.
// Experimental.
ShouldSynthesize() *bool
// Allows this construct to emit artifacts into the cloud assembly during synthesis.
//
// This method is usually implemented by framework-level constructs such as `Stack` and `Asset`
// as they participate in synthesizing the cloud assembly.
// Experimental.
Synthesize(session awscdk.ISynthesisSession)
// Returns a string representation of this construct.
//
// Returns: a string representation of this resource.
// Experimental.
ToString() *string
// Validate the current construct.
//
// This method can be implemented by derived constructs in order to perform
// validation logic. It is called on all constructs before synthesis.
//
// Returns: An array of validation error messages, or an empty array if the construct is valid.
// Experimental.
Validate() *[]*string
// Experimental.
ValidateProperties(_properties interface{})
}
A CloudFormation `AWS::Omics::Workflow`.
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{
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"),
},
})
func NewCfnWorkflow ¶
func NewCfnWorkflow(scope awscdk.Construct, id *string, props *CfnWorkflowProps) CfnWorkflow
Create a new `AWS::Omics::Workflow`.
type CfnWorkflowProps ¶
type CfnWorkflowProps struct {
// The URI of a definition for the workflow.
DefinitionUri *string `field:"optional" json:"definitionUri" yaml:"definitionUri"`
// The parameter's description.
Description *string `field:"optional" json:"description" yaml:"description"`
// An engine for the workflow.
Engine *string `field:"optional" json:"engine" yaml:"engine"`
// The path of the main definition file for the workflow.
Main *string `field:"optional" json:"main" yaml:"main"`
// The workflow's name.
Name *string `field:"optional" json:"name" yaml:"name"`
// The workflow's parameter template.
ParameterTemplate interface{} `field:"optional" json:"parameterTemplate" yaml:"parameterTemplate"`
// A storage capacity for the workflow in gigabytes.
StorageCapacity *float64 `field:"optional" json:"storageCapacity" yaml:"storageCapacity"`
// Tags for the workflow.
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{
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"),
},
}
type CfnWorkflow_WorkflowParameterProperty ¶
type CfnWorkflow_WorkflowParameterProperty struct {
// The parameter's description.
Description *string `field:"optional" json:"description" yaml:"description"`
// Whether the parameter is 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
¶
- awsomics.go
- awsomics_CfnAnnotationStore.go
- awsomics_CfnAnnotationStoreProps.go
- awsomics_CfnAnnotationStore_ReferenceItemProperty.go
- awsomics_CfnAnnotationStore_SseConfigProperty.go
- awsomics_CfnAnnotationStore_StoreOptionsProperty.go
- awsomics_CfnAnnotationStore_TsvStoreOptionsProperty.go
- awsomics_CfnAnnotationStore__runtime_type_checks.go
- awsomics_CfnReferenceStore.go
- awsomics_CfnReferenceStoreProps.go
- awsomics_CfnReferenceStore_SseConfigProperty.go
- awsomics_CfnReferenceStore__runtime_type_checks.go
- awsomics_CfnRunGroup.go
- awsomics_CfnRunGroupProps.go
- awsomics_CfnRunGroup__runtime_type_checks.go
- awsomics_CfnSequenceStore.go
- awsomics_CfnSequenceStoreProps.go
- awsomics_CfnSequenceStore_SseConfigProperty.go
- awsomics_CfnSequenceStore__runtime_type_checks.go
- awsomics_CfnVariantStore.go
- awsomics_CfnVariantStoreProps.go
- awsomics_CfnVariantStore_ReferenceItemProperty.go
- awsomics_CfnVariantStore_SseConfigProperty.go
- awsomics_CfnVariantStore__runtime_type_checks.go
- awsomics_CfnWorkflow.go
- awsomics_CfnWorkflowProps.go
- awsomics_CfnWorkflow_WorkflowParameterProperty.go
- awsomics_CfnWorkflow__runtime_type_checks.go