Package software.amazon.awssdk.services.opsworkscm.model

Interface Server.Builder

    • Method Detail

      • associatePublicIpAddress

        Server.Builder associatePublicIpAddress​(Boolean associatePublicIpAddress)

        Associate a public IP address with a server that you are launching.

        Parameters:
        associatePublicIpAddress - Associate a public IP address with a server that you are launching.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • backupRetentionCount

        Server.Builder backupRetentionCount​(Integer backupRetentionCount)

        The number of automated backups to keep.

        Parameters:
        backupRetentionCount - The number of automated backups to keep.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • serverName

        Server.Builder serverName​(String serverName)

        The name of the server.

        Parameters:
        serverName - The name of the server.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • createdAt

        Server.Builder createdAt​(Instant createdAt)

        Time stamp of server creation. Example 2016-07-29T13:38:47.520Z

        Parameters:
        createdAt - Time stamp of server creation. Example 2016-07-29T13:38:47.520Z
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • cloudFormationStackArn

        Server.Builder cloudFormationStackArn​(String cloudFormationStackArn)

        The ARN of the CloudFormation stack that was used to create the server.

        Parameters:
        cloudFormationStackArn - The ARN of the CloudFormation stack that was used to create the server.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • customDomain

        Server.Builder customDomain​(String customDomain)

        An optional public endpoint of a server, such as https://aws.my-company.com. You cannot access the server by using the Endpoint value if the server has a CustomDomain specified.

        Parameters:
        customDomain - An optional public endpoint of a server, such as https://aws.my-company.com. You cannot access the server by using the Endpoint value if the server has a CustomDomain specified.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • disableAutomatedBackup

        Server.Builder disableAutomatedBackup​(Boolean disableAutomatedBackup)

        Disables automated backups. The number of stored backups is dependent on the value of PreferredBackupCount.

        Parameters:
        disableAutomatedBackup - Disables automated backups. The number of stored backups is dependent on the value of PreferredBackupCount.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • endpoint

        Server.Builder endpoint​(String endpoint)

        A DNS name that can be used to access the engine. Example: myserver-asdfghjkl.us-east-1.opsworks.io. You cannot access the server by using the Endpoint value if the server has a CustomDomain specified.

        Parameters:
        endpoint - A DNS name that can be used to access the engine. Example: myserver-asdfghjkl.us-east-1.opsworks.io. You cannot access the server by using the Endpoint value if the server has a CustomDomain specified.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • engine

        Server.Builder engine​(String engine)

        The engine type of the server. Valid values in this release include ChefAutomate and Puppet.

        Parameters:
        engine - The engine type of the server. Valid values in this release include ChefAutomate and Puppet.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • engineModel

        Server.Builder engineModel​(String engineModel)

        The engine model of the server. Valid values in this release include Monolithic for Puppet and Single for Chef.

        Parameters:
        engineModel - The engine model of the server. Valid values in this release include Monolithic for Puppet and Single for Chef.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • engineAttributes

        Server.Builder engineAttributes​(Collection<EngineAttribute> engineAttributes)

        The response of a createServer() request returns the master credential to access the server in EngineAttributes. These credentials are not stored by AWS OpsWorks CM; they are returned only as part of the result of createServer().

        Attributes returned in a createServer response for Chef

        • CHEF_AUTOMATE_PIVOTAL_KEY: A base64-encoded RSA private key that is generated by AWS OpsWorks for Chef Automate. This private key is required to access the Chef API.

        • CHEF_STARTER_KIT: A base64-encoded ZIP file. The ZIP file contains a Chef starter kit, which includes a README, a configuration file, and the required RSA private key. Save this file, unzip it, and then change to the directory where you've unzipped the file contents. From this directory, you can run Knife commands.

        Attributes returned in a createServer response for Puppet

        • PUPPET_STARTER_KIT: A base64-encoded ZIP file. The ZIP file contains a Puppet starter kit, including a README and a required private key. Save this file, unzip it, and then change to the directory where you've unzipped the file contents.

        • PUPPET_ADMIN_PASSWORD: An administrator password that you can use to sign in to the Puppet Enterprise console after the server is online.

        Parameters:
        engineAttributes - The response of a createServer() request returns the master credential to access the server in EngineAttributes. These credentials are not stored by AWS OpsWorks CM; they are returned only as part of the result of createServer().

        Attributes returned in a createServer response for Chef

        • CHEF_AUTOMATE_PIVOTAL_KEY: A base64-encoded RSA private key that is generated by AWS OpsWorks for Chef Automate. This private key is required to access the Chef API.

        • CHEF_STARTER_KIT: A base64-encoded ZIP file. The ZIP file contains a Chef starter kit, which includes a README, a configuration file, and the required RSA private key. Save this file, unzip it, and then change to the directory where you've unzipped the file contents. From this directory, you can run Knife commands.

        Attributes returned in a createServer response for Puppet

        • PUPPET_STARTER_KIT: A base64-encoded ZIP file. The ZIP file contains a Puppet starter kit, including a README and a required private key. Save this file, unzip it, and then change to the directory where you've unzipped the file contents.

        • PUPPET_ADMIN_PASSWORD: An administrator password that you can use to sign in to the Puppet Enterprise console after the server is online.

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • engineAttributes

        Server.Builder engineAttributes​(EngineAttribute... engineAttributes)

        The response of a createServer() request returns the master credential to access the server in EngineAttributes. These credentials are not stored by AWS OpsWorks CM; they are returned only as part of the result of createServer().

        Attributes returned in a createServer response for Chef

        • CHEF_AUTOMATE_PIVOTAL_KEY: A base64-encoded RSA private key that is generated by AWS OpsWorks for Chef Automate. This private key is required to access the Chef API.

        • CHEF_STARTER_KIT: A base64-encoded ZIP file. The ZIP file contains a Chef starter kit, which includes a README, a configuration file, and the required RSA private key. Save this file, unzip it, and then change to the directory where you've unzipped the file contents. From this directory, you can run Knife commands.

        Attributes returned in a createServer response for Puppet

        • PUPPET_STARTER_KIT: A base64-encoded ZIP file. The ZIP file contains a Puppet starter kit, including a README and a required private key. Save this file, unzip it, and then change to the directory where you've unzipped the file contents.

        • PUPPET_ADMIN_PASSWORD: An administrator password that you can use to sign in to the Puppet Enterprise console after the server is online.

        Parameters:
        engineAttributes - The response of a createServer() request returns the master credential to access the server in EngineAttributes. These credentials are not stored by AWS OpsWorks CM; they are returned only as part of the result of createServer().

        Attributes returned in a createServer response for Chef

        • CHEF_AUTOMATE_PIVOTAL_KEY: A base64-encoded RSA private key that is generated by AWS OpsWorks for Chef Automate. This private key is required to access the Chef API.

        • CHEF_STARTER_KIT: A base64-encoded ZIP file. The ZIP file contains a Chef starter kit, which includes a README, a configuration file, and the required RSA private key. Save this file, unzip it, and then change to the directory where you've unzipped the file contents. From this directory, you can run Knife commands.

        Attributes returned in a createServer response for Puppet

        • PUPPET_STARTER_KIT: A base64-encoded ZIP file. The ZIP file contains a Puppet starter kit, including a README and a required private key. Save this file, unzip it, and then change to the directory where you've unzipped the file contents.

        • PUPPET_ADMIN_PASSWORD: An administrator password that you can use to sign in to the Puppet Enterprise console after the server is online.

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • engineAttributes

        Server.Builder engineAttributes​(Consumer<EngineAttribute.Builder>... engineAttributes)

        The response of a createServer() request returns the master credential to access the server in EngineAttributes. These credentials are not stored by AWS OpsWorks CM; they are returned only as part of the result of createServer().

        Attributes returned in a createServer response for Chef

        • CHEF_AUTOMATE_PIVOTAL_KEY: A base64-encoded RSA private key that is generated by AWS OpsWorks for Chef Automate. This private key is required to access the Chef API.

        • CHEF_STARTER_KIT: A base64-encoded ZIP file. The ZIP file contains a Chef starter kit, which includes a README, a configuration file, and the required RSA private key. Save this file, unzip it, and then change to the directory where you've unzipped the file contents. From this directory, you can run Knife commands.

        Attributes returned in a createServer response for Puppet

        • PUPPET_STARTER_KIT: A base64-encoded ZIP file. The ZIP file contains a Puppet starter kit, including a README and a required private key. Save this file, unzip it, and then change to the directory where you've unzipped the file contents.

        • PUPPET_ADMIN_PASSWORD: An administrator password that you can use to sign in to the Puppet Enterprise console after the server is online.

        This is a convenience method that creates an instance of the EngineAttribute.Builder avoiding the need to create one manually via EngineAttribute.builder().

        When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #engineAttributes(List).

        Parameters:
        engineAttributes - a consumer that will call methods on EngineAttribute.Builder
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        #engineAttributes(java.util.Collection)

      • engineVersion

        Server.Builder engineVersion​(String engineVersion)

        The engine version of the server. For a Chef server, the valid value for EngineVersion is currently 2. For a Puppet server, specify either 2019 or 2017.

        Parameters:
        engineVersion - The engine version of the server. For a Chef server, the valid value for EngineVersion is currently 2. For a Puppet server, specify either 2019 or 2017.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • instanceProfileArn

        Server.Builder instanceProfileArn​(String instanceProfileArn)

        The instance profile ARN of the server.

        Parameters:
        instanceProfileArn - The instance profile ARN of the server.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • instanceType

        Server.Builder instanceType​(String instanceType)

        The instance type for the server, as specified in the CloudFormation stack. This might not be the same instance type that is shown in the EC2 console.

        Parameters:
        instanceType - The instance type for the server, as specified in the CloudFormation stack. This might not be the same instance type that is shown in the EC2 console.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • keyPair

        Server.Builder keyPair​(String keyPair)

        The key pair associated with the server.

        Parameters:
        keyPair - The key pair associated with the server.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • maintenanceStatus

        Server.Builder maintenanceStatus​(String maintenanceStatus)

        The status of the most recent server maintenance run. Shows SUCCESS or FAILED.

        Parameters:
        maintenanceStatus - The status of the most recent server maintenance run. Shows SUCCESS or FAILED.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        MaintenanceStatus, MaintenanceStatus

      • maintenanceStatus

        Server.Builder maintenanceStatus​(MaintenanceStatus maintenanceStatus)

        The status of the most recent server maintenance run. Shows SUCCESS or FAILED.

        Parameters:
        maintenanceStatus - The status of the most recent server maintenance run. Shows SUCCESS or FAILED.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        MaintenanceStatus, MaintenanceStatus

      • preferredMaintenanceWindow

        Server.Builder preferredMaintenanceWindow​(String preferredMaintenanceWindow)

        The preferred maintenance period specified for the server.

        Parameters:
        preferredMaintenanceWindow - The preferred maintenance period specified for the server.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • preferredBackupWindow

        Server.Builder preferredBackupWindow​(String preferredBackupWindow)

        The preferred backup period specified for the server.

        Parameters:
        preferredBackupWindow - The preferred backup period specified for the server.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • securityGroupIds

        Server.Builder securityGroupIds​(Collection<String> securityGroupIds)

        The security group IDs for the server, as specified in the CloudFormation stack. These might not be the same security groups that are shown in the EC2 console.

        Parameters:
        securityGroupIds - The security group IDs for the server, as specified in the CloudFormation stack. These might not be the same security groups that are shown in the EC2 console.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • securityGroupIds

        Server.Builder securityGroupIds​(String... securityGroupIds)

        The security group IDs for the server, as specified in the CloudFormation stack. These might not be the same security groups that are shown in the EC2 console.

        Parameters:
        securityGroupIds - The security group IDs for the server, as specified in the CloudFormation stack. These might not be the same security groups that are shown in the EC2 console.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • serviceRoleArn

        Server.Builder serviceRoleArn​(String serviceRoleArn)

        The service role ARN used to create the server.

        Parameters:
        serviceRoleArn - The service role ARN used to create the server.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • status

        Server.Builder status​(String status)

        The server's status. This field displays the states of actions in progress, such as creating, running, or backing up the server, as well as the server's health state.

        Parameters:
        status - The server's status. This field displays the states of actions in progress, such as creating, running, or backing up the server, as well as the server's health state.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        ServerStatus, ServerStatus

      • status

        Server.Builder status​(ServerStatus status)

        The server's status. This field displays the states of actions in progress, such as creating, running, or backing up the server, as well as the server's health state.

        Parameters:
        status - The server's status. This field displays the states of actions in progress, such as creating, running, or backing up the server, as well as the server's health state.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        ServerStatus, ServerStatus

      • statusReason

        Server.Builder statusReason​(String statusReason)

        Depending on the server status, this field has either a human-readable message (such as a create or backup error), or an escaped block of JSON (used for health check results).

        Parameters:
        statusReason - Depending on the server status, this field has either a human-readable message (such as a create or backup error), or an escaped block of JSON (used for health check results).
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • subnetIds

        Server.Builder subnetIds​(Collection<String> subnetIds)

        The subnet IDs specified in a CreateServer request.

        Parameters:
        subnetIds - The subnet IDs specified in a CreateServer request.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • subnetIds

        Server.Builder subnetIds​(String... subnetIds)

        The subnet IDs specified in a CreateServer request.

        Parameters:
        subnetIds - The subnet IDs specified in a CreateServer request.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • serverArn

        Server.Builder serverArn​(String serverArn)

        The ARN of the server.

        Parameters:
        serverArn - The ARN of the server.
        Returns:
        Returns a reference to this object so that method calls can be chained together.