Skip to content
v2.275.0

ManagedInstanceProperty Struct ​

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 managedInstanceProperty: workspacesinstances.CfnWorkspaceInstance.ManagedInstanceProperty = {
  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',
};

Properties ​

blockDeviceMappingsoptionalIResolvable | IResolvable | CfnWorkspaceInstance.BlockDeviceMappingProperty[]block_device_mappingsoptionaltyping.Union[IResolvable, typing.List[typing.Union[IResolvable, BlockDeviceMappingProperty]]]blockDeviceMappingsoptionalIResolvableBlockDeviceMappingsoptionalIResolvableBlockDeviceMappingsoptionalinterface{}#
capacityReservationSpecificationoptionalIResolvable | CfnWorkspaceInstance.CapacityReservationSpecificationPropertycapacity_reservation_specificationoptionaltyping.Union[IResolvable, CapacityReservationSpecificationProperty]capacityReservationSpecificationoptionalIResolvableCapacityReservationSpecificationoptionalIResolvableCapacityReservationSpecificationoptionalinterface{}#
cpuOptionsoptionalIResolvable | CfnWorkspaceInstance.CpuOptionsRequestPropertycpu_optionsoptionaltyping.Union[IResolvable, CpuOptionsRequestProperty]cpuOptionsoptionalIResolvableCpuOptionsoptionalIResolvableCpuOptionsoptionalinterface{}#
creditSpecificationoptionalIResolvable | CfnWorkspaceInstance.CreditSpecificationRequestPropertycredit_specificationoptionaltyping.Union[IResolvable, CreditSpecificationRequestProperty]creditSpecificationoptionalIResolvableCreditSpecificationoptionalIResolvableCreditSpecificationoptionalinterface{}#
disableApiStopoptionalboolean | IResolvabledisable_api_stopoptionaltyping.Union[bool, IResolvable]disableApiStopoptionalBooleanDisableApiStopoptionalboolDisableApiStopoptionalinterface{}#
ebsOptimizedoptionalboolean | IResolvableebs_optimizedoptionaltyping.Union[bool, IResolvable]ebsOptimizedoptionalBooleanEbsOptimizedoptionalboolEbsOptimizedoptionalinterface{}#
enablePrimaryIpv6optionalboolean | IResolvableenable_primary_ipv6optionaltyping.Union[bool, IResolvable]enablePrimaryIpv6optionalBooleanEnablePrimaryIpv6optionalboolEnablePrimaryIpv6optionalinterface{}#
enclaveOptionsoptionalIResolvable | CfnWorkspaceInstance.EnclaveOptionsRequestPropertyenclave_optionsoptionaltyping.Union[IResolvable, EnclaveOptionsRequestProperty]enclaveOptionsoptionalIResolvableEnclaveOptionsoptionalIResolvableEnclaveOptionsoptionalinterface{}#
hibernationOptionsoptionalIResolvable | CfnWorkspaceInstance.HibernationOptionsRequestPropertyhibernation_optionsoptionaltyping.Union[IResolvable, HibernationOptionsRequestProperty]hibernationOptionsoptionalIResolvableHibernationOptionsoptionalIResolvableHibernationOptionsoptionalinterface{}#
iamInstanceProfileoptionalIResolvable | CfnWorkspaceInstance.IamInstanceProfileSpecificationPropertyiam_instance_profileoptionaltyping.Union[IResolvable, IamInstanceProfileSpecificationProperty]iamInstanceProfileoptionalIResolvableIamInstanceProfileoptionalIResolvableIamInstanceProfileoptionalinterface{}#
imageIdstringimage_idstrimageIdStringImageIdstringImageId*stringrequired#
instanceTypestringinstance_typestrinstanceTypeStringInstanceTypestringInstanceType*stringrequired#
ipv6AddressCountoptionalnumberipv6_address_countoptionalint | floatipv6AddressCountoptionalNumberIpv6AddressCountoptionaldoubleIpv6AddressCountoptional*float64#
keyNameoptionalstringkey_nameoptionalstrkeyNameoptionalStringKeyNameoptionalstringKeyNameoptional*string#
licenseSpecificationsoptionalIResolvable | IResolvable | CfnWorkspaceInstance.LicenseConfigurationRequestProperty[]license_specificationsoptionaltyping.Union[IResolvable, typing.List[typing.Union[IResolvable, LicenseConfigurationRequestProperty]]]licenseSpecificationsoptionalIResolvableLicenseSpecificationsoptionalIResolvableLicenseSpecificationsoptionalinterface{}#
maintenanceOptionsoptionalIResolvable | CfnWorkspaceInstance.InstanceMaintenanceOptionsRequestPropertymaintenance_optionsoptionaltyping.Union[IResolvable, InstanceMaintenanceOptionsRequestProperty]maintenanceOptionsoptionalIResolvableMaintenanceOptionsoptionalIResolvableMaintenanceOptionsoptionalinterface{}#
metadataOptionsoptionalIResolvable | CfnWorkspaceInstance.InstanceMetadataOptionsRequestPropertymetadata_optionsoptionaltyping.Union[IResolvable, InstanceMetadataOptionsRequestProperty]metadataOptionsoptionalIResolvableMetadataOptionsoptionalIResolvableMetadataOptionsoptionalinterface{}#
monitoringoptionalIResolvable | CfnWorkspaceInstance.RunInstancesMonitoringEnabledPropertymonitoringoptionaltyping.Union[IResolvable, RunInstancesMonitoringEnabledProperty]monitoringoptionalIResolvableMonitoringoptionalIResolvableMonitoringoptionalinterface{}#
networkInterfacesoptionalIResolvable | IResolvable | CfnWorkspaceInstance.InstanceNetworkInterfaceSpecificationProperty[]network_interfacesoptionaltyping.Union[IResolvable, typing.List[typing.Union[IResolvable, InstanceNetworkInterfaceSpecificationProperty]]]networkInterfacesoptionalIResolvableNetworkInterfacesoptionalIResolvableNetworkInterfacesoptionalinterface{}#
networkPerformanceOptionsoptionalIResolvable | CfnWorkspaceInstance.InstanceNetworkPerformanceOptionsRequestPropertynetwork_performance_optionsoptionaltyping.Union[IResolvable, InstanceNetworkPerformanceOptionsRequestProperty]networkPerformanceOptionsoptionalIResolvableNetworkPerformanceOptionsoptionalIResolvableNetworkPerformanceOptionsoptionalinterface{}#
placementoptionalIResolvable | CfnWorkspaceInstance.PlacementPropertyplacementoptionaltyping.Union[IResolvable, PlacementProperty]placementoptionalIResolvablePlacementoptionalIResolvablePlacementoptionalinterface{}#
privateDnsNameOptionsoptionalIResolvable | CfnWorkspaceInstance.PrivateDnsNameOptionsRequestPropertyprivate_dns_name_optionsoptionaltyping.Union[IResolvable, PrivateDnsNameOptionsRequestProperty]privateDnsNameOptionsoptionalIResolvablePrivateDnsNameOptionsoptionalIResolvablePrivateDnsNameOptionsoptionalinterface{}#
subnetIdoptionalstringsubnet_idoptionalstrsubnetIdoptionalStringSubnetIdoptionalstringSubnetIdoptional*string#
tagSpecificationsoptionalIResolvable | IResolvable | CfnWorkspaceInstance.TagSpecificationProperty[]tag_specificationsoptionaltyping.Union[IResolvable, typing.List[typing.Union[IResolvable, TagSpecificationProperty]]]tagSpecificationsoptionalIResolvableTagSpecificationsoptionalIResolvableTagSpecificationsoptionalinterface{}#
userDataoptionalstringuser_dataoptionalstruserDataoptionalStringUserDataoptionalstringUserDataoptional*string#