Package software.amazon.awscdk.services.backupgateway

Class CfnHypervisor

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.backupgateway.CfnHypervisor
All Implemented Interfaces:
IEnvironmentAware, IInspectable, ITaggable, IHypervisorRef, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.118.0 (build 02eec31)", date="2025-11-10T13:39:59.049Z") @Stability(Stable) public class CfnHypervisor extends CfnResource implements IInspectable, IHypervisorRef, ITaggable
Represents the hypervisor's permissions to which the gateway will connect.

A hypervisor is hardware, software, or firmware that creates and manages virtual machines, and allocates resources to them.

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.backupgateway.*;
 CfnHypervisor cfnHypervisor = CfnHypervisor.Builder.create(this, "MyCfnHypervisor")
         .host("host")
         .kmsKeyArn("kmsKeyArn")
         .logGroupArn("logGroupArn")
         .name("name")
         .password("password")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .username("username")
         .build();

See Also:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnHypervisor

      protected CfnHypervisor(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnHypervisor

      protected CfnHypervisor(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnHypervisor

      @Stability(Stable) public CfnHypervisor(@NotNull software.constructs.Construct scope, @NotNull String id, @Nullable CfnHypervisorProps props)
      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties.

    • CfnHypervisor

      @Stability(Stable) public CfnHypervisor(@NotNull software.constructs.Construct scope, @NotNull String id)
      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.

  • Method Details

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrHypervisorArn

      @Stability(Stable) @NotNull public String getAttrHypervisorArn()
      Returns HypervisorArn , an Amazon Resource Name (ARN) that uniquely identifies a Hypervisor.

      For example: arn:aws:backup-gateway:us-east-1:123456789012:hypervisor/hype-1234D67D

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getHypervisorRef

      @Stability(Stable) @NotNull public HypervisorReference getHypervisorRef()
      A reference to a Hypervisor resource.
      Specified by:
      getHypervisorRef in interface IHypervisorRef

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getTags in interface ITaggable

    • getHost

      @Stability(Stable) @Nullable public String getHost()
      The server host of the hypervisor.

    • setHost

      @Stability(Stable) public void setHost(@Nullable String value)
      The server host of the hypervisor.

    • getKmsKeyArn

      @Stability(Stable) @Nullable public String getKmsKeyArn()
      The Amazon Resource Name (ARN) of the AWS Key Management Service used to encrypt the hypervisor.

    • setKmsKeyArn

      @Stability(Stable) public void setKmsKeyArn(@Nullable String value)
      The Amazon Resource Name (ARN) of the AWS Key Management Service used to encrypt the hypervisor.

    • getLogGroupArn

      @Stability(Stable) @Nullable public String getLogGroupArn()
      The Amazon Resource Name (ARN) of the group of gateways within the requested log.

    • setLogGroupArn

      @Stability(Stable) public void setLogGroupArn(@Nullable String value)
      The Amazon Resource Name (ARN) of the group of gateways within the requested log.

    • getName

      @Stability(Stable) @Nullable public String getName()
      The name of the hypervisor.

    • setName

      @Stability(Stable) public void setName(@Nullable String value)
      The name of the hypervisor.

    • getPassword

      @Stability(Stable) @Nullable public String getPassword()
      The password for the hypervisor.

    • setPassword

      @Stability(Stable) public void setPassword(@Nullable String value)
      The password for the hypervisor.

    • getTagsRaw

      @Stability(Stable) @Nullable public List<CfnTag> getTagsRaw()
      The tags of the hypervisor configuration to import.

    • setTagsRaw

      @Stability(Stable) public void setTagsRaw(@Nullable List<CfnTag> value)
      The tags of the hypervisor configuration to import.

    • getUsername

      @Stability(Stable) @Nullable public String getUsername()
      The username for the hypervisor.

    • setUsername

      @Stability(Stable) public void setUsername(@Nullable String value)
      The username for the hypervisor.