Struct aws_sdk_cloudcontrol::client::fluent_builders::GetResource
source · pub struct GetResource { /* private fields */ }
Expand description
Fluent builder constructing a request to GetResource
.
Returns information about the current state of the specified resource. For details, see Reading a resource's current state.
You can use this action to return information about an existing resource in your account and Amazon Web Services Region, whether those resources were provisioned using Cloud Control API.
Implementations§
source§impl GetResource
impl GetResource
sourcepub async fn customize(
self
) -> Result<CustomizableOperation<GetResource, AwsResponseRetryClassifier>, SdkError<GetResourceError>>
pub async fn customize(
self
) -> Result<CustomizableOperation<GetResource, AwsResponseRetryClassifier>, SdkError<GetResourceError>>
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<GetResourceOutput, SdkError<GetResourceError>>
pub async fn send(self) -> Result<GetResourceOutput, SdkError<GetResourceError>>
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 identifier(self, input: impl Into<String>) -> Self
pub fn identifier(self, input: impl Into<String>) -> Self
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.
sourcepub fn set_identifier(self, input: Option<String>) -> Self
pub fn set_identifier(self, input: Option<String>) -> Self
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.
Trait Implementations§
source§impl Clone for GetResource
impl Clone for GetResource
source§fn clone(&self) -> GetResource
fn clone(&self) -> GetResource
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read more