Class CfnCapacityProvider

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

Inheritance
object
CfnElement
CfnRefElement
CfnResource
CfnCapacityProvider
Inherited Members
Namespace: Amazon.CDK.AWS.BedrockAgentCore
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnCapacityProvider : CfnResource, IInspectable, ICapacityProviderRef, IConstruct, IDependable, IEnvironmentAware, ITaggableV2
Syntax (vb)
Public Class CfnCapacityProvider Inherits CfnResource Implements IInspectable, ICapacityProviderRef, IConstruct, IDependable, IEnvironmentAware, ITaggableV2
Remarks

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

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

             var cfnCapacityProvider = new CfnCapacityProvider(this, "MyCfnCapacityProvider", new CfnCapacityProviderProps {
                 ComputeConfiguration = new ComputeConfigurationProperty {
                     Ec2Configuration = new Ec2ConfigurationProperty {
                         LaunchTemplateSource = new LaunchTemplateSourceProperty {
                             LaunchParameters = new LaunchParametersProperty {
                                 InstanceRequirements = new InstanceRequirementsProperty {
                                     AllowedInstanceTypes = new [] { "allowedInstanceTypes" }
                                 },
                                 OperatingSystem = "operatingSystem",

                                 // the properties below are optional
                                 CapacityReservationSpecification = new CapacityReservationSpecificationProperty {
                                     CapacityReservationPreference = "capacityReservationPreference",
                                     CapacityReservationTarget = new CapacityReservationTargetProperty {
                                         CapacityReservationId = "capacityReservationId",
                                         CapacityReservationResourceGroupArn = "capacityReservationResourceGroupArn"
                                     }
                                 },
                                 EphemeralVolumes = new [] { new EphemeralBlockDeviceMappingProperty {
                                     DeviceName = "deviceName",
                                     Ebs = new EphemeralEBSVolumeConfigurationProperty {
                                         EbsCardIndex = 123,
                                         Encrypted = false,
                                         Iops = 123,
                                         KmsKeyId = "kmsKeyId",
                                         SnapshotId = "snapshotId",
                                         Throughput = 123,
                                         VolumeInitializationRate = 123,
                                         VolumeSize = 123,
                                         VolumeType = "volumeType"
                                     },
                                     VirtualName = "virtualName"
                                 } },
                                 InstanceProfileArn = "instanceProfileArn",
                                 LicenseSpecifications = new [] { new LicenseSpecificationProperty {
                                     LicenseConfigurationArn = "licenseConfigurationArn"
                                 } },
                                 Monitoring = "monitoring",
                                 PropagatedTags = new Dictionary<string, string> {
                                     { "propagatedTagsKey", "propagatedTags" }
                                 },
                                 SshKeyName = "sshKeyName"
                             }
                         },
                         VpcConfiguration = new VpcConfigurationProperty {
                             SecurityGroups = new [] { "securityGroups" },
                             Subnets = new [] { "subnets" }
                         },

                         // the properties below are optional
                         LifecycleConfiguration = new InstanceLifecycleConfigurationProperty {
                             IdleInstanceTimeout = 123,
                             MaxLifetime = 123
                         },
                         RootVolume = new RootVolumeConfigurationProperty {
                             Encrypted = false,
                             FreeSpaceGiB = 123,
                             Iops = 123,
                             KmsKeyId = "kmsKeyId",
                             Throughput = 123,
                             VolumeType = "volumeType"
                         },
                         Volumes = new [] { new VolumeConfigurationProperty {
                             EbsConfiguration = new EbsVolumeConfigurationProperty {
                                 Name = "name",
                                 SizeGiB = 123,

                                 // the properties below are optional
                                 Encrypted = false,
                                 Iops = 123,
                                 KmsKeyId = "kmsKeyId",
                                 SnapshotId = "snapshotId",
                                 Throughput = 123,
                                 VolumeType = "volumeType"
                             }
                         } }
                     }
                 },
                 Name = "name",
                 PermissionsConfiguration = new PermissionsConfigurationProperty {
                     CapacityProviderOperatorRoleArn = "capacityProviderOperatorRoleArn"
                 },

                 // the properties below are optional
                 Description = "description",
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } }
             });

Synopsis

Constructors

CfnCapacityProvider(Construct, string, ICfnCapacityProviderProps)

Create a new AWS::BedrockAgentCore::CapacityProvider.

Properties

AttrArn

The ARN of the capacity provider.
AttrCapacityProviderId

The unique identifier of the capacity provider.
AttrCreatedAt

The timestamp when the capacity provider was created.
AttrLastUpdatedAt

The timestamp when the capacity provider was last updated.
AttrStatus

The current status of the capacity provider.
CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.
CapacityProviderRef

A reference to a CapacityProvider resource.
CdkTagManager

Tag Manager which manages the tags for this resource.
CfnProperties

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

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

The capacity configuration for the capacity provider.
Description

An optional description of the capacity provider.
Name

The name of the capacity provider.
PermissionsConfiguration

Configuration for permissions associated with a capacity provider.
Tags

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

Methods

ArnForCapacityProvider(ICapacityProviderRef)

Resource Type definition for AWS::BedrockAgentCore::CapacityProvider.
Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.
IsCfnCapacityProvider(object)

Checks whether the given object is a CfnCapacityProvider.
RenderProperties(IDictionary<string, object>)

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

Constructors

CfnCapacityProvider(Construct, string, ICfnCapacityProviderProps)

Create a new AWS::BedrockAgentCore::CapacityProvider.

public CfnCapacityProvider(Construct scope, string id, ICfnCapacityProviderProps props)
Parameters
scope Construct

Scope in which this resource is defined.

id string

Construct identifier for this resource (unique in its scope).

props ICfnCapacityProviderProps

Resource properties.

Remarks

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

Properties

AttrArn

The ARN of the capacity provider.

public virtual string AttrArn { get; }
Property Value

string

Remarks

CloudformationAttribute: Arn

AttrCapacityProviderId

The unique identifier of the capacity provider.

public virtual string AttrCapacityProviderId { get; }
Property Value

string

Remarks

CloudformationAttribute: CapacityProviderId

AttrCreatedAt

The timestamp when the capacity provider was created.

public virtual string AttrCreatedAt { get; }
Property Value

string

Remarks

CloudformationAttribute: CreatedAt

AttrLastUpdatedAt

The timestamp when the capacity provider was last updated.

public virtual string AttrLastUpdatedAt { get; }
Property Value

string

Remarks

CloudformationAttribute: LastUpdatedAt

AttrStatus

The current status of the capacity provider.

public virtual string AttrStatus { get; }
Property Value

string

Remarks

CloudformationAttribute: Status

CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value

string

Remarks

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

CapacityProviderRef

A reference to a CapacityProvider resource.

public virtual ICapacityProviderReference CapacityProviderRef { get; }
Property Value

ICapacityProviderReference

Remarks

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

CdkTagManager

Tag Manager which manages the tags for this resource.

public virtual TagManager CdkTagManager { get; }
Property Value

TagManager

Remarks

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

CfnProperties

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

protected override IDictionary<string, object> CfnProperties { get; }
Property Value

IDictionary<string, object>

Overrides
Remarks

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

CfnPropertyNames

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

protected override IDictionary<string, string> CfnPropertyNames { get; }
Property Value

IDictionary<string, string>

Overrides
Remarks

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

ComputeConfiguration

The capacity configuration for the capacity provider.

public virtual object ComputeConfiguration { get; set; }
Property Value

object

Remarks

Type union: either IResolvable or CfnCapacityProvider.IComputeConfigurationProperty

Description

An optional description of the capacity provider.

public virtual string? Description { get; set; }
Property Value

string

Remarks

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

Name

The name of the capacity provider.

public virtual string Name { get; set; }
Property Value

string

Remarks

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

PermissionsConfiguration

Configuration for permissions associated with a capacity provider.

public virtual object PermissionsConfiguration { get; set; }
Property Value

object

Remarks

Type union: either IResolvable or CfnCapacityProvider.IPermissionsConfigurationProperty

Tags

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

public virtual ICfnTag[]? Tags { get; set; }
Property Value

ICfnTag[]

Remarks

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

Methods

ArnForCapacityProvider(ICapacityProviderRef)

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

public static string ArnForCapacityProvider(ICapacityProviderRef resource)
Parameters
resource ICapacityProviderRef
Returns

string

Remarks

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

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

             var cfnCapacityProvider = new CfnCapacityProvider(this, "MyCfnCapacityProvider", new CfnCapacityProviderProps {
                 ComputeConfiguration = new ComputeConfigurationProperty {
                     Ec2Configuration = new Ec2ConfigurationProperty {
                         LaunchTemplateSource = new LaunchTemplateSourceProperty {
                             LaunchParameters = new LaunchParametersProperty {
                                 InstanceRequirements = new InstanceRequirementsProperty {
                                     AllowedInstanceTypes = new [] { "allowedInstanceTypes" }
                                 },
                                 OperatingSystem = "operatingSystem",

                                 // the properties below are optional
                                 CapacityReservationSpecification = new CapacityReservationSpecificationProperty {
                                     CapacityReservationPreference = "capacityReservationPreference",
                                     CapacityReservationTarget = new CapacityReservationTargetProperty {
                                         CapacityReservationId = "capacityReservationId",
                                         CapacityReservationResourceGroupArn = "capacityReservationResourceGroupArn"
                                     }
                                 },
                                 EphemeralVolumes = new [] { new EphemeralBlockDeviceMappingProperty {
                                     DeviceName = "deviceName",
                                     Ebs = new EphemeralEBSVolumeConfigurationProperty {
                                         EbsCardIndex = 123,
                                         Encrypted = false,
                                         Iops = 123,
                                         KmsKeyId = "kmsKeyId",
                                         SnapshotId = "snapshotId",
                                         Throughput = 123,
                                         VolumeInitializationRate = 123,
                                         VolumeSize = 123,
                                         VolumeType = "volumeType"
                                     },
                                     VirtualName = "virtualName"
                                 } },
                                 InstanceProfileArn = "instanceProfileArn",
                                 LicenseSpecifications = new [] { new LicenseSpecificationProperty {
                                     LicenseConfigurationArn = "licenseConfigurationArn"
                                 } },
                                 Monitoring = "monitoring",
                                 PropagatedTags = new Dictionary<string, string> {
                                     { "propagatedTagsKey", "propagatedTags" }
                                 },
                                 SshKeyName = "sshKeyName"
                             }
                         },
                         VpcConfiguration = new VpcConfigurationProperty {
                             SecurityGroups = new [] { "securityGroups" },
                             Subnets = new [] { "subnets" }
                         },

                         // the properties below are optional
                         LifecycleConfiguration = new InstanceLifecycleConfigurationProperty {
                             IdleInstanceTimeout = 123,
                             MaxLifetime = 123
                         },
                         RootVolume = new RootVolumeConfigurationProperty {
                             Encrypted = false,
                             FreeSpaceGiB = 123,
                             Iops = 123,
                             KmsKeyId = "kmsKeyId",
                             Throughput = 123,
                             VolumeType = "volumeType"
                         },
                         Volumes = new [] { new VolumeConfigurationProperty {
                             EbsConfiguration = new EbsVolumeConfigurationProperty {
                                 Name = "name",
                                 SizeGiB = 123,

                                 // the properties below are optional
                                 Encrypted = false,
                                 Iops = 123,
                                 KmsKeyId = "kmsKeyId",
                                 SnapshotId = "snapshotId",
                                 Throughput = 123,
                                 VolumeType = "volumeType"
                             }
                         } }
                     }
                 },
                 Name = "name",
                 PermissionsConfiguration = new PermissionsConfigurationProperty {
                     CapacityProviderOperatorRoleArn = "capacityProviderOperatorRoleArn"
                 },

                 // the properties below are optional
                 Description = "description",
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } }
             });

Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.

public virtual void Inspect(TreeInspector inspector)
Parameters
inspector TreeInspector

tree inspector to collect and process attributes.

Remarks

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

IsCfnCapacityProvider(object)

Checks whether the given object is a CfnCapacityProvider.

public static bool IsCfnCapacityProvider(object x)
Parameters
x object
Returns

bool

Remarks

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

RenderProperties(IDictionary<string, object>)

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

protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
props IDictionary<string, object>
Returns

IDictionary<string, object>

Overrides
Remarks

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

Implements

Constructs.IConstruct
Constructs.IDependable