Package software.amazon.awssdk.services.opsworks.model

Interface Stack.Builder

All Superinterfaces:
Buildable, CopyableBuilder<Stack.Builder,Stack>, SdkBuilder<Stack.Builder,Stack>, SdkPojo
Enclosing class:
Stack
public static interface Stack.Builder extends SdkPojo, CopyableBuilder<Stack.Builder,Stack>

  • Method Details

    • stackId

      Stack.Builder stackId(String stackId)

      The stack ID.

      Parameters:
      stackId - The stack ID.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • name

      Stack.Builder name(String name)

      The stack name. Stack names can be a maximum of 64 characters.

      Parameters:
      name - The stack name. Stack names can be a maximum of 64 characters.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • arn

      Stack.Builder arn(String arn)

      The stack's ARN.

      Parameters:
      arn - The stack's ARN.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • region

      Stack.Builder region(String region)

      The stack Amazon Web Services Region, such as ap-northeast-2. For more information about Amazon Web Services Regions, see Regions and Endpoints.

      Parameters:
      region - The stack Amazon Web Services Region, such as ap-northeast-2. For more information about Amazon Web Services Regions, see Regions and Endpoints.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • vpcId

      Stack.Builder vpcId(String vpcId)

      The VPC ID; applicable only if the stack is running in a VPC.

      Parameters:
      vpcId - The VPC ID; applicable only if the stack is running in a VPC.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • attributesWithStrings

      Stack.Builder attributesWithStrings(Map<String,String> attributes)

      The stack's attributes.

      Parameters:
      attributes - The stack's attributes.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • attributes

      Stack.Builder attributes(Map<StackAttributesKeys,String> attributes)

      The stack's attributes.

      Parameters:
      attributes - The stack's attributes.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • serviceRoleArn

      Stack.Builder serviceRoleArn(String serviceRoleArn)

      The stack Identity and Access Management (IAM) role.

      Parameters:
      serviceRoleArn - The stack Identity and Access Management (IAM) role.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • defaultInstanceProfileArn

      Stack.Builder defaultInstanceProfileArn(String defaultInstanceProfileArn)

      The ARN of an IAM profile that is the default profile for all of the stack's EC2 instances. For more information about IAM ARNs, see Using Identifiers.

      Parameters:
      defaultInstanceProfileArn - The ARN of an IAM profile that is the default profile for all of the stack's EC2 instances. For more information about IAM ARNs, see Using Identifiers.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • defaultOs

      Stack.Builder defaultOs(String defaultOs)

      The stack's default operating system.

      Parameters:
      defaultOs - The stack's default operating system.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • hostnameTheme

      Stack.Builder hostnameTheme(String hostnameTheme)

      The stack host name theme, with spaces replaced by underscores.

      Parameters:
      hostnameTheme - The stack host name theme, with spaces replaced by underscores.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • defaultAvailabilityZone

      Stack.Builder defaultAvailabilityZone(String defaultAvailabilityZone)

      The stack's default Availability Zone. For more information, see Regions and Endpoints.

      Parameters:
      defaultAvailabilityZone - The stack's default Availability Zone. For more information, see Regions and Endpoints.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • defaultSubnetId

      Stack.Builder defaultSubnetId(String defaultSubnetId)

      The default subnet ID; applicable only if the stack is running in a VPC.

      Parameters:
      defaultSubnetId - The default subnet ID; applicable only if the stack is running in a VPC.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • customJson

      Stack.Builder customJson(String customJson)

      A JSON object that contains user-defined attributes to be added to the stack configuration and deployment attributes. You can use custom JSON to override the corresponding default stack configuration attribute values or to pass data to recipes. The string should be in the following format:

      "{\"key1\": \"value1\", \"key2\": \"value2\",...}"

      For more information on custom JSON, see Use Custom JSON to Modify the Stack Configuration Attributes.

      Parameters:
      customJson - A JSON object that contains user-defined attributes to be added to the stack configuration and deployment attributes. You can use custom JSON to override the corresponding default stack configuration attribute values or to pass data to recipes. The string should be in the following format:

      "{\"key1\": \"value1\", \"key2\": \"value2\",...}"

      For more information on custom JSON, see Use Custom JSON to Modify the Stack Configuration Attributes.

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

    • configurationManager

      Stack.Builder configurationManager(StackConfigurationManager configurationManager)

      The configuration manager.

      Parameters:
      configurationManager - The configuration manager.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • configurationManager

      default Stack.Builder configurationManager(Consumer<StackConfigurationManager.Builder> configurationManager)

      The configuration manager.

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

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to configurationManager(StackConfigurationManager).

      Parameters:
      configurationManager - a consumer that will call methods on StackConfigurationManager.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • chefConfiguration

      Stack.Builder chefConfiguration(ChefConfiguration chefConfiguration)

      A ChefConfiguration object that specifies whether to enable Berkshelf and the Berkshelf version. For more information, see Create a New Stack.

      Parameters:
      chefConfiguration - A ChefConfiguration object that specifies whether to enable Berkshelf and the Berkshelf version. For more information, see Create a New Stack.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • chefConfiguration

      default Stack.Builder chefConfiguration(Consumer<ChefConfiguration.Builder> chefConfiguration)

      A ChefConfiguration object that specifies whether to enable Berkshelf and the Berkshelf version. For more information, see Create a New Stack.

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

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to chefConfiguration(ChefConfiguration).

      Parameters:
      chefConfiguration - a consumer that will call methods on ChefConfiguration.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • useCustomCookbooks

      Stack.Builder useCustomCookbooks(Boolean useCustomCookbooks)

      Whether the stack uses custom cookbooks.

      Parameters:
      useCustomCookbooks - Whether the stack uses custom cookbooks.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • useOpsworksSecurityGroups

      Stack.Builder useOpsworksSecurityGroups(Boolean useOpsworksSecurityGroups)

      Whether the stack automatically associates the OpsWorks Stacks built-in security groups with the stack's layers.

      Parameters:
      useOpsworksSecurityGroups - Whether the stack automatically associates the OpsWorks Stacks built-in security groups with the stack's layers.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • customCookbooksSource

      Stack.Builder customCookbooksSource(Source customCookbooksSource)

      Contains the information required to retrieve an app or cookbook from a repository. For more information, see Adding Apps or Cookbooks and Recipes.

      Parameters:
      customCookbooksSource - Contains the information required to retrieve an app or cookbook from a repository. For more information, see Adding Apps or Cookbooks and Recipes.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • customCookbooksSource

      default Stack.Builder customCookbooksSource(Consumer<Source.Builder> customCookbooksSource)

      Contains the information required to retrieve an app or cookbook from a repository. For more information, see Adding Apps or Cookbooks and Recipes.

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

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to customCookbooksSource(Source).

      Parameters:
      customCookbooksSource - a consumer that will call methods on Source.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • defaultSshKeyName

      Stack.Builder defaultSshKeyName(String defaultSshKeyName)

      A default Amazon EC2 key pair for the stack's instances. You can override this value when you create or update an instance.

      Parameters:
      defaultSshKeyName - A default Amazon EC2 key pair for the stack's instances. You can override this value when you create or update an instance.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • createdAt

      Stack.Builder createdAt(String createdAt)

      The date when the stack was created.

      Parameters:
      createdAt - The date when the stack was created.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • defaultRootDeviceType

      Stack.Builder defaultRootDeviceType(String defaultRootDeviceType)

      The default root device type. This value is used by default for all instances in the stack, but you can override it when you create an instance. For more information, see Storage for the Root Device.

      Parameters:
      defaultRootDeviceType - The default root device type. This value is used by default for all instances in the stack, but you can override it when you create an instance. For more information, see Storage for the Root Device.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • defaultRootDeviceType

      Stack.Builder defaultRootDeviceType(RootDeviceType defaultRootDeviceType)

      The default root device type. This value is used by default for all instances in the stack, but you can override it when you create an instance. For more information, see Storage for the Root Device.

      Parameters:
      defaultRootDeviceType - The default root device type. This value is used by default for all instances in the stack, but you can override it when you create an instance. For more information, see Storage for the Root Device.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • agentVersion

      Stack.Builder agentVersion(String agentVersion)

      The agent version. This parameter is set to LATEST for auto-update. or a version number for a fixed agent version.

      Parameters:
      agentVersion - The agent version. This parameter is set to LATEST for auto-update. or a version number for a fixed agent version.
      Returns:
      Returns a reference to this object so that method calls can be chained together.