InferenceProfileBase

class aws_cdk.aws_bedrock_alpha.InferenceProfileBase(scope, id, *, account=None, environment_from_arn=None, physical_name=None, region=None)

Bases: Resource

(experimental) Abstract base class for an Inference Profile.

Contains methods and attributes valid for Inference Profiles either created with CDK or imported.

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

abstractmethod grant_profile_usage(grantee)

(experimental) Grants appropriate permissions to use the inference profile.

Each profile type requires different permissions based on its usage pattern:

  • Application profiles need bedrock:InvokeModel for direct invocation

  • Cross-region profiles need bedrock:InvokeModel* for routing capabilities

Note: This does not grant permissions to use the underlying model in the profile. For comprehensive model invocation permissions, use the grantInvoke method instead.

Parameters:

grantee (IGrantable) –

  • The IAM principal to grant permissions to.

Return type:

Grant

Returns:

An IAM Grant object representing the granted permissions

Stability:

experimental

to_string()

Returns a string representation of this construct.

Return type:

str

Attributes

env

The environment this resource belongs to.

For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.

inference_profile_arn

(experimental) The ARN of the inference profile.

Stability:

experimental

Attribute:

true

inference_profile_id

(experimental) The unique identifier of the inference profile.

Stability:

experimental

Attribute:

true

node

The tree node.

stack

The stack in which this resource is defined.

type

(experimental) The type of inference profile (SYSTEM_DEFINED or APPLICATION).

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