Creates a capacity provider¶

Description¶

Creates a capacity provider. A capacity provider defines the Amazon EC2 infrastructure for AgentCore Runtime, including the operating system, allowed instance types, networking, and storage. It also specifies the IAM permissions that AgentCore uses to manage those instances.

The capacity provider name must be unique within your account. After you create the capacity provider, it enters a CREATING state and transitions to READY when it is available for use.

Usage¶

bedrockagentcorecontrol_create_capacity_provider(name, description,
  permissionsConfiguration, clientToken, tags, computeConfiguration)

Arguments¶

name

[required] The name of the capacity provider. The name must be unique within your account.
description

An optional description of the capacity provider. If you don't specify a description, the service creates the capacity provider without one.
permissionsConfiguration

[required] The permissions configuration for the capacity provider. This specifies the IAM role that AgentCore uses to manage the Amazon EC2 instances on your behalf.
clientToken

A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If you don't specify this field, a value is randomly generated for you. If this token matches a previous request, the service ignores the request, but doesn't return an error. For more information, see Ensuring idempotency.
tags

A map of tag keys and values to associate with the capacity provider. If you don't specify tags, the capacity provider is created with no tags.
computeConfiguration

[required] The compute configuration for the capacity provider. This defines the Amazon EC2 compute resources used to launch instances: the operating system, allowed instance types, networking, and storage.

Value¶

A list with the following syntax:

list(
  capacityProviderId = "string",
  capacityProviderArn = "string",
  name = "string",
  status = "CREATING"|"CREATE_FAILED"|"UPDATING"|"UPDATE_FAILED"|"READY"|"DELETING"|"DELETE_FAILED"
)

Request syntax¶

svc$create_capacity_provider(
  name = "string",
  description = "string",
  permissionsConfiguration = list(
    capacityProviderOperatorRoleArn = "string"
  ),
  clientToken = "string",
  tags = list(
    "string"
  ),
  computeConfiguration = list(
    ec2Configuration = list(
      launchTemplateSource = list(
        launchParameters = list(
          operatingSystem = "LINUX_X86_64"|"LINUX_ARM64",
          instanceRequirements = list(
            allowedInstanceTypes = list(
              "string"
            )
          ),
          ephemeralVolumes = list(
            list(
              deviceName = "string",
              virtualName = "string",
              ebs = list(
                volumeType = "standard"|"io1"|"io2"|"gp2"|"sc1"|"st1"|"gp3",
                iops = 123,
                throughput = 123,
                encrypted = TRUE|FALSE,
                kmsKeyId = "string",
                snapshotId = "string",
                volumeSize = 123,
                volumeInitializationRate = 123,
                ebsCardIndex = 123
              )
            )
          ),
          monitoring = "BASIC"|"DETAILED",
          licenseSpecifications = list(
            list(
              licenseConfigurationArn = "string"
            )
          ),
          capacityReservationSpecification = list(
            capacityReservationPreference = "capacity-reservations-only"|"open"|"none",
            capacityReservationTarget = list(
              capacityReservationId = "string",
              capacityReservationResourceGroupArn = "string"
            )
          ),
          sshKeyName = "string",
          instanceProfileArn = "string",
          propagatedTags = list(
            "string"
          )
        )
      ),
      vpcConfiguration = list(
        subnets = list(
          "string"
        ),
        securityGroups = list(
          "string"
        )
      ),
      volumes = list(
        list(
          ebsConfiguration = list(
            name = "string",
            sizeGiB = 123,
            volumeType = "standard"|"io1"|"io2"|"gp2"|"sc1"|"st1"|"gp3",
            iops = 123,
            throughput = 123,
            encrypted = TRUE|FALSE,
            kmsKeyId = "string",
            snapshotId = "string"
          )
        )
      ),
      lifecycleConfiguration = list(
        idleInstanceTimeout = 123,
        maxLifetime = 123
      ),
      rootVolume = list(
        volumeType = "standard"|"io1"|"io2"|"gp2"|"sc1"|"st1"|"gp3",
        iops = 123,
        throughput = 123,
        encrypted = TRUE|FALSE,
        kmsKeyId = "string",
        freeSpaceGiB = 123
      )
    )
  )
)