Skip to main content

CreateInstanceBody

Type Alias CreateInstanceBody 

Source
pub type CreateInstanceBody = InstanceCreateRequestInput;

Aliased Type§

pub struct CreateInstanceBody {
    pub name: String,
    pub description: Option<String>,
    pub flavor: String,
    pub architecture: Option<String>,
    pub image: Option<String>,
    pub networks: Vec<NetworkConfigInput>,
    pub volumes: Option<Vec<InstanceLaunchVolumeInput>>,
    pub metadata: Option<BTreeMap<String, String>>,
    pub tags: Option<BTreeMap<String, String>>,
    pub user_data: Option<String>,
    pub iam_role: Option<String>,
}

Fields§

§name: String

Resource names must not start with the literal crn: prefix or be UUIDs (canonical, compact, braced, or urn:uuid: forms, in either case).

§description: Option<String>§flavor: String

Regional flavor reference (UUID, CRN or exact name)

§architecture: Option<String>

Architecture for image names and name:version tags (default amd64); a CRN pins its own architecture and version.

§image: Option<String>

Image to clone the boot disk from. Required unless volumes contains an existing boot volume; cannot be combined with an existing boot volume. Four forms are accepted: a complete image/name/architecture/arch/version/version CRN; an image id; name:version, which pins one build and is how you opt out of the tag moving under you; or a bare name, which follows the tag to whichever build is current when the instance is created. Names prefer a usable caller-owned build over a tagged platform catalog build for the requested architecture (default amd64). A CRN pins owner, name, architecture and version. Resolution never retries another reference kind; responses and stored templates retain the resolved image UUID.

§networks: Vec<NetworkConfigInput>

Interfaces to attach, at least one. index 0 is the primary NIC. Required because an instance with no interface boots with no network at all, and nothing inside it can add one afterwards.

§volumes: Option<Vec<InstanceLaunchVolumeInput>>

New or existing disks bound with the instance, the boot disk included — mark it with boot: true. At most one entry may. Omit the boot entry to take the image’s minimum size and the region’s default tier.

§metadata: Option<BTreeMap<String, String>>§tags: Option<BTreeMap<String, String>>§user_data: Option<String>

Base64-encoded user data (cloud-init)

§iam_role: Option<String>

Attach an IAM role from the same account by UUID, CRN or exact name. The role’s trust policy must permit crn:compute:*:*:instance/* (or the specific instance CRN). The instance’s IMDS endpoint (169.254.169.254) mints short-lived STS credentials for this role from inside the VM.