com.amazonaws.services.cloudformation.model

Class ListTypesRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.cloudformation.model.ListTypesRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

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

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
ListTypesRequest()

Method Summary

Modifier and Type	Method and Description
ListTypesRequest	clone()
boolean	equals(Object obj)
String	getDeprecatedStatus() The deprecation status of the types that you want to get summary information about.
Integer	getMaxResults() The maximum number of results to be returned with a single call.
String	getNextToken() If the previous paginated request didn't return all of the remaining results, the response object's NextToken parameter value is set to a token.
String	getProvisioningType() The provisioning behavior of the type.
String	getVisibility() The scope at which the type is visible and usable in CloudFormation operations.
int	hashCode()
void	setDeprecatedStatus(String deprecatedStatus) The deprecation status of the types that you want to get summary information about.
void	setMaxResults(Integer maxResults) The maximum number of results to be returned with a single call.
void	setNextToken(String nextToken) If the previous paginated request didn't return all of the remaining results, the response object's NextToken parameter value is set to a token.
void	setProvisioningType(String provisioningType) The provisioning behavior of the type.
void	setVisibility(String visibility) The scope at which the type is visible and usable in CloudFormation operations.
String	toString() Returns a string representation of this object.
ListTypesRequest	withDeprecatedStatus(DeprecatedStatus deprecatedStatus) The deprecation status of the types that you want to get summary information about.
ListTypesRequest	withDeprecatedStatus(String deprecatedStatus) The deprecation status of the types that you want to get summary information about.
ListTypesRequest	withMaxResults(Integer maxResults) The maximum number of results to be returned with a single call.
ListTypesRequest	withNextToken(String nextToken) If the previous paginated request didn't return all of the remaining results, the response object's NextToken parameter value is set to a token.
ListTypesRequest	withProvisioningType(ProvisioningType provisioningType) The provisioning behavior of the type.
ListTypesRequest	withProvisioningType(String provisioningType) The provisioning behavior of the type.
ListTypesRequest	withVisibility(String visibility) The scope at which the type is visible and usable in CloudFormation operations.
ListTypesRequest	withVisibility(Visibility visibility) The scope at which the type is visible and usable in CloudFormation operations.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, copyBaseTo, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ListTypesRequest

public ListTypesRequest()

Method Detail

setVisibility

public void setVisibility(String visibility)

The scope at which the type is visible and usable in CloudFormation operations.

Valid values include:

• PRIVATE: The type is only visible and usable within the account in which it is registered. Currently, AWS CloudFormation marks any types you create as PRIVATE.

• PUBLIC: The type is publically visible and usable within any Amazon account.

The default is PRIVATE.

Parameters:

visibility - The scope at which the type is visible and usable in CloudFormation operations.

Valid values include:

• PRIVATE: The type is only visible and usable within the account in which it is registered. Currently, AWS CloudFormation marks any types you create as PRIVATE.

• PUBLIC: The type is publically visible and usable within any Amazon account.

The default is PRIVATE.

See Also:

Visibility

getVisibility

public String getVisibility()

The scope at which the type is visible and usable in CloudFormation operations.

Valid values include:

• PRIVATE: The type is only visible and usable within the account in which it is registered. Currently, AWS CloudFormation marks any types you create as PRIVATE.

• PUBLIC: The type is publically visible and usable within any Amazon account.

The default is PRIVATE.

Returns:

The scope at which the type is visible and usable in CloudFormation operations.

Valid values include:

• PRIVATE: The type is only visible and usable within the account in which it is registered. Currently, AWS CloudFormation marks any types you create as PRIVATE.

• PUBLIC: The type is publically visible and usable within any Amazon account.

The default is PRIVATE.

See Also:

Visibility

withVisibility

public ListTypesRequest withVisibility(String visibility)

The scope at which the type is visible and usable in CloudFormation operations.

Valid values include:

• PRIVATE: The type is only visible and usable within the account in which it is registered. Currently, AWS CloudFormation marks any types you create as PRIVATE.

• PUBLIC: The type is publically visible and usable within any Amazon account.

The default is PRIVATE.

Parameters:

visibility - The scope at which the type is visible and usable in CloudFormation operations.

Valid values include:

• PRIVATE: The type is only visible and usable within the account in which it is registered. Currently, AWS CloudFormation marks any types you create as PRIVATE.

• PUBLIC: The type is publically visible and usable within any Amazon account.

The default is PRIVATE.

Returns:

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

See Also:

Visibility

withVisibility

public ListTypesRequest withVisibility(Visibility visibility)

The scope at which the type is visible and usable in CloudFormation operations.

Valid values include:

• PRIVATE: The type is only visible and usable within the account in which it is registered. Currently, AWS CloudFormation marks any types you create as PRIVATE.

• PUBLIC: The type is publically visible and usable within any Amazon account.

The default is PRIVATE.

Parameters:

visibility - The scope at which the type is visible and usable in CloudFormation operations.

Valid values include:

• PRIVATE: The type is only visible and usable within the account in which it is registered. Currently, AWS CloudFormation marks any types you create as PRIVATE.

• PUBLIC: The type is publically visible and usable within any Amazon account.

The default is PRIVATE.

Returns:

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

See Also:

Visibility

setProvisioningType

public void setProvisioningType(String provisioningType)

The provisioning behavior of the type. AWS CloudFormation determines the provisioning type during registration, based on the types of handlers in the schema handler package submitted.

Valid values include:

• FULLY_MUTABLE: The type includes an update handler to process updates to the type during stack update operations.

• IMMUTABLE: The type does not include an update handler, so the type cannot be updated and must instead be replaced during stack update operations.

• NON_PROVISIONABLE: The type does not include create, read, and delete handlers, and therefore cannot actually be provisioned.

Parameters:

provisioningType - The provisioning behavior of the type. AWS CloudFormation determines the provisioning type during registration, based on the types of handlers in the schema handler package submitted.

Valid values include:

• FULLY_MUTABLE: The type includes an update handler to process updates to the type during stack update operations.

• IMMUTABLE: The type does not include an update handler, so the type cannot be updated and must instead be replaced during stack update operations.

• NON_PROVISIONABLE: The type does not include create, read, and delete handlers, and therefore cannot actually be provisioned.

See Also:

ProvisioningType

getProvisioningType

public String getProvisioningType()

The provisioning behavior of the type. AWS CloudFormation determines the provisioning type during registration, based on the types of handlers in the schema handler package submitted.

Valid values include:

• FULLY_MUTABLE: The type includes an update handler to process updates to the type during stack update operations.

• IMMUTABLE: The type does not include an update handler, so the type cannot be updated and must instead be replaced during stack update operations.

• NON_PROVISIONABLE: The type does not include create, read, and delete handlers, and therefore cannot actually be provisioned.

Returns:

The provisioning behavior of the type. AWS CloudFormation determines the provisioning type during registration, based on the types of handlers in the schema handler package submitted.

Valid values include:

• FULLY_MUTABLE: The type includes an update handler to process updates to the type during stack update operations.

• IMMUTABLE: The type does not include an update handler, so the type cannot be updated and must instead be replaced during stack update operations.

• NON_PROVISIONABLE: The type does not include create, read, and delete handlers, and therefore cannot actually be provisioned.

See Also:

ProvisioningType

withProvisioningType

public ListTypesRequest withProvisioningType(String provisioningType)

The provisioning behavior of the type. AWS CloudFormation determines the provisioning type during registration, based on the types of handlers in the schema handler package submitted.

Valid values include:

• FULLY_MUTABLE: The type includes an update handler to process updates to the type during stack update operations.

• IMMUTABLE: The type does not include an update handler, so the type cannot be updated and must instead be replaced during stack update operations.

• NON_PROVISIONABLE: The type does not include create, read, and delete handlers, and therefore cannot actually be provisioned.

Parameters:

provisioningType - The provisioning behavior of the type. AWS CloudFormation determines the provisioning type during registration, based on the types of handlers in the schema handler package submitted.

Valid values include:

• FULLY_MUTABLE: The type includes an update handler to process updates to the type during stack update operations.

• IMMUTABLE: The type does not include an update handler, so the type cannot be updated and must instead be replaced during stack update operations.

• NON_PROVISIONABLE: The type does not include create, read, and delete handlers, and therefore cannot actually be provisioned.

Returns:

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

See Also:

ProvisioningType

withProvisioningType

public ListTypesRequest withProvisioningType(ProvisioningType provisioningType)

The provisioning behavior of the type. AWS CloudFormation determines the provisioning type during registration, based on the types of handlers in the schema handler package submitted.

Valid values include:

• FULLY_MUTABLE: The type includes an update handler to process updates to the type during stack update operations.

• IMMUTABLE: The type does not include an update handler, so the type cannot be updated and must instead be replaced during stack update operations.

• NON_PROVISIONABLE: The type does not include create, read, and delete handlers, and therefore cannot actually be provisioned.

Parameters:

provisioningType - The provisioning behavior of the type. AWS CloudFormation determines the provisioning type during registration, based on the types of handlers in the schema handler package submitted.

Valid values include:

• FULLY_MUTABLE: The type includes an update handler to process updates to the type during stack update operations.

• IMMUTABLE: The type does not include an update handler, so the type cannot be updated and must instead be replaced during stack update operations.

• NON_PROVISIONABLE: The type does not include create, read, and delete handlers, and therefore cannot actually be provisioned.

Returns:

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

See Also:

ProvisioningType

setDeprecatedStatus

public void setDeprecatedStatus(String deprecatedStatus)

The deprecation status of the types that you want to get summary information about.

Valid values include:

• LIVE: The type is registered for use in CloudFormation operations.

• DEPRECATED: The type has been deregistered and can no longer be used in CloudFormation operations.

Parameters:

deprecatedStatus - The deprecation status of the types that you want to get summary information about.

Valid values include:

• LIVE: The type is registered for use in CloudFormation operations.

• DEPRECATED: The type has been deregistered and can no longer be used in CloudFormation operations.

See Also:

DeprecatedStatus

getDeprecatedStatus

public String getDeprecatedStatus()

The deprecation status of the types that you want to get summary information about.

Valid values include:

• LIVE: The type is registered for use in CloudFormation operations.

• DEPRECATED: The type has been deregistered and can no longer be used in CloudFormation operations.

Returns:

The deprecation status of the types that you want to get summary information about.

Valid values include:

• LIVE: The type is registered for use in CloudFormation operations.

• DEPRECATED: The type has been deregistered and can no longer be used in CloudFormation operations.

See Also:

DeprecatedStatus

withDeprecatedStatus

public ListTypesRequest withDeprecatedStatus(String deprecatedStatus)

The deprecation status of the types that you want to get summary information about.

Valid values include:

• LIVE: The type is registered for use in CloudFormation operations.

• DEPRECATED: The type has been deregistered and can no longer be used in CloudFormation operations.

Parameters:

deprecatedStatus - The deprecation status of the types that you want to get summary information about.

Valid values include:

• LIVE: The type is registered for use in CloudFormation operations.

• DEPRECATED: The type has been deregistered and can no longer be used in CloudFormation operations.

Returns:

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

See Also:

DeprecatedStatus

withDeprecatedStatus

public ListTypesRequest withDeprecatedStatus(DeprecatedStatus deprecatedStatus)

The deprecation status of the types that you want to get summary information about.

Valid values include:

• LIVE: The type is registered for use in CloudFormation operations.

• DEPRECATED: The type has been deregistered and can no longer be used in CloudFormation operations.

Parameters:

deprecatedStatus - The deprecation status of the types that you want to get summary information about.

Valid values include:

• LIVE: The type is registered for use in CloudFormation operations.

• DEPRECATED: The type has been deregistered and can no longer be used in CloudFormation operations.

Returns:

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

See Also:

DeprecatedStatus

setMaxResults

public void setMaxResults(Integer maxResults)

The maximum number of results to be returned with a single call. If the number of available results exceeds this maximum, the response includes a NextToken value that you can assign to the NextToken request parameter to get the next set of results.

Parameters:

maxResults - The maximum number of results to be returned with a single call. If the number of available results exceeds this maximum, the response includes a NextToken value that you can assign to the NextToken request parameter to get the next set of results.

getMaxResults

public Integer getMaxResults()

The maximum number of results to be returned with a single call. If the number of available results exceeds this maximum, the response includes a NextToken value that you can assign to the NextToken request parameter to get the next set of results.

Returns:

The maximum number of results to be returned with a single call. If the number of available results exceeds this maximum, the response includes a NextToken value that you can assign to the NextToken request parameter to get the next set of results.

withMaxResults

public ListTypesRequest withMaxResults(Integer maxResults)

The maximum number of results to be returned with a single call. If the number of available results exceeds this maximum, the response includes a NextToken value that you can assign to the NextToken request parameter to get the next set of results.

Parameters:

maxResults - The maximum number of results to be returned with a single call. If the number of available results exceeds this maximum, the response includes a NextToken value that you can assign to the NextToken request parameter to get the next set of results.

Returns:

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

setNextToken

public void setNextToken(String nextToken)

If the previous paginated request didn't return all of the remaining results, the response object's NextToken parameter value is set to a token. To retrieve the next set of results, call this action again and assign that token to the request object's NextToken parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null.

Parameters:

nextToken - If the previous paginated request didn't return all of the remaining results, the response object's NextToken parameter value is set to a token. To retrieve the next set of results, call this action again and assign that token to the request object's NextToken parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null.

getNextToken

public String getNextToken()

If the previous paginated request didn't return all of the remaining results, the response object's NextToken parameter value is set to a token. To retrieve the next set of results, call this action again and assign that token to the request object's NextToken parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null.

Returns:

If the previous paginated request didn't return all of the remaining results, the response object's NextToken parameter value is set to a token. To retrieve the next set of results, call this action again and assign that token to the request object's NextToken parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null.

withNextToken

public ListTypesRequest withNextToken(String nextToken)

If the previous paginated request didn't return all of the remaining results, the response object's NextToken parameter value is set to a token. To retrieve the next set of results, call this action again and assign that token to the request object's NextToken parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null.

Parameters:

nextToken - If the previous paginated request didn't return all of the remaining results, the response object's NextToken parameter value is set to a token. To retrieve the next set of results, call this action again and assign that token to the request object's NextToken parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null.

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 ListTypesRequest clone()

Overrides:

clone in class AmazonWebServiceRequest