GatewayTargetBase

class aws_cdk.aws_bedrock_agentcore_alpha.GatewayTargetBase(scope, id, *, account=None, environment_from_arn=None, physical_name=None, region=None)

Bases: Resource

(experimental) Base class for gateway target implementations.

Provides common functionality for all gateway target types including permission management and property definitions.

Stability:

experimental

Parameters:

scope (Construct)
id (str)
account (Optional[str]) – The AWS account ID this resource belongs to. Default: - the resource is in the same account as the stack it belongs to
environment_from_arn (Optional[str]) – ARN to deduce region and account from. The ARN is parsed and the account and region are taken from the ARN. This should be used for imported resources. Cannot be supplied together with either account or region. Default: - take environment from account, region parameters, or use Stack environment.
physical_name (Optional[str]) – The value passed in by users to the physical name prop of the resource. - undefined implies that a physical name will be allocated by CloudFormation during deployment. - a concrete value implies a specific physical name - PhysicalName.GENERATE_IF_NEEDED is a marker that indicates that a physical will only be generated by the CDK if it is needed for cross-environment references. Otherwise, it will be allocated by CloudFormation. Default: - The physical name will be allocated by CloudFormation at deployment time
region (Optional[str]) – The AWS region this resource belongs to. Default: - the resource is in the same region as the stack it belongs to

Methods

apply_removal_policy(policy)

Apply the given removal policy to this resource.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you’ve removed it from the CDK application or because you’ve made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

Parameters:: policy (RemovalPolicy)
Return type:: None

grant(grantee, *actions)

(experimental) Grants IAM actions to the IAM Principal.

Parameters:

grantee (IGrantable) – The principal to grant permissions to.
actions (str) – The IAM actions to grant.

Stability:

experimental

Return type:

Grant

grant_manage(grantee)

(experimental) Grants Create, Update, and Delete actions on the Gateway Target.

Parameters:: grantee (IGrantable) – The principal to grant manage permissions to.
Stability:: experimental
Return type:: Grant

grant_read(grantee)

(experimental) Grants Get and List actions on the Gateway Target.

Parameters:: grantee (IGrantable) – The principal to grant read permissions to.
Stability:: experimental
Return type:: Grant

to_string()

Returns a string representation of this construct.

Return type:: str

Attributes

created_at

(experimental) Timestamp when the gateway target was created.

Stability:: experimental

credential_provider_configurations

(experimental) The credential provider configuration for the target.

Stability:: experimental

description

(experimental) The description of the gateway target.

Stability:: experimental

env

The environment this resource belongs to.

For resources that are created and managed in a Stack (those created by creating new class instances like new Role(), new Bucket(), etc.), this is always the same as the environment of the stack they belong to.

For referenced resources (those obtained from referencing methods like Role.fromRoleArn(), Bucket.fromBucketName(), etc.), they might be different than the stack they were imported into.

gateway

(experimental) The gateway that this target belongs to.

Stability:: experimental

name

(experimental) The name of the gateway target.

Stability:: experimental

node: The tree node.

stack: The stack in which this resource is defined.

status

(experimental) The status of the gateway target.

Stability:: experimental

status_reasons

(experimental) The status reasons for the gateway target.

Stability:: experimental

target_arn

(experimental) The ARN of the gateway target resource.

Stability:: experimental

target_id

(experimental) The id of the gateway target.

Stability:: experimental

target_protocol_type

(experimental) The target protocol.

Stability:: experimental

updated_at

(experimental) Timestamp when the gateway target was last updated.

Stability:: experimental

Static Methods

classmethod is_construct(x)

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

Parameters:: x (Any) – Any object.
Return type:: bool
Returns:: true if x is an object created from a class which extends Construct.

classmethod is_owned_resource(construct)

Returns true if the construct was created by CDK, and false otherwise.

Parameters:: construct (IConstruct)
Return type:: bool

classmethod is_resource(construct)

Check whether the given construct is a Resource.

Parameters:: construct (IConstruct)
Return type:: bool