Modify Cluster

cloudhsmv2_modify_cluster

R Documentation

Modifies CloudHSM cluster

Description

Modifies CloudHSM cluster.

Cross-account use: No. You cannot perform this operation on an CloudHSM cluster in a different Amazon Web Services account.

Usage

cloudhsmv2_modify_cluster(BackupRetentionPolicy, ClusterId)

Arguments

BackupRetentionPolicy

[required] A policy that defines how the service retains backups.

ClusterId

[required] The identifier (ID) of the cluster that you want to modify. To find the cluster ID, use describe_clusters.

Value

A list with the following syntax:

list(
  Cluster = list(
    BackupPolicy = "DEFAULT",
    BackupRetentionPolicy = list(
      Type = "DAYS",
      Value = "string"
    ),
    ClusterId = "string",
    CreateTimestamp = as.POSIXct(
      "2015-01-01"
    ),
    Hsms = list(
      list(
        AvailabilityZone = "string",
        ClusterId = "string",
        SubnetId = "string",
        EniId = "string",
        EniIp = "string",
        HsmId = "string",
        State = "CREATE_IN_PROGRESS"|"ACTIVE"|"DEGRADED"|"DELETE_IN_PROGRESS"|"DELETED",
        StateMessage = "string"
      )
    ),
    HsmType = "string",
    PreCoPassword = "string",
    SecurityGroup = "string",
    SourceBackupId = "string",
    State = "CREATE_IN_PROGRESS"|"UNINITIALIZED"|"INITIALIZE_IN_PROGRESS"|"INITIALIZED"|"ACTIVE"|"UPDATE_IN_PROGRESS"|"DELETE_IN_PROGRESS"|"DELETED"|"DEGRADED",
    StateMessage = "string",
    SubnetMapping = list(
      "string"
    ),
    VpcId = "string",
    Certificates = list(
      ClusterCsr = "string",
      HsmCertificate = "string",
      AwsHardwareCertificate = "string",
      ManufacturerHardwareCertificate = "string",
      ClusterCertificate = "string"
    ),
    TagList = list(
      list(
        Key = "string",
        Value = "string"
      )
    ),
    Mode = "FIPS"|"NON_FIPS"
  )
)

Request syntax

svc$modify_cluster(
  BackupRetentionPolicy = list(
    Type = "DAYS",
    Value = "string"
  ),
  ClusterId = "string"
)