Skip to content
v2.275.0

CfnWorkspaceInstanceProps Struct ​

Properties for defining a CfnWorkspaceInstance.

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_workspacesinstances as workspacesinstances } from 'aws-cdk-lib';
const cfnWorkspaceInstanceProps: workspacesinstances.CfnWorkspaceInstanceProps = {
  managedInstance: {
    imageId: 'imageId',
    instanceType: 'instanceType',

    // the properties below are optional
    blockDeviceMappings: [{
      deviceName: 'deviceName',
      ebs: {
        encrypted: false,
        iops: 123,
        kmsKeyId: 'kmsKeyId',
        throughput: 123,
        volumeSize: 123,
        volumeType: 'volumeType',
      },
      noDevice: 'noDevice',
      virtualName: 'virtualName',
    }],
    capacityReservationSpecification: {
      capacityReservationPreference: 'capacityReservationPreference',
      capacityReservationTarget: {
        capacityReservationId: 'capacityReservationId',
        capacityReservationResourceGroupArn: 'capacityReservationResourceGroupArn',
      },
    },
    cpuOptions: {
      coreCount: 123,
      threadsPerCore: 123,
    },
    creditSpecification: {
      cpuCredits: 'cpuCredits',
    },
    disableApiStop: false,
    ebsOptimized: false,
    enablePrimaryIpv6: false,
    enclaveOptions: {
      enabled: false,
    },
    hibernationOptions: {
      configured: false,
    },
    iamInstanceProfile: {
      arn: 'arn',
      name: 'name',
    },
    ipv6AddressCount: 123,
    keyName: 'keyName',
    licenseSpecifications: [{
      licenseConfigurationArn: 'licenseConfigurationArn',
    }],
    maintenanceOptions: {
      autoRecovery: 'autoRecovery',
    },
    metadataOptions: {
      httpEndpoint: 'httpEndpoint',
      httpProtocolIpv6: 'httpProtocolIpv6',
      httpPutResponseHopLimit: 123,
      httpTokens: 'httpTokens',
      instanceMetadataTags: 'instanceMetadataTags',
    },
    monitoring: {
      enabled: false,
    },
    networkInterfaces: [{
      description: 'description',
      deviceIndex: 123,
      groups: ['groups'],
      subnetId: 'subnetId',
    }],
    networkPerformanceOptions: {
      bandwidthWeighting: 'bandwidthWeighting',
    },
    placement: {
      availabilityZone: 'availabilityZone',
      groupId: 'groupId',
      groupName: 'groupName',
      partitionNumber: 123,
      tenancy: 'tenancy',
    },
    privateDnsNameOptions: {
      enableResourceNameDnsAaaaRecord: false,
      enableResourceNameDnsARecord: false,
      hostnameType: 'hostnameType',
    },
    subnetId: 'subnetId',
    tagSpecifications: [{
      resourceType: 'resourceType',
      tags: [{
        key: 'key',
        value: 'value',
      }],
    }],
    userData: 'userData',
  },
  tags: [{
    key: 'key',
    value: 'value',
  }],
};

Properties ​

managedInstanceoptionalIResolvable | CfnWorkspaceInstance.ManagedInstancePropertymanaged_instanceoptionaltyping.Union[IResolvable, ManagedInstanceProperty]managedInstanceoptionalIResolvableManagedInstanceoptionalIResolvableManagedInstanceoptionalinterface{}#
tagsoptionalCfnTag[]tagsoptionaltyping.List[CfnTag]tagsoptionalList<CfnTag>TagsoptionalCfnTag[]Tagsoptional*[]CfnTag#