@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class CreateResourceRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
NOOP
Constructor and Description |
---|
CreateResourceRequest() |
Modifier and Type | Method and Description |
---|---|
CreateResourceRequest |
clone()
Creates a shallow clone of this object for all fields except the handler context.
|
boolean |
equals(Object obj) |
String |
getClientToken()
A unique identifier to ensure the idempotency of the resource request.
|
String |
getDesiredState()
Structured data format representing the desired state of the resource, consisting of that resource's properties
and their desired values.
|
String |
getRoleArn()
The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role for Cloud Control API to use when
performing this resource operation.
|
String |
getTypeName()
The name of the resource type.
|
String |
getTypeVersionId()
For private resource types, the type version to use in this resource operation.
|
int |
hashCode() |
void |
setClientToken(String clientToken)
A unique identifier to ensure the idempotency of the resource request.
|
void |
setDesiredState(String desiredState)
Structured data format representing the desired state of the resource, consisting of that resource's properties
and their desired values.
|
void |
setRoleArn(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.
|
void |
setTypeName(String typeName)
The name of the resource type.
|
void |
setTypeVersionId(String typeVersionId)
For private resource types, the type version to use in this resource operation.
|
String |
toString()
Returns a string representation of this object.
|
CreateResourceRequest |
withClientToken(String clientToken)
A unique identifier to ensure the idempotency of the resource request.
|
CreateResourceRequest |
withDesiredState(String desiredState)
Structured data format representing the desired state of the resource, consisting of that resource's properties
and their desired values.
|
CreateResourceRequest |
withRoleArn(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.
|
CreateResourceRequest |
withTypeName(String typeName)
The name of the resource type.
|
CreateResourceRequest |
withTypeVersionId(String typeVersionId)
For private resource types, the type version to use in this resource operation.
|
addHandlerContext, 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
public void setTypeName(String typeName)
The name of the resource type.
typeName
- The name of the resource type.public String getTypeName()
The name of the resource type.
public CreateResourceRequest withTypeName(String typeName)
The name of the resource type.
typeName
- The name of the resource type.public void setTypeVersionId(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.
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.public String getTypeVersionId()
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.
public CreateResourceRequest withTypeVersionId(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.
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.public void setRoleArn(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.
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.
public String getRoleArn()
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.
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.
public CreateResourceRequest withRoleArn(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.
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.
public void setClientToken(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.
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.
public String getClientToken()
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.
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.
public CreateResourceRequest withClientToken(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.
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.
public void setDesiredState(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.
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.
public String getDesiredState()
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.
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.
public CreateResourceRequest withDesiredState(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.
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.
public String toString()
toString
in class Object
Object.toString()
public CreateResourceRequest clone()
AmazonWebServiceRequest
clone
in class AmazonWebServiceRequest
Object.clone()