Struct aws_sdk_cloudhsm::Client
source · [−]pub struct Client { /* private fields */ }
Expand description
Client for Amazon CloudHSM
Client for invoking operations on Amazon CloudHSM. Each operation on Amazon CloudHSM is a method on this
this struct. .send()
MUST be invoked on the generated operations to dispatch the request to the service.
Examples
Constructing a client and invoking an operation
// create a shared configuration. This can be used & shared between multiple service clients.
let shared_config = aws_config::load_from_env().await;
let client = aws_sdk_cloudhsm::Client::new(&shared_config);
// invoke an operation
/* let rsp = client
.<operation_name>().
.<param>("some value")
.send().await; */
Constructing a client with custom configuration
use aws_config::RetryConfig;
let shared_config = aws_config::load_from_env().await;
let config = aws_sdk_cloudhsm::config::Builder::from(&shared_config)
.retry_config(RetryConfig::disabled())
.build();
let client = aws_sdk_cloudhsm::Client::from_conf(config);
Implementations
sourceimpl Client
impl Client
sourcepub fn with_config(
client: Client<DynConnector, DynMiddleware<DynConnector>>,
conf: Config
) -> Self
pub fn with_config(
client: Client<DynConnector, DynMiddleware<DynConnector>>,
conf: Config
) -> Self
Creates a client with the given service configuration.
sourceimpl Client
impl Client
Constructs a fluent builder for the AddTagsToResource
operation.
- The fluent builder is configurable:
resource_arn(impl Into<String>)
/set_resource_arn(Option<String>)
:The Amazon Resource Name (ARN) of the AWS CloudHSM resource to tag.
tag_list(Vec<Tag>)
/set_tag_list(Option<Vec<Tag>>)
:One or more tags.
- On success, responds with
AddTagsToResourceOutput
with field(s):status(Option<String>)
:The status of the operation.
- On failure, responds with
SdkError<AddTagsToResourceError>
sourcepub fn create_hapg(&self) -> CreateHapg
pub fn create_hapg(&self) -> CreateHapg
Constructs a fluent builder for the CreateHapg
operation.
- The fluent builder is configurable:
label(impl Into<String>)
/set_label(Option<String>)
:The label of the new high-availability partition group.
- On success, responds with
CreateHapgOutput
with field(s):hapg_arn(Option<String>)
:The ARN of the high-availability partition group.
- On failure, responds with
SdkError<CreateHapgError>
sourcepub fn create_hsm(&self) -> CreateHsm
pub fn create_hsm(&self) -> CreateHsm
Constructs a fluent builder for the CreateHsm
operation.
- The fluent builder is configurable:
subnet_id(impl Into<String>)
/set_subnet_id(Option<String>)
:The identifier of the subnet in your VPC in which to place the HSM.
ssh_key(impl Into<String>)
/set_ssh_key(Option<String>)
:The SSH public key to install on the HSM.
eni_ip(impl Into<String>)
/set_eni_ip(Option<String>)
:The IP address to assign to the HSM’s ENI.
If an IP address is not specified, an IP address will be randomly chosen from the CIDR range of the subnet.
iam_role_arn(impl Into<String>)
/set_iam_role_arn(Option<String>)
:The ARN of an IAM role to enable the AWS CloudHSM service to allocate an ENI on your behalf.
external_id(impl Into<String>)
/set_external_id(Option<String>)
:The external ID from
IamRoleArn
, if present.subscription_type(SubscriptionType)
/set_subscription_type(Option<SubscriptionType>)
:Specifies the type of subscription for the HSM.
-
PRODUCTION - The HSM is being used in a production environment.
-
TRIAL - The HSM is being used in a product trial.
-
client_token(impl Into<String>)
/set_client_token(Option<String>)
:A user-defined token to ensure idempotence. Subsequent calls to this operation with the same token will be ignored.
syslog_ip(impl Into<String>)
/set_syslog_ip(Option<String>)
:The IP address for the syslog monitoring server. The AWS CloudHSM service only supports one syslog monitoring server.
- On success, responds with
CreateHsmOutput
with field(s):hsm_arn(Option<String>)
:The ARN of the HSM.
- On failure, responds with
SdkError<CreateHsmError>
sourcepub fn create_luna_client(&self) -> CreateLunaClient
pub fn create_luna_client(&self) -> CreateLunaClient
Constructs a fluent builder for the CreateLunaClient
operation.
- The fluent builder is configurable:
label(impl Into<String>)
/set_label(Option<String>)
:The label for the client.
certificate(impl Into<String>)
/set_certificate(Option<String>)
:The contents of a Base64-Encoded X.509 v3 certificate to be installed on the HSMs used by this client.
- On success, responds with
CreateLunaClientOutput
with field(s):client_arn(Option<String>)
:The ARN of the client.
- On failure, responds with
SdkError<CreateLunaClientError>
sourcepub fn delete_hapg(&self) -> DeleteHapg
pub fn delete_hapg(&self) -> DeleteHapg
Constructs a fluent builder for the DeleteHapg
operation.
- The fluent builder is configurable:
hapg_arn(impl Into<String>)
/set_hapg_arn(Option<String>)
:The ARN of the high-availability partition group to delete.
- On success, responds with
DeleteHapgOutput
with field(s):status(Option<String>)
:The status of the action.
- On failure, responds with
SdkError<DeleteHapgError>
sourcepub fn delete_hsm(&self) -> DeleteHsm
pub fn delete_hsm(&self) -> DeleteHsm
Constructs a fluent builder for the DeleteHsm
operation.
- The fluent builder is configurable:
hsm_arn(impl Into<String>)
/set_hsm_arn(Option<String>)
:The ARN of the HSM to delete.
- On success, responds with
DeleteHsmOutput
with field(s):status(Option<String>)
:The status of the operation.
- On failure, responds with
SdkError<DeleteHsmError>
sourcepub fn delete_luna_client(&self) -> DeleteLunaClient
pub fn delete_luna_client(&self) -> DeleteLunaClient
Constructs a fluent builder for the DeleteLunaClient
operation.
- The fluent builder is configurable:
client_arn(impl Into<String>)
/set_client_arn(Option<String>)
:The ARN of the client to delete.
- On success, responds with
DeleteLunaClientOutput
with field(s):status(Option<String>)
:The status of the action.
- On failure, responds with
SdkError<DeleteLunaClientError>
sourcepub fn describe_hapg(&self) -> DescribeHapg
pub fn describe_hapg(&self) -> DescribeHapg
Constructs a fluent builder for the DescribeHapg
operation.
- The fluent builder is configurable:
hapg_arn(impl Into<String>)
/set_hapg_arn(Option<String>)
:The ARN of the high-availability partition group to describe.
- On success, responds with
DescribeHapgOutput
with field(s):hapg_arn(Option<String>)
:The ARN of the high-availability partition group.
hapg_serial(Option<String>)
:The serial number of the high-availability partition group.
hsms_last_action_failed(Option<Vec<String>>)
:hsms_pending_deletion(Option<Vec<String>>)
:hsms_pending_registration(Option<Vec<String>>)
:label(Option<String>)
:The label for the high-availability partition group.
last_modified_timestamp(Option<String>)
:The date and time the high-availability partition group was last modified.
partition_serial_list(Option<Vec<String>>)
:The list of partition serial numbers that belong to the high-availability partition group.
state(Option<CloudHsmObjectState>)
:The state of the high-availability partition group.
- On failure, responds with
SdkError<DescribeHapgError>
sourcepub fn describe_hsm(&self) -> DescribeHsm
pub fn describe_hsm(&self) -> DescribeHsm
Constructs a fluent builder for the DescribeHsm
operation.
- The fluent builder is configurable:
hsm_arn(impl Into<String>)
/set_hsm_arn(Option<String>)
:The ARN of the HSM. Either the
HsmArn
or theSerialNumber
parameter must be specified.hsm_serial_number(impl Into<String>)
/set_hsm_serial_number(Option<String>)
:The serial number of the HSM. Either the
HsmArn
or theHsmSerialNumber
parameter must be specified.
- On success, responds with
DescribeHsmOutput
with field(s):hsm_arn(Option<String>)
:The ARN of the HSM.
status(Option<HsmStatus>)
:The status of the HSM.
status_details(Option<String>)
:Contains additional information about the status of the HSM.
availability_zone(Option<String>)
:The Availability Zone that the HSM is in.
eni_id(Option<String>)
:The identifier of the elastic network interface (ENI) attached to the HSM.
eni_ip(Option<String>)
:The IP address assigned to the HSM’s ENI.
subscription_type(Option<SubscriptionType>)
:Specifies the type of subscription for the HSM.
-
PRODUCTION - The HSM is being used in a production environment.
-
TRIAL - The HSM is being used in a product trial.
-
subscription_start_date(Option<String>)
:The subscription start date.
subscription_end_date(Option<String>)
:The subscription end date.
vpc_id(Option<String>)
:The identifier of the VPC that the HSM is in.
subnet_id(Option<String>)
:The identifier of the subnet that the HSM is in.
iam_role_arn(Option<String>)
:The ARN of the IAM role assigned to the HSM.
serial_number(Option<String>)
:The serial number of the HSM.
vendor_name(Option<String>)
:The name of the HSM vendor.
hsm_type(Option<String>)
:The HSM model type.
software_version(Option<String>)
:The HSM software version.
ssh_public_key(Option<String>)
:The public SSH key.
ssh_key_last_updated(Option<String>)
:The date and time that the SSH key was last updated.
server_cert_uri(Option<String>)
:The URI of the certificate server.
server_cert_last_updated(Option<String>)
:The date and time that the server certificate was last updated.
partitions(Option<Vec<String>>)
:The list of partitions on the HSM.
- On failure, responds with
SdkError<DescribeHsmError>
sourcepub fn describe_luna_client(&self) -> DescribeLunaClient
pub fn describe_luna_client(&self) -> DescribeLunaClient
Constructs a fluent builder for the DescribeLunaClient
operation.
- The fluent builder is configurable:
client_arn(impl Into<String>)
/set_client_arn(Option<String>)
:The ARN of the client.
certificate_fingerprint(impl Into<String>)
/set_certificate_fingerprint(Option<String>)
:The certificate fingerprint.
- On success, responds with
DescribeLunaClientOutput
with field(s):client_arn(Option<String>)
:The ARN of the client.
certificate(Option<String>)
:The certificate installed on the HSMs used by this client.
certificate_fingerprint(Option<String>)
:The certificate fingerprint.
last_modified_timestamp(Option<String>)
:The date and time the client was last modified.
label(Option<String>)
:The label of the client.
- On failure, responds with
SdkError<DescribeLunaClientError>
sourcepub fn get_config(&self) -> GetConfig
pub fn get_config(&self) -> GetConfig
Constructs a fluent builder for the GetConfig
operation.
- The fluent builder is configurable:
client_arn(impl Into<String>)
/set_client_arn(Option<String>)
:The ARN of the client.
client_version(ClientVersion)
/set_client_version(Option<ClientVersion>)
:The client version.
hapg_list(Vec<String>)
/set_hapg_list(Option<Vec<String>>)
:A list of ARNs that identify the high-availability partition groups that are associated with the client.
- On success, responds with
GetConfigOutput
with field(s):config_type(Option<String>)
:The type of credentials.
config_file(Option<String>)
:The chrystoki.conf configuration file.
config_cred(Option<String>)
:The certificate file containing the server.pem files of the HSMs.
- On failure, responds with
SdkError<GetConfigError>
sourcepub fn list_available_zones(&self) -> ListAvailableZones
pub fn list_available_zones(&self) -> ListAvailableZones
Constructs a fluent builder for the ListAvailableZones
operation.
- The fluent builder takes no input, just
send
it. - On success, responds with
ListAvailableZonesOutput
with field(s):az_list(Option<Vec<String>>)
:The list of Availability Zones that have available AWS CloudHSM capacity.
- On failure, responds with
SdkError<ListAvailableZonesError>
sourcepub fn list_hapgs(&self) -> ListHapgs
pub fn list_hapgs(&self) -> ListHapgs
Constructs a fluent builder for the ListHapgs
operation.
- The fluent builder is configurable:
next_token(impl Into<String>)
/set_next_token(Option<String>)
:The
NextToken
value from a previous call toListHapgs
. Pass null if this is the first call.
- On success, responds with
ListHapgsOutput
with field(s):hapg_list(Option<Vec<String>>)
:The list of high-availability partition groups.
next_token(Option<String>)
:If not null, more results are available. Pass this value to
ListHapgs
to retrieve the next set of items.
- On failure, responds with
SdkError<ListHapgsError>
sourcepub fn list_hsms(&self) -> ListHsms
pub fn list_hsms(&self) -> ListHsms
Constructs a fluent builder for the ListHsms
operation.
- The fluent builder is configurable:
next_token(impl Into<String>)
/set_next_token(Option<String>)
:The
NextToken
value from a previous call toListHsms
. Pass null if this is the first call.
- On success, responds with
ListHsmsOutput
with field(s):hsm_list(Option<Vec<String>>)
:The list of ARNs that identify the HSMs.
next_token(Option<String>)
:If not null, more results are available. Pass this value to
ListHsms
to retrieve the next set of items.
- On failure, responds with
SdkError<ListHsmsError>
sourcepub fn list_luna_clients(&self) -> ListLunaClients
pub fn list_luna_clients(&self) -> ListLunaClients
Constructs a fluent builder for the ListLunaClients
operation.
- The fluent builder is configurable:
next_token(impl Into<String>)
/set_next_token(Option<String>)
:The
NextToken
value from a previous call toListLunaClients
. Pass null if this is the first call.
- On success, responds with
ListLunaClientsOutput
with field(s):client_list(Option<Vec<String>>)
:The list of clients.
next_token(Option<String>)
:If not null, more results are available. Pass this to
ListLunaClients
to retrieve the next set of items.
- On failure, responds with
SdkError<ListLunaClientsError>
Constructs a fluent builder for the ListTagsForResource
operation.
- The fluent builder is configurable:
resource_arn(impl Into<String>)
/set_resource_arn(Option<String>)
:The Amazon Resource Name (ARN) of the AWS CloudHSM resource.
- On success, responds with
ListTagsForResourceOutput
with field(s):tag_list(Option<Vec<Tag>>)
:One or more tags.
- On failure, responds with
SdkError<ListTagsForResourceError>
sourcepub fn modify_hapg(&self) -> ModifyHapg
pub fn modify_hapg(&self) -> ModifyHapg
Constructs a fluent builder for the ModifyHapg
operation.
- The fluent builder is configurable:
hapg_arn(impl Into<String>)
/set_hapg_arn(Option<String>)
:The ARN of the high-availability partition group to modify.
label(impl Into<String>)
/set_label(Option<String>)
:The new label for the high-availability partition group.
partition_serial_list(Vec<String>)
/set_partition_serial_list(Option<Vec<String>>)
:The list of partition serial numbers to make members of the high-availability partition group.
- On success, responds with
ModifyHapgOutput
with field(s):hapg_arn(Option<String>)
:The ARN of the high-availability partition group.
- On failure, responds with
SdkError<ModifyHapgError>
sourcepub fn modify_hsm(&self) -> ModifyHsm
pub fn modify_hsm(&self) -> ModifyHsm
Constructs a fluent builder for the ModifyHsm
operation.
- The fluent builder is configurable:
hsm_arn(impl Into<String>)
/set_hsm_arn(Option<String>)
:The ARN of the HSM to modify.
subnet_id(impl Into<String>)
/set_subnet_id(Option<String>)
:The new identifier of the subnet that the HSM is in. The new subnet must be in the same Availability Zone as the current subnet.
eni_ip(impl Into<String>)
/set_eni_ip(Option<String>)
:The new IP address for the elastic network interface (ENI) attached to the HSM.
If the HSM is moved to a different subnet, and an IP address is not specified, an IP address will be randomly chosen from the CIDR range of the new subnet.
iam_role_arn(impl Into<String>)
/set_iam_role_arn(Option<String>)
:The new IAM role ARN.
external_id(impl Into<String>)
/set_external_id(Option<String>)
:The new external ID.
syslog_ip(impl Into<String>)
/set_syslog_ip(Option<String>)
:The new IP address for the syslog monitoring server. The AWS CloudHSM service only supports one syslog monitoring server.
- On success, responds with
ModifyHsmOutput
with field(s):hsm_arn(Option<String>)
:The ARN of the HSM.
- On failure, responds with
SdkError<ModifyHsmError>
sourcepub fn modify_luna_client(&self) -> ModifyLunaClient
pub fn modify_luna_client(&self) -> ModifyLunaClient
Constructs a fluent builder for the ModifyLunaClient
operation.
- The fluent builder is configurable:
client_arn(impl Into<String>)
/set_client_arn(Option<String>)
:The ARN of the client.
certificate(impl Into<String>)
/set_certificate(Option<String>)
:The new certificate for the client.
- On success, responds with
ModifyLunaClientOutput
with field(s):client_arn(Option<String>)
:The ARN of the client.
- On failure, responds with
SdkError<ModifyLunaClientError>
Constructs a fluent builder for the RemoveTagsFromResource
operation.
- The fluent builder is configurable:
resource_arn(impl Into<String>)
/set_resource_arn(Option<String>)
:The Amazon Resource Name (ARN) of the AWS CloudHSM resource.
tag_key_list(Vec<String>)
/set_tag_key_list(Option<Vec<String>>)
:The tag key or keys to remove.
Specify only the tag key to remove (not the value). To overwrite the value for an existing tag, use
AddTagsToResource
.
- On success, responds with
RemoveTagsFromResourceOutput
with field(s):status(Option<String>)
:The status of the operation.
- On failure, responds with
SdkError<RemoveTagsFromResourceError>
sourceimpl Client
impl Client
sourcepub fn from_conf_conn<C, E>(conf: Config, conn: C) -> Self where
C: SmithyConnector<Error = E> + Send + 'static,
E: Into<ConnectorError>,
pub fn from_conf_conn<C, E>(conf: Config, conn: C) -> Self where
C: SmithyConnector<Error = E> + Send + 'static,
E: Into<ConnectorError>,
Creates a client with the given service config and connector override.
Trait Implementations
sourceimpl From<Client<DynConnector, DynMiddleware<DynConnector>, Standard>> for Client
impl From<Client<DynConnector, DynMiddleware<DynConnector>, Standard>> for Client
sourcefn from(client: Client<DynConnector, DynMiddleware<DynConnector>>) -> Self
fn from(client: Client<DynConnector, DynMiddleware<DynConnector>>) -> Self
Performs the conversion.
Auto Trait Implementations
impl !RefUnwindSafe for Client
impl Send for Client
impl Sync for Client
impl Unpin for Client
impl !UnwindSafe for Client
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcepub fn borrow_mut(&mut self) -> &mut T
pub fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
sourcefn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
sourceimpl<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcepub fn to_owned(&self) -> T
pub fn to_owned(&self) -> T
Creates owned data from borrowed data, usually by cloning. Read more
sourcepub fn clone_into(&self, target: &mut T)
pub fn clone_into(&self, target: &mut T)
toowned_clone_into
)Uses borrowed data to replace owned data, usually by cloning. Read more
sourceimpl<T> WithSubscriber for T
impl<T> WithSubscriber for T
sourcefn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
sourcefn with_current_subscriber(self) -> WithDispatch<Self>
fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more