CapacityProvider (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.ecs.model.CapacityProvider

All Implemented Interfaces:: StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class CapacityProvider
extends Object
implements Serializable, Cloneable, StructuredPojo

The details of a capacity provider.

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

CapacityProvider()

Constructors
Constructor and Description
`CapacityProvider()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`CapacityProvider`	`clone()`
`boolean`	`equals(Object obj)`
`AutoScalingGroupProvider`	`getAutoScalingGroupProvider()` The Auto Scaling group settings for the capacity provider.
`String`	`getCapacityProviderArn()` The Amazon Resource Name (ARN) that identifies the capacity provider.
`String`	`getName()` The name of the capacity provider.
`String`	`getStatus()` The current status of the capacity provider.
`List<Tag>`	`getTags()` The metadata that you apply to the capacity provider to help you categorize and organize it.
`String`	`getUpdateStatus()` The update status of the capacity provider.
`String`	`getUpdateStatusReason()` The update status reason.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setAutoScalingGroupProvider(AutoScalingGroupProvider autoScalingGroupProvider)` The Auto Scaling group settings for the capacity provider.
`void`	`setCapacityProviderArn(String capacityProviderArn)` The Amazon Resource Name (ARN) that identifies the capacity provider.
`void`	`setName(String name)` The name of the capacity provider.
`void`	`setStatus(String status)` The current status of the capacity provider.
`void`	`setTags(Collection<Tag> tags)` The metadata that you apply to the capacity provider to help you categorize and organize it.
`void`	`setUpdateStatus(String updateStatus)` The update status of the capacity provider.
`void`	`setUpdateStatusReason(String updateStatusReason)` The update status reason.
`String`	`toString()` Returns a string representation of this object.
`CapacityProvider`	`withAutoScalingGroupProvider(AutoScalingGroupProvider autoScalingGroupProvider)` The Auto Scaling group settings for the capacity provider.
`CapacityProvider`	`withCapacityProviderArn(String capacityProviderArn)` The Amazon Resource Name (ARN) that identifies the capacity provider.
`CapacityProvider`	`withName(String name)` The name of the capacity provider.
`CapacityProvider`	`withStatus(CapacityProviderStatus status)` The current status of the capacity provider.
`CapacityProvider`	`withStatus(String status)` The current status of the capacity provider.
`CapacityProvider`	`withTags(Collection<Tag> tags)` The metadata that you apply to the capacity provider to help you categorize and organize it.
`CapacityProvider`	`withTags(Tag... tags)` The metadata that you apply to the capacity provider to help you categorize and organize it.
`CapacityProvider`	`withUpdateStatus(CapacityProviderUpdateStatus updateStatus)` The update status of the capacity provider.
`CapacityProvider`	`withUpdateStatus(String updateStatus)` The update status of the capacity provider.
`CapacityProvider`	`withUpdateStatusReason(String updateStatusReason)` The update status reason.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - CapacityProvider
```
public CapacityProvider()
```
- Method Detail
  - setCapacityProviderArn
```
public void setCapacityProviderArn(String capacityProviderArn)
```
    The Amazon Resource Name (ARN) that identifies the capacity provider.
    
    Parameters:
    
    capacityProviderArn - The Amazon Resource Name (ARN) that identifies the capacity provider.
  - getCapacityProviderArn
```
public String getCapacityProviderArn()
```
    The Amazon Resource Name (ARN) that identifies the capacity provider.
    
    Returns:
    
    The Amazon Resource Name (ARN) that identifies the capacity provider.
  - withCapacityProviderArn
```
public CapacityProvider withCapacityProviderArn(String capacityProviderArn)
```
    The Amazon Resource Name (ARN) that identifies the capacity provider.
    
    Parameters:
    
    capacityProviderArn - The Amazon Resource Name (ARN) that identifies the capacity provider.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setName
```
public void setName(String name)
```
    The name of the capacity provider.
    
    Parameters:
    
    name - The name of the capacity provider.
  - getName
```
public String getName()
```
    The name of the capacity provider.
    
    Returns:
    
    The name of the capacity provider.
  - withName
```
public CapacityProvider withName(String name)
```
    The name of the capacity provider.
    
    Parameters:
    
    name - The name of the capacity provider.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setStatus
```
public void setStatus(String status)
```
    The current status of the capacity provider. Only capacity providers in an ACTIVE state can be used in a cluster. When a capacity provider is successfully deleted, it will have an INACTIVE status.
    
    Parameters:
    
    status - The current status of the capacity provider. Only capacity providers in an ACTIVE state can be used in a cluster. When a capacity provider is successfully deleted, it will have an INACTIVE status.
    
    See Also:
    
    CapacityProviderStatus
  - getStatus
```
public String getStatus()
```
    The current status of the capacity provider. Only capacity providers in an ACTIVE state can be used in a cluster. When a capacity provider is successfully deleted, it will have an INACTIVE status.
    
    Returns:
    
    The current status of the capacity provider. Only capacity providers in an ACTIVE state can be used in a cluster. When a capacity provider is successfully deleted, it will have an INACTIVE status.
    
    See Also:
    
    CapacityProviderStatus
  - withStatus
```
public CapacityProvider withStatus(String status)
```
    The current status of the capacity provider. Only capacity providers in an ACTIVE state can be used in a cluster. When a capacity provider is successfully deleted, it will have an INACTIVE status.
    
    Parameters:
    
    status - The current status of the capacity provider. Only capacity providers in an ACTIVE state can be used in a cluster. When a capacity provider is successfully deleted, it will have an INACTIVE status.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    CapacityProviderStatus
  - withStatus
```
public CapacityProvider withStatus(CapacityProviderStatus status)
```
    The current status of the capacity provider. Only capacity providers in an ACTIVE state can be used in a cluster. When a capacity provider is successfully deleted, it will have an INACTIVE status.
    
    Parameters:
    
    status - The current status of the capacity provider. Only capacity providers in an ACTIVE state can be used in a cluster. When a capacity provider is successfully deleted, it will have an INACTIVE status.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    CapacityProviderStatus
  - setAutoScalingGroupProvider
```
public void setAutoScalingGroupProvider(AutoScalingGroupProvider autoScalingGroupProvider)
```
    The Auto Scaling group settings for the capacity provider.
    
    Parameters:
    
    autoScalingGroupProvider - The Auto Scaling group settings for the capacity provider.
  - getAutoScalingGroupProvider
```
public AutoScalingGroupProvider getAutoScalingGroupProvider()
```
    The Auto Scaling group settings for the capacity provider.
    
    Returns:
    
    The Auto Scaling group settings for the capacity provider.
  - withAutoScalingGroupProvider
```
public CapacityProvider withAutoScalingGroupProvider(AutoScalingGroupProvider autoScalingGroupProvider)
```
    The Auto Scaling group settings for the capacity provider.
    
    Parameters:
    
    autoScalingGroupProvider - The Auto Scaling group settings for the capacity provider.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setUpdateStatus
```
public void setUpdateStatus(String updateStatus)
```
    The update status of the capacity provider. The following are the possible states that will be returned.
    
    DELETE_IN_PROGRESS
    
    The capacity provider is in the process of being deleted.
    
    DELETE_COMPLETE
    
    The capacity provider has been successfully deleted and will have an INACTIVE status.
    
    DELETE_FAILED
    
    The capacity provider was unable to be deleted. The update status reason will provide further details about why the delete failed.
    
    Parameters:
    
    updateStatus - The update status of the capacity provider. The following are the possible states that will be returned.
    
    DELETE_IN_PROGRESS
    
    The capacity provider is in the process of being deleted.
    
    DELETE_COMPLETE
    
    The capacity provider has been successfully deleted and will have an INACTIVE status.
    
    DELETE_FAILED
    
    The capacity provider was unable to be deleted. The update status reason will provide further details about why the delete failed.
    
    See Also:
    
    CapacityProviderUpdateStatus
  - getUpdateStatus
```
public String getUpdateStatus()
```
    The update status of the capacity provider. The following are the possible states that will be returned.
    
    DELETE_IN_PROGRESS
    
    The capacity provider is in the process of being deleted.
    
    DELETE_COMPLETE
    
    The capacity provider has been successfully deleted and will have an INACTIVE status.
    
    DELETE_FAILED
    
    The capacity provider was unable to be deleted. The update status reason will provide further details about why the delete failed.
    
    Returns:
    
    The update status of the capacity provider. The following are the possible states that will be returned.
    
    DELETE_IN_PROGRESS
    
    The capacity provider is in the process of being deleted.
    
    DELETE_COMPLETE
    
    The capacity provider has been successfully deleted and will have an INACTIVE status.
    
    DELETE_FAILED
    
    The capacity provider was unable to be deleted. The update status reason will provide further details about why the delete failed.
    
    See Also:
    
    CapacityProviderUpdateStatus
  - withUpdateStatus
```
public CapacityProvider withUpdateStatus(String updateStatus)
```
    The update status of the capacity provider. The following are the possible states that will be returned.
    
    DELETE_IN_PROGRESS
    
    The capacity provider is in the process of being deleted.
    
    DELETE_COMPLETE
    
    The capacity provider has been successfully deleted and will have an INACTIVE status.
    
    DELETE_FAILED
    
    The capacity provider was unable to be deleted. The update status reason will provide further details about why the delete failed.
    
    Parameters:
    
    updateStatus - The update status of the capacity provider. The following are the possible states that will be returned.
    
    DELETE_IN_PROGRESS
    
    The capacity provider is in the process of being deleted.
    
    DELETE_COMPLETE
    
    The capacity provider has been successfully deleted and will have an INACTIVE status.
    
    DELETE_FAILED
    
    The capacity provider was unable to be deleted. The update status reason will provide further details about why the delete failed.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    CapacityProviderUpdateStatus
  - withUpdateStatus
```
public CapacityProvider withUpdateStatus(CapacityProviderUpdateStatus updateStatus)
```
    The update status of the capacity provider. The following are the possible states that will be returned.
    
    DELETE_IN_PROGRESS
    
    The capacity provider is in the process of being deleted.
    
    DELETE_COMPLETE
    
    The capacity provider has been successfully deleted and will have an INACTIVE status.
    
    DELETE_FAILED
    
    The capacity provider was unable to be deleted. The update status reason will provide further details about why the delete failed.
    
    Parameters:
    
    updateStatus - The update status of the capacity provider. The following are the possible states that will be returned.
    
    DELETE_IN_PROGRESS
    
    The capacity provider is in the process of being deleted.
    
    DELETE_COMPLETE
    
    The capacity provider has been successfully deleted and will have an INACTIVE status.
    
    DELETE_FAILED
    
    The capacity provider was unable to be deleted. The update status reason will provide further details about why the delete failed.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    CapacityProviderUpdateStatus
  - setUpdateStatusReason
```
public void setUpdateStatusReason(String updateStatusReason)
```
    The update status reason. This provides further details about the update status for the capacity provider.
    
    Parameters:
    
    updateStatusReason - The update status reason. This provides further details about the update status for the capacity provider.
  - getUpdateStatusReason
```
public String getUpdateStatusReason()
```
    The update status reason. This provides further details about the update status for the capacity provider.
    
    Returns:
    
    The update status reason. This provides further details about the update status for the capacity provider.
  - withUpdateStatusReason
```
public CapacityProvider withUpdateStatusReason(String updateStatusReason)
```
    The update status reason. This provides further details about the update status for the capacity provider.
    
    Parameters:
    
    updateStatusReason - The update status reason. This provides further details about the update status for the capacity provider.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getTags
```
public List<Tag> getTags()
```
    The metadata that you apply to the capacity provider to help you categorize and organize it. Each tag consists of a key and an optional value, both of which you define.
    
    The following basic restrictions apply to tags:
    - Maximum number of tags per resource - 50
    - For each resource, each tag key must be unique, and each tag key can have only one value.
    - Maximum key length - 128 Unicode characters in UTF-8
    - Maximum value length - 256 Unicode characters in UTF-8
    - If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
    - Tag keys and values are case-sensitive.
    - Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.
    Returns:
    The metadata that you apply to the capacity provider to help you categorize and organize it. Each tag consists of a key and an optional value, both of which you define.
    
    The following basic restrictions apply to tags:
    
    Maximum number of tags per resource - 50
    
    For each resource, each tag key must be unique, and each tag key can have only one value.
    
    Maximum key length - 128 Unicode characters in UTF-8
    
    Maximum value length - 256 Unicode characters in UTF-8
    
    If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
    
    Tag keys and values are case-sensitive.
    
    Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.
  - setTags
```
public void setTags(Collection<Tag> tags)
```
    The metadata that you apply to the capacity provider to help you categorize and organize it. Each tag consists of a key and an optional value, both of which you define.
    
    The following basic restrictions apply to tags:
    - Maximum number of tags per resource - 50
    - For each resource, each tag key must be unique, and each tag key can have only one value.
    - Maximum key length - 128 Unicode characters in UTF-8
    - Maximum value length - 256 Unicode characters in UTF-8
    - If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
    - Tag keys and values are case-sensitive.
    - Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.
    Parameters:
    tags - The metadata that you apply to the capacity provider to help you categorize and organize it. Each tag consists of a key and an optional value, both of which you define.
    
    The following basic restrictions apply to tags:
    
    Maximum number of tags per resource - 50
    
    For each resource, each tag key must be unique, and each tag key can have only one value.
    
    Maximum key length - 128 Unicode characters in UTF-8
    
    Maximum value length - 256 Unicode characters in UTF-8
    
    If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
    
    Tag keys and values are case-sensitive.
    
    Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.
  - withTags
```
public CapacityProvider withTags(Tag... tags)
```
    The metadata that you apply to the capacity provider to help you categorize and organize it. Each tag consists of a key and an optional value, both of which you define.
    
    The following basic restrictions apply to tags:
    - Maximum number of tags per resource - 50
    - For each resource, each tag key must be unique, and each tag key can have only one value.
    - Maximum key length - 128 Unicode characters in UTF-8
    - Maximum value length - 256 Unicode characters in UTF-8
    - If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
    - Tag keys and values are case-sensitive.
    - Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.
    NOTE: This method appends the values to the existing list (if any). Use setTags(java.util.Collection) or withTags(java.util.Collection) if you want to override the existing values.
    Parameters:
    tags - The metadata that you apply to the capacity provider to help you categorize and organize it. Each tag consists of a key and an optional value, both of which you define.
    
    The following basic restrictions apply to tags:
    
    Maximum number of tags per resource - 50
    
    For each resource, each tag key must be unique, and each tag key can have only one value.
    
    Maximum key length - 128 Unicode characters in UTF-8
    
    Maximum value length - 256 Unicode characters in UTF-8
    
    If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
    
    Tag keys and values are case-sensitive.
    
    Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withTags
```
public CapacityProvider withTags(Collection<Tag> tags)
```
    The metadata that you apply to the capacity provider to help you categorize and organize it. Each tag consists of a key and an optional value, both of which you define.
    
    The following basic restrictions apply to tags:
    - Maximum number of tags per resource - 50
    - For each resource, each tag key must be unique, and each tag key can have only one value.
    - Maximum key length - 128 Unicode characters in UTF-8
    - Maximum value length - 256 Unicode characters in UTF-8
    - If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
    - Tag keys and values are case-sensitive.
    - Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.
    Parameters:
    tags - The metadata that you apply to the capacity provider to help you categorize and organize it. Each tag consists of a key and an optional value, both of which you define.
    
    The following basic restrictions apply to tags:
    
    Maximum number of tags per resource - 50
    
    For each resource, each tag key must be unique, and each tag key can have only one value.
    
    Maximum key length - 128 Unicode characters in UTF-8
    
    Maximum value length - 256 Unicode characters in UTF-8
    
    If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
    
    Tag keys and values are case-sensitive.
    
    Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public CapacityProvider clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Did this page help you?

Class CapacityProvider

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

CapacityProvider

Method Detail

setCapacityProviderArn

getCapacityProviderArn

withCapacityProviderArn

setName

getName

withName

setStatus

getStatus

withStatus

withStatus

setAutoScalingGroupProvider

getAutoScalingGroupProvider

withAutoScalingGroupProvider

setUpdateStatus

getUpdateStatus

withUpdateStatus

withUpdateStatus

setUpdateStatusReason

getUpdateStatusReason

withUpdateStatusReason

getTags

setTags

withTags

withTags

toString

equals

hashCode

clone

marshall