CfnCapacityProvider

class aws_cdk.aws_bedrockagentcore.CfnCapacityProvider(scope, id, *, compute_configuration, name, permissions_configuration, description=None, tags=None)

Bases: CfnResource

Resource Type definition for AWS::BedrockAgentCore::CapacityProvider.

A capacity provider defines the compute resources (EC2) used to run Amazon Bedrock AgentCore agent runtimes.

See:

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

CloudformationResource:

AWS::BedrockAgentCore::CapacityProvider

ExampleMetadata:

fixture=_generated

Example:

from aws_cdk import CfnTag
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_bedrockagentcore as bedrockagentcore

cfn_capacity_provider = bedrockagentcore.CfnCapacityProvider(self, "MyCfnCapacityProvider",
    compute_configuration=bedrockagentcore.CfnCapacityProvider.ComputeConfigurationProperty(
        ec2_configuration=bedrockagentcore.CfnCapacityProvider.Ec2ConfigurationProperty(
            launch_template_source=bedrockagentcore.CfnCapacityProvider.LaunchTemplateSourceProperty(
                launch_parameters=bedrockagentcore.CfnCapacityProvider.LaunchParametersProperty(
                    instance_requirements=bedrockagentcore.CfnCapacityProvider.InstanceRequirementsProperty(
                        allowed_instance_types=["allowedInstanceTypes"]
                    ),
                    operating_system="operatingSystem",

                    # the properties below are optional
                    capacity_reservation_specification=bedrockagentcore.CfnCapacityProvider.CapacityReservationSpecificationProperty(
                        capacity_reservation_preference="capacityReservationPreference",
                        capacity_reservation_target=bedrockagentcore.CfnCapacityProvider.CapacityReservationTargetProperty(
                            capacity_reservation_id="capacityReservationId",
                            capacity_reservation_resource_group_arn="capacityReservationResourceGroupArn"
                        )
                    ),
                    ephemeral_volumes=[bedrockagentcore.CfnCapacityProvider.EphemeralBlockDeviceMappingProperty(
                        device_name="deviceName",
                        ebs=bedrockagentcore.CfnCapacityProvider.EphemeralEBSVolumeConfigurationProperty(
                            ebs_card_index=123,
                            encrypted=False,
                            iops=123,
                            kms_key_id="kmsKeyId",
                            snapshot_id="snapshotId",
                            throughput=123,
                            volume_initialization_rate=123,
                            volume_size=123,
                            volume_type="volumeType"
                        ),
                        virtual_name="virtualName"
                    )],
                    instance_profile_arn="instanceProfileArn",
                    license_specifications=[bedrockagentcore.CfnCapacityProvider.LicenseSpecificationProperty(
                        license_configuration_arn="licenseConfigurationArn"
                    )],
                    monitoring="monitoring",
                    propagated_tags={
                        "propagated_tags_key": "propagatedTags"
                    },
                    ssh_key_name="sshKeyName"
                )
            ),
            vpc_configuration=bedrockagentcore.CfnCapacityProvider.VpcConfigurationProperty(
                security_groups=["securityGroups"],
                subnets=["subnets"]
            ),

            # the properties below are optional
            lifecycle_configuration=bedrockagentcore.CfnCapacityProvider.InstanceLifecycleConfigurationProperty(
                idle_instance_timeout=123,
                max_lifetime=123
            ),
            root_volume=bedrockagentcore.CfnCapacityProvider.RootVolumeConfigurationProperty(
                encrypted=False,
                free_space_gi_b=123,
                iops=123,
                kms_key_id="kmsKeyId",
                throughput=123,
                volume_type="volumeType"
            ),
            volumes=[bedrockagentcore.CfnCapacityProvider.VolumeConfigurationProperty(
                ebs_configuration=bedrockagentcore.CfnCapacityProvider.EbsVolumeConfigurationProperty(
                    name="name",
                    size_gi_b=123,

                    # the properties below are optional
                    encrypted=False,
                    iops=123,
                    kms_key_id="kmsKeyId",
                    snapshot_id="snapshotId",
                    throughput=123,
                    volume_type="volumeType"
                )
            )]
        )
    ),
    name="name",
    permissions_configuration=bedrockagentcore.CfnCapacityProvider.PermissionsConfigurationProperty(
        capacity_provider_operator_role_arn="capacityProviderOperatorRoleArn"
    ),

    # the properties below are optional
    description="description",
    tags=[CfnTag(
        key="key",
        value="value"
    )]
)

Create a new AWS::BedrockAgentCore::CapacityProvider.

Parameters:

  • scope (Construct) – Scope in which this resource is defined.

  • id (str) – Construct identifier for this resource (unique in its scope).

  • compute_configuration (Union[IResolvable, ComputeConfigurationProperty, Dict[str, Any]]) – The capacity configuration for the capacity provider. Defines the compute resources for this capacity provider.

  • name (str) – The name of the capacity provider.

  • permissions_configuration (Union[IResolvable, PermissionsConfigurationProperty, Dict[str, Any]]) – Configuration for permissions associated with a capacity provider.

  • description (Optional[str]) – An optional description of the capacity provider.

  • tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – An array of key-value pairs to apply to the capacity provider.

Methods

add_deletion_override(path)

Syntactic sugar for addOverride(path, undefined).

Parameters:

path (str) – The path of the value to delete.

Return type:

None

add_dependency(target)

(deprecated) Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This method has been renamed to addResourceDependency to more clearly set it apart from construct.node.addDependency. See the documentation of that function for more details.

Parameters:

target (CfnResource)

Deprecated:

Use addResourceDependency instead.

Stability:

deprecated

Return type:

None

add_depends_on(target)

(deprecated) Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

This method has been renamed to addResourceDependency, which makes it more clear that this method operates at a different level from the construct-level construct.node.addDependency() mechanism.

Parameters:

target (CfnResource)

Deprecated:

Use addResourceDependency instead.

Stability:

deprecated

Return type:

None

add_metadata(key, value)

Add a value to the CloudFormation Resource Metadata.

Parameters:

  • key (str)

  • value (Any)

See:

Return type:

None

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

add_override(path, value)

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use addPropertyOverride or prefix path with “Properties.” (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example:

cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"])
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")

would add the overrides Example:

"Properties": {
  "GlobalSecondaryIndexes": [
    {
      "Projection": {
        "NonKeyAttributes": [ "myattribute" ]
        ...
      }
      ...
    },
    {
      "ProjectionType": "INCLUDE"
      ...
    },
  ]
  ...
}

The value argument to addOverride will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

Parameters:

  • path (str) –

    • The path of the property, you can use dot notation to override values in complex types. Any intermediate keys will be created as needed.

  • value (Any) –

    • The value. Could be primitive or complex.

Return type:

None

add_property_deletion_override(property_path)

Adds an override that deletes the value of a property from the resource definition.

Parameters:

property_path (str) – The path to the property.

Return type:

None

add_property_override(property_path, value)

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

Parameters:

  • property_path (str) – The path of the property.

  • value (Any) – The value.

Return type:

None

add_resource_dependency(target, reason=None)

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

This method only adds dependencies between L1 resources. If you are looking for a generic construct-to-construct dependency mechanism that works for all constructs including L2s, use construct.node.addDependency instead.

Parameters:
Return type:

None

apply_cross_stack_reference_strength(strength)

Sets the cross-stack reference strength for this resource.

When set, any cross-stack reference to this resource will use the specified strength instead of the global default from the consuming stack’s context.

Parameters:

strength (ReferenceStrength) –

  • The reference strength to use for this resource.

Return type:

None

apply_removal_policy(policy=None, *, apply_to_update_replace_policy=None, default=None)

Sets the deletion policy of the resource based on the removal policy specified.

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). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:

Parameters:

  • policy (Optional[RemovalPolicy])

  • apply_to_update_replace_policy (Optional[bool]) – Apply the same deletion policy to the resource’s “UpdateReplacePolicy”. Default: true

  • default (Optional[RemovalPolicy]) – The default policy to apply in case the removal policy is not defined. Default: - Default value is resource specific. To determine the default value for a resource, please consult that specific resource’s documentation.

See:

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options

Return type:

None

cfn_property_name(cdk_property_name)
Parameters:

cdk_property_name (str)

Return type:

Optional[str]

get_att(attribute_name, type_hint=None)

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

Parameters:

  • attribute_name (str) – The name of the attribute.

  • type_hint (Optional[ResolutionTypeHint])

Return type:

Reference

get_metadata(key)

Retrieve a value value from the CloudFormation Resource Metadata.

Parameters:

key (str)

See:

Return type:

Any

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

inspect(inspector)

Examines the CloudFormation resource and discloses attributes.

Parameters:

inspector (TreeInspector) – tree inspector to collect and process attributes.

Return type:

None

obtain_dependencies()

Retrieves an array of resources and stacks this resource depends on.

For resources depended on directly, returns the CfnResource object. For dependencies on other stacks, returns the Stack object. The order of the array is not guaranteed.

Return type:

List[Union[Stack, CfnResource]]

override_logical_id(new_logical_id)

Overrides the auto-generated logical ID with a specific ID.

Parameters:

new_logical_id (str) – The new logical ID to use for this stack element.

Return type:

None

remove_dependency(target)

(deprecated) Indicates that this resource no longer depends on another resource.

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.

Parameters:

target (CfnResource)

Deprecated:

Use removeResourceDependency instead

Stability:

deprecated

Return type:

None

remove_resource_dependency(target)

Indicates that this resource no longer depends on another resource.

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.

Parameters:

target (CfnResource)

Return type:

None

replace_dependency(target, new_target)

Replaces one dependency with another.

Parameters:
Return type:

None

to_string()

Returns a string representation of this construct.

Return type:

str

Returns:

a string representation of this resource

with_(*mixins)

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

Parameters:

mixins (IMixin)

Return type:

IConstruct

Attributes

CFN_RESOURCE_TYPE_NAME = 'AWS::BedrockAgentCore::CapacityProvider'
attr_arn

The ARN of the capacity provider.

CloudformationAttribute:

Arn

attr_capacity_provider_id

The unique identifier of the capacity provider.

CloudformationAttribute:

CapacityProviderId

attr_created_at

The timestamp when the capacity provider was created.

CloudformationAttribute:

CreatedAt

attr_last_updated_at

The timestamp when the capacity provider was last updated.

CloudformationAttribute:

LastUpdatedAt

attr_status

The current status of the capacity provider.

CloudformationAttribute:

Status

capacity_provider_ref

A reference to a CapacityProvider resource.

cdk_tag_manager

Tag Manager which manages the tags for this resource.

cfn_options

Options for this resource, such as condition, update policy etc.

cfn_resource_type

AWS resource type.

compute_configuration

The capacity configuration for the capacity provider.

creation_stack

return:

the stack trace of the point where this Resource was created from, sourced from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most node +internal+ entries filtered.

description

An optional description of the capacity provider.

env
logical_id

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

Returns:

the logical ID as a stringified token. This value will only get resolved during synthesis.

name

The name of the capacity provider.

node

The tree node.

permissions_configuration

Configuration for permissions associated with a capacity provider.

ref

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

tags

An array of key-value pairs to apply to the capacity provider.

Static Methods

classmethod arn_for_capacity_provider(resource)
Parameters:

resource (ICapacityProviderRef)

Return type:

str

classmethod is_cfn_capacity_provider(x)

Checks whether the given object is a CfnCapacityProvider.

Parameters:

x (Any)

Return type:

bool

classmethod is_cfn_element(x)

Returns true if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of instanceof to allow stack elements from different versions of this library to be included in the same stack.

Parameters:

x (Any)

Return type:

bool

Returns:

The construct as a stack element or undefined if it is not a stack element.

classmethod is_cfn_resource(x)

Check whether the given object is a CfnResource.

Parameters:

x (Any)

Return type:

bool

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.

CapacityReservationSpecificationProperty

class CfnCapacityProvider.CapacityReservationSpecificationProperty(*, capacity_reservation_preference=None, capacity_reservation_target=None)

Bases: object

The Capacity Reservation targeting option.

Parameters:

  • capacity_reservation_preference (Optional[str]) – Indicates the instance’s Capacity Reservation preferences.

  • capacity_reservation_target (Union[IResolvable, CapacityReservationTargetProperty, Dict[str, Any], None]) – Information about the target Capacity Reservation or Capacity Reservation group.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-capacityprovider-capacityreservationspecification.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_bedrockagentcore as bedrockagentcore

capacity_reservation_specification_property = bedrockagentcore.CfnCapacityProvider.CapacityReservationSpecificationProperty(
    capacity_reservation_preference="capacityReservationPreference",
    capacity_reservation_target=bedrockagentcore.CfnCapacityProvider.CapacityReservationTargetProperty(
        capacity_reservation_id="capacityReservationId",
        capacity_reservation_resource_group_arn="capacityReservationResourceGroupArn"
    )
)

Attributes

capacity_reservation_preference

Indicates the instance’s Capacity Reservation preferences.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-capacityprovider-capacityreservationspecification.html#cfn-bedrockagentcore-capacityprovider-capacityreservationspecification-capacityreservationpreference

capacity_reservation_target

Information about the target Capacity Reservation or Capacity Reservation group.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-capacityprovider-capacityreservationspecification.html#cfn-bedrockagentcore-capacityprovider-capacityreservationspecification-capacityreservationtarget

CapacityReservationTargetProperty

class CfnCapacityProvider.CapacityReservationTargetProperty(*, capacity_reservation_id=None, capacity_reservation_resource_group_arn=None)

Bases: object

Information about the target Capacity Reservation or Capacity Reservation group.

Parameters:

  • capacity_reservation_id (Optional[str]) – The ID of the Capacity Reservation in which to run the instance.

  • capacity_reservation_resource_group_arn (Optional[str]) – The ARN of the Capacity Reservation resource group in which to run the instance.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-capacityprovider-capacityreservationtarget.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_bedrockagentcore as bedrockagentcore

capacity_reservation_target_property = bedrockagentcore.CfnCapacityProvider.CapacityReservationTargetProperty(
    capacity_reservation_id="capacityReservationId",
    capacity_reservation_resource_group_arn="capacityReservationResourceGroupArn"
)

Attributes

capacity_reservation_id

The ID of the Capacity Reservation in which to run the instance.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-capacityprovider-capacityreservationtarget.html#cfn-bedrockagentcore-capacityprovider-capacityreservationtarget-capacityreservationid

capacity_reservation_resource_group_arn

The ARN of the Capacity Reservation resource group in which to run the instance.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-capacityprovider-capacityreservationtarget.html#cfn-bedrockagentcore-capacityprovider-capacityreservationtarget-capacityreservationresourcegrouparn

ComputeConfigurationProperty

class CfnCapacityProvider.ComputeConfigurationProperty(*, ec2_configuration)

Bases: object

The capacity configuration for the capacity provider.

Defines the compute resources for this capacity provider.

Parameters:

ec2_configuration (Union[IResolvable, Ec2ConfigurationProperty, Dict[str, Any]]) – Configuration for EC2-based capacity.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-capacityprovider-computeconfiguration.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_bedrockagentcore as bedrockagentcore

compute_configuration_property = bedrockagentcore.CfnCapacityProvider.ComputeConfigurationProperty(
    ec2_configuration=bedrockagentcore.CfnCapacityProvider.Ec2ConfigurationProperty(
        launch_template_source=bedrockagentcore.CfnCapacityProvider.LaunchTemplateSourceProperty(
            launch_parameters=bedrockagentcore.CfnCapacityProvider.LaunchParametersProperty(
                instance_requirements=bedrockagentcore.CfnCapacityProvider.InstanceRequirementsProperty(
                    allowed_instance_types=["allowedInstanceTypes"]
                ),
                operating_system="operatingSystem",

                # the properties below are optional
                capacity_reservation_specification=bedrockagentcore.CfnCapacityProvider.CapacityReservationSpecificationProperty(
                    capacity_reservation_preference="capacityReservationPreference",
                    capacity_reservation_target=bedrockagentcore.CfnCapacityProvider.CapacityReservationTargetProperty(
                        capacity_reservation_id="capacityReservationId",
                        capacity_reservation_resource_group_arn="capacityReservationResourceGroupArn"
                    )
                ),
                ephemeral_volumes=[bedrockagentcore.CfnCapacityProvider.EphemeralBlockDeviceMappingProperty(
                    device_name="deviceName",
                    ebs=bedrockagentcore.CfnCapacityProvider.EphemeralEBSVolumeConfigurationProperty(
                        ebs_card_index=123,
                        encrypted=False,
                        iops=123,
                        kms_key_id="kmsKeyId",
                        snapshot_id="snapshotId",
                        throughput=123,
                        volume_initialization_rate=123,
                        volume_size=123,
                        volume_type="volumeType"
                    ),
                    virtual_name="virtualName"
                )],
                instance_profile_arn="instanceProfileArn",
                license_specifications=[bedrockagentcore.CfnCapacityProvider.LicenseSpecificationProperty(
                    license_configuration_arn="licenseConfigurationArn"
                )],
                monitoring="monitoring",
                propagated_tags={
                    "propagated_tags_key": "propagatedTags"
                },
                ssh_key_name="sshKeyName"
            )
        ),
        vpc_configuration=bedrockagentcore.CfnCapacityProvider.VpcConfigurationProperty(
            security_groups=["securityGroups"],
            subnets=["subnets"]
        ),

        # the properties below are optional
        lifecycle_configuration=bedrockagentcore.CfnCapacityProvider.InstanceLifecycleConfigurationProperty(
            idle_instance_timeout=123,
            max_lifetime=123
        ),
        root_volume=bedrockagentcore.CfnCapacityProvider.RootVolumeConfigurationProperty(
            encrypted=False,
            free_space_gi_b=123,
            iops=123,
            kms_key_id="kmsKeyId",
            throughput=123,
            volume_type="volumeType"
        ),
        volumes=[bedrockagentcore.CfnCapacityProvider.VolumeConfigurationProperty(
            ebs_configuration=bedrockagentcore.CfnCapacityProvider.EbsVolumeConfigurationProperty(
                name="name",
                size_gi_b=123,

                # the properties below are optional
                encrypted=False,
                iops=123,
                kms_key_id="kmsKeyId",
                snapshot_id="snapshotId",
                throughput=123,
                volume_type="volumeType"
            )
        )]
    )
)

Attributes

ec2_configuration

Configuration for EC2-based capacity.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-capacityprovider-computeconfiguration.html#cfn-bedrockagentcore-capacityprovider-computeconfiguration-ec2configuration

EbsVolumeConfigurationProperty

class CfnCapacityProvider.EbsVolumeConfigurationProperty(*, name, size_gib, encrypted=None, iops=None, kms_key_id=None, snapshot_id=None, throughput=None, volume_type=None)

Bases: object

Configuration for an EBS-backed persistent volume.

Parameters:

  • name (str) – The logical name of the volume, used to reference it when mounting.

  • size_gib (Union[int, float]) – The size of the volume in GiB.

  • encrypted (Union[bool, IResolvable, None]) – Whether to encrypt the volume. Defaults to true.

  • iops (Union[int, float, None]) – The number of IOPS to provision. Only valid for gp3, io1, and io2 volumes.

  • kms_key_id (Optional[str]) – Identifier of the KMS key to use for encryption.

  • snapshot_id (Optional[str]) – Optional EBS snapshot ID to initialize the volume from.

  • throughput (Union[int, float, None]) – The throughput in MiB/s. Only valid for gp3 volumes.

  • volume_type (Optional[str]) – The EBS volume type. Defaults to gp3 if not specified.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-capacityprovider-ebsvolumeconfiguration.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_bedrockagentcore as bedrockagentcore

ebs_volume_configuration_property = bedrockagentcore.CfnCapacityProvider.EbsVolumeConfigurationProperty(
    name="name",
    size_gi_b=123,

    # the properties below are optional
    encrypted=False,
    iops=123,
    kms_key_id="kmsKeyId",
    snapshot_id="snapshotId",
    throughput=123,
    volume_type="volumeType"
)

Attributes

encrypted

Whether to encrypt the volume.

Defaults to true.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-capacityprovider-ebsvolumeconfiguration.html#cfn-bedrockagentcore-capacityprovider-ebsvolumeconfiguration-encrypted

iops

The number of IOPS to provision.

Only valid for gp3, io1, and io2 volumes.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-capacityprovider-ebsvolumeconfiguration.html#cfn-bedrockagentcore-capacityprovider-ebsvolumeconfiguration-iops

kms_key_id

Identifier of the KMS key to use for encryption.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-capacityprovider-ebsvolumeconfiguration.html#cfn-bedrockagentcore-capacityprovider-ebsvolumeconfiguration-kmskeyid

name

The logical name of the volume, used to reference it when mounting.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-capacityprovider-ebsvolumeconfiguration.html#cfn-bedrockagentcore-capacityprovider-ebsvolumeconfiguration-name

size_gib

The size of the volume in GiB.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-capacityprovider-ebsvolumeconfiguration.html#cfn-bedrockagentcore-capacityprovider-ebsvolumeconfiguration-sizegib

snapshot_id

Optional EBS snapshot ID to initialize the volume from.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-capacityprovider-ebsvolumeconfiguration.html#cfn-bedrockagentcore-capacityprovider-ebsvolumeconfiguration-snapshotid

throughput

The throughput in MiB/s.

Only valid for gp3 volumes.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-capacityprovider-ebsvolumeconfiguration.html#cfn-bedrockagentcore-capacityprovider-ebsvolumeconfiguration-throughput

volume_type

The EBS volume type.

Defaults to gp3 if not specified.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-capacityprovider-ebsvolumeconfiguration.html#cfn-bedrockagentcore-capacityprovider-ebsvolumeconfiguration-volumetype

Ec2ConfigurationProperty

class CfnCapacityProvider.Ec2ConfigurationProperty(*, launch_template_source, vpc_configuration, lifecycle_configuration=None, root_volume=None, volumes=None)

Bases: object

Configuration for EC2-based capacity.

Parameters:

  • launch_template_source (Union[IResolvable, LaunchTemplateSourceProperty, Dict[str, Any]]) – How the launch template is specified.

  • vpc_configuration (Union[IResolvable, VpcConfigurationProperty, Dict[str, Any]]) – VPC configuration for launching EC2 instances.

  • lifecycle_configuration (Union[IResolvable, InstanceLifecycleConfigurationProperty, Dict[str, Any], None]) – Configuration for managing the lifecycle of instances in a capacity provider.

  • root_volume (Union[IResolvable, RootVolumeConfigurationProperty, Dict[str, Any], None]) – Customer-facing configuration for the (service-managed) root volume. The service provisions the root volume at its own AMI size estimate plus FreeSpaceGiB, and pins the visible free space to FreeSpaceGiB with a filler file, so the space you are guaranteed does not change as the underlying AMI grows. The device name and the delete-on-termination behavior are service-owned and are not configurable.

  • volumes (Union[IResolvable, Sequence[Union[IResolvable, VolumeConfigurationProperty, Dict[str, Any]]], None]) – Named persistent EBS volumes for this capacity provider.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-capacityprovider-ec2configuration.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_bedrockagentcore as bedrockagentcore

ec2_configuration_property = bedrockagentcore.CfnCapacityProvider.Ec2ConfigurationProperty(
    launch_template_source=bedrockagentcore.CfnCapacityProvider.LaunchTemplateSourceProperty(
        launch_parameters=bedrockagentcore.CfnCapacityProvider.LaunchParametersProperty(
            instance_requirements=bedrockagentcore.CfnCapacityProvider.InstanceRequirementsProperty(
                allowed_instance_types=["allowedInstanceTypes"]
            ),
            operating_system="operatingSystem",

            # the properties below are optional
            capacity_reservation_specification=bedrockagentcore.CfnCapacityProvider.CapacityReservationSpecificationProperty(
                capacity_reservation_preference="capacityReservationPreference",
                capacity_reservation_target=bedrockagentcore.CfnCapacityProvider.CapacityReservationTargetProperty(
                    capacity_reservation_id="capacityReservationId",
                    capacity_reservation_resource_group_arn="capacityReservationResourceGroupArn"
                )
            ),
            ephemeral_volumes=[bedrockagentcore.CfnCapacityProvider.EphemeralBlockDeviceMappingProperty(
                device_name="deviceName",
                ebs=bedrockagentcore.CfnCapacityProvider.EphemeralEBSVolumeConfigurationProperty(
                    ebs_card_index=123,
                    encrypted=False,
                    iops=123,
                    kms_key_id="kmsKeyId",
                    snapshot_id="snapshotId",
                    throughput=123,
                    volume_initialization_rate=123,
                    volume_size=123,
                    volume_type="volumeType"
                ),
                virtual_name="virtualName"
            )],
            instance_profile_arn="instanceProfileArn",
            license_specifications=[bedrockagentcore.CfnCapacityProvider.LicenseSpecificationProperty(
                license_configuration_arn="licenseConfigurationArn"
            )],
            monitoring="monitoring",
            propagated_tags={
                "propagated_tags_key": "propagatedTags"
            },
            ssh_key_name="sshKeyName"
        )
    ),
    vpc_configuration=bedrockagentcore.CfnCapacityProvider.VpcConfigurationProperty(
        security_groups=["securityGroups"],
        subnets=["subnets"]
    ),

    # the properties below are optional
    lifecycle_configuration=bedrockagentcore.CfnCapacityProvider.InstanceLifecycleConfigurationProperty(
        idle_instance_timeout=123,
        max_lifetime=123
    ),
    root_volume=bedrockagentcore.CfnCapacityProvider.RootVolumeConfigurationProperty(
        encrypted=False,
        free_space_gi_b=123,
        iops=123,
        kms_key_id="kmsKeyId",
        throughput=123,
        volume_type="volumeType"
    ),
    volumes=[bedrockagentcore.CfnCapacityProvider.VolumeConfigurationProperty(
        ebs_configuration=bedrockagentcore.CfnCapacityProvider.EbsVolumeConfigurationProperty(
            name="name",
            size_gi_b=123,

            # the properties below are optional
            encrypted=False,
            iops=123,
            kms_key_id="kmsKeyId",
            snapshot_id="snapshotId",
            throughput=123,
            volume_type="volumeType"
        )
    )]
)

Attributes

launch_template_source

How the launch template is specified.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-capacityprovider-ec2configuration.html#cfn-bedrockagentcore-capacityprovider-ec2configuration-launchtemplatesource

lifecycle_configuration

Configuration for managing the lifecycle of instances in a capacity provider.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-capacityprovider-ec2configuration.html#cfn-bedrockagentcore-capacityprovider-ec2configuration-lifecycleconfiguration

root_volume

Customer-facing configuration for the (service-managed) root volume.

The service provisions the root volume at its own AMI size estimate plus FreeSpaceGiB, and pins the visible free space to FreeSpaceGiB with a filler file, so the space you are guaranteed does not change as the underlying AMI grows. The device name and the delete-on-termination behavior are service-owned and are not configurable.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-capacityprovider-ec2configuration.html#cfn-bedrockagentcore-capacityprovider-ec2configuration-rootvolume

volumes

Named persistent EBS volumes for this capacity provider.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-capacityprovider-ec2configuration.html#cfn-bedrockagentcore-capacityprovider-ec2configuration-volumes

vpc_configuration

VPC configuration for launching EC2 instances.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-capacityprovider-ec2configuration.html#cfn-bedrockagentcore-capacityprovider-ec2configuration-vpcconfiguration

EphemeralBlockDeviceMappingProperty

class CfnCapacityProvider.EphemeralBlockDeviceMappingProperty(*, device_name=None, ebs=None, virtual_name=None)

Bases: object

Describes an ephemeral block device mapping.

Parameters:

  • device_name (Optional[str]) – The device name (for example, /dev/sdh or xvdh).

  • ebs (Union[IResolvable, EphemeralEBSVolumeConfigurationProperty, Dict[str, Any], None]) – Parameters used to automatically set up EBS volumes when the instance is launched.

  • virtual_name (Optional[str]) – The virtual device name (ephemeralN).

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-capacityprovider-ephemeralblockdevicemapping.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_bedrockagentcore as bedrockagentcore

ephemeral_block_device_mapping_property = bedrockagentcore.CfnCapacityProvider.EphemeralBlockDeviceMappingProperty(
    device_name="deviceName",
    ebs=bedrockagentcore.CfnCapacityProvider.EphemeralEBSVolumeConfigurationProperty(
        ebs_card_index=123,
        encrypted=False,
        iops=123,
        kms_key_id="kmsKeyId",
        snapshot_id="snapshotId",
        throughput=123,
        volume_initialization_rate=123,
        volume_size=123,
        volume_type="volumeType"
    ),
    virtual_name="virtualName"
)

Attributes

device_name

The device name (for example, /dev/sdh or xvdh).

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-capacityprovider-ephemeralblockdevicemapping.html#cfn-bedrockagentcore-capacityprovider-ephemeralblockdevicemapping-devicename

ebs

Parameters used to automatically set up EBS volumes when the instance is launched.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-capacityprovider-ephemeralblockdevicemapping.html#cfn-bedrockagentcore-capacityprovider-ephemeralblockdevicemapping-ebs

virtual_name

The virtual device name (ephemeralN).

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-capacityprovider-ephemeralblockdevicemapping.html#cfn-bedrockagentcore-capacityprovider-ephemeralblockdevicemapping-virtualname

EphemeralEBSVolumeConfigurationProperty

class CfnCapacityProvider.EphemeralEBSVolumeConfigurationProperty(*, ebs_card_index=None, encrypted=None, iops=None, kms_key_id=None, snapshot_id=None, throughput=None, volume_initialization_rate=None, volume_size=None, volume_type=None)

Bases: object

Parameters used to automatically set up EBS volumes when the instance is launched.

Parameters:

  • ebs_card_index (Union[int, float, None]) – The index of the EBS card. Applies to instances with multiple EBS cards.

  • encrypted (Union[bool, IResolvable, None]) – Indicates whether the EBS volume is encrypted.

  • iops (Union[int, float, None]) – The number of I/O operations per second (IOPS).

  • kms_key_id (Optional[str]) – Identifier of the customer managed KMS key to use for EBS encryption.

  • snapshot_id (Optional[str]) – The ID of the snapshot.

  • throughput (Union[int, float, None]) – The throughput to provision for a gp3 volume, in MiB/s.

  • volume_initialization_rate (Union[int, float, None]) – The rate at which the volume is initialized after creation, in MiB/s. Supported only for volumes created from snapshots. If the snapshot is enabled for fast snapshot restore and a volume initialization rate is also specified, the volume is initialized at the specified rate instead of by fast snapshot restore. Valid range: 100-300 MiB/s.

  • volume_size (Union[int, float, None]) – The size of the volume, in GiBs.

  • volume_type (Optional[str]) – The volume type. Defaults to gp3 if not specified.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-capacityprovider-ephemeralebsvolumeconfiguration.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_bedrockagentcore as bedrockagentcore

ephemeral_ebs_volume_configuration_property = bedrockagentcore.CfnCapacityProvider.EphemeralEBSVolumeConfigurationProperty(
    ebs_card_index=123,
    encrypted=False,
    iops=123,
    kms_key_id="kmsKeyId",
    snapshot_id="snapshotId",
    throughput=123,
    volume_initialization_rate=123,
    volume_size=123,
    volume_type="volumeType"
)

Attributes

ebs_card_index

The index of the EBS card.

Applies to instances with multiple EBS cards.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-capacityprovider-ephemeralebsvolumeconfiguration.html#cfn-bedrockagentcore-capacityprovider-ephemeralebsvolumeconfiguration-ebscardindex

encrypted

Indicates whether the EBS volume is encrypted.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-capacityprovider-ephemeralebsvolumeconfiguration.html#cfn-bedrockagentcore-capacityprovider-ephemeralebsvolumeconfiguration-encrypted

iops

The number of I/O operations per second (IOPS).

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-capacityprovider-ephemeralebsvolumeconfiguration.html#cfn-bedrockagentcore-capacityprovider-ephemeralebsvolumeconfiguration-iops

kms_key_id

Identifier of the customer managed KMS key to use for EBS encryption.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-capacityprovider-ephemeralebsvolumeconfiguration.html#cfn-bedrockagentcore-capacityprovider-ephemeralebsvolumeconfiguration-kmskeyid

snapshot_id

The ID of the snapshot.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-capacityprovider-ephemeralebsvolumeconfiguration.html#cfn-bedrockagentcore-capacityprovider-ephemeralebsvolumeconfiguration-snapshotid

throughput

The throughput to provision for a gp3 volume, in MiB/s.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-capacityprovider-ephemeralebsvolumeconfiguration.html#cfn-bedrockagentcore-capacityprovider-ephemeralebsvolumeconfiguration-throughput

volume_initialization_rate

The rate at which the volume is initialized after creation, in MiB/s.

Supported only for volumes created from snapshots. If the snapshot is enabled for fast snapshot restore and a volume initialization rate is also specified, the volume is initialized at the specified rate instead of by fast snapshot restore. Valid range: 100-300 MiB/s.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-capacityprovider-ephemeralebsvolumeconfiguration.html#cfn-bedrockagentcore-capacityprovider-ephemeralebsvolumeconfiguration-volumeinitializationrate

volume_size

The size of the volume, in GiBs.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-capacityprovider-ephemeralebsvolumeconfiguration.html#cfn-bedrockagentcore-capacityprovider-ephemeralebsvolumeconfiguration-volumesize

volume_type

The volume type.

Defaults to gp3 if not specified.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-capacityprovider-ephemeralebsvolumeconfiguration.html#cfn-bedrockagentcore-capacityprovider-ephemeralebsvolumeconfiguration-volumetype

InstanceLifecycleConfigurationProperty

class CfnCapacityProvider.InstanceLifecycleConfigurationProperty(*, idle_instance_timeout=None, max_lifetime=None)

Bases: object

Configuration for managing the lifecycle of instances in a capacity provider.

Parameters:

  • idle_instance_timeout (Union[int, float, None]) – The number of seconds an instance can remain idle before it is stopped.

  • max_lifetime (Union[int, float, None]) – Maximum lifetime for the instance in seconds. Once reached, instances will be automatically terminated regardless of activity. Default: 28800 seconds (8 hours). Maximum: 1209600 seconds (14 days).

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-capacityprovider-instancelifecycleconfiguration.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_bedrockagentcore as bedrockagentcore

instance_lifecycle_configuration_property = bedrockagentcore.CfnCapacityProvider.InstanceLifecycleConfigurationProperty(
    idle_instance_timeout=123,
    max_lifetime=123
)

Attributes

idle_instance_timeout

The number of seconds an instance can remain idle before it is stopped.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-capacityprovider-instancelifecycleconfiguration.html#cfn-bedrockagentcore-capacityprovider-instancelifecycleconfiguration-idleinstancetimeout

max_lifetime

Maximum lifetime for the instance in seconds.

Once reached, instances will be automatically terminated regardless of activity. Default: 28800 seconds (8 hours). Maximum: 1209600 seconds (14 days).

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-capacityprovider-instancelifecycleconfiguration.html#cfn-bedrockagentcore-capacityprovider-instancelifecycleconfiguration-maxlifetime

InstanceRequirementsProperty

class CfnCapacityProvider.InstanceRequirementsProperty(*, allowed_instance_types)

Bases: object

Requirements for EC2 instance types.

Parameters:

allowed_instance_types (Sequence[str]) – List of allowed instance types.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-capacityprovider-instancerequirements.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_bedrockagentcore as bedrockagentcore

instance_requirements_property = bedrockagentcore.CfnCapacityProvider.InstanceRequirementsProperty(
    allowed_instance_types=["allowedInstanceTypes"]
)

Attributes

allowed_instance_types

List of allowed instance types.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-capacityprovider-instancerequirements.html#cfn-bedrockagentcore-capacityprovider-instancerequirements-allowedinstancetypes

LaunchParametersProperty

class CfnCapacityProvider.LaunchParametersProperty(*, instance_requirements, operating_system, capacity_reservation_specification=None, ephemeral_volumes=None, instance_profile_arn=None, license_specifications=None, monitoring=None, propagated_tags=None, ssh_key_name=None)

Bases: object

Parameters for launching EC2 instances.

Parameters:

  • instance_requirements (Union[IResolvable, InstanceRequirementsProperty, Dict[str, Any]]) – Requirements for EC2 instance types.

  • operating_system (str) – The operating system and CPU architecture for the instances.

  • capacity_reservation_specification (Union[IResolvable, CapacityReservationSpecificationProperty, Dict[str, Any], None]) – The Capacity Reservation targeting option.

  • ephemeral_volumes (Union[IResolvable, Sequence[Union[IResolvable, EphemeralBlockDeviceMappingProperty, Dict[str, Any]]], None]) – The block device mapping for ephemeral (instance store) volumes.

  • instance_profile_arn (Optional[str]) – The ARN of the IAM instance profile to associate with launched instances.

  • license_specifications (Union[IResolvable, Sequence[Union[IResolvable, LicenseSpecificationProperty, Dict[str, Any]]], None]) – The license configurations.

  • monitoring (Optional[str]) – The monitoring level for the instance.

  • propagated_tags (Union[IResolvable, Mapping[str, str], None]) – Tags to apply to all EC2 resources (instances, volumes, and network interfaces) created by this capacity provider.

  • ssh_key_name (Optional[str]) – The name of the SSH key pair to configure on instances for SSH connectivity.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-capacityprovider-launchparameters.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_bedrockagentcore as bedrockagentcore

launch_parameters_property = bedrockagentcore.CfnCapacityProvider.LaunchParametersProperty(
    instance_requirements=bedrockagentcore.CfnCapacityProvider.InstanceRequirementsProperty(
        allowed_instance_types=["allowedInstanceTypes"]
    ),
    operating_system="operatingSystem",

    # the properties below are optional
    capacity_reservation_specification=bedrockagentcore.CfnCapacityProvider.CapacityReservationSpecificationProperty(
        capacity_reservation_preference="capacityReservationPreference",
        capacity_reservation_target=bedrockagentcore.CfnCapacityProvider.CapacityReservationTargetProperty(
            capacity_reservation_id="capacityReservationId",
            capacity_reservation_resource_group_arn="capacityReservationResourceGroupArn"
        )
    ),
    ephemeral_volumes=[bedrockagentcore.CfnCapacityProvider.EphemeralBlockDeviceMappingProperty(
        device_name="deviceName",
        ebs=bedrockagentcore.CfnCapacityProvider.EphemeralEBSVolumeConfigurationProperty(
            ebs_card_index=123,
            encrypted=False,
            iops=123,
            kms_key_id="kmsKeyId",
            snapshot_id="snapshotId",
            throughput=123,
            volume_initialization_rate=123,
            volume_size=123,
            volume_type="volumeType"
        ),
        virtual_name="virtualName"
    )],
    instance_profile_arn="instanceProfileArn",
    license_specifications=[bedrockagentcore.CfnCapacityProvider.LicenseSpecificationProperty(
        license_configuration_arn="licenseConfigurationArn"
    )],
    monitoring="monitoring",
    propagated_tags={
        "propagated_tags_key": "propagatedTags"
    },
    ssh_key_name="sshKeyName"
)

Attributes

capacity_reservation_specification

The Capacity Reservation targeting option.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-capacityprovider-launchparameters.html#cfn-bedrockagentcore-capacityprovider-launchparameters-capacityreservationspecification

ephemeral_volumes

The block device mapping for ephemeral (instance store) volumes.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-capacityprovider-launchparameters.html#cfn-bedrockagentcore-capacityprovider-launchparameters-ephemeralvolumes

instance_profile_arn

The ARN of the IAM instance profile to associate with launched instances.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-capacityprovider-launchparameters.html#cfn-bedrockagentcore-capacityprovider-launchparameters-instanceprofilearn

instance_requirements

Requirements for EC2 instance types.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-capacityprovider-launchparameters.html#cfn-bedrockagentcore-capacityprovider-launchparameters-instancerequirements

license_specifications

The license configurations.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-capacityprovider-launchparameters.html#cfn-bedrockagentcore-capacityprovider-launchparameters-licensespecifications

monitoring

The monitoring level for the instance.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-capacityprovider-launchparameters.html#cfn-bedrockagentcore-capacityprovider-launchparameters-monitoring

operating_system

The operating system and CPU architecture for the instances.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-capacityprovider-launchparameters.html#cfn-bedrockagentcore-capacityprovider-launchparameters-operatingsystem

propagated_tags

Tags to apply to all EC2 resources (instances, volumes, and network interfaces) created by this capacity provider.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-capacityprovider-launchparameters.html#cfn-bedrockagentcore-capacityprovider-launchparameters-propagatedtags

ssh_key_name

The name of the SSH key pair to configure on instances for SSH connectivity.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-capacityprovider-launchparameters.html#cfn-bedrockagentcore-capacityprovider-launchparameters-sshkeyname

LaunchTemplateSourceProperty

class CfnCapacityProvider.LaunchTemplateSourceProperty(*, launch_parameters)

Bases: object

How the launch template is specified.

Parameters:

launch_parameters (Union[IResolvable, LaunchParametersProperty, Dict[str, Any]]) – Parameters for launching EC2 instances.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-capacityprovider-launchtemplatesource.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_bedrockagentcore as bedrockagentcore

launch_template_source_property = bedrockagentcore.CfnCapacityProvider.LaunchTemplateSourceProperty(
    launch_parameters=bedrockagentcore.CfnCapacityProvider.LaunchParametersProperty(
        instance_requirements=bedrockagentcore.CfnCapacityProvider.InstanceRequirementsProperty(
            allowed_instance_types=["allowedInstanceTypes"]
        ),
        operating_system="operatingSystem",

        # the properties below are optional
        capacity_reservation_specification=bedrockagentcore.CfnCapacityProvider.CapacityReservationSpecificationProperty(
            capacity_reservation_preference="capacityReservationPreference",
            capacity_reservation_target=bedrockagentcore.CfnCapacityProvider.CapacityReservationTargetProperty(
                capacity_reservation_id="capacityReservationId",
                capacity_reservation_resource_group_arn="capacityReservationResourceGroupArn"
            )
        ),
        ephemeral_volumes=[bedrockagentcore.CfnCapacityProvider.EphemeralBlockDeviceMappingProperty(
            device_name="deviceName",
            ebs=bedrockagentcore.CfnCapacityProvider.EphemeralEBSVolumeConfigurationProperty(
                ebs_card_index=123,
                encrypted=False,
                iops=123,
                kms_key_id="kmsKeyId",
                snapshot_id="snapshotId",
                throughput=123,
                volume_initialization_rate=123,
                volume_size=123,
                volume_type="volumeType"
            ),
            virtual_name="virtualName"
        )],
        instance_profile_arn="instanceProfileArn",
        license_specifications=[bedrockagentcore.CfnCapacityProvider.LicenseSpecificationProperty(
            license_configuration_arn="licenseConfigurationArn"
        )],
        monitoring="monitoring",
        propagated_tags={
            "propagated_tags_key": "propagatedTags"
        },
        ssh_key_name="sshKeyName"
    )
)

Attributes

launch_parameters

Parameters for launching EC2 instances.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-capacityprovider-launchtemplatesource.html#cfn-bedrockagentcore-capacityprovider-launchtemplatesource-launchparameters

LicenseSpecificationProperty

class CfnCapacityProvider.LicenseSpecificationProperty(*, license_configuration_arn)

Bases: object

Describes a license configuration.

Parameters:

license_configuration_arn (str) – The ARN of the license configuration.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-capacityprovider-licensespecification.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_bedrockagentcore as bedrockagentcore

license_specification_property = bedrockagentcore.CfnCapacityProvider.LicenseSpecificationProperty(
    license_configuration_arn="licenseConfigurationArn"
)

Attributes

license_configuration_arn

The ARN of the license configuration.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-capacityprovider-licensespecification.html#cfn-bedrockagentcore-capacityprovider-licensespecification-licenseconfigurationarn

PermissionsConfigurationProperty

class CfnCapacityProvider.PermissionsConfigurationProperty(*, capacity_provider_operator_role_arn)

Bases: object

Configuration for permissions associated with a capacity provider.

Parameters:

capacity_provider_operator_role_arn (str) – The ARN of the IAM role that operators use to manage the capacity provider.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-capacityprovider-permissionsconfiguration.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_bedrockagentcore as bedrockagentcore

permissions_configuration_property = bedrockagentcore.CfnCapacityProvider.PermissionsConfigurationProperty(
    capacity_provider_operator_role_arn="capacityProviderOperatorRoleArn"
)

Attributes

capacity_provider_operator_role_arn

The ARN of the IAM role that operators use to manage the capacity provider.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-capacityprovider-permissionsconfiguration.html#cfn-bedrockagentcore-capacityprovider-permissionsconfiguration-capacityprovideroperatorrolearn

RootVolumeConfigurationProperty

class CfnCapacityProvider.RootVolumeConfigurationProperty(*, encrypted=None, free_space_gib=None, iops=None, kms_key_id=None, throughput=None, volume_type=None)

Bases: object

Customer-facing configuration for the (service-managed) root volume.

The service provisions the root volume at its own AMI size estimate plus FreeSpaceGiB, and pins the visible free space to FreeSpaceGiB with a filler file, so the space you are guaranteed does not change as the underlying AMI grows. The device name and the delete-on-termination behavior are service-owned and are not configurable.

Parameters:

  • encrypted (Union[bool, IResolvable, None]) – Indicates whether the EBS volume is encrypted. Encrypted volumes can only be attached to instances that support Amazon EBS encryption. If you are creating a volume from a snapshot, you can’t specify an encryption value.

  • free_space_gib (Union[int, float, None]) – The free space guaranteed on the root volume, in GiB. The service adds the operating system overhead on top of this value. Defaults to 8 GiB. The maximum is below the 65,536 GiB gp3 ceiling because the service adds the AMI size bucket on top of this value, and the resulting total must still be a provisionable gp3 volume.

  • iops (Union[int, float, None]) – The number of IOPS to provision. Only valid for gp3, io1, and io2 volumes.

  • kms_key_id (Optional[str]) – Identifier of the customer managed KMS key to use for EBS encryption.

  • throughput (Union[int, float, None]) – The throughput to provision for a gp3 volume, in MiB/s. Valid range: 125-2000 MiB/s.

  • volume_type (Optional[str]) – The EBS volume type. Defaults to gp3 if not specified.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-capacityprovider-rootvolumeconfiguration.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_bedrockagentcore as bedrockagentcore

root_volume_configuration_property = bedrockagentcore.CfnCapacityProvider.RootVolumeConfigurationProperty(
    encrypted=False,
    free_space_gi_b=123,
    iops=123,
    kms_key_id="kmsKeyId",
    throughput=123,
    volume_type="volumeType"
)

Attributes

encrypted

Indicates whether the EBS volume is encrypted.

Encrypted volumes can only be attached to instances that support Amazon EBS encryption. If you are creating a volume from a snapshot, you can’t specify an encryption value.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-capacityprovider-rootvolumeconfiguration.html#cfn-bedrockagentcore-capacityprovider-rootvolumeconfiguration-encrypted

free_space_gib

The free space guaranteed on the root volume, in GiB.

The service adds the operating system overhead on top of this value. Defaults to 8 GiB. The maximum is below the 65,536 GiB gp3 ceiling because the service adds the AMI size bucket on top of this value, and the resulting total must still be a provisionable gp3 volume.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-capacityprovider-rootvolumeconfiguration.html#cfn-bedrockagentcore-capacityprovider-rootvolumeconfiguration-freespacegib

iops

The number of IOPS to provision.

Only valid for gp3, io1, and io2 volumes.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-capacityprovider-rootvolumeconfiguration.html#cfn-bedrockagentcore-capacityprovider-rootvolumeconfiguration-iops

kms_key_id

Identifier of the customer managed KMS key to use for EBS encryption.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-capacityprovider-rootvolumeconfiguration.html#cfn-bedrockagentcore-capacityprovider-rootvolumeconfiguration-kmskeyid

throughput

The throughput to provision for a gp3 volume, in MiB/s.

Valid range: 125-2000 MiB/s.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-capacityprovider-rootvolumeconfiguration.html#cfn-bedrockagentcore-capacityprovider-rootvolumeconfiguration-throughput

volume_type

The EBS volume type.

Defaults to gp3 if not specified.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-capacityprovider-rootvolumeconfiguration.html#cfn-bedrockagentcore-capacityprovider-rootvolumeconfiguration-volumetype

VolumeConfigurationProperty

class CfnCapacityProvider.VolumeConfigurationProperty(*, ebs_configuration)

Bases: object

Configuration for a persistent volume attached to a capacity provider session.

Parameters:

ebs_configuration (Union[IResolvable, EbsVolumeConfigurationProperty, Dict[str, Any]]) – Configuration for an EBS-backed persistent volume.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-capacityprovider-volumeconfiguration.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_bedrockagentcore as bedrockagentcore

volume_configuration_property = bedrockagentcore.CfnCapacityProvider.VolumeConfigurationProperty(
    ebs_configuration=bedrockagentcore.CfnCapacityProvider.EbsVolumeConfigurationProperty(
        name="name",
        size_gi_b=123,

        # the properties below are optional
        encrypted=False,
        iops=123,
        kms_key_id="kmsKeyId",
        snapshot_id="snapshotId",
        throughput=123,
        volume_type="volumeType"
    )
)

Attributes

ebs_configuration

Configuration for an EBS-backed persistent volume.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-capacityprovider-volumeconfiguration.html#cfn-bedrockagentcore-capacityprovider-volumeconfiguration-ebsconfiguration

VpcConfigurationProperty

class CfnCapacityProvider.VpcConfigurationProperty(*, security_groups, subnets)

Bases: object

VPC configuration for launching EC2 instances.

Parameters:

  • security_groups (Sequence[str]) – The IDs of the security groups to associate with the instances.

  • subnets (Sequence[str]) – The IDs of the subnets in which to launch instances.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-capacityprovider-vpcconfiguration.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_bedrockagentcore as bedrockagentcore

vpc_configuration_property = bedrockagentcore.CfnCapacityProvider.VpcConfigurationProperty(
    security_groups=["securityGroups"],
    subnets=["subnets"]
)

Attributes

security_groups

The IDs of the security groups to associate with the instances.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-capacityprovider-vpcconfiguration.html#cfn-bedrockagentcore-capacityprovider-vpcconfiguration-securitygroups

subnets

The IDs of the subnets in which to launch instances.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-capacityprovider-vpcconfiguration.html#cfn-bedrockagentcore-capacityprovider-vpcconfiguration-subnets