Skip to content
v2.278.0

GatewayTargetCommonProps Struct ​

Common properties for all Gateway Target types.

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as bedrock_agentcore_alpha from '@aws-cdk/aws-bedrock-agentcore-alpha';
const gatewayTargetCommonProps: bedrock_agentcore_alpha.GatewayTargetCommonProps = {
  description: 'description',
  gatewayTargetName: 'gatewayTargetName',
};
python
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_bedrock_agentcore_alpha as bedrock_agentcore_alpha

gateway_target_common_props = bedrock_agentcore_alpha.GatewayTargetCommonProps(
    description="description",
    gateway_target_name="gatewayTargetName"
)
java
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.bedrock.agentcore.alpha.*;

GatewayTargetCommonProps gatewayTargetCommonProps = GatewayTargetCommonProps.builder()
        .description("description")
        .gatewayTargetName("gatewayTargetName")
        .build();
csharp
// Install: dotnet add package Amazon.CDK.AWS.Bedrock.Agentcore.Alpha
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.Bedrock.Agentcore.Alpha;

var gatewayTargetCommonProps = new GatewayTargetCommonProps {
    Description = "description",
    GatewayTargetName = "gatewayTargetName"
};
go
// Install: go get github.com/aws/aws-cdk-go/awsbedrockagentcorealpha/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import bedrock_agentcore_alpha "github.com/aws/aws-cdk-go/awsbedrockagentcorealpha"

gatewayTargetCommonProps := &GatewayTargetCommonProps{
	Description: jsii.String("description"),
	GatewayTargetName: jsii.String("gatewayTargetName"),
}

Properties ​

descriptionoptionalstringdescriptionoptionalstrdescriptionoptionalStringDescriptionoptionalstringDescriptionoptional*string #
Optional description for the gateway target The description can have up to 200 characters.

Default: No description

gatewayTargetNameoptionalstringgateway_target_nameoptionalstrgatewayTargetNameoptionalStringGatewayTargetNameoptionalstringGatewayTargetNameoptional*string #
The name of the gateway target The name must be unique within the gateway Pattern: ^([0-9a-zA-Z][-]?){1,100}$.

Default: auto generate