Package software.amazon.awscdk.services.opsworkscm

Class CfnServer

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.core.Construct
software.amazon.awscdk.core.CfnElement
software.amazon.awscdk.core.CfnRefElement
software.amazon.awscdk.core.CfnResource
software.amazon.awscdk.services.opsworkscm.CfnServer
All Implemented Interfaces:
IConstruct, IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:00.658Z") @Stability(Stable) public class CfnServer extends CfnResource implements IInspectable
A CloudFormation AWS::OpsWorksCM::Server.

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 AWS 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();

  • 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 Construct scope, @NotNull String id, @NotNull CfnServerProps props)
      Create a new AWS::OpsWorksCM::Server.

      Parameters:
      scope -
      • scope in which this resource is defined.
      This parameter is required.
      id -
      • scoped id of the resource.
      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

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      A map that contains tag keys and tag values to attach to an AWS OpsWorks for Chef Automate or OpsWorks for Puppet Enterprise server.

      • The key cannot be empty.
      • The key can be a maximum of 127 characters, and can contain only Unicode letters, numbers, or separators, or the following special characters: + - = . _ : / @
      • The value can be a maximum 255 characters, and contain only Unicode letters, numbers, or separators, or the following special characters: + - = . _ : / @
      • Leading and trailing spaces are trimmed from both the key and value.
      • A maximum of 50 user-applied tags is allowed for any AWS OpsWorks CM server.

    • 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.

      For example, m5.large .

    • setInstanceType

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

      For example, m5.large .

    • getServiceRoleArn

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

      Although the AWS OpsWorks management console typically creates the service role for you, if you are using the AWS CLI or API commands, run the service-role-creation.yaml AWS CloudFormation template, located at https://s3.amazonaws.com/opsworks-cm-us-east-1-prod-default-assets/misc/opsworks-cm-roles.yaml. This template creates a CloudFormation stack that includes the service role and instance profile that you need.

    • 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.

      Although the AWS OpsWorks management console typically creates the service role for you, if you are using the AWS CLI or API commands, run the service-role-creation.yaml AWS CloudFormation template, located at https://s3.amazonaws.com/opsworks-cm-us-east-1-prod-default-assets/misc/opsworks-cm-roles.yaml. This template creates a CloudFormation stack that includes the service role and instance profile that you need.

    • getAssociatePublicIpAddress

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

      Valid values are true or false . The default value is true .

    • setAssociatePublicIpAddress

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

      Valid values are true or false . The default value is true .

    • setAssociatePublicIpAddress

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

      Valid values are true or false . The default value is true .

    • 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.

      Whenever a new backup is created, AWS OpsWorks CM deletes the oldest backups if this number is exceeded. The default value is 1 .

    • setBackupRetentionCount

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

      Whenever a new backup is created, AWS OpsWorks CM deletes the oldest backups if this number is exceeded. The default value is 1 .

    • 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:.

      • You can provide either a self-signed, custom certificate, or the full certificate chain.
      • The certificate must be a valid X509 certificate, or a certificate chain in PEM format.
      • The certificate must be valid at the time of upload. A certificate can't be used before its validity period begins (the certificate's NotBefore date), or after it expires (the certificate's NotAfter date).
      • The certificate’s common name or subject alternative names (SANs), if present, must match the value of CustomDomain .
      • The certificate must match the value of CustomPrivateKey .

    • 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:.

      • You can provide either a self-signed, custom certificate, or the full certificate chain.
      • The certificate must be a valid X509 certificate, or a certificate chain in PEM format.
      • The certificate must be valid at the time of upload. A certificate can't be used before its validity period begins (the certificate's NotBefore date), or after it expires (the certificate's NotAfter date).
      • The certificate’s common name or subject alternative names (SANs), if present, must match the value of CustomDomain .
      • The certificate must match the value of CustomPrivateKey .

    • 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.

      Valid values are true or false . The default value is true .

    • setDisableAutomatedBackup

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

      Valid values are true or false . The default value is true .

    • setDisableAutomatedBackup

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

      Valid values are true or false . The default value is true .

    • getEngine

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

      Valid values include ChefAutomate and Puppet .

    • setEngine

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

      Valid values include ChefAutomate and Puppet .

    • getEngineAttributes

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

      Attributes accepted in a Chef createServer request: - CHEF_AUTOMATE_PIVOTAL_KEY : A base64-encoded RSA public key. The corresponding private key is required to access the Chef API. When no CHEF_AUTOMATE_PIVOTAL_KEY is set, a private key is generated and returned in the response. When you are specifying the value of CHEF_AUTOMATE_PIVOTAL_KEY as a parameter in the AWS CloudFormation console, you must add newline ( \n ) characters at the end of each line of the pivotal key value.

      • CHEF_AUTOMATE_ADMIN_PASSWORD : The password for the administrative user in the Chef Automate web-based dashboard. The password length is a minimum of eight characters, and a maximum of 32. The password can contain letters, numbers, and special characters (!/@#$%^&+=_). The password must contain at least one lower case letter, one upper case letter, one number, and one special character. When no CHEF_AUTOMATE_ADMIN_PASSWORD is set, one is generated and returned in the response.

      Attributes accepted in a Puppet createServer request: - PUPPET_ADMIN_PASSWORD : To work with the Puppet Enterprise console, a password must use ASCII characters.

      • PUPPET_R10K_REMOTE : The r10k remote is the URL of your control repository (for example, ssh://git@your.git-repo.com:user/control-repo.git). Specifying an r10k remote opens TCP port 8170.
      • PUPPET_R10K_PRIVATE_KEY : If you are using a private Git repository, add PUPPET_R10K_PRIVATE_KEY to specify a PEM-encoded private SSH key.

    • setEngineAttributes

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

      Attributes accepted in a Chef createServer request: - CHEF_AUTOMATE_PIVOTAL_KEY : A base64-encoded RSA public key. The corresponding private key is required to access the Chef API. When no CHEF_AUTOMATE_PIVOTAL_KEY is set, a private key is generated and returned in the response. When you are specifying the value of CHEF_AUTOMATE_PIVOTAL_KEY as a parameter in the AWS CloudFormation console, you must add newline ( \n ) characters at the end of each line of the pivotal key value.

      • CHEF_AUTOMATE_ADMIN_PASSWORD : The password for the administrative user in the Chef Automate web-based dashboard. The password length is a minimum of eight characters, and a maximum of 32. The password can contain letters, numbers, and special characters (!/@#$%^&+=_). The password must contain at least one lower case letter, one upper case letter, one number, and one special character. When no CHEF_AUTOMATE_ADMIN_PASSWORD is set, one is generated and returned in the response.

      Attributes accepted in a Puppet createServer request: - PUPPET_ADMIN_PASSWORD : To work with the Puppet Enterprise console, a password must use ASCII characters.

      • PUPPET_R10K_REMOTE : The r10k remote is the URL of your control repository (for example, ssh://git@your.git-repo.com:user/control-repo.git). Specifying an r10k remote opens TCP port 8170.
      • PUPPET_R10K_PRIVATE_KEY : If you are using a private Git repository, add PUPPET_R10K_PRIVATE_KEY to specify a PEM-encoded private SSH key.

    • setEngineAttributes

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

      Attributes accepted in a Chef createServer request: - CHEF_AUTOMATE_PIVOTAL_KEY : A base64-encoded RSA public key. The corresponding private key is required to access the Chef API. When no CHEF_AUTOMATE_PIVOTAL_KEY is set, a private key is generated and returned in the response. When you are specifying the value of CHEF_AUTOMATE_PIVOTAL_KEY as a parameter in the AWS CloudFormation console, you must add newline ( \n ) characters at the end of each line of the pivotal key value.

      • CHEF_AUTOMATE_ADMIN_PASSWORD : The password for the administrative user in the Chef Automate web-based dashboard. The password length is a minimum of eight characters, and a maximum of 32. The password can contain letters, numbers, and special characters (!/@#$%^&+=_). The password must contain at least one lower case letter, one upper case letter, one number, and one special character. When no CHEF_AUTOMATE_ADMIN_PASSWORD is set, one is generated and returned in the response.

      Attributes accepted in a Puppet createServer request: - PUPPET_ADMIN_PASSWORD : To work with the Puppet Enterprise console, a password must use ASCII characters.

      • PUPPET_R10K_REMOTE : The r10k remote is the URL of your control repository (for example, ssh://git@your.git-repo.com:user/control-repo.git). Specifying an r10k remote opens TCP port 8170.
      • PUPPET_R10K_PRIVATE_KEY : If you are using a private Git repository, add PUPPET_R10K_PRIVATE_KEY to specify a PEM-encoded private SSH key.

    • getEngineModel

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

      Valid values in this release include Monolithic for Puppet and Single for Chef.

    • setEngineModel

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

      Valid values in this release include Monolithic for Puppet and Single for Chef.

    • getEngineVersion

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

      For a Chef server, the valid value for EngineVersion is currently 2 . For a Puppet server, valid values are 2019 or 2017 .

    • setEngineVersion

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

      For a Chef server, the valid value for EngineVersion is currently 2 . For a Puppet server, valid values are 2019 or 2017 .

    • getKeyPair

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

      This parameter is optional; if desired, you may specify this parameter to connect to your instances by using SSH.

    • setKeyPair

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

      This parameter is optional; if desired, you may specify this parameter to connect to your instances by using SSH.

    • 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.

      Valid values must be specified in one of the following formats:

      • HH:MM for daily backups
      • DDD:HH:MM for weekly backups

      MM must be specified as 00 . The specified time is in coordinated universal time (UTC). The default value is a random, daily start time.

      Example: 08:00 , which represents a daily start time of 08:00 UTC.

      Example: Mon:08:00 , which represents a start time of every Monday at 08:00 UTC. (8:00 a.m.)

    • 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.

      Valid values must be specified in one of the following formats:

      • HH:MM for daily backups
      • DDD:HH:MM for weekly backups

      MM must be specified as 00 . The specified time is in coordinated universal time (UTC). The default value is a random, daily start time.

      Example: 08:00 , which represents a daily start time of 08:00 UTC.

      Example: Mon:08:00 , which represents a start time of every Monday at 08:00 UTC. (8:00 a.m.)

    • 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.

      Valid values must be specified in the following format: DDD:HH:MM . MM must be specified as 00 . The specified time is in coordinated universal time (UTC). The default value is a random one-hour period on Tuesday, Wednesday, or Friday. See TimeWindowDefinition for more information.

      Example: Mon:08:00 , which represents a start time of every Monday at 08:00 UTC. (8:00 a.m.)

    • 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.

      Valid values must be specified in the following format: DDD:HH:MM . MM must be specified as 00 . The specified time is in coordinated universal time (UTC). The default value is a random one-hour period on Tuesday, Wednesday, or Friday. See TimeWindowDefinition for more information.

      Example: Mon:08:00 , which represents a start time of every Monday at 08:00 UTC. (8:00 a.m.)

    • getSecurityGroupIds

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

      If you add this parameter, the specified security groups must be within the VPC that is specified by SubnetIds .

      If you do not specify this parameter, AWS OpsWorks CM creates one new security group that uses TCP ports 22 and 443, open to 0.0.0.0/0 (everyone).

    • setSecurityGroupIds

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

      If you add this parameter, the specified security groups must be within the VPC that is specified by SubnetIds .

      If you do not specify this parameter, AWS OpsWorks CM creates one new security group that uses TCP ports 22 and 443, open to 0.0.0.0/0 (everyone).

    • getSubnetIds

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

      Amazon EC2-Classic customers: This field is required. All servers must run within a VPC. The VPC must have "Auto Assign Public IP" enabled.

      EC2-VPC customers: This field is optional. If you do not specify subnet IDs, your EC2 instances are created in a default subnet that is selected by Amazon EC2. If you specify subnet IDs, the VPC must have "Auto Assign Public IP" enabled.

      For more information about supported Amazon EC2 platforms, see Supported Platforms .

    • setSubnetIds

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

      Amazon EC2-Classic customers: This field is required. All servers must run within a VPC. The VPC must have "Auto Assign Public IP" enabled.

      EC2-VPC customers: This field is optional. If you do not specify subnet IDs, your EC2 instances are created in a default subnet that is selected by Amazon EC2. If you specify subnet IDs, the VPC must have "Auto Assign Public IP" enabled.

      For more information about supported Amazon EC2 platforms, see Supported Platforms .