Class CfnGatewayTargetMixinProps

Properties for CfnGatewayTargetPropsMixin.

Inheritance

object

CfnGatewayTargetMixinProps

Implements

ICfnGatewayTargetMixinProps

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Amazon.CDK.CfnPropertyMixins.AWS.BedrockAgentCore

Assembly: Amazon.CDK.CfnPropertyMixins.dll

Syntax (csharp)

public class CfnGatewayTargetMixinProps : ICfnGatewayTargetMixinProps

Syntax (vb)

Public Class CfnGatewayTargetMixinProps Implements ICfnGatewayTargetMixinProps

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-gatewaytarget.html

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.CfnPropertyMixins.AWS.BedrockAgentCore;

             SchemaDefinitionProperty schemaDefinitionProperty_;

             var cfnGatewayTargetMixinProps = new CfnGatewayTargetMixinProps {
                 CredentialProviderConfigurations = new [] { new CredentialProviderConfigurationProperty {
                     CredentialProvider = new CredentialProviderProperty {
                         ApiKeyCredentialProvider = new ApiKeyCredentialProviderProperty {
                             CredentialLocation = "credentialLocation",
                             CredentialParameterName = "credentialParameterName",
                             CredentialPrefix = "credentialPrefix",
                             ProviderArn = "providerArn"
                         },
                         OauthCredentialProvider = new OAuthCredentialProviderProperty {
                             CustomParameters = new Dictionary<string, string> {
                                 { "customParametersKey", "customParameters" }
                             },
                             DefaultReturnUrl = "defaultReturnUrl",
                             GrantType = "grantType",
                             ProviderArn = "providerArn",
                             Scopes = new [] { "scopes" }
                         }
                     },
                     CredentialProviderType = "credentialProviderType"
                 } },
                 Description = "description",
                 GatewayIdentifier = "gatewayIdentifier",
                 MetadataConfiguration = new MetadataConfigurationProperty {
                     AllowedQueryParameters = new [] { "allowedQueryParameters" },
                     AllowedRequestHeaders = new [] { "allowedRequestHeaders" },
                     AllowedResponseHeaders = new [] { "allowedResponseHeaders" }
                 },
                 Name = "name",
                 TargetConfiguration = new TargetConfigurationProperty {
                     Mcp = new McpTargetConfigurationProperty {
                         ApiGateway = new ApiGatewayTargetConfigurationProperty {
                             ApiGatewayToolConfiguration = new ApiGatewayToolConfigurationProperty {
                                 ToolFilters = new [] { new ApiGatewayToolFilterProperty {
                                     FilterPath = "filterPath",
                                     Methods = new [] { "methods" }
                                 } },
                                 ToolOverrides = new [] { new ApiGatewayToolOverrideProperty {
                                     Description = "description",
                                     Method = "method",
                                     Name = "name",
                                     Path = "path"
                                 } }
                             },
                             RestApiId = "restApiId",
                             Stage = "stage"
                         },
                         Lambda = new McpLambdaTargetConfigurationProperty {
                             LambdaArn = "lambdaArn",
                             ToolSchema = new ToolSchemaProperty {
                                 InlinePayload = new [] { new ToolDefinitionProperty {
                                     Description = "description",
                                     InputSchema = new SchemaDefinitionProperty {
                                         Description = "description",
                                         Items = schemaDefinitionProperty_,
                                         Properties = new Dictionary<string, object> {
                                             { "propertiesKey", schemaDefinitionProperty_ }
                                         },
                                         Required = new [] { "required" },
                                         Type = "type"
                                     },
                                     Name = "name",
                                     OutputSchema = new SchemaDefinitionProperty {
                                         Description = "description",
                                         Items = schemaDefinitionProperty_,
                                         Properties = new Dictionary<string, object> {
                                             { "propertiesKey", schemaDefinitionProperty_ }
                                         },
                                         Required = new [] { "required" },
                                         Type = "type"
                                     }
                                 } },
                                 S3 = new S3ConfigurationProperty {
                                     BucketOwnerAccountId = "bucketOwnerAccountId",
                                     Uri = "uri"
                                 }
                             }
                         },
                         McpServer = new McpServerTargetConfigurationProperty {
                             Endpoint = "endpoint"
                         },
                         OpenApiSchema = new ApiSchemaConfigurationProperty {
                             InlinePayload = "inlinePayload",
                             S3 = new S3ConfigurationProperty {
                                 BucketOwnerAccountId = "bucketOwnerAccountId",
                                 Uri = "uri"
                             }
                         },
                         SmithyModel = new ApiSchemaConfigurationProperty {
                             InlinePayload = "inlinePayload",
                             S3 = new S3ConfigurationProperty {
                                 BucketOwnerAccountId = "bucketOwnerAccountId",
                                 Uri = "uri"
                             }
                         }
                     }
                 }
             };

Synopsis

Constructors

CfnGatewayTargetMixinProps()

Properties for CfnGatewayTargetPropsMixin.

Properties

CredentialProviderConfigurations	The OAuth credential provider configuration.
Description	The description for the gateway target.
GatewayIdentifier	The gateway ID for the gateway target.
MetadataConfiguration	Properties for CfnGatewayTargetPropsMixin.
Name	The name for the gateway target.
TargetConfiguration	The target configuration for the Smithy model target.

Constructors

CfnGatewayTargetMixinProps()

Properties for CfnGatewayTargetPropsMixin.

public CfnGatewayTargetMixinProps()

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-gatewaytarget.html

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.CfnPropertyMixins.AWS.BedrockAgentCore;

             SchemaDefinitionProperty schemaDefinitionProperty_;

             var cfnGatewayTargetMixinProps = new CfnGatewayTargetMixinProps {
                 CredentialProviderConfigurations = new [] { new CredentialProviderConfigurationProperty {
                     CredentialProvider = new CredentialProviderProperty {
                         ApiKeyCredentialProvider = new ApiKeyCredentialProviderProperty {
                             CredentialLocation = "credentialLocation",
                             CredentialParameterName = "credentialParameterName",
                             CredentialPrefix = "credentialPrefix",
                             ProviderArn = "providerArn"
                         },
                         OauthCredentialProvider = new OAuthCredentialProviderProperty {
                             CustomParameters = new Dictionary<string, string> {
                                 { "customParametersKey", "customParameters" }
                             },
                             DefaultReturnUrl = "defaultReturnUrl",
                             GrantType = "grantType",
                             ProviderArn = "providerArn",
                             Scopes = new [] { "scopes" }
                         }
                     },
                     CredentialProviderType = "credentialProviderType"
                 } },
                 Description = "description",
                 GatewayIdentifier = "gatewayIdentifier",
                 MetadataConfiguration = new MetadataConfigurationProperty {
                     AllowedQueryParameters = new [] { "allowedQueryParameters" },
                     AllowedRequestHeaders = new [] { "allowedRequestHeaders" },
                     AllowedResponseHeaders = new [] { "allowedResponseHeaders" }
                 },
                 Name = "name",
                 TargetConfiguration = new TargetConfigurationProperty {
                     Mcp = new McpTargetConfigurationProperty {
                         ApiGateway = new ApiGatewayTargetConfigurationProperty {
                             ApiGatewayToolConfiguration = new ApiGatewayToolConfigurationProperty {
                                 ToolFilters = new [] { new ApiGatewayToolFilterProperty {
                                     FilterPath = "filterPath",
                                     Methods = new [] { "methods" }
                                 } },
                                 ToolOverrides = new [] { new ApiGatewayToolOverrideProperty {
                                     Description = "description",
                                     Method = "method",
                                     Name = "name",
                                     Path = "path"
                                 } }
                             },
                             RestApiId = "restApiId",
                             Stage = "stage"
                         },
                         Lambda = new McpLambdaTargetConfigurationProperty {
                             LambdaArn = "lambdaArn",
                             ToolSchema = new ToolSchemaProperty {
                                 InlinePayload = new [] { new ToolDefinitionProperty {
                                     Description = "description",
                                     InputSchema = new SchemaDefinitionProperty {
                                         Description = "description",
                                         Items = schemaDefinitionProperty_,
                                         Properties = new Dictionary<string, object> {
                                             { "propertiesKey", schemaDefinitionProperty_ }
                                         },
                                         Required = new [] { "required" },
                                         Type = "type"
                                     },
                                     Name = "name",
                                     OutputSchema = new SchemaDefinitionProperty {
                                         Description = "description",
                                         Items = schemaDefinitionProperty_,
                                         Properties = new Dictionary<string, object> {
                                             { "propertiesKey", schemaDefinitionProperty_ }
                                         },
                                         Required = new [] { "required" },
                                         Type = "type"
                                     }
                                 } },
                                 S3 = new S3ConfigurationProperty {
                                     BucketOwnerAccountId = "bucketOwnerAccountId",
                                     Uri = "uri"
                                 }
                             }
                         },
                         McpServer = new McpServerTargetConfigurationProperty {
                             Endpoint = "endpoint"
                         },
                         OpenApiSchema = new ApiSchemaConfigurationProperty {
                             InlinePayload = "inlinePayload",
                             S3 = new S3ConfigurationProperty {
                                 BucketOwnerAccountId = "bucketOwnerAccountId",
                                 Uri = "uri"
                             }
                         },
                         SmithyModel = new ApiSchemaConfigurationProperty {
                             InlinePayload = "inlinePayload",
                             S3 = new S3ConfigurationProperty {
                                 BucketOwnerAccountId = "bucketOwnerAccountId",
                                 Uri = "uri"
                             }
                         }
                     }
                 }
             };

Properties

CredentialProviderConfigurations

The OAuth credential provider configuration.

public object? CredentialProviderConfigurations { get; set; }

Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-gatewaytarget.html#cfn-bedrockagentcore-gatewaytarget-credentialproviderconfigurations

Type union: either IResolvable or (either IResolvable or CfnGatewayTargetPropsMixin.ICredentialProviderConfigurationProperty)[]

Description

The description for the gateway target.

public string? Description { get; set; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-gatewaytarget.html#cfn-bedrockagentcore-gatewaytarget-description

GatewayIdentifier

The gateway ID for the gateway target.

public string? GatewayIdentifier { get; set; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-gatewaytarget.html#cfn-bedrockagentcore-gatewaytarget-gatewayidentifier

MetadataConfiguration

Properties for CfnGatewayTargetPropsMixin.

public object? MetadataConfiguration { get; set; }

Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-gatewaytarget.html#cfn-bedrockagentcore-gatewaytarget-metadataconfiguration

Type union: either IResolvable or CfnGatewayTargetPropsMixin.IMetadataConfigurationProperty

Name

The name for the gateway target.

public string? Name { get; set; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-gatewaytarget.html#cfn-bedrockagentcore-gatewaytarget-name

TargetConfiguration

The target configuration for the Smithy model target.

public object? TargetConfiguration { get; set; }