Class Stack

java.lang.Object
software.amazon.awssdk.services.opsworks.model.Stack
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<Stack.Builder,Stack>
@Generated("software.amazon.awssdk:codegen") public final class Stack extends Object implements SdkPojo, Serializable, ToCopyableBuilder<Stack.Builder,Stack>

Describes a stack.

See Also:

  • Method Details

    • stackId

      public final String stackId()

      The stack ID.

      Returns:
      The stack ID.

    • name

      public final String name()

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

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

    • arn

      public final String arn()

      The stack's ARN.

      Returns:
      The stack's ARN.

    • region

      public final 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.

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

    • vpcId

      public final String vpcId()

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

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

    • attributes

      public final Map<StackAttributesKeys,String> attributes()

      The stack's attributes.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasAttributes() method.

      Returns:
      The stack's attributes.

    • hasAttributes

      public final boolean hasAttributes()
      For responses, this returns true if the service returned a value for the Attributes property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • attributesAsStrings

      public final Map<String,String> attributesAsStrings()

      The stack's attributes.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasAttributes() method.

      Returns:
      The stack's attributes.

    • serviceRoleArn

      public final String serviceRoleArn()

      The stack Identity and Access Management (IAM) role.

      Returns:
      The stack Identity and Access Management (IAM) role.

    • defaultInstanceProfileArn

      public final 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.

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

    • defaultOs

      public final String defaultOs()

      The stack's default operating system.

      Returns:
      The stack's default operating system.

    • hostnameTheme

      public final String hostnameTheme()

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

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

    • defaultAvailabilityZone

      public final String defaultAvailabilityZone()

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

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

    • defaultSubnetId

      public final String defaultSubnetId()

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

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

    • customJson

      public final 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.

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

    • configurationManager

      public final StackConfigurationManager configurationManager()

      The configuration manager.

      Returns:
      The configuration manager.

    • chefConfiguration

      public final ChefConfiguration chefConfiguration()

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

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

    • useCustomCookbooks

      public final Boolean useCustomCookbooks()

      Whether the stack uses custom cookbooks.

      Returns:
      Whether the stack uses custom cookbooks.

    • useOpsworksSecurityGroups

      public final Boolean useOpsworksSecurityGroups()

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

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

    • customCookbooksSource

      public final 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.

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

    • defaultSshKeyName

      public final 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.

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

    • createdAt

      public final String createdAt()

      The date when the stack was created.

      Returns:
      The date when the stack was created.

    • defaultRootDeviceType

      public final 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.

      If the service returns an enum value that is not available in the current SDK version, defaultRootDeviceType will return RootDeviceType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from defaultRootDeviceTypeAsString().

      Returns:
      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.
      See Also:

    • defaultRootDeviceTypeAsString

      public final String defaultRootDeviceTypeAsString()

      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.

      If the service returns an enum value that is not available in the current SDK version, defaultRootDeviceType will return RootDeviceType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from defaultRootDeviceTypeAsString().

      Returns:
      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.
      See Also:

    • agentVersion

      public final String agentVersion()

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

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

    • toBuilder

      public Stack.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<Stack.Builder,Stack>
      Returns:
      a builder for type T

    • builder

      public static Stack.Builder builder()

    • serializableBuilderClass

      public static Class<? extends Stack.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.