Categorygithub.com/alibabacloud-go/ros-cdk/alicloudroscdkcore
modulepackage
1.5.0
Repository: https://github.com/alibabacloud-go/ros-cdk.git
Documentation: pkg.go.dev

# README

@alicloud/ros-cdk-core

TODO: description

Usage

const core = require('@alicloud/ros-cdk-core');

// TODO: DEMONSTRATE API

# Packages

Package jsii contains the functionaility needed for jsii packages to initialize their dependencies and themselves.

# Functions

Checks if an object is an instance of the 'App' class.
Return whether the given object is a Construct.
Test whether the given construct is a stage.
Return the stage this construct is contained with, if available.
No description provided by the author
No description provided by the author
Clears the asset hash cache.
Return whether the given object is a Construct.
Return whether the given object is a Construct.
No description provided by the author
Invokes "prepare" on all constructs (depth-first, post-order) in the tree under `node`.
Synthesizes a CloudAssembly from a construct tree.
Invokes "validate" on all constructs in the tree (depth-first, pre-order) and returns the list of all errors.
No description provided by the author
No description provided by the author
No description provided by the author
Return the matching DependableTrait for the given class instance.
Register `instance` to have the given DependableTrait.
A Docker build secret from a file source.
Ignores file paths based on the [`.dockerignore specification`](https://docs.docker.com/engine/reference/builder/#dockerignore-file).
Creates an IgnoreStrategy based on the `ignoreMode` and `exclude` in a `CopyOptions`.
Ignores file paths based on the [`.gitignore specification`](https://git-scm.com/docs/gitignore).
Ignores file paths based on simple glob patterns.
Builds a Docker image.
Reference an image on DockerHub or another online registry.
Copies an entire directory structure.
Produces fingerprint based on the contents of a single file or an entire directory tree.
Checks whether a directory is empty.
Creates a unique temporary directory in the **system temp directory**.
No description provided by the author
No description provided by the author
Returns whether a value in the specified array is true or false.
No description provided by the author
No description provided by the author
The intrinsic function ``Fn::Base64`` returns the Base64 representation of the input string.
No description provided by the author
Returns a list of CIDR addresses.
Returns true if all the specified conditions evaluate to true, or returns false if any one of the conditions evaluates to false.
Compares if two values are equal.
Returns one value if the specified condition evaluates to true and another value if the specified condition evaluates to false.
Returns true for a condition that evaluates to false or returns false for a condition that evaluates to true.
Returns true if any one of the specified conditions evaluate to true, or returns false if all of the conditions evaluates to false.
Returns true if at least one member of the list matches the specified value and false otherwise.
Returns true if every member of the first list is equal to at least one value in the second list, and false otherwise.
The intrinsic function ``Fn::FindInMap`` returns the value corresponding to keys in a two-level map that is declared in the Mappings section.
Returns the formatted time of the object.
The ``Fn::GetAtt`` intrinsic function returns the value of an attribute from a resource in the template.
The intrinsic function ``Fn::GetAZs`` returns an array that lists Availability Zones for a specified region.
No description provided by the author
The intrinsic function ``Fn::GetStackOutput`` returns the value of an output exported by another stack.
The intrinsic function Fn::Indent adjust the indentation of the string.
Returns the index of the item in the list.
The intrinsic function ``Fn::Join`` appends a set of values into a single value, separated by the specified delimiter.
No description provided by the author
Returns the length of the object.
No description provided by the author
The intrinsic function Fn::MarketplaceImage returns the default image ID of the specified cloud marketplace image product Code.
Returns true if a specified string matches a specified pattern.
No description provided by the author
No description provided by the author
No description provided by the author
The ``Ref`` intrinsic function returns the value of the specified parameter or resource.
No description provided by the author
The intrinsic function ``Fn::Select`` returns a single object from a list of objects by index.
No description provided by the author
To split a string into a list of string values so that you can select an element from the resulting string list, use the ``Fn::Split`` intrinsic function.
No description provided by the author
The intrinsic function ``Fn::Sub`` substitutes variables in an input string with values that you specify.
Ignores file paths based on the [`.dockerignore specification`](https://docs.docker.com/engine/reference/builder/#dockerignore-file).
Creates an IgnoreStrategy based on the `ignoreMode` and `exclude` in a `CopyOptions`.
Ignores file paths based on the [`.gitignore specification`](https://git-scm.com/docs/gitignore).
Ignores file paths based on simple glob patterns.
Ignores file paths based on the [`.dockerignore specification`](https://docs.docker.com/engine/reference/builder/#dockerignore-file).
Creates an IgnoreStrategy based on the `ignoreMode` and `exclude` in a `CopyOptions`.
Ignores file paths based on the [`.gitignore specification`](https://git-scm.com/docs/gitignore).
Ignores file paths based on simple glob patterns.
Ignores file paths based on the [`.dockerignore specification`](https://docs.docker.com/engine/reference/builder/#dockerignore-file).
Creates an IgnoreStrategy based on the `ignoreMode` and `exclude` in a `CopyOptions`.
Ignores file paths based on the [`.gitignore specification`](https://git-scm.com/docs/gitignore).
Ignores file paths based on simple glob patterns.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Return whether the given object is a Construct.
No description provided by the author
Return whether the given object is a Stack.
Looks up the first stack scope in which `construct` is defined.
Initializes a CDK application.
Initializes a CDK application.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Experimental.
Experimental.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Experimental.
Experimental.
Experimental.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Creates an ``Add`` function.
Creates an ``Add`` function.
No description provided by the author
No description provided by the author
Creates an ``Any`` function.
Creates an ``Any`` function.
Creates an ``Avg`` function.
Creates an ``Avg`` function.
No description provided by the author
No description provided by the author
Creates an ``Fn::Base64`` function.
Creates an ``Fn::Base64`` function.
Creates an ``Calculate`` function.
Creates an ``Calculate`` function.
Creates an ``Cidr`` function.
Creates an ``Cidr`` function.
Creates an ``Contains`` function.
Creates an ``Contains`` function.
Creates an ``EachMemberIn`` function.
Creates an ``EachMemberIn`` function.
Creates an ``Fn::Equals`` condition function.
Creates an ``Fn::Equals`` condition function.
Creates an ``Fn::FindInMap`` function.
Creates an ``Fn::FindInMap`` function.
Creates an ``FormatTime`` function.
Creates an ``FormatTime`` function.
Creates a ``Fn::GetAtt`` function.
Creates a ``Fn::GetAtt`` function.
Creates an ``Fn::GetAZs`` function.
Creates an ``Fn::GetAZs`` function.
Creates an ``GetJsonValue`` function.
Creates an ``GetJsonValue`` function.
Creates an ``GetStackOutput`` function.
Creates an ``GetStackOutput`` function.
Creates an ``Fn::If`` condition function.
Creates an ``Fn::If`` condition function.
Creates an ``Indent`` function.
Creates an ``Indent`` function.
Creates an ``Index`` function.
Creates an ``Index`` function.
Creates an ``Fn::Join`` function.
Creates an ``Fn::Join`` function.
Creates an ``Jq`` function.
Creates an ``Jq`` function.
Creates an ``Length`` function.
Creates an ``Length`` function.
Creates an ``ListMerge`` function.
Creates an ``ListMerge`` function.
Creates an ``MarketplaceImage`` function.
Creates an ``MarketplaceImage`` function.
Creates an ``MatchPattern`` function.
Creates an ``MatchPattern`` function.
Creates an ``Max`` function.
Creates an ``Max`` function.
Creates an ``FnMergeMapToList`` function.
Creates an ``FnMergeMapToList`` function.
Creates an ``Min`` function.
Creates an ``Min`` function.
Creates an ``Fn::Not`` condition function.
Creates an ``Fn::Not`` condition function.
Creates an ``Fn::Or`` condition function.
Creates an ``Fn::Or`` condition function.
Creates an ``Ref`` function.
Creates an ``Ref`` function.
Creates an ``Replace`` function.
Creates an ``Replace`` function.
Creates an ``Fn::Select`` function.
Creates an ``Fn::Select`` function.
Creates an ``FnMergeMapToList`` function.
Creates an ``FnMergeMapToList`` function.
Create an ``Fn::Split`` function.
Create an ``Fn::Split`` function.
Creates an ``Str`` function.
Creates an ``Str`` function.
Creates an ``Fn::Sub`` function.
Creates an ``Fn::Sub`` function.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Experimental.
Experimental.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Build a new condition.
Build a new condition.
Creates an entity and binds it to a tree.
Creates properties for this stack.
Creates properties for this stack.
No description provided by the author
No description provided by the author
Creates an RosOutput value for this stack.
Creates an RosOutput value for this stack.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Creates an entity and binds it to a tree.
Creates a resource construct.
Creates a resource construct.
No description provided by the author
No description provided by the author
Creates a new stack.
Creates a new stack.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Check whether this is actually a Reference.
Return whether the given object is a Construct.
Return whether the given object is a Construct.
Returns `true` if a construct is a stack element (i.e.
Return whether the given object is a Construct.
Returns `true` if a construct is a stack element (i.e.
No description provided by the author
No description provided by the author
Return whether the given object is a Construct.
Returns `true` if a construct is a stack element (i.e.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Return whether the given object is a Construct.
Returns `true` if a construct is a stack element (i.e.
Return whether the given object is a Construct.
Returns `true` if a construct is a stack element (i.e.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Return whether the given object is a Construct.
Returns `true` if a construct is a stack element (i.e.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Return whether the given object is a Construct.
Returns `true` if a construct is a stack element (i.e.
Return whether the given object is a Construct.
Returns `true` if a construct is a stack element (i.e.
Check whether the given construct is a RosResource.
Return whether the given object is a Construct.
Returns `true` if a construct is a stack element (i.e.
Return whether the given object is a Construct.
Return whether the given object is a Stack.
Looks up the first stack scope in which `construct` is defined.
Return whether the given object is a Construct.
Test whether the given construct is a stage.
Return the stage this construct is contained with, if available.
Validate that the given string does not contain tokens.
Check whether the given construct is Taggable.
Return a resolvable representation of the given value.
Return a reversible list representation of this token.
Return a reversible number representation of this token.
Return a reversible string representation of this token.
Returns true if obj represents an unresolved value.
Return whether the given object is an IResolvable object.
Resolves an object by evaluating all tokens and removing any undefined or empty objects or arrays.
Un-encode a Tokenized value from a list.
Un-encode a Tokenized value from a number.
Un-encode a string potentially containing encoded tokens.
Stringify a number directly or lazily if it's a Token.

# Constants

Use a custom hash.
Based on the content of the bundling output.
Based on the content of the source path.
The source and output folders will be mounted as bind mount from the host system This is faster and simpler, but less portable than `VOLUME_COPY`.
Creates temporary volumes and containers to copy files from the host to the bundling container and back.
The bundling output directory includes a single .zip or .jar file which will be used as the final bundle.
If the bundling output directory contains a single archive file (zip or jar) it will be used as the bundle output as-is.
The bundling output directory contains one or more files which will be archived and uploaded as a .zip file to OSS bucket.
The bundling output directory includes a single file which will be used as the final bundle.
Depth-first, post-order (leaf nodes first).
Depth-first, pre-order.
Read/write operations on mounted Docker volumes are first applied on the host machine and then synchronized to the container.
Read/write operations inside the Docker container are applied immediately on the mounted host machine volumes.
Read/write operations on mounted Docker volumes are first written inside the container and then synchronized to the host machine.
The asset source path points to a single file, which should be uploaded to Aliyun OSS bucket.
The asset source path points to a directory, which should be archived using zip and and then uploaded to Aliyun OSS bucket.
Ignores file paths based on the [`.dockerignore specification`](https://docs.docker.com/engine/reference/builder/#dockerignore-file).
Ignores file paths based on the [`.gitignore specification`](https://git-scm.com/docs/gitignore).
Ignores file paths based on simple glob patterns.
No description provided by the author
No description provided by the author
ROS will deletes the resource and all its content if applicable during stack deletion.
ROS keeps the resource without deleting the resource or its contents when its stack is deleted.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Materialize all symlinks, whether they are internal or external to the source directory.
Forbids source from having any symlinks pointing outside of the source tree.
Only follows symlinks that are external to the source directory.
Never follow symlinks.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author

# Structs

Initialization props for apps.
The destination for a docker image asset, when it is given to the AssetManifestBuilder.
The destination for a file asset, when it is given to the AssetManifestBuilder.
Asset hash options.
Initialization properties for `AssetStaging`.
Bundling options.
Options applied when copying directories.
Configuration properties for DefaultStackSynthesizer.
A single dependency.
Docker build options.
Options for configuring the Docker cache backend.
The location of the published docker image.
No description provided by the author
Docker run options.
A Docker volume.
Properties to string encodings.
The deployment environment for a stack.
The location of the published file asset.
Represents the source for a file asset.
Options applied when copying directories into the staging location.
Options related to calculating source hash.
Options related to calculating source hash.
Options for creating lazy untyped tokens.
Options for creating a lazy list token.
Options for creating a lazy string token.
No description provided by the author
No description provided by the author
No description provided by the author
Options to the resolve() operation.
Construction properties for {@link Resource}.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Initialization props for a stage.
Options for assemly synthesis.
Options for synthesis.
Stack artifact options.
Options to configure TagManager behavior.
An error returned during the validation phase.

# Interfaces

A construct which represents an entire CDK app.
Build an asset manifest from assets added to a stack.
Stages a file or directory from a location on the file system into a staging directory.
A set of constructs to be used as a dependable.
Represents the building block of the construct graph.
Represents the construct node in the scope tree.
Uses conventionally named roles and reify asset storage locations.
Default resolver implementation.
Trait for IDependable.
Methods to build Docker CLI arguments for builds using secrets.
Ignores file paths based on the [`.dockerignore specification`](https://docs.docker.com/engine/reference/builder/#dockerignore-file).
A Docker image.
File system utilities.
Resource Orchestration Service intrinsic functions.
No description provided by the author
Returns true if all the specified conditions evaluate to true, or returns false if any one of the conditions evaluates to false.
No description provided by the author
No description provided by the author
No description provided by the author
The intrinsic function ``Fn::Base64`` returns the Base64 representation of the input string.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Compares if two values are equal.
The intrinsic function ``Fn::FindInMap`` returns the value corresponding to keys in a two-level map that is declared in the Mappings section.
No description provided by the author
The ``Fn::GetAtt`` intrinsic function returns the value of an attribute from a resource in the template.
The intrinsic function ``Fn::GetAZs`` returns an array that lists Availability Zones for a specified region.
No description provided by the author
No description provided by the author
Returns one value if the specified condition evaluates to true and another value if the specified condition evaluates to false.
No description provided by the author
No description provided by the author
The intrinsic function ``Fn::Join`` appends a set of values into a single value, separated by the specified delimiter.
No description provided by the author
No description provided by the author
Returns true if a specified string matches all values in a list.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Returns true for a condition that evaluates to false or returns false for a condition that evaluates to true.
Returns true if any one of the specified conditions evaluate to true, or returns false if all of the conditions evaluates to false.
The intrinsic function ``Ref`` returns the value of the specified parameter or resource.
No description provided by the author
The intrinsic function ``Fn::Select`` returns a single object from a list of objects by index.
No description provided by the author
To split a string into a list of string values so that you can select an element from the resulting string list, use the ``Fn::Split`` intrinsic function.
No description provided by the author
The intrinsic function ``Fn::Sub`` substitutes variables in an input string with values that you specify.
Ignores file paths based on the [`.gitignore specification`](https://git-scm.com/docs/gitignore).
Ignores file paths based on simple glob patterns.
Interface for lazy untyped value producers.
Common interface for all assets.
A Stack Synthesizer, obtained from `IReusableStackSynthesizer.`.
Represents a construct.
Trait marker for classes that can be depended upon.
Function used to concatenate symbols in the target document language.
Represents file path ignoring behavior.
Interface for examining a construct and exposing metadata.
Interface for lazy list producers.
Local bundling.
Token subclass that represents values intrinsic to the target document language.
Interface for lazy number producers.
A Token that can post-process the complete resolved value, after resolve() has recursed over it.
Interface for values that can be resolvable later.
Current resolution context for tokens.
Interface for the Resource construct.
Interface for Stack Synthesizers that can be used for more than one stack.
Represents a RosTemplate element that can be used within a Condition.
No description provided by the author
Encodes information how a certain Stack should be deployed.
Interface for lazy string producers.
Represents a single session of synthesis.
Interface to implement tags.
ROS template options for a stack.
Interface to apply operation to tokens in a string.
How to resolve tokens.
Lazily produce a value.
No description provided by the author
An intrinsic Token that represents a reference to a construct.
A construct which represents a resource.
Represents a RosTemplate condition, for resources which must be conditionally created and the determination must be made at deploy time.
An element of a stack.
No description provided by the author
Represents a mapping.
No description provided by the author
A ROS parameter.
No description provided by the author
Accessor for pseudo parameters.
Base class for referenceable template constructs which are not Resources.
Represents a ROS resource.
Rules are used to verify that the parameter values passed to the template when the resource stack is created or updated are as expected.
A root construct which represents a single ROS stack.
Base class for implementing an IStackSynthesizer.
An abstract application modeling unit consisting of Stacks that should be deployed together.
Converts all fragments to strings and concats those.
No description provided by the author
TagManager facilitates a common implementation of tagging for Constructs.
Represents a special or lazily-evaluated value.
Less oft-needed functions to manipulate Tokens.
Fragments of a concatenated string containing stringified Tokens.
Inspector that maintains an attribute bag.
Representation of validation results.
A collection of validation results.

# Type aliases

The type of asset hash.
The access mechanism used to make source files available to the bundling container and to return the bundling output back to the host.
The type of output that a bundling operation is producing.
In what order to return constructs.
Supported Docker volume consistency types.
Packaging modes for file assets.
Determines the ignore behavior to use.
No description provided by the author
With the DeletionPolicy attribute you can preserve or (in some cases) backup a resource when its stack is deleted.
No description provided by the author
Determines how symlinks are followed.
No description provided by the author