aws.cloudhsmv2.getCluster
Use this data source to get information about a CloudHSM v2 cluster
Example Usage
using System.Collections.Generic;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var cluster = Aws.CloudHsmV2.GetCluster.Invoke(new()
{
ClusterId = "cluster-testclusterid",
});
});
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v5/go/aws/cloudhsmv2"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := cloudhsmv2.LookupCluster(ctx, &cloudhsmv2.LookupClusterArgs{
ClusterId: "cluster-testclusterid",
}, nil)
if err != nil {
return err
}
return nil
})
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.cloudhsmv2.Cloudhsmv2Functions;
import com.pulumi.aws.cloudhsmv2.inputs.GetClusterArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
final var cluster = Cloudhsmv2Functions.getCluster(GetClusterArgs.builder()
.clusterId("cluster-testclusterid")
.build());
}
}
import pulumi
import pulumi_aws as aws
cluster = aws.cloudhsmv2.get_cluster(cluster_id="cluster-testclusterid")
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const cluster = aws.cloudhsmv2.getCluster({
clusterId: "cluster-testclusterid",
});
variables:
cluster:
fn::invoke:
Function: aws:cloudhsmv2:getCluster
Arguments:
clusterId: cluster-testclusterid
Using getCluster
Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.
function getCluster(args: GetClusterArgs, opts?: InvokeOptions): Promise<GetClusterResult>
function getClusterOutput(args: GetClusterOutputArgs, opts?: InvokeOptions): Output<GetClusterResult>
def get_cluster(cluster_id: Optional[str] = None,
cluster_state: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetClusterResult
def get_cluster_output(cluster_id: Optional[pulumi.Input[str]] = None,
cluster_state: Optional[pulumi.Input[str]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetClusterResult]
func LookupCluster(ctx *Context, args *LookupClusterArgs, opts ...InvokeOption) (*LookupClusterResult, error)
func LookupClusterOutput(ctx *Context, args *LookupClusterOutputArgs, opts ...InvokeOption) LookupClusterResultOutput
> Note: This function is named LookupCluster
in the Go SDK.
public static class GetCluster
{
public static Task<GetClusterResult> InvokeAsync(GetClusterArgs args, InvokeOptions? opts = null)
public static Output<GetClusterResult> Invoke(GetClusterInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetClusterResult> getCluster(GetClusterArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
fn::invoke:
function: aws:cloudhsmv2/getCluster:getCluster
arguments:
# arguments dictionary
The following arguments are supported:
- Cluster
Id string ID of Cloud HSM v2 cluster.
- Cluster
State string State of the cluster to be found.
- Cluster
Id string ID of Cloud HSM v2 cluster.
- Cluster
State string State of the cluster to be found.
- cluster
Id String ID of Cloud HSM v2 cluster.
- cluster
State String State of the cluster to be found.
- cluster
Id string ID of Cloud HSM v2 cluster.
- cluster
State string State of the cluster to be found.
- cluster_
id str ID of Cloud HSM v2 cluster.
- cluster_
state str State of the cluster to be found.
- cluster
Id String ID of Cloud HSM v2 cluster.
- cluster
State String State of the cluster to be found.
getCluster Result
The following output properties are available:
- Cluster
Certificates List<GetCluster Cluster Certificate> The list of cluster certificates.
cluster_certificates.0.cluster_certificate
- The cluster certificate issued (signed) by the issuing certificate authority (CA) of the cluster's owner.cluster_certificates.0.cluster_csr
- The certificate signing request (CSR). Available only in UNINITIALIZED state.cluster_certificates.0.aws_hardware_certificate
- The HSM hardware certificate issued (signed) by AWS CloudHSM.cluster_certificates.0.hsm_certificate
- The HSM certificate issued (signed) by the HSM hardware.cluster_certificates.0.manufacturer_hardware_certificate
- The HSM hardware certificate issued (signed) by the hardware manufacturer. The number of available cluster certificates may vary depending on state of the cluster.
- Cluster
Id string - Cluster
State string - Id string
The provider-assigned unique ID for this managed resource.
- Security
Group stringId ID of the security group associated with the CloudHSM cluster.
- Subnet
Ids List<string> IDs of subnets in which cluster operates.
- Vpc
Id string ID of the VPC that the CloudHSM cluster resides in.
- Cluster
Certificates []GetCluster Cluster Certificate The list of cluster certificates.
cluster_certificates.0.cluster_certificate
- The cluster certificate issued (signed) by the issuing certificate authority (CA) of the cluster's owner.cluster_certificates.0.cluster_csr
- The certificate signing request (CSR). Available only in UNINITIALIZED state.cluster_certificates.0.aws_hardware_certificate
- The HSM hardware certificate issued (signed) by AWS CloudHSM.cluster_certificates.0.hsm_certificate
- The HSM certificate issued (signed) by the HSM hardware.cluster_certificates.0.manufacturer_hardware_certificate
- The HSM hardware certificate issued (signed) by the hardware manufacturer. The number of available cluster certificates may vary depending on state of the cluster.
- Cluster
Id string - Cluster
State string - Id string
The provider-assigned unique ID for this managed resource.
- Security
Group stringId ID of the security group associated with the CloudHSM cluster.
- Subnet
Ids []string IDs of subnets in which cluster operates.
- Vpc
Id string ID of the VPC that the CloudHSM cluster resides in.
- cluster
Certificates List<GetCluster Cluster Certificate> The list of cluster certificates.
cluster_certificates.0.cluster_certificate
- The cluster certificate issued (signed) by the issuing certificate authority (CA) of the cluster's owner.cluster_certificates.0.cluster_csr
- The certificate signing request (CSR). Available only in UNINITIALIZED state.cluster_certificates.0.aws_hardware_certificate
- The HSM hardware certificate issued (signed) by AWS CloudHSM.cluster_certificates.0.hsm_certificate
- The HSM certificate issued (signed) by the HSM hardware.cluster_certificates.0.manufacturer_hardware_certificate
- The HSM hardware certificate issued (signed) by the hardware manufacturer. The number of available cluster certificates may vary depending on state of the cluster.
- cluster
Id String - cluster
State String - id String
The provider-assigned unique ID for this managed resource.
- security
Group StringId ID of the security group associated with the CloudHSM cluster.
- subnet
Ids List<String> IDs of subnets in which cluster operates.
- vpc
Id String ID of the VPC that the CloudHSM cluster resides in.
- cluster
Certificates GetCluster Cluster Certificate[] The list of cluster certificates.
cluster_certificates.0.cluster_certificate
- The cluster certificate issued (signed) by the issuing certificate authority (CA) of the cluster's owner.cluster_certificates.0.cluster_csr
- The certificate signing request (CSR). Available only in UNINITIALIZED state.cluster_certificates.0.aws_hardware_certificate
- The HSM hardware certificate issued (signed) by AWS CloudHSM.cluster_certificates.0.hsm_certificate
- The HSM certificate issued (signed) by the HSM hardware.cluster_certificates.0.manufacturer_hardware_certificate
- The HSM hardware certificate issued (signed) by the hardware manufacturer. The number of available cluster certificates may vary depending on state of the cluster.
- cluster
Id string - cluster
State string - id string
The provider-assigned unique ID for this managed resource.
- security
Group stringId ID of the security group associated with the CloudHSM cluster.
- subnet
Ids string[] IDs of subnets in which cluster operates.
- vpc
Id string ID of the VPC that the CloudHSM cluster resides in.
- cluster_
certificates Sequence[GetCluster Cluster Certificate] The list of cluster certificates.
cluster_certificates.0.cluster_certificate
- The cluster certificate issued (signed) by the issuing certificate authority (CA) of the cluster's owner.cluster_certificates.0.cluster_csr
- The certificate signing request (CSR). Available only in UNINITIALIZED state.cluster_certificates.0.aws_hardware_certificate
- The HSM hardware certificate issued (signed) by AWS CloudHSM.cluster_certificates.0.hsm_certificate
- The HSM certificate issued (signed) by the HSM hardware.cluster_certificates.0.manufacturer_hardware_certificate
- The HSM hardware certificate issued (signed) by the hardware manufacturer. The number of available cluster certificates may vary depending on state of the cluster.
- cluster_
id str - cluster_
state str - id str
The provider-assigned unique ID for this managed resource.
- security_
group_ strid ID of the security group associated with the CloudHSM cluster.
- subnet_
ids Sequence[str] IDs of subnets in which cluster operates.
- vpc_
id str ID of the VPC that the CloudHSM cluster resides in.
- cluster
Certificates List<Property Map> The list of cluster certificates.
cluster_certificates.0.cluster_certificate
- The cluster certificate issued (signed) by the issuing certificate authority (CA) of the cluster's owner.cluster_certificates.0.cluster_csr
- The certificate signing request (CSR). Available only in UNINITIALIZED state.cluster_certificates.0.aws_hardware_certificate
- The HSM hardware certificate issued (signed) by AWS CloudHSM.cluster_certificates.0.hsm_certificate
- The HSM certificate issued (signed) by the HSM hardware.cluster_certificates.0.manufacturer_hardware_certificate
- The HSM hardware certificate issued (signed) by the hardware manufacturer. The number of available cluster certificates may vary depending on state of the cluster.
- cluster
Id String - cluster
State String - id String
The provider-assigned unique ID for this managed resource.
- security
Group StringId ID of the security group associated with the CloudHSM cluster.
- subnet
Ids List<String> IDs of subnets in which cluster operates.
- vpc
Id String ID of the VPC that the CloudHSM cluster resides in.
Supporting Types
GetClusterClusterCertificate
- Aws
Hardware stringCertificate - Cluster
Certificate string - Cluster
Csr string - Hsm
Certificate string - Manufacturer
Hardware stringCertificate
- Aws
Hardware stringCertificate - Cluster
Certificate string - Cluster
Csr string - Hsm
Certificate string - Manufacturer
Hardware stringCertificate
- aws
Hardware StringCertificate - cluster
Certificate String - cluster
Csr String - hsm
Certificate String - manufacturer
Hardware StringCertificate
- aws
Hardware stringCertificate - cluster
Certificate string - cluster
Csr string - hsm
Certificate string - manufacturer
Hardware stringCertificate
- aws
Hardware StringCertificate - cluster
Certificate String - cluster
Csr String - hsm
Certificate String - manufacturer
Hardware StringCertificate
Package Details
- Repository
- AWS Classic pulumi/pulumi-aws
- License
- Apache-2.0
- Notes
This Pulumi package is based on the
aws
Terraform Provider.