CloudHSM

1 resource kind. Generated from the operator's CRD schemas.

API Group: aws.konfig.io/v1alpha1

CloudHSMCluster # CLOUD CONTROL · AWS::CloudHSM::Cluster

CloudHSMCluster manages AWS::CloudHSM::Cluster through the AWS Cloud Control API.

kubectl get cloudhsmclusters · example on GitHub

Example

# CloudHSMCluster — CloudHSM
# Full-options example generated from the CRD schema. Optional fields are
# included with sample values; delete what you don't need. Field reference:
# https://konfig-konector.io/docs/cloudhsm.html#cloudhsmcluster
apiVersion: aws.konfig.io/v1alpha1
kind: CloudHSMCluster
metadata:
  name: example-cloudhsmcluster
  namespace: default
spec:
  backupRetentionPolicy:
    type: DAYS
    value: exa
  hsmType: example
  mode: FIPS
  networkType: IPV4
  providerRef:
    name: example-cloudhsmcluster
    region: us-east-1
  subnetIds:
  - example
  tags:
  - key: example
    value: example

Spec

Field	Type	Required	Description
`backupRetentionPolicy`	object	—	A policy that defines how the service retains backups.
`backupRetentionPolicy.type`	enum	—	The type of backup retention policy. Allowed: `DAYS`
`backupRetentionPolicy.value`	string	—	Use a value between 7 - 379.
`hsmType`	string	yes	The type of HSM to use in the cluster.
`mode`	enum	—	The mode to use in the cluster. Allowed: `FIPS, NON_FIPS`
`networkType`	enum	—	The NetworkType to create a cluster with. Allowed: `IPV4, DUALSTACK`
`providerRef`	object	—	ProviderRef selects the AWSProvider (account/region) this resource is reconciled against.
`providerRef.name`	string	yes	Name of a cluster-scoped AWSProvider.
`providerRef.region`	string	—	Region overrides the provider's region for this resource only.
`subnetIds`	array<string>	—	The identifiers (IDs) of the subnets where the cluster is created.
`tags`	array<object>	—	Tags to apply to the CloudHSM cluster.
`tags[].key`	string	yes	The key of the tag.
`tags[].value`	string	yes	The value of the tag.

Status

Field	Type	Required	Description
`arn`	string	—	The Amazon Resource Name (ARN) of the cluster.
`attempt`	integer	—	Attempt counts failed create/delete requests; it salts the Cloud Control idempotency token so a retry is not served the cached failure.
`awsProvider`	object	—	AWSProvider confirms the account and region this resource was reconciled against.
`awsProvider.accountId`	string	—	AccountID the resource lives in.
`awsProvider.name`	string	—	Name of the AWSProvider used; empty when the operator's own credentials were used.
`awsProvider.region`	string	—	Region the resource lives in (empty for global services).
`backupPolicy`	enum	—	The cluster's backup policy. Allowed: `DEFAULT`
`clusterId`	string	—	The cluster's identifier (ID).
`conditions`	array<object>	—	Conditions describe the current state of the resource.
`conditions[].lastTransitionTime`	string	yes	lastTransitionTime is the last time the condition transitioned from one status to another.
`conditions[].message`	string	yes	message is a human readable message indicating details about the transition.
`conditions[].observedGeneration`	integer	—	observedGeneration represents the .metadata.generation that the condition was set based upon.
`conditions[].reason`	string	yes	reason contains a programmatic identifier indicating the reason for the condition's last transition.
`conditions[].status`	enum	yes	status of the condition, one of True, False, Unknown. Allowed: `True, False, Unknown`
`conditions[].type`	string	yes	type of condition in CamelCase or in foo.example.com/CamelCase.
`identifier`	string	—	Identifier is the Cloud Control primary identifier of the resource.
`lastSyncTime`	string	—
`observedGeneration`	integer	—
`operation`	string	—	Operation is the in-flight operation (CREATE, UPDATE, DELETE).
`operationStatus`	string	—	OperationStatus is the last reported operation status.
`requestToken`	string	—	RequestToken tracks an in-flight asynchronous operation.
`securityGroup`	string	—	The identifier (ID) of the cluster's security group.
`state`	enum	—	The cluster's state. Allowed: `CREATE_IN_PROGRESS, UNINITIALIZED, INITIALIZE_IN_PROGRESS, INITIALIZED, ACTIVE, UPDATE_IN_PROGRESS, MODIFY_IN_PROGRESS, ROLLBACK_IN_PROGRESS…`
`subnetMapping`	map<string>	—	A map from availability zone to the cluster's subnet in that availability zone.
`vpcId`	string	—	The identifier (ID) of the virtual private cloud (VPC) that contains the cluster.