pub struct CreateResource { /* private fields */ }
Expand description
Fluent builder constructing a request to CreateResource
.
Creates the specified resource. For more information, see Creating a resource in the Amazon Web Services Cloud Control API User Guide.
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
type returned by CreateResource
.
Implementations§
source§impl CreateResource
impl CreateResource
sourcepub async fn customize(
self
) -> Result<CustomizableOperation<CreateResource, AwsResponseRetryClassifier>, SdkError<CreateResourceError>>
pub async fn customize(
self
) -> Result<CustomizableOperation<CreateResource, AwsResponseRetryClassifier>, SdkError<CreateResourceError>>
Consume this builder, creating a customizable operation that can be modified before being sent. The operation’s inner http::Request can be modified as well.
sourcepub async fn send(
self
) -> Result<CreateResourceOutput, SdkError<CreateResourceError>>
pub async fn send(
self
) -> Result<CreateResourceOutput, SdkError<CreateResourceError>>
Sends the request and returns the response.
If an error occurs, an SdkError
will be returned with additional details that
can be matched against.
By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.
sourcepub fn set_type_name(self, input: Option<String>) -> Self
pub fn set_type_name(self, input: Option<String>) -> Self
The name of the resource type.
sourcepub fn type_version_id(self, input: impl Into<String>) -> Self
pub fn type_version_id(self, input: impl Into<String>) -> Self
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.
sourcepub fn set_type_version_id(self, input: Option<String>) -> Self
pub fn set_type_version_id(self, input: Option<String>) -> Self
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.
sourcepub fn role_arn(self, input: impl Into<String>) -> Self
pub fn role_arn(self, input: impl Into<String>) -> Self
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.
sourcepub fn set_role_arn(self, input: Option<String>) -> Self
pub fn set_role_arn(self, input: Option<String>) -> Self
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.
sourcepub fn client_token(self, input: impl Into<String>) -> Self
pub fn client_token(self, input: impl Into<String>) -> Self
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.
sourcepub fn set_client_token(self, input: Option<String>) -> Self
pub fn set_client_token(self, input: Option<String>) -> Self
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.
sourcepub fn desired_state(self, input: impl Into<String>) -> Self
pub fn desired_state(self, input: impl Into<String>) -> Self
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.
sourcepub fn set_desired_state(self, input: Option<String>) -> Self
pub fn set_desired_state(self, input: Option<String>) -> Self
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.
Trait Implementations§
source§impl Clone for CreateResource
impl Clone for CreateResource
source§fn clone(&self) -> CreateResource
fn clone(&self) -> CreateResource
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read more