@propulsionworks/cloudformation 0.1.29 → 0.1.31

package/out/exports/resources.generated/aws-bedrockagentcore-gatewaytarget.d.ts

@@ -1,35 +1,48 @@
 import type { ResourceDefinitionWithAttributes } from "../main.ts";
 /**
- * Definition of AWS::BedrockAgentCore::GatewayTarget Resource Type
+ * After creating a gateway, you can add targets, which define the tools that your gateway will host.
+ *
+ * For more information about adding gateway targets, see [Add targets to an existing gateway](https://docs.aws.amazon.com/bedrock-agentcore/latest/devguide/gateway-building-adding-targets.html) .
+ *
+ * See the *Properties* section below for descriptions of both the required and optional properties.
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-gatewaytarget.html}
  */
 export type BedrockAgentCoreGatewayTarget = ResourceDefinitionWithAttributes<"AWS::BedrockAgentCore::GatewayTarget", BedrockAgentCoreGatewayTargetProps, BedrockAgentCoreGatewayTargetAttribs>;
 /**
- * Definition of AWS::BedrockAgentCore::GatewayTarget Resource Type
+ * After creating a gateway, you can add targets, which define the tools that your gateway will host.
+ *
+ * For more information about adding gateway targets, see [Add targets to an existing gateway](https://docs.aws.amazon.com/bedrock-agentcore/latest/devguide/gateway-building-adding-targets.html) .
+ *
+ * See the *Properties* section below for descriptions of both the required and optional properties.
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-gatewaytarget.html}
  */
 export type BedrockAgentCoreGatewayTargetProps = {
     /**
+     * The OAuth credential provider configuration.
      * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-gatewaytarget.html#cfn-bedrockagentcore-gatewaytarget-credentialproviderconfigurations}
      */
     CredentialProviderConfigurations: CredentialProviderConfiguration[];
     /**
+     * The description for the gateway target.
      * @minLength 1
      * @maxLength 200
      * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-gatewaytarget.html#cfn-bedrockagentcore-gatewaytarget-description}
      */
     Description?: string | undefined;
     /**
+     * The gateway ID for the gateway target.
      * @pattern ^([0-9a-z][-]?){1,100}-[0-9a-z]{10}$
      * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-gatewaytarget.html#cfn-bedrockagentcore-gatewaytarget-gatewayidentifier}
      */
     GatewayIdentifier?: string | undefined;
     /**
+     * The name for the gateway target.
      * @pattern ^([0-9a-zA-Z][-]?){1,100}$
      * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-gatewaytarget.html#cfn-bedrockagentcore-gatewaytarget-name}
      */
     Name: string;
     /**
+     * The target configuration for the Smithy model target.
      * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-gatewaytarget.html#cfn-bedrockagentcore-gatewaytarget-targetconfiguration}
      */
     TargetConfiguration: TargetConfiguration;
@@ -39,6 +52,7 @@ export type BedrockAgentCoreGatewayTargetProps = {
  */
 export type BedrockAgentCoreGatewayTargetAttribs = {
     /**
+     * The date and time at which the gateway target was created.
      * @format date-time
      * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-gatewaytarget.html#cfn-bedrockagentcore-gatewaytarget-createdat}
      */
@@ -49,19 +63,23 @@ export type BedrockAgentCoreGatewayTargetAttribs = {
      */
     GatewayArn: string;
     /**
+     * The status for the gateway target.
      * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-gatewaytarget.html#cfn-bedrockagentcore-gatewaytarget-status}
      */
     Status: TargetStatus;
     /**
+     * The status reasons for the gateway target.
      * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-gatewaytarget.html#cfn-bedrockagentcore-gatewaytarget-statusreasons}
      */
     StatusReasons: string[];
     /**
+     * The target ID for the gateway target.
      * @pattern ^[0-9a-zA-Z]{10}$
      * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-gatewaytarget.html#cfn-bedrockagentcore-gatewaytarget-targetid}
      */
     TargetId: string;
     /**
+     * The time at which the resource was updated.
      * @format date-time
      * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-gatewaytarget.html#cfn-bedrockagentcore-gatewaytarget-updatedat}
      */
@@ -72,32 +90,38 @@ export type BedrockAgentCoreGatewayTargetAttribs = {
  */
 export type ApiKeyCredentialLocation = "HEADER" | "QUERY_PARAMETER";
 /**
+ * The API key credential provider for the gateway target.
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-apikeycredentialprovider.html}
  */
 export type ApiKeyCredentialProvider = {
     /**
+     * The credential location for the gateway target.
      * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-apikeycredentialprovider.html#cfn-bedrockagentcore-gatewaytarget-apikeycredentialprovider-credentiallocation}
      */
     CredentialLocation?: ApiKeyCredentialLocation | undefined;
     /**
+     * The credential parameter name for the provider for the gateway target.
      * @minLength 1
      * @maxLength 64
      * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-apikeycredentialprovider.html#cfn-bedrockagentcore-gatewaytarget-apikeycredentialprovider-credentialparametername}
      */
     CredentialParameterName?: string | undefined;
     /**
+     * The API key credential provider for the gateway target.
      * @minLength 1
      * @maxLength 64
      * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-apikeycredentialprovider.html#cfn-bedrockagentcore-gatewaytarget-apikeycredentialprovider-credentialprefix}
      */
     CredentialPrefix?: string | undefined;
     /**
+     * The provider ARN for the gateway target.
      * @pattern ^arn:([^:]*):([^:]*):([^:]*):([0-9]{12})?:(.+)$
      * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-apikeycredentialprovider.html#cfn-bedrockagentcore-gatewaytarget-apikeycredentialprovider-providerarn}
      */
     ProviderArn: string;
 };
 /**
+ * The API schema configuration for the gateway target.
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-apischemaconfiguration.html}
  */
 export type ApiSchemaConfiguration = {
@@ -114,14 +138,17 @@ export type CredentialProvider = {
     ApiKeyCredentialProvider: ApiKeyCredentialProvider;
 };
 /**
+ * The credential provider configuration for the gateway target.
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-credentialproviderconfiguration.html}
  */
 export type CredentialProviderConfiguration = {
     /**
+     * The credential provider for the gateway target.
      * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-credentialproviderconfiguration.html#cfn-bedrockagentcore-gatewaytarget-credentialproviderconfiguration-credentialprovider}
      */
     CredentialProvider?: CredentialProvider | undefined;
     /**
+     * The credential provider type for the gateway target.
      * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-credentialproviderconfiguration.html#cfn-bedrockagentcore-gatewaytarget-credentialproviderconfiguration-credentialprovidertype}
      */
     CredentialProviderType: CredentialProviderType;
@@ -131,10 +158,12 @@ export type CredentialProviderConfiguration = {
  */
 export type CredentialProviderType = "GATEWAY_IAM_ROLE" | "OAUTH" | "API_KEY";
 /**
+ * The Lambda target configuration.
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-mcplambdatargetconfiguration.html}
  */
 export type McpLambdaTargetConfiguration = {
     /**
+     * The ARN of the Lambda target configuration.
      * @minLength 1
      * @maxLength 170
      * @pattern ^arn:(aws[a-zA-Z-]*)?:lambda:([a-z]{2}(-gov)?-[a-z]+-\d{1}):(\d{12}):function:([a-zA-Z0-9-_.]+)(:(\$LATEST|[a-zA-Z0-9-_]+))?$
@@ -142,11 +171,13 @@ export type McpLambdaTargetConfiguration = {
      */
     LambdaArn: string;
     /**
+     * The tool schema configuration for the gateway target MCP configuration for Lambda.
      * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-mcplambdatargetconfiguration.html#cfn-bedrockagentcore-gatewaytarget-mcplambdatargetconfiguration-toolschema}
      */
     ToolSchema: ToolSchema;
 };
 /**
+ * The MCP target configuration for the gateway target.
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-mcptargetconfiguration.html}
  */
 export type McpTargetConfiguration = {
@@ -157,43 +188,52 @@ export type McpTargetConfiguration = {
     Lambda: McpLambdaTargetConfiguration;
 };
 /**
+ * The OAuth credential provider for the gateway target.
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-oauthcredentialprovider.html}
  */
 export type OAuthCredentialProvider = {
     /**
+     * The OAuth credential provider.
      * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-oauthcredentialprovider.html#cfn-bedrockagentcore-gatewaytarget-oauthcredentialprovider-customparameters}
      */
     CustomParameters?: Record<string, string> | undefined;
     /**
+     * The provider ARN for the gateway target.
      * @pattern ^arn:([^:]*):([^:]*):([^:]*):([0-9]{12})?:(.+)$
      * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-oauthcredentialprovider.html#cfn-bedrockagentcore-gatewaytarget-oauthcredentialprovider-providerarn}
      */
     ProviderArn: string;
     /**
+     * The OAuth credential provider scopes.
      * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-oauthcredentialprovider.html#cfn-bedrockagentcore-gatewaytarget-oauthcredentialprovider-scopes}
      */
     Scopes: string[];
 };
 /**
+ * The S3 configuration for the gateway target.
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-s3configuration.html}
  */
 export type S3Configuration = {
     /**
+     * The S3 configuration bucket owner account ID for the gateway target.
      * @pattern ^[0-9]{12}$
      * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-s3configuration.html#cfn-bedrockagentcore-gatewaytarget-s3configuration-bucketowneraccountid}
      */
     BucketOwnerAccountId?: string | undefined;
     /**
+     * The configuration URI for the gateway target.
      * @pattern ^s3://.{1,2043}$
      * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-s3configuration.html#cfn-bedrockagentcore-gatewaytarget-s3configuration-uri}
      */
     Uri?: string | undefined;
 };
 /**
+ * The schema definition for the gateway target.
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-schemadefinition.html}
  */
 export type SchemaDefinition = {
     /**
+     * The workload identity details for the gateway.
      * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-schemadefinition.html#cfn-bedrockagentcore-gatewaytarget-schemadefinition-description}
      */
     Description?: string | undefined;
@@ -202,14 +242,17 @@ export type SchemaDefinition = {
      */
     Items?: SchemaDefinition | undefined;
     /**
+     * The schema definition properties for the gateway target.
      * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-schemadefinition.html#cfn-bedrockagentcore-gatewaytarget-schemadefinition-properties}
      */
     Properties?: Record<string, SchemaDefinition> | undefined;
     /**
+     * The schema definition.
      * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-schemadefinition.html#cfn-bedrockagentcore-gatewaytarget-schemadefinition-required}
      */
     Required?: string[] | undefined;
     /**
+     * The scheme definition type for the gateway target.
      * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-schemadefinition.html#cfn-bedrockagentcore-gatewaytarget-schemadefinition-type}
      */
     Type: SchemaType;
@@ -219,6 +262,7 @@ export type SchemaDefinition = {
  */
 export type SchemaType = "string" | "number" | "object" | "array" | "boolean" | "integer";
 /**
+ * The target configuration.
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-targetconfiguration.html}
  */
 export type TargetConfiguration = {
@@ -229,6 +273,7 @@ export type TargetConfiguration = {
  */
 export type TargetStatus = "CREATING" | "UPDATING" | "UPDATE_UNSUCCESSFUL" | "DELETING" | "READY" | "FAILED";
 /**
+ * The tool definition for the gateway.
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-tooldefinition.html}
  */
 export type ToolDefinition = {
@@ -237,19 +282,23 @@ export type ToolDefinition = {
      */
     Description: string;
     /**
+     * The input schema for the gateway target.
      * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-tooldefinition.html#cfn-bedrockagentcore-gatewaytarget-tooldefinition-inputschema}
      */
     InputSchema: SchemaDefinition;
     /**
+     * The tool name.
      * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-tooldefinition.html#cfn-bedrockagentcore-gatewaytarget-tooldefinition-name}
      */
     Name: string;
     /**
+     * The tool definition output schema for the gateway target.
      * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-tooldefinition.html#cfn-bedrockagentcore-gatewaytarget-tooldefinition-outputschema}
      */
     OutputSchema?: SchemaDefinition | undefined;
 };
 /**
+ * The tool schema for the gateway target.
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-toolschema.html}
  */
 export type ToolSchema = {