Serialized Form

Package com.amazonaws.services.cloudcontrolapi.model

Class com.amazonaws.services.cloudcontrolapi.model.AlreadyExistsException extends AWSCloudControlApiException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.cloudcontrolapi.model.AWSCloudControlApiException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.cloudcontrolapi.model.CancelResourceRequestRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

requestToken

String requestToken

The RequestToken of the ProgressEvent object returned by the resource operation request.

Class com.amazonaws.services.cloudcontrolapi.model.CancelResourceRequestResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable

Serialized Fields

progressEvent

ProgressEvent progressEvent

Class com.amazonaws.services.cloudcontrolapi.model.ClientTokenConflictException extends AWSCloudControlApiException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.cloudcontrolapi.model.ConcurrentModificationException extends AWSCloudControlApiException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.cloudcontrolapi.model.ConcurrentOperationException extends AWSCloudControlApiException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.cloudcontrolapi.model.CreateResourceRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

typeName

String typeName

The name of the resource type.

typeVersionId

String typeVersionId

For private resource types, the type version to use in this resource operation. If you do not specify a resource version, CloudFormation uses the default version.

roleArn

String roleArn

The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role for Cloud Control API to use when performing this resource operation. The role specified must have the permissions required for this operation. The necessary permissions for each event handler are defined in the handlers section of the resource type definition schema.

If you do not specify a role, Cloud Control API uses a temporary session created using your Amazon Web Services user credentials.

For more information, see Specifying credentials in the Amazon Web Services Cloud Control API User Guide.

clientToken

String clientToken

A unique identifier to ensure the idempotency of the resource request. As a best practice, specify this token to ensure idempotency, so that Amazon Web Services Cloud Control API can accurately distinguish between request retries and new resource requests. You might retry a resource request to ensure that it was successfully received.

A client token is valid for 36 hours once used. After that, a resource request with the same client token is treated as a new request.

If you do not specify a client token, one is generated for inclusion in the request.

For more information, see Ensuring resource operation requests are unique in the Amazon Web Services Cloud Control API User Guide.

desiredState

String desiredState

Structured data format representing the desired state of the resource, consisting of that resource's properties and their desired values.

Cloud Control API currently supports JSON as a structured data format.

Specify the desired state as one of the following:

• A JSON blob

• A local path containing the desired state in JSON data format

For more information, see Composing the desired state of the resource in the Amazon Web Services Cloud Control API User Guide.

For more information about the properties of a specific resource, refer to the related topic for the resource in the Resource and property types reference in the CloudFormation Users Guide.

Class com.amazonaws.services.cloudcontrolapi.model.CreateResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable

Serialized Fields

progressEvent

ProgressEvent progressEvent

Represents the current status of the resource creation request.

After you have initiated a resource creation request, you can monitor the progress of your request by calling GetResourceRequestStatus using the RequestToken of the ProgressEvent returned by CreateResource.

Class com.amazonaws.services.cloudcontrolapi.model.DeleteResourceRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

typeName

String typeName

The name of the resource type.

typeVersionId

String typeVersionId

For private resource types, the type version to use in this resource operation. If you do not specify a resource version, CloudFormation uses the default version.

roleArn

String roleArn

The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role for Cloud Control API to use when performing this resource operation. The role specified must have the permissions required for this operation. The necessary permissions for each event handler are defined in the handlers section of the resource type definition schema.

If you do not specify a role, Cloud Control API uses a temporary session created using your Amazon Web Services user credentials.

For more information, see Specifying credentials in the Amazon Web Services Cloud Control API User Guide.

clientToken

String clientToken

A unique identifier to ensure the idempotency of the resource request. As a best practice, specify this token to ensure idempotency, so that Amazon Web Services Cloud Control API can accurately distinguish between request retries and new resource requests. You might retry a resource request to ensure that it was successfully received.

A client token is valid for 36 hours once used. After that, a resource request with the same client token is treated as a new request.

If you do not specify a client token, one is generated for inclusion in the request.

For more information, see Ensuring resource operation requests are unique in the Amazon Web Services Cloud Control API User Guide.

identifier

String identifier

The identifier for the resource.

You can specify the primary identifier, or any secondary identifier defined for the resource type in its resource schema. You can only specify one identifier. Primary identifiers can be specified as a string or JSON; secondary identifiers must be specified as JSON.

For compound primary identifiers (that is, one that consists of multiple resource properties strung together), to specify the primary identifier as a string, list the property values in the order they are specified in the primary identifier definition, separated by |.

For more information, see Identifying resources in the Amazon Web Services Cloud Control API User Guide.

Class com.amazonaws.services.cloudcontrolapi.model.DeleteResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable

Serialized Fields

progressEvent

ProgressEvent progressEvent

Represents the current status of the resource deletion request.

After you have initiated a resource deletion request, you can monitor the progress of your request by calling GetResourceRequestStatus using the RequestToken of the ProgressEvent returned by DeleteResource.

Class com.amazonaws.services.cloudcontrolapi.model.GeneralServiceException extends AWSCloudControlApiException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.cloudcontrolapi.model.GetResourceRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

typeName

String typeName

The name of the resource type.

typeVersionId

String typeVersionId

For private resource types, the type version to use in this resource operation. If you do not specify a resource version, CloudFormation uses the default version.

roleArn

String roleArn

The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role for Cloud Control API to use when performing this resource operation. The role specified must have the permissions required for this operation. The necessary permissions for each event handler are defined in the handlers section of the resource type definition schema.

If you do not specify a role, Cloud Control API uses a temporary session created using your Amazon Web Services user credentials.

For more information, see Specifying credentials in the Amazon Web Services Cloud Control API User Guide.

identifier

String identifier

The identifier for the resource.

You can specify the primary identifier, or any secondary identifier defined for the resource type in its resource schema. You can only specify one identifier. Primary identifiers can be specified as a string or JSON; secondary identifiers must be specified as JSON.

For compound primary identifiers (that is, one that consists of multiple resource properties strung together), to specify the primary identifier as a string, list the property values in the order they are specified in the primary identifier definition, separated by |.

For more information, see Identifying resources in the Amazon Web Services Cloud Control API User Guide.

Class com.amazonaws.services.cloudcontrolapi.model.GetResourceRequestStatusRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

requestToken

String requestToken

A unique token used to track the progress of the resource operation request.

Request tokens are included in the ProgressEvent type returned by a resource operation request.

Class com.amazonaws.services.cloudcontrolapi.model.GetResourceRequestStatusResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable

Serialized Fields

progressEvent

ProgressEvent progressEvent

Represents the current status of the resource operation request.

Class com.amazonaws.services.cloudcontrolapi.model.GetResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable

Serialized Fields

typeName

String typeName

The name of the resource type.

resourceDescription

ResourceDescription resourceDescription

Class com.amazonaws.services.cloudcontrolapi.model.HandlerFailureException extends AWSCloudControlApiException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.cloudcontrolapi.model.HandlerInternalFailureException extends AWSCloudControlApiException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.cloudcontrolapi.model.InvalidCredentialsException extends AWSCloudControlApiException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.cloudcontrolapi.model.InvalidRequestException extends AWSCloudControlApiException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.cloudcontrolapi.model.ListResourceRequestsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

maxResults

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.

The default is 20.

nextToken

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.

resourceRequestStatusFilter

ResourceRequestStatusFilter resourceRequestStatusFilter

The filter criteria to apply to the requests returned.

Class com.amazonaws.services.cloudcontrolapi.model.ListResourceRequestsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable

Serialized Fields

resourceRequestStatusSummaries

List<E> resourceRequestStatusSummaries

The requests that match the specified filter criteria.

nextToken

String nextToken

If the request doesn't return all of the remaining results, NextToken is set to a token. To retrieve the next set of results, call ListResources again and assign that token to the request object's NextToken parameter. If the request returns all results, NextToken is set to null.

Class com.amazonaws.services.cloudcontrolapi.model.ListResourcesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

typeName

String typeName

The name of the resource type.

typeVersionId

String typeVersionId

For private resource types, the type version to use in this resource operation. If you do not specify a resource version, CloudFormation uses the default version.

roleArn

String roleArn

The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role for Cloud Control API to use when performing this resource operation. The role specified must have the permissions required for this operation. The necessary permissions for each event handler are defined in the handlers section of the resource type definition schema.

If you do not specify a role, Cloud Control API uses a temporary session created using your Amazon Web Services user credentials.

For more information, see Specifying credentials in the Amazon Web Services Cloud Control API User Guide.

nextToken

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.

maxResults

Integer maxResults

Reserved.

resourceModel

String resourceModel

The resource model to use to select the resources to return.

Class com.amazonaws.services.cloudcontrolapi.model.ListResourcesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable

Serialized Fields

typeName

String typeName

The name of the resource type.

resourceDescriptions

List<E> resourceDescriptions

Information about the specified resources, including primary identifier and resource model.

nextToken

String nextToken

If the request doesn't return all of the remaining results, NextToken is set to a token. To retrieve the next set of results, call ListResources again and assign that token to the request object's NextToken parameter. If the request returns all results, NextToken is set to null.

Class com.amazonaws.services.cloudcontrolapi.model.NetworkFailureException extends AWSCloudControlApiException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.cloudcontrolapi.model.NotStabilizedException extends AWSCloudControlApiException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.cloudcontrolapi.model.NotUpdatableException extends AWSCloudControlApiException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.cloudcontrolapi.model.PrivateTypeException extends AWSCloudControlApiException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.cloudcontrolapi.model.ProgressEvent extends Object implements Serializable

Serialized Fields

typeName

String typeName

The name of the resource type used in the operation.

identifier

String identifier

The primary identifier for the resource.

In some cases, the resource identifier may be available before the resource operation has reached a status of SUCCESS.

requestToken

String requestToken

The unique token representing this resource operation request.

Use the RequestToken with GetResourceRequestStatus to return the current status of a resource operation request.

operation

String operation

The resource operation type.

operationStatus

String operationStatus

The current status of the resource operation request.

• PENDING: The resource operation hasn't yet started.

• IN_PROGRESS: The resource operation is currently in progress.

• SUCCESS: The resource operation has successfully completed.

• FAILED: The resource operation has failed. Refer to the error code and status message for more information.

• CANCEL_IN_PROGRESS: The resource operation is in the process of being canceled.

• CANCEL_COMPLETE: The resource operation has been canceled.

eventTime

Date eventTime

When the resource operation request was initiated.

resourceModel

String resourceModel

A JSON string containing the resource model, consisting of each resource property and its current value.

statusMessage

String statusMessage

Any message explaining the current status.

errorCode

String errorCode

For requests with a status of FAILED, the associated error code.

For error code definitions, see Handler error codes in the CloudFormation Command Line Interface User Guide for Extension Development.

retryAfter

Date retryAfter

When to next request the status of this resource operation request.

Class com.amazonaws.services.cloudcontrolapi.model.RequestTokenNotFoundException extends AWSCloudControlApiException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.cloudcontrolapi.model.ResourceConflictException extends AWSCloudControlApiException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.cloudcontrolapi.model.ResourceDescription extends Object implements Serializable

Serialized Fields

identifier

String identifier

The primary identifier for the resource.

For more information, see Identifying resources in the Amazon Web Services Cloud Control API User Guide.

properties

String properties

A list of the resource properties and their current values.

Class com.amazonaws.services.cloudcontrolapi.model.ResourceNotFoundException extends AWSCloudControlApiException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.cloudcontrolapi.model.ResourceRequestStatusFilter extends Object implements Serializable

Serialized Fields

operations

List<E> operations

The operation types to include in the filter.

operationStatuses

List<E> operationStatuses

The operation statuses to include in the filter.

• PENDING: The operation has been requested, but not yet initiated.

• IN_PROGRESS: The operation is in progress.

• SUCCESS: The operation completed.

• FAILED: The operation failed.

• CANCEL_IN_PROGRESS: The operation is in the process of being canceled.

• CANCEL_COMPLETE: The operation has been canceled.

Class com.amazonaws.services.cloudcontrolapi.model.ServiceInternalErrorException extends AWSCloudControlApiException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.cloudcontrolapi.model.ServiceLimitExceededException extends AWSCloudControlApiException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.cloudcontrolapi.model.ThrottlingException extends AWSCloudControlApiException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.cloudcontrolapi.model.TypeNotFoundException extends AWSCloudControlApiException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.cloudcontrolapi.model.UnsupportedActionException extends AWSCloudControlApiException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.cloudcontrolapi.model.UpdateResourceRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

typeName

String typeName

The name of the resource type.

typeVersionId

String typeVersionId

For private resource types, the type version to use in this resource operation. If you do not specify a resource version, CloudFormation uses the default version.

roleArn

String roleArn

The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role for Cloud Control API to use when performing this resource operation. The role specified must have the permissions required for this operation. The necessary permissions for each event handler are defined in the handlers section of the resource type definition schema.

If you do not specify a role, Cloud Control API uses a temporary session created using your Amazon Web Services user credentials.

For more information, see Specifying credentials in the Amazon Web Services Cloud Control API User Guide.

clientToken

String clientToken

A unique identifier to ensure the idempotency of the resource request. As a best practice, specify this token to ensure idempotency, so that Amazon Web Services Cloud Control API can accurately distinguish between request retries and new resource requests. You might retry a resource request to ensure that it was successfully received.

A client token is valid for 36 hours once used. After that, a resource request with the same client token is treated as a new request.

If you do not specify a client token, one is generated for inclusion in the request.

For more information, see Ensuring resource operation requests are unique in the Amazon Web Services Cloud Control API User Guide.

identifier

String identifier

The identifier for the resource.

You can specify the primary identifier, or any secondary identifier defined for the resource type in its resource schema. You can only specify one identifier. Primary identifiers can be specified as a string or JSON; secondary identifiers must be specified as JSON.

For compound primary identifiers (that is, one that consists of multiple resource properties strung together), to specify the primary identifier as a string, list the property values in the order they are specified in the primary identifier definition, separated by |.

For more information, see Identifying resources in the Amazon Web Services Cloud Control API User Guide.

patchDocument

String patchDocument

A JavaScript Object Notation (JSON) document listing the patch operations that represent the updates to apply to the current resource properties. For details, see Composing the patch document in the Amazon Web Services Cloud Control API User Guide.

Class com.amazonaws.services.cloudcontrolapi.model.UpdateResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable

Serialized Fields

progressEvent

ProgressEvent progressEvent

Represents the current status of the resource update request.

Use the RequestToken of the ProgressEvent with GetResourceRequestStatus to return the current status of a resource operation request.