agent-claw: automated task changes

This commit is contained in:
daniel
2026-05-06 18:55:16 -05:00
parent 38905bb1e9
commit 732b00fb66
8494 changed files with 2018127 additions and 4 deletions

View File

@@ -0,0 +1,301 @@
/**
* Information needed to access an IAM role created
* as part of the bootstrap process
*/
export interface BootstrapRole {
/**
* The ARN of the IAM role created as part of bootrapping
* e.g. lookupRoleArn
*/
readonly arn: string;
/**
* External ID to use when assuming the bootstrap role
*
* @default - No external ID
*/
readonly assumeRoleExternalId?: string;
/**
* Additional options to pass to STS when assuming the role.
*
* - `RoleArn` should not be used. Use the dedicated `arn` property instead.
* - `ExternalId` should not be used. Use the dedicated `assumeRoleExternalId` instead.
*
* @see https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/STS.html#assumeRole-property
* @default - No additional options.
*/
readonly assumeRoleAdditionalOptions?: {
[key: string]: any;
};
/**
* Version of bootstrap stack required to use this role
*
* @default - No bootstrap stack required
*/
readonly requiresBootstrapStackVersion?: number;
/**
* Name of SSM parameter with bootstrap stack version
*
* @default - Discover SSM parameter by reading stack
*/
readonly bootstrapStackVersionSsmParameter?: string;
}
/**
* Artifact properties for CloudFormation stacks.
*/
export interface AwsCloudFormationStackProperties {
/**
* A file relative to the assembly root which contains the CloudFormation template for this stack.
*/
readonly templateFile: string;
/**
* Values for CloudFormation stack parameters that should be passed when the stack is deployed.
*
* @default - No parameters
*/
readonly parameters?: {
[id: string]: string;
};
/**
* Values for CloudFormation stack tags that should be passed when the stack is deployed.
*
* N.B.: Tags are also written to stack metadata, under the path of the Stack
* construct. Only in CDK CLI v1 are those tags found in metadata used for
* actual deployments; in all stable versions of CDK only the stack tags
* directly found in the `tags` property of `AwsCloudFormationStack` artifact
* (i.e., this property) are used.
*
* @default - No tags
*/
readonly tags?: {
[id: string]: string;
};
/**
* SNS Notification ARNs that should receive CloudFormation Stack Events.
*
* @default - No notification arns
*/
readonly notificationArns?: string[];
/**
* The name to use for the CloudFormation stack.
* @default - name derived from artifact ID
*/
readonly stackName?: string;
/**
* Whether to enable termination protection for this stack.
*
* @default false
*/
readonly terminationProtection?: boolean;
/**
* The role that needs to be assumed to deploy the stack
*
* @default - No role is assumed (current credentials are used)
*/
readonly assumeRoleArn?: string;
/**
* External ID to use when assuming role for cloudformation deployments
*
* @default - No external ID
*/
readonly assumeRoleExternalId?: string;
/**
* Additional options to pass to STS when assuming the role.
*
* - `RoleArn` should not be used. Use the dedicated `assumeRoleArn` property instead.
* - `ExternalId` should not be used. Use the dedicated `assumeRoleExternalId` instead.
*
* @see https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/STS.html#assumeRole-property
* @default - No additional options.
*/
readonly assumeRoleAdditionalOptions?: {
[key: string]: any;
};
/**
* The role that is passed to CloudFormation to execute the change set
*
* @default - No role is passed (currently assumed role/credentials are used)
*/
readonly cloudFormationExecutionRoleArn?: string;
/**
* The role to use to look up values from the target AWS account
*
* @default - No role is assumed (current credentials are used)
*/
readonly lookupRole?: BootstrapRole;
/**
* If the stack template has already been included in the asset manifest, its asset URL
*
* @default - Not uploaded yet, upload just before deploying
*/
readonly stackTemplateAssetObjectUrl?: string;
/**
* Version of bootstrap stack required to deploy this stack
*
* @default - No bootstrap stack required
*/
readonly requiresBootstrapStackVersion?: number;
/**
* SSM parameter where the bootstrap stack version number can be found
*
* Only used if `requiresBootstrapStackVersion` is set.
*
* - If this value is not set, the bootstrap stack name must be known at
* deployment time so the stack version can be looked up from the stack
* outputs.
* - If this value is set, the bootstrap stack can have any name because
* we won't need to look it up.
*
* @default - Bootstrap stack version number looked up
*/
readonly bootstrapStackVersionSsmParameter?: string;
/**
* Whether this stack should be validated by the CLI after synthesis
*
* @default - false
*/
readonly validateOnSynth?: boolean;
}
/**
* Configuration options for the Asset Manifest
*/
export interface AssetManifestOptions {
/**
* Version of bootstrap stack required to deploy this stack
*
* @default - Version 1 (basic modern bootstrap stack)
*/
readonly requiresBootstrapStackVersion?: number;
/**
* SSM parameter where the bootstrap stack version number can be found
*
* - If this value is not set, the bootstrap stack name must be known at
* deployment time so the stack version can be looked up from the stack
* outputs.
* - If this value is set, the bootstrap stack can have any name because
* we won't need to look it up.
*
* @default - Bootstrap stack version number looked up
*/
readonly bootstrapStackVersionSsmParameter?: string;
}
/**
* Artifact properties for the Asset Manifest
*/
export interface AssetManifestProperties extends AssetManifestOptions {
/**
* Filename of the asset manifest
*/
readonly file: string;
}
/**
* Artifact properties for the Construct Tree Artifact
*/
export interface TreeArtifactProperties {
/**
* Filename of the tree artifact
*/
readonly file: string;
}
/**
* Artifact properties for nested cloud assemblies
*/
export interface NestedCloudAssemblyProperties {
/**
* Relative path to the nested cloud assembly
*/
readonly directoryName: string;
/**
* Display name for the cloud assembly
*
* @default - The artifact ID
*/
readonly displayName?: string;
}
/**
* Artifact properties for a feature flag report
*
* A feature flag report is small enough that all the properties can be inlined
* here, and doesn't need an additional file.
*/
export interface FeatureFlagReportProperties {
/**
* The library that this feature flag report applies to.
*/
readonly module: string;
/**
* Information about every feature flag supported by this library.
*/
readonly flags: {
[flagName: string]: FeatureFlag;
};
}
/**
* A single feature flag
*/
export interface FeatureFlag {
/**
* The library-recommended value for this flag, if any
*
* It is possible that there is no recommended value.
*
* @default - No recommended value.
*/
readonly recommendedValue?: any;
/**
* The value configured by the user
*
* This is the value configured at the root of the tree. Users may also have
* configured values at specific locations in the tree; we don't report on
* those.
*
* @default - Not configured by the user
*/
readonly userValue?: any;
/**
* Explanation about the purpose of this flag that can be shown to the user.
*
* @default - No description
*/
readonly explanation?: string;
/**
* The value of the flag that produces the same behavior as when the flag is not configured at all
*
*The structure of this field is a historical accident. The type of this field
*should have been boolean, which should have contained the default value for
*the flag appropriate for the *current* version of the CDK library. We are
*not rectifying this accident because doing so
*
* Instead, the canonical way to access this value is by evaluating
* `unconfiguredBehavesLike?.v2 ?? false`.
*
* @default false
*/
readonly unconfiguredBehavesLike?: UnconfiguredBehavesLike;
}
export interface UnconfiguredBehavesLike {
/**
* Historical accident, don't use.
*
* This value may be present, but it should never be used. The actual value is
* in the `v2` field, regardless of the version of the CDK library.
*
* @default - ignore
*/
readonly v1?: any;
/**
* The value of the flag that produces the same behavior as when the flag is not configured at all
*
* Even though it is called 'v2', this is the official name of this field. In
* any future versions of CDK (v3, v4, ...), this field will still be called 'v2'.
*
* The structure of this field is a historical accident. See the comment on
* `unconfiguredBehavesLike` for more information.
*
* @default false
*/
readonly v2?: any;
}
/**
* Properties for manifest artifacts
*/
export type ArtifactProperties = AwsCloudFormationStackProperties | AssetManifestProperties | TreeArtifactProperties | NestedCloudAssemblyProperties | FeatureFlagReportProperties;

File diff suppressed because one or more lines are too long

View File

@@ -0,0 +1,462 @@
import type { Tag } from './metadata-schema';
/**
* Identifier for the context provider
*/
export declare enum ContextProvider {
/**
* AMI provider
*/
AMI_PROVIDER = "ami",
/**
* AZ provider
*/
AVAILABILITY_ZONE_PROVIDER = "availability-zones",
/**
* Route53 Hosted Zone provider
*/
HOSTED_ZONE_PROVIDER = "hosted-zone",
/**
* SSM Parameter Provider
*/
SSM_PARAMETER_PROVIDER = "ssm",
/**
* VPC Provider
*/
VPC_PROVIDER = "vpc-provider",
/**
* VPC Endpoint Service AZ Provider
*/
ENDPOINT_SERVICE_AVAILABILITY_ZONE_PROVIDER = "endpoint-service-availability-zones",
/**
* Load balancer provider
*/
LOAD_BALANCER_PROVIDER = "load-balancer",
/**
* Load balancer listener provider
*/
LOAD_BALANCER_LISTENER_PROVIDER = "load-balancer-listener",
/**
* Security group provider
*/
SECURITY_GROUP_PROVIDER = "security-group",
/**
* KMS Key Provider
*/
KEY_PROVIDER = "key-provider",
/**
* CCAPI Provider
*/
CC_API_PROVIDER = "cc-api-provider",
/**
* A plugin provider (the actual plugin name will be in the properties)
*/
PLUGIN = "plugin"
}
/**
* Options for context lookup roles.
*/
export interface ContextLookupRoleOptions {
/**
* Query account
*/
readonly account: string;
/**
* Query region
*/
readonly region: string;
/**
* The ARN of the role that should be used to look up the missing values
*
* @default - None
*/
readonly lookupRoleArn?: string;
/**
* The ExternalId that needs to be supplied while assuming this role
*
* @default - No ExternalId will be supplied
*/
readonly lookupRoleExternalId?: string;
/**
* Additional options to pass to STS when assuming the lookup role.
*
* - `RoleArn` should not be used. Use the dedicated `lookupRoleArn` property instead.
* - `ExternalId` should not be used. Use the dedicated `lookupRoleExternalId` instead.
*
* @see https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/STS.html#assumeRole-property
* @default - No additional options.
*/
readonly assumeRoleAdditionalOptions?: {
[key: string]: any;
};
}
/**
* Query to AMI context provider
*/
export interface AmiContextQuery extends ContextLookupRoleOptions {
/**
* Owners to DescribeImages call
*
* @default - All owners
*/
readonly owners?: string[];
/**
* Filters to DescribeImages call
*/
readonly filters: {
[key: string]: string[];
};
}
/**
* Query to availability zone context provider
*/
export interface AvailabilityZonesContextQuery extends ContextLookupRoleOptions {
}
/**
* Query to hosted zone context provider
*/
export interface HostedZoneContextQuery extends ContextLookupRoleOptions {
/**
* The domain name e.g. example.com to lookup
*/
readonly domainName: string;
/**
* True if the zone you want to find is a private hosted zone
*
* @default false
*/
readonly privateZone?: boolean;
/**
* The VPC ID to that the private zone must be associated with
*
* If you provide VPC ID and privateZone is false, this will return no results
* and raise an error.
*
* @default - Required if privateZone=true
*/
readonly vpcId?: string;
}
/**
* Query to SSM Parameter Context Provider
*/
export interface SSMParameterContextQuery extends ContextLookupRoleOptions {
/**
* Parameter name to query
*/
readonly parameterName: string;
}
/**
* Query input for looking up a VPC
*/
export interface VpcContextQuery extends ContextLookupRoleOptions {
/**
* Filters to apply to the VPC
*
* Filter parameters are the same as passed to DescribeVpcs.
*
* @see https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeVpcs.html
*/
readonly filter: {
[key: string]: string;
};
/**
* Whether to populate the subnetGroups field of the `VpcContextResponse`,
* which contains potentially asymmetric subnet groups.
*
* @default false
*/
readonly returnAsymmetricSubnets?: boolean;
/**
* Optional tag for subnet group name.
* If not provided, we'll look at the aws-cdk:subnet-name tag.
* If the subnet does not have the specified tag,
* we'll use its type as the name.
*
* @default 'aws-cdk:subnet-name'
*/
readonly subnetGroupNameTag?: string;
/**
* Whether to populate the `vpnGatewayId` field of the `VpcContextResponse`,
* which contains the VPN Gateway ID, if one exists. You can explicitly
* disable this in order to avoid the lookup if you know the VPC does not have
* a VPN Gatway attached.
*
* @default true
*/
readonly returnVpnGateways?: boolean;
}
/**
* Query to endpoint service context provider
*/
export interface EndpointServiceAvailabilityZonesContextQuery extends ContextLookupRoleOptions {
/**
* Query service name
*/
readonly serviceName: string;
}
/**
* Type of load balancer
*/
export declare enum LoadBalancerType {
/**
* Network load balancer
*/
NETWORK = "network",
/**
* Application load balancer
*/
APPLICATION = "application"
}
/**
* Filters for selecting load balancers
*/
export interface LoadBalancerFilter extends ContextLookupRoleOptions {
/**
* Filter load balancers by their type
*/
readonly loadBalancerType: LoadBalancerType;
/**
* Find by load balancer's ARN
* @default - does not search by load balancer arn
*/
readonly loadBalancerArn?: string;
/**
* Match load balancer tags
* @default - does not match load balancers by tags
*/
readonly loadBalancerTags?: Tag[];
}
/**
* Query input for looking up a load balancer
*/
export interface LoadBalancerContextQuery extends LoadBalancerFilter {
}
/**
* The protocol for connections from clients to the load balancer
*/
export declare enum LoadBalancerListenerProtocol {
/**
* HTTP protocol
*/
HTTP = "HTTP",
/**
* HTTPS protocol
*/
HTTPS = "HTTPS",
/**
* TCP protocol
*/
TCP = "TCP",
/**
* TLS protocol
*/
TLS = "TLS",
/**
* UDP protocol
* */
UDP = "UDP",
/**
* TCP and UDP protocol
* */
TCP_UDP = "TCP_UDP"
}
/**
* Query input for looking up a load balancer listener
*/
export interface LoadBalancerListenerContextQuery extends LoadBalancerFilter {
/**
* Find by listener's arn
* @default - does not find by listener arn
*/
readonly listenerArn?: string;
/**
* Filter by listener protocol
* @default - does not filter by listener protocol
*/
readonly listenerProtocol?: LoadBalancerListenerProtocol;
/**
* Filter listeners by listener port
* @default - does not filter by a listener port
*/
readonly listenerPort?: number;
}
/**
* Query input for looking up a security group
*/
export interface SecurityGroupContextQuery extends ContextLookupRoleOptions {
/**
* Security group id
*
* @default - None
*/
readonly securityGroupId?: string;
/**
* Security group name
*
* @default - None
*/
readonly securityGroupName?: string;
/**
* VPC ID
*
* @default - None
*/
readonly vpcId?: string;
}
/**
* Query input for looking up a KMS Key
*/
export interface KeyContextQuery extends ContextLookupRoleOptions {
/**
* Alias name used to search the Key
*/
readonly aliasName: string;
}
/**
* Query input for lookup up CloudFormation resources using CC API
*
* The example below is required to successfully compile CDK (otherwise,
* the CDK build will generate a synthetic example for the below, but it
* doesn't have enough type information about the literal string union
* to generate a validly compiling example).
*
* @example
* import { CcApiContextQuery } from '@aws-cdk/cloud-assembly-schema';
*
* const x: CcApiContextQuery = {
* typeName: 'AWS::Some::Type',
* expectedMatchCount: 'exactly-one',
* resourceModel: {SomeArn: 'arn:aws:....'},
* propertiesToReturn: ['SomeProp'],
* account: '11111111111',
* region: 'us-east-1',
* };
*/
export interface CcApiContextQuery extends ContextLookupRoleOptions {
/**
* The CloudFormation resource type.
* See https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/supported-resources.html
*/
readonly typeName: string;
/**
* Identifier of the resource to look up using `GetResource`.
*
* Specifying exactIdentifier will return exactly one result, or throw an error
* unless `ignoreErrorOnMissingContext` is set.
*
* @default - Either exactIdentifier or propertyMatch should be specified.
*/
readonly exactIdentifier?: string;
/**
* The resource model to use to select the resources, using `ListResources`..
*
* This is needed for sub-resources where the parent Arn is required.
*
* See https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-list.html#resource-operations-list-containers
*
* @default - no resource Model is provided
*/
readonly resourceModel?: Record<string, unknown>;
/**
* Returns any resources matching these properties, using `ListResources`.
*
* By default, specifying propertyMatch will successfully return 0 or more
* results. To throw an error if the number of results is unexpected (and
* prevent the query results from being committed to context), specify
* `expectedMatchCount`.
*
* ## Notes on property completeness
*
* CloudControl API's `ListResources` may return fewer properties than
* `GetResource` would, depending on the resource implementation.
*
* The resources that `propertyMatch` matches against will *only ever* be the
* properties returned by the `ListResources` call.
*
* @default - Either exactIdentifier or propertyMatch should be specified.
*/
readonly propertyMatch?: Record<string, unknown>;
/**
* This is a set of properties returned from CC API that we want to return from ContextQuery.
*
* If any properties listed here are absent from the target resource, an error will be thrown.
*
* The returned object will always include the key `Identifier` with the CC-API returned
* field `Identifier`.
*
* ## Notes on property completeness
*
* CloudControl API's `ListResources` may return fewer properties than
* `GetResource` would, depending on the resource implementation.
*
* The returned properties here are *currently* selected from the response
* object that CloudControl API returns to the CDK CLI.
*
* However, if we find there is need to do so, we may decide to change this
* behavior in the future: we might change it to perform an additional
* `GetResource` call for resources matched by `propertyMatch`.
*/
readonly propertiesToReturn: string[];
/**
* Expected count of results if `propertyMatch` is specified.
*
* If the expected result count does not match the actual count,
* by default an error is produced and the result is not committed to cached
* context, and the user can correct the situation and try again without
* having to manually clear out the context key using `cdk context --remove`
*
* If the value of * `ignoreErrorOnMissingContext` is `true`, the value of
* `expectedMatchCount` is `at-least-one | exactly-one` and the number
* of found resources is 0, `dummyValue` is returned and committed to context
* instead.
*
* @default 'any'
*/
readonly expectedMatchCount?: 'any' | 'at-least-one' | 'at-most-one' | 'exactly-one';
/**
* The value to return if the resource was not found and `ignoreErrorOnMissingContext` is true.
*
* If supplied, `dummyValue` should be an array of objects.
*
* `dummyValue` does not have to have elements, and it may have objects with
* different properties than the properties in `propertiesToReturn`, but it
* will be easiest for downstream code if the `dummyValue` conforms to
* the expected response shape.
*
* @default - No dummy value available
*/
readonly dummyValue?: any;
/**
* Ignore an error and return the `dummyValue` instead if the resource was not found.
*
* - In case of an `exactIdentifier` lookup, return the `dummyValue` if the resource with
* that identifier was not found.
* - In case of a `propertyMatch` lookup, return the `dummyValue` if `expectedMatchCount`
* is `at-least-one | exactly-one` and the number of resources found was 0.
*
* if `ignoreErrorOnMissingContext` is set, `dummyValue` should be set and be an array.
*
* @default false
*/
readonly ignoreErrorOnMissingContext?: boolean;
}
/**
* Query input for plugins
*
* This alternate branch is necessary because it needs to be able to escape all type checking
* we do on on the cloud assembly -- we cannot know the properties that will be used a priori.
*/
export interface PluginContextQuery {
/**
* The name of the plugin
*/
readonly pluginName: string;
/**
* Arbitrary other arguments for the plugin.
*
* This index signature is not usable in non-TypeScript/JavaScript languages.
*
* @jsii ignore
*/
[key: string]: any;
}
export type ContextQueryProperties = AmiContextQuery | AvailabilityZonesContextQuery | HostedZoneContextQuery | SSMParameterContextQuery | VpcContextQuery | EndpointServiceAvailabilityZonesContextQuery | LoadBalancerContextQuery | LoadBalancerListenerContextQuery | SecurityGroupContextQuery | KeyContextQuery | CcApiContextQuery | PluginContextQuery;

File diff suppressed because one or more lines are too long

View File

@@ -0,0 +1,5 @@
export * from './schema';
export * from './metadata-schema';
export * from './artifact-schema';
export * from './context-queries';
export * from './interfaces';

View File

@@ -0,0 +1,22 @@
"use strict";
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
if (k2 === undefined) k2 = k;
var desc = Object.getOwnPropertyDescriptor(m, k);
if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
desc = { enumerable: true, get: function() { return m[k]; } };
}
Object.defineProperty(o, k2, desc);
}) : (function(o, m, k, k2) {
if (k2 === undefined) k2 = k;
o[k2] = m[k];
}));
var __exportStar = (this && this.__exportStar) || function(m, exports) {
for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
};
Object.defineProperty(exports, "__esModule", { value: true });
__exportStar(require("./schema"), exports);
__exportStar(require("./metadata-schema"), exports);
__exportStar(require("./artifact-schema"), exports);
__exportStar(require("./context-queries"), exports);
__exportStar(require("./interfaces"), exports);
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyJpbmRleC50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOzs7Ozs7Ozs7Ozs7Ozs7O0FBQUEsMkNBQXlCO0FBQ3pCLG9EQUFrQztBQUNsQyxvREFBa0M7QUFDbEMsb0RBQWtDO0FBQ2xDLCtDQUE2QiIsInNvdXJjZXNDb250ZW50IjpbImV4cG9ydCAqIGZyb20gJy4vc2NoZW1hJztcbmV4cG9ydCAqIGZyb20gJy4vbWV0YWRhdGEtc2NoZW1hJztcbmV4cG9ydCAqIGZyb20gJy4vYXJ0aWZhY3Qtc2NoZW1hJztcbmV4cG9ydCAqIGZyb20gJy4vY29udGV4dC1xdWVyaWVzJztcbmV4cG9ydCAqIGZyb20gJy4vaW50ZXJmYWNlcyc7XG4iXX0=

View File

@@ -0,0 +1,23 @@
/**
* Interoperable representation of a deployable cloud application.
*
* The external and interoperable contract for a Cloud Assembly is
* a directory containing a valid Cloud Assembly.
*
* Implementations should use the directory to load the Cloud Assembly from disk.
* It is recommended that implementations validate loaded manifest files using
* the provided functionality from this package.
* Within an implementation, it may be prudent to keep (parts of) the Cloud Assembly
* in memory during execution and use an implementation-specific contract.
* However when an implementation is providing an external contract,
* this interface should be used.
*/
export interface ICloudAssembly {
/**
* The directory of the cloud assembly.
*
* This directory will be used to read the Cloud Assembly from.
* Its contents (in particular `manifest.json`) must comply with the schema defined in this package.
*/
readonly directory: string;
}

View File

@@ -0,0 +1,10 @@
"use strict";
// The interfaces in this file, mainly exist __here__ because this is a convenient place to put them.
// The Assembly Schema package is already a jsii package and a dependency of `aws-cdk-lib`.
// It is effectively the only place we can put shared interfaces to be used across the jsii ecosystem.
//
// Putting a shared interface in here should be a huge exception.
// It needs to be justified by great benefits it provides to the ecosystems.
// All interfaces should be as minimal as possible.
Object.defineProperty(exports, "__esModule", { value: true });
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW50ZXJmYWNlcy5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbImludGVyZmFjZXMudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IjtBQUFBLHFHQUFxRztBQUNyRywyRkFBMkY7QUFDM0Ysc0dBQXNHO0FBQ3RHLEVBQUU7QUFDRixpRUFBaUU7QUFDakUsNEVBQTRFO0FBQzVFLG1EQUFtRCIsInNvdXJjZXNDb250ZW50IjpbIi8vIFRoZSBpbnRlcmZhY2VzIGluIHRoaXMgZmlsZSwgbWFpbmx5IGV4aXN0IF9faGVyZV9fIGJlY2F1c2UgdGhpcyBpcyBhIGNvbnZlbmllbnQgcGxhY2UgdG8gcHV0IHRoZW0uXG4vLyBUaGUgQXNzZW1ibHkgU2NoZW1hIHBhY2thZ2UgaXMgYWxyZWFkeSBhIGpzaWkgcGFja2FnZSBhbmQgYSBkZXBlbmRlbmN5IG9mIGBhd3MtY2RrLWxpYmAuXG4vLyBJdCBpcyBlZmZlY3RpdmVseSB0aGUgb25seSBwbGFjZSB3ZSBjYW4gcHV0IHNoYXJlZCBpbnRlcmZhY2VzIHRvIGJlIHVzZWQgYWNyb3NzIHRoZSBqc2lpIGVjb3N5c3RlbS5cbi8vXG4vLyBQdXR0aW5nIGEgc2hhcmVkIGludGVyZmFjZSBpbiBoZXJlIHNob3VsZCBiZSBhIGh1Z2UgZXhjZXB0aW9uLlxuLy8gSXQgbmVlZHMgdG8gYmUganVzdGlmaWVkIGJ5IGdyZWF0IGJlbmVmaXRzIGl0IHByb3ZpZGVzIHRvIHRoZSBlY29zeXN0ZW1zLlxuLy8gQWxsIGludGVyZmFjZXMgc2hvdWxkIGJlIGFzIG1pbmltYWwgYXMgcG9zc2libGUuXG5cbi8qKlxuICogSW50ZXJvcGVyYWJsZSByZXByZXNlbnRhdGlvbiBvZiBhIGRlcGxveWFibGUgY2xvdWQgYXBwbGljYXRpb24uXG4gKlxuICogVGhlIGV4dGVybmFsIGFuZCBpbnRlcm9wZXJhYmxlIGNvbnRyYWN0IGZvciBhIENsb3VkIEFzc2VtYmx5IGlzXG4gKiBhIGRpcmVjdG9yeSBjb250YWluaW5nIGEgdmFsaWQgQ2xvdWQgQXNzZW1ibHkuXG4gKlxuICogSW1wbGVtZW50YXRpb25zIHNob3VsZCB1c2UgdGhlIGRpcmVjdG9yeSB0byBsb2FkIHRoZSBDbG91ZCBBc3NlbWJseSBmcm9tIGRpc2suXG4gKiBJdCBpcyByZWNvbW1lbmRlZCB0aGF0IGltcGxlbWVudGF0aW9ucyB2YWxpZGF0ZSBsb2FkZWQgbWFuaWZlc3QgZmlsZXMgdXNpbmdcbiAqIHRoZSBwcm92aWRlZCBmdW5jdGlvbmFsaXR5IGZyb20gdGhpcyBwYWNrYWdlLlxuICogV2l0aGluIGFuIGltcGxlbWVudGF0aW9uLCBpdCBtYXkgYmUgcHJ1ZGVudCB0byBrZWVwIChwYXJ0cyBvZikgdGhlIENsb3VkIEFzc2VtYmx5XG4gKiBpbiBtZW1vcnkgZHVyaW5nIGV4ZWN1dGlvbiBhbmQgdXNlIGFuIGltcGxlbWVudGF0aW9uLXNwZWNpZmljIGNvbnRyYWN0LlxuICogSG93ZXZlciB3aGVuIGFuIGltcGxlbWVudGF0aW9uIGlzIHByb3ZpZGluZyBhbiBleHRlcm5hbCBjb250cmFjdCxcbiAqIHRoaXMgaW50ZXJmYWNlIHNob3VsZCBiZSB1c2VkLlxuICovXG5leHBvcnQgaW50ZXJmYWNlIElDbG91ZEFzc2VtYmx5IHtcbiAgLyoqXG4gICAqIFRoZSBkaXJlY3Rvcnkgb2YgdGhlIGNsb3VkIGFzc2VtYmx5LlxuICAgKlxuICAgKiBUaGlzIGRpcmVjdG9yeSB3aWxsIGJlIHVzZWQgdG8gcmVhZCB0aGUgQ2xvdWQgQXNzZW1ibHkgZnJvbS5cbiAgICogSXRzIGNvbnRlbnRzIChpbiBwYXJ0aWN1bGFyIGBtYW5pZmVzdC5qc29uYCkgbXVzdCBjb21wbHkgd2l0aCB0aGUgc2NoZW1hIGRlZmluZWQgaW4gdGhpcyBwYWNrYWdlLlxuICAgKi9cbiAgcmVhZG9ubHkgZGlyZWN0b3J5OiBzdHJpbmc7XG59XG4iXX0=

View File

@@ -0,0 +1,331 @@
/**
* Common properties for asset metadata.
*/
interface BaseAssetMetadataEntry {
/**
* Requested packaging style
*/
readonly packaging: string;
/**
* Logical identifier for the asset
*/
readonly id: string;
/**
* The hash of the asset source.
*/
readonly sourceHash: string;
/**
* Path on disk to the asset
*/
readonly path: string;
}
/**
* Metadata Entry spec for files.
*
* @example
* const entry = {
* packaging: 'file',
* s3BucketParameter: 'bucket-parameter',
* s3KeyParamenter: 'key-parameter',
* artifactHashParameter: 'hash-parameter',
* }
*/
export interface FileAssetMetadataEntry extends BaseAssetMetadataEntry {
/**
* Requested packaging style
*/
readonly packaging: 'zip' | 'file';
/**
* Name of parameter where S3 bucket should be passed in
*/
readonly s3BucketParameter: string;
/**
* Name of parameter where S3 key should be passed in
*/
readonly s3KeyParameter: string;
/**
* The name of the parameter where the hash of the bundled asset should be passed in.
*/
readonly artifactHashParameter: string;
}
/**
* Metadata Entry spec for stack tag.
*/
export interface Tag {
/**
* Tag key.
*
* (In the actual file on disk this will be cased as "Key", and the structure is
* patched to match this structure upon loading:
* https://github.com/aws/aws-cdk/blob/4aadaa779b48f35838cccd4e25107b2338f05547/packages/%40aws-cdk/cloud-assembly-schema/lib/manifest.ts#L137)
*/
readonly key: string;
/**
* Tag value.
*
* (In the actual file on disk this will be cased as "Value", and the structure is
* patched to match this structure upon loading:
* https://github.com/aws/aws-cdk/blob/4aadaa779b48f35838cccd4e25107b2338f05547/packages/%40aws-cdk/cloud-assembly-schema/lib/manifest.ts#L137)
*/
readonly value: string;
}
/**
* Options for configuring the Docker cache backend
*/
export interface ContainerImageAssetCacheOption {
/**
* The type of cache to use.
* Refer to https://docs.docker.com/build/cache/backends/ for full list of backends.
* @default - unspecified
*
* @example 'registry'
*/
readonly type: string;
/**
* Any parameters to pass into the docker cache backend configuration.
* Refer to https://docs.docker.com/build/cache/backends/ for cache backend configuration.
* @default {} No options provided
*
* @example
* declare const branch: string;
*
* const params = {
* ref: `12345678.dkr.ecr.us-west-2.amazonaws.com/cache:${branch}`,
* mode: "max",
* };
*/
readonly params?: {
[key: string]: string;
};
}
/**
* Metadata Entry spec for container images.
*
* @example
* const entry = {
* packaging: 'container-image',
* repositoryName: 'repository-name',
* imageTag: 'tag',
* }
*/
export interface ContainerImageAssetMetadataEntry extends BaseAssetMetadataEntry {
/**
* Type of asset
*/
readonly packaging: 'container-image';
/**
* ECR Repository name and repo digest (separated by "@sha256:") where this
* image is stored.
*
* @default undefined If not specified, `repositoryName` and `imageTag` are
* required because otherwise how will the stack know where to find the asset,
* ha?
* @deprecated specify `repositoryName` and `imageTag` instead, and then you
* know where the image will go.
*/
readonly imageNameParameter?: string;
/**
* ECR repository name, if omitted a default name based on the asset's ID is
* used instead. Specify this property if you need to statically address the
* image, e.g. from a Kubernetes Pod. Note, this is only the repository name,
* without the registry and the tag parts.
*
* @default - this parameter is REQUIRED after 1.21.0
*/
readonly repositoryName?: string;
/**
* The docker image tag to use for tagging pushed images. This field is
* required if `imageParameterName` is ommited (otherwise, the app won't be
* able to find the image).
*
* @default - this parameter is REQUIRED after 1.21.0
*/
readonly imageTag?: string;
/**
* Build args to pass to the `docker build` command
*
* @default no build args are passed
*/
readonly buildArgs?: {
[key: string]: string;
};
/**
* Build contexts to pass to the `docker build` command
*
* @default no build contexts are passed
*/
readonly buildContexts?: {
[key: string]: string;
};
/**
* SSH agent socket or keys to pass to the `docker build` command
*
* @default no ssh arg is passed
*/
readonly buildSsh?: string;
/**
* Build secrets to pass to the `docker build` command
*
* @default no build secrets are passed
*/
readonly buildSecrets?: {
[key: string]: string;
};
/**
* Docker target to build to
*
* @default no build target
*/
readonly target?: string;
/**
* Path to the Dockerfile (relative to the directory).
*
* @default - no file is passed
*/
readonly file?: string;
/**
* Networking mode for the RUN commands during build.
*
* @default - no networking mode specified
*/
readonly networkMode?: string;
/**
* Platform to build for. _Requires Docker Buildx_.
*
* @default - current machine platform
*/
readonly platform?: string;
/**
* Outputs to pass to the `docker build` command.
*
* @default - no outputs are passed to the build command (default outputs are used)
* @see https://docs.docker.com/engine/reference/commandline/build/#custom-build-outputs
*/
readonly outputs?: string[];
/**
* Cache from options to pass to the `docker build` command.
*
* @default - no cache from options are passed to the build command
* @see https://docs.docker.com/build/cache/backends/
*/
readonly cacheFrom?: ContainerImageAssetCacheOption[];
/**
* Cache to options to pass to the `docker build` command.
*
* @default - no cache to options are passed to the build command
* @see https://docs.docker.com/build/cache/backends/
*/
readonly cacheTo?: ContainerImageAssetCacheOption;
/**
* Disable the cache and pass `--no-cache` to the `docker build` command.
*
* @default - cache is used
*/
readonly cacheDisabled?: boolean;
}
/**
* @see ArtifactMetadataEntryType.ASSET
*/
export type AssetMetadataEntry = FileAssetMetadataEntry | ContainerImageAssetMetadataEntry;
/**
* @see ArtifactMetadataEntryType.INFO
* @see ArtifactMetadataEntryType.WARN
* @see ArtifactMetadataEntryType.ERROR
*/
export type LogMessageMetadataEntry = string;
/**
* @see ArtifactMetadataEntryType.LOGICAL_ID
*/
export type LogicalIdMetadataEntry = string;
/**
* @see ArtifactMetadataEntryType.STACK_TAGS
*/
export type StackTagsMetadataEntry = Tag[];
/**
* Any other type of metadata entry
*
* This could probably be changed to `any`, but it's safer not
* to do so right now.
* See https://github.com/cdklabs/cloud-assembly-schema/pull/121.
*/
export type PrimitiveType = boolean | number | string;
/**
* Metadata type of a PropertyMutation
*/
export interface PropertyMutationMetadataEntry {
/**
* Name of the property
*/
readonly propertyName: string;
/**
* Stack trace of the mutation
*/
readonly stackTrace: string[];
}
/**
* Union type for all metadata entries that might exist in the manifest.
*/
export type MetadataEntryData = AssetMetadataEntry | LogMessageMetadataEntry | LogicalIdMetadataEntry | PrimitiveType | PropertyMutationMetadataEntry | (Tag | string)[];
/**
* Type of artifact metadata entry.
*/
export declare enum ArtifactMetadataEntryType {
/**
* Asset in metadata.
*/
ASSET = "aws:cdk:asset",
/**
* Metadata key used to print INFO-level messages by the toolkit when an app is syntheized.
*/
INFO = "aws:cdk:info",
/**
* Metadata key used to print WARNING-level messages by the toolkit when an app is syntheized.
*/
WARN = "aws:cdk:warning",
/**
* Metadata key used to print ERROR-level messages by the toolkit when an app is syntheized.
*/
ERROR = "aws:cdk:error",
/**
* Represents the CloudFormation logical ID of a resource at a certain path.
*/
LOGICAL_ID = "aws:cdk:logicalId",
/**
* Represents tags of a stack.
*/
STACK_TAGS = "aws:cdk:stack-tags",
/**
* Whether the resource should be excluded during refactoring.
*/
DO_NOT_REFACTOR = "aws:cdk:do-not-refactor",
/**
* Creation stack of a construct
*/
CREATION_STACK = "aws:cdk:creationStack",
/**
* A property mutation trace
*/
PROPERTY_ASSIGNMENT = "aws:cdk:propertyAssignment"
}
/**
* A metadata entry in a cloud assembly artifact.
*/
export interface MetadataEntry {
/**
* The type of the metadata entry.
*/
readonly type: string;
/**
* The data.
*
* @default - no data.
*/
readonly data?: MetadataEntryData;
/**
* A stack trace for when the entry was created.
*
* @default - no trace.
*/
readonly trace?: string[];
}
export {};

File diff suppressed because one or more lines are too long

View File

@@ -0,0 +1,162 @@
import type { ArtifactProperties } from './artifact-schema';
import type { ContextProvider, ContextQueryProperties } from './context-queries';
import type { MetadataEntry } from './metadata-schema';
/**
* Type of cloud artifact.
*/
export declare enum ArtifactType {
/**
* Stub required because of JSII.
*/
NONE = "none",// required due to a jsii bug
/**
* The artifact is an AWS CloudFormation stack.
*/
AWS_CLOUDFORMATION_STACK = "aws:cloudformation:stack",
/**
* The artifact contains the CDK application's construct tree.
*/
CDK_TREE = "cdk:tree",
/**
* Manifest for all assets in the Cloud Assembly
*/
ASSET_MANIFEST = "cdk:asset-manifest",
/**
* Nested Cloud Assembly
*/
NESTED_CLOUD_ASSEMBLY = "cdk:cloud-assembly",
/**
* Feature flag report
*/
FEATURE_FLAG_REPORT = "cdk:feature-flag-report"
}
/**
* Information about the application's runtime components.
*/
export interface RuntimeInfo {
/**
* The list of libraries loaded in the application, associated with their versions.
*/
readonly libraries: {
[name: string]: string;
};
}
/**
* Represents a missing piece of context.
*/
export interface MissingContext {
/**
* The missing context key.
*/
readonly key: string;
/**
* The provider from which we expect this context key to be obtained.
*/
readonly provider: ContextProvider;
/**
* A set of provider-specific options.
*/
readonly props: ContextQueryProperties;
}
/**
* A manifest for a single artifact within the cloud assembly.
*/
export interface ArtifactManifest {
/**
* The type of artifact.
*/
readonly type: ArtifactType;
/**
* The environment into which this artifact is deployed.
*
* @default - no envrionment.
*/
readonly environment?: string;
/**
* Associated metadata.
*
* Metadata can be stored directly in the assembly manifest, as well as in a
* separate file (see `additionalMetadataFile`). It should prefer to be stored
* in the additional file, as that will reduce the size of the assembly
* manifest in cases of a lot of metdata (which CDK does emit by default).
*
* @default - no metadata.
*/
readonly metadata?: {
[path: string]: MetadataEntry[];
};
/**
* A file with additional metadata entries.
*
* The schema of this file is exactly the same as the type of the `metadata` field.
* In other words, that file contains an object mapping construct paths to arrays
* of metadata entries.
*
* @default - no additional metadata
*/
readonly additionalMetadataFile?: string;
/**
* IDs of artifacts that must be deployed before this artifact.
*
* @default - no dependencies.
*/
readonly dependencies?: string[];
/**
* The set of properties for this artifact (depends on type)
*
* @default - no properties.
*/
readonly properties?: ArtifactProperties;
/**
* A string that can be shown to a user to uniquely identify this artifact inside a cloud assembly tree
*
* Is used by the CLI to present a list of stacks to the user in a way that
* makes sense to them. Even though the property name "display name" doesn't
* imply it, this field is used to select stacks as well, so all stacks should
* have a unique display name.
*
* @default - no display name
*/
readonly displayName?: string;
}
/**
* A manifest which describes the cloud assembly.
*/
export interface AssemblyManifest {
/**
* Protocol version
*/
readonly version: string;
/**
* Required CLI version, if available
*
* If the manifest producer knows, it can put the minimum version of the CLI
* here that supports reading this assembly.
*
* If set, it can be used to show a more informative error message to users.
*
* @default - Minimum CLI version unknown
*/
readonly minimumCliVersion?: string;
/**
* The set of artifacts in this assembly.
*
* @default - no artifacts.
*/
readonly artifacts?: {
[id: string]: ArtifactManifest;
};
/**
* Missing context information. If this field has values, it means that the
* cloud assembly is not complete and should not be deployed.
*
* @default - no missing context.
*/
readonly missing?: MissingContext[];
/**
* Runtime information.
*
* @default - no info.
*/
readonly runtime?: RuntimeInfo;
}

File diff suppressed because one or more lines are too long