Package software.amazon.awscdk.services.opsworkscm

Class CfnServer

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.opsworkscm.CfnServer
All Implemented Interfaces:
IInspectable, ITaggable, IServerRef, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.116.0 (build 0eddcff)", date="2025-10-24T13:34:42.958Z") @Stability(Stable) public class CfnServer extends CfnResource implements IInspectable, IServerRef, ITaggable
The AWS::OpsWorksCM::Server resource creates an AWS OpsWorks for Chef Automate or OpsWorks for Puppet Enterprise configuration management server.

For more information, see Create a Chef Automate Server in AWS CloudFormation or Create a Puppet Enterprise Master in AWS CloudFormation in the OpsWorks User Guide , and CreateServer in the AWS OpsWorks CM API Reference .

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.opsworkscm.*;
 CfnServer cfnServer = CfnServer.Builder.create(this, "MyCfnServer")
         .instanceProfileArn("instanceProfileArn")
         .instanceType("instanceType")
         .serviceRoleArn("serviceRoleArn")
         // the properties below are optional
         .associatePublicIpAddress(false)
         .backupId("backupId")
         .backupRetentionCount(123)
         .customCertificate("customCertificate")
         .customDomain("customDomain")
         .customPrivateKey("customPrivateKey")
         .disableAutomatedBackup(false)
         .engine("engine")
         .engineAttributes(List.of(EngineAttributeProperty.builder()
                 .name("name")
                 .value("value")
                 .build()))
         .engineModel("engineModel")
         .engineVersion("engineVersion")
         .keyPair("keyPair")
         .preferredBackupWindow("preferredBackupWindow")
         .preferredMaintenanceWindow("preferredMaintenanceWindow")
         .securityGroupIds(List.of("securityGroupIds"))
         .subnetIds(List.of("subnetIds"))
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .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

    • CfnServer

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

    • CfnServer

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

    • CfnServer

      @Stability(Stable) public CfnServer(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnServerProps 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. 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.

    • getAttrArn

      @Stability(Stable) @NotNull public String getAttrArn()
      The Amazon Resource Name (ARN) of the server, such as arn:aws:OpsWorksCM:us-east-1:123456789012:server/server-a1bzhi .

    • getAttrEndpoint

      @Stability(Stable) @NotNull public String getAttrEndpoint()
      A DNS name that can be used to access the engine.

      Example: myserver-asdfghjkl.us-east-1.opsworks.io .

    • getAttrServerName

      @Stability(Stable) @NotNull public String getAttrServerName()

    • getCfnProperties

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

    • getServerRef

      @Stability(Stable) @NotNull public ServerReference getServerRef()
      A reference to a Server resource.
      Specified by:
      getServerRef in interface IServerRef

    • getTags

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

    • getInstanceProfileArn

      @Stability(Stable) @NotNull public String getInstanceProfileArn()
      The ARN of the instance profile that your Amazon EC2 instances use.

    • setInstanceProfileArn

      @Stability(Stable) public void setInstanceProfileArn(@NotNull String value)
      The ARN of the instance profile that your Amazon EC2 instances use.

    • getInstanceType

      @Stability(Stable) @NotNull public String getInstanceType()
      The Amazon EC2 instance type to use.

    • setInstanceType

      @Stability(Stable) public void setInstanceType(@NotNull String value)
      The Amazon EC2 instance type to use.

    • getServiceRoleArn

      @Stability(Stable) @NotNull public String getServiceRoleArn()
      The service role that the AWS OpsWorks CM service backend uses to work with your account.

    • setServiceRoleArn

      @Stability(Stable) public void setServiceRoleArn(@NotNull String value)
      The service role that the AWS OpsWorks CM service backend uses to work with your account.

    • getAssociatePublicIpAddress

      @Stability(Stable) @Nullable public Object getAssociatePublicIpAddress()
      Associate a public IP address with a server that you are launching.

      Returns union: either Boolean or IResolvable

    • setAssociatePublicIpAddress

      @Stability(Stable) public void setAssociatePublicIpAddress(@Nullable Boolean value)
      Associate a public IP address with a server that you are launching.

    • setAssociatePublicIpAddress

      @Stability(Stable) public void setAssociatePublicIpAddress(@Nullable IResolvable value)
      Associate a public IP address with a server that you are launching.

    • getBackupId

      @Stability(Stable) @Nullable public String getBackupId()
      If you specify this field, AWS OpsWorks CM creates the server by using the backup represented by BackupId.

    • setBackupId

      @Stability(Stable) public void setBackupId(@Nullable String value)
      If you specify this field, AWS OpsWorks CM creates the server by using the backup represented by BackupId.

    • getBackupRetentionCount

      @Stability(Stable) @Nullable public Number getBackupRetentionCount()
      The number of automated backups that you want to keep.

    • setBackupRetentionCount

      @Stability(Stable) public void setBackupRetentionCount(@Nullable Number value)
      The number of automated backups that you want to keep.

    • getCustomCertificate

      @Stability(Stable) @Nullable public String getCustomCertificate()
      Supported on servers running Chef Automate 2.0 only. A PEM-formatted HTTPS certificate. The value can be be a single, self-signed certificate, or a certificate chain. If you specify a custom certificate, you must also specify values for CustomDomain and CustomPrivateKey . The following are requirements for the CustomCertificate value:.

    • setCustomCertificate

      @Stability(Stable) public void setCustomCertificate(@Nullable String value)
      Supported on servers running Chef Automate 2.0 only. A PEM-formatted HTTPS certificate. The value can be be a single, self-signed certificate, or a certificate chain. If you specify a custom certificate, you must also specify values for CustomDomain and CustomPrivateKey . The following are requirements for the CustomCertificate value:.

    • getCustomDomain

      @Stability(Stable) @Nullable public String getCustomDomain()
      Supported on servers running Chef Automate 2.0 only. An optional public endpoint of a server, such as https://aws.my-company.com . To access the server, create a CNAME DNS record in your preferred DNS service that points the custom domain to the endpoint that is generated when the server is created (the value of the CreateServer Endpoint attribute). You cannot access the server by using the generated Endpoint value if the server is using a custom domain. If you specify a custom domain, you must also specify values for CustomCertificate and CustomPrivateKey .

    • setCustomDomain

      @Stability(Stable) public void setCustomDomain(@Nullable String value)
      Supported on servers running Chef Automate 2.0 only. An optional public endpoint of a server, such as https://aws.my-company.com . To access the server, create a CNAME DNS record in your preferred DNS service that points the custom domain to the endpoint that is generated when the server is created (the value of the CreateServer Endpoint attribute). You cannot access the server by using the generated Endpoint value if the server is using a custom domain. If you specify a custom domain, you must also specify values for CustomCertificate and CustomPrivateKey .

    • getCustomPrivateKey

      @Stability(Stable) @Nullable public String getCustomPrivateKey()
      Supported on servers running Chef Automate 2.0 only. A private key in PEM format for connecting to the server by using HTTPS. The private key must not be encrypted; it cannot be protected by a password or passphrase. If you specify a custom private key, you must also specify values for CustomDomain and CustomCertificate .

    • setCustomPrivateKey

      @Stability(Stable) public void setCustomPrivateKey(@Nullable String value)
      Supported on servers running Chef Automate 2.0 only. A private key in PEM format for connecting to the server by using HTTPS. The private key must not be encrypted; it cannot be protected by a password or passphrase. If you specify a custom private key, you must also specify values for CustomDomain and CustomCertificate .

    • getDisableAutomatedBackup

      @Stability(Stable) @Nullable public Object getDisableAutomatedBackup()
      Enable or disable scheduled backups.

      Returns union: either Boolean or IResolvable

    • setDisableAutomatedBackup

      @Stability(Stable) public void setDisableAutomatedBackup(@Nullable Boolean value)
      Enable or disable scheduled backups.

    • setDisableAutomatedBackup

      @Stability(Stable) public void setDisableAutomatedBackup(@Nullable IResolvable value)
      Enable or disable scheduled backups.

    • getEngine

      @Stability(Stable) @Nullable public String getEngine()
      The configuration management engine to use.

    • setEngine

      @Stability(Stable) public void setEngine(@Nullable String value)
      The configuration management engine to use.

    • getEngineAttributes

      @Stability(Stable) @Nullable public Object getEngineAttributes()
      Optional engine attributes on a specified server.

      Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnServer.EngineAttributeProperty>

    • setEngineAttributes

      @Stability(Stable) public void setEngineAttributes(@Nullable IResolvable value)
      Optional engine attributes on a specified server.

    • setEngineAttributes

      @Stability(Stable) public void setEngineAttributes(@Nullable List<Object> value)
      Optional engine attributes on a specified server.

    • getEngineModel

      @Stability(Stable) @Nullable public String getEngineModel()
      The engine model of the server.

    • setEngineModel

      @Stability(Stable) public void setEngineModel(@Nullable String value)
      The engine model of the server.

    • getEngineVersion

      @Stability(Stable) @Nullable public String getEngineVersion()
      The major release version of the engine that you want to use.

    • setEngineVersion

      @Stability(Stable) public void setEngineVersion(@Nullable String value)
      The major release version of the engine that you want to use.

    • getKeyPair

      @Stability(Stable) @Nullable public String getKeyPair()
      The Amazon EC2 key pair to set for the instance.

    • setKeyPair

      @Stability(Stable) public void setKeyPair(@Nullable String value)
      The Amazon EC2 key pair to set for the instance.

    • getPreferredBackupWindow

      @Stability(Stable) @Nullable public String getPreferredBackupWindow()
      The start time for a one-hour period during which AWS OpsWorks CM backs up application-level data on your server if automated backups are enabled.

    • setPreferredBackupWindow

      @Stability(Stable) public void setPreferredBackupWindow(@Nullable String value)
      The start time for a one-hour period during which AWS OpsWorks CM backs up application-level data on your server if automated backups are enabled.

    • getPreferredMaintenanceWindow

      @Stability(Stable) @Nullable public String getPreferredMaintenanceWindow()
      The start time for a one-hour period each week during which AWS OpsWorks CM performs maintenance on the instance.

    • setPreferredMaintenanceWindow

      @Stability(Stable) public void setPreferredMaintenanceWindow(@Nullable String value)
      The start time for a one-hour period each week during which AWS OpsWorks CM performs maintenance on the instance.

    • getSecurityGroupIds

      @Stability(Stable) @Nullable public List<String> getSecurityGroupIds()
      A list of security group IDs to attach to the Amazon EC2 instance.

    • setSecurityGroupIds

      @Stability(Stable) public void setSecurityGroupIds(@Nullable List<String> value)
      A list of security group IDs to attach to the Amazon EC2 instance.

    • getSubnetIds

      @Stability(Stable) @Nullable public List<String> getSubnetIds()
      The IDs of subnets in which to launch the server EC2 instance.

    • setSubnetIds

      @Stability(Stable) public void setSubnetIds(@Nullable List<String> value)
      The IDs of subnets in which to launch the server EC2 instance.

    • getTagsRaw

      @Stability(Stable) @Nullable public List<CfnTag> getTagsRaw()
      A map that contains tag keys and tag values to attach to an AWS OpsWorks for Chef Automate or OpsWorks for Puppet Enterprise server.

    • setTagsRaw

      @Stability(Stable) public void setTagsRaw(@Nullable List<CfnTag> value)
      A map that contains tag keys and tag values to attach to an AWS OpsWorks for Chef Automate or OpsWorks for Puppet Enterprise server.