cloudhsmv2

package
v6.59.1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Nov 12, 2024 License: Apache-2.0 Imports: 7 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Cluster

type Cluster struct {
	pulumi.CustomResourceState

	// The list of cluster certificates.
	ClusterCertificates ClusterClusterCertificateArrayOutput `pulumi:"clusterCertificates"`
	// The id of the CloudHSM cluster.
	ClusterId pulumi.StringOutput `pulumi:"clusterId"`
	// The state of the CloudHSM cluster.
	ClusterState pulumi.StringOutput `pulumi:"clusterState"`
	// The type of HSM module in the cluster. Currently, `hsm1.medium` and `hsm2m.medium` are supported.
	HsmType pulumi.StringOutput `pulumi:"hsmType"`
	// The mode to use in the cluster. The allowed values are `FIPS` and `NON_FIPS`. This field is required if `hsmType` is `hsm2m.medium`.
	Mode pulumi.StringOutput `pulumi:"mode"`
	// The ID of the security group associated with the CloudHSM cluster.
	SecurityGroupId pulumi.StringOutput `pulumi:"securityGroupId"`
	// ID of Cloud HSM v2 cluster backup to be restored.
	SourceBackupIdentifier pulumi.StringPtrOutput `pulumi:"sourceBackupIdentifier"`
	// The IDs of subnets in which cluster will operate.
	SubnetIds pulumi.StringArrayOutput `pulumi:"subnetIds"`
	// A map of tags to assign to the resource. .If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.
	Tags pulumi.StringMapOutput `pulumi:"tags"`
	// A map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block.
	//
	// Deprecated: Please use `tags` instead.
	TagsAll pulumi.StringMapOutput `pulumi:"tagsAll"`
	// The id of the VPC that the CloudHSM cluster resides in.
	VpcId pulumi.StringOutput `pulumi:"vpcId"`
}

Creates an Amazon CloudHSM v2 cluster.

For information about CloudHSM v2, see the [AWS CloudHSM User Guide](https://docs.aws.amazon.com/cloudhsm/latest/userguide/introduction.html) and the [Amazon CloudHSM API Reference][2].

> **NOTE:** A CloudHSM Cluster can take several minutes to set up. Practically no single attribute can be updated, except for `tags`. If you need to delete a cluster, you have to remove its HSM modules first. To initialize cluster, you have to add an HSM instance to the cluster, then sign CSR and upload it.

## Import

Using `pulumi import`, import CloudHSM v2 Clusters using the cluster `id`. For example:

```sh $ pulumi import aws:cloudhsmv2/cluster:Cluster test_cluster cluster-aeb282a201 ```

func GetCluster

func GetCluster(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *ClusterState, opts ...pulumi.ResourceOption) (*Cluster, error)

GetCluster gets an existing Cluster resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewCluster

func NewCluster(ctx *pulumi.Context,
	name string, args *ClusterArgs, opts ...pulumi.ResourceOption) (*Cluster, error)

NewCluster registers a new resource with the given unique name, arguments, and options.

func (*Cluster) ElementType

func (*Cluster) ElementType() reflect.Type

func (*Cluster) ToClusterOutput

func (i *Cluster) ToClusterOutput() ClusterOutput

func (*Cluster) ToClusterOutputWithContext

func (i *Cluster) ToClusterOutputWithContext(ctx context.Context) ClusterOutput

type ClusterArgs

type ClusterArgs struct {
	// The type of HSM module in the cluster. Currently, `hsm1.medium` and `hsm2m.medium` are supported.
	HsmType pulumi.StringInput
	// The mode to use in the cluster. The allowed values are `FIPS` and `NON_FIPS`. This field is required if `hsmType` is `hsm2m.medium`.
	Mode pulumi.StringPtrInput
	// ID of Cloud HSM v2 cluster backup to be restored.
	SourceBackupIdentifier pulumi.StringPtrInput
	// The IDs of subnets in which cluster will operate.
	SubnetIds pulumi.StringArrayInput
	// A map of tags to assign to the resource. .If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.
	Tags pulumi.StringMapInput
}

The set of arguments for constructing a Cluster resource.

func (ClusterArgs) ElementType

func (ClusterArgs) ElementType() reflect.Type

type ClusterArray

type ClusterArray []ClusterInput

func (ClusterArray) ElementType

func (ClusterArray) ElementType() reflect.Type

func (ClusterArray) ToClusterArrayOutput

func (i ClusterArray) ToClusterArrayOutput() ClusterArrayOutput

func (ClusterArray) ToClusterArrayOutputWithContext

func (i ClusterArray) ToClusterArrayOutputWithContext(ctx context.Context) ClusterArrayOutput

type ClusterArrayInput

type ClusterArrayInput interface {
	pulumi.Input

	ToClusterArrayOutput() ClusterArrayOutput
	ToClusterArrayOutputWithContext(context.Context) ClusterArrayOutput
}

ClusterArrayInput is an input type that accepts ClusterArray and ClusterArrayOutput values. You can construct a concrete instance of `ClusterArrayInput` via:

ClusterArray{ ClusterArgs{...} }

type ClusterArrayOutput

type ClusterArrayOutput struct{ *pulumi.OutputState }

func (ClusterArrayOutput) ElementType

func (ClusterArrayOutput) ElementType() reflect.Type

func (ClusterArrayOutput) Index

func (ClusterArrayOutput) ToClusterArrayOutput

func (o ClusterArrayOutput) ToClusterArrayOutput() ClusterArrayOutput

func (ClusterArrayOutput) ToClusterArrayOutputWithContext

func (o ClusterArrayOutput) ToClusterArrayOutputWithContext(ctx context.Context) ClusterArrayOutput

type ClusterClusterCertificate

type ClusterClusterCertificate struct {
	// The HSM hardware certificate issued (signed) by AWS CloudHSM.
	AwsHardwareCertificate *string `pulumi:"awsHardwareCertificate"`
	// The cluster certificate issued (signed) by the issuing certificate authority (CA) of the cluster's owner.
	ClusterCertificate *string `pulumi:"clusterCertificate"`
	// The certificate signing request (CSR). Available only in `UNINITIALIZED` state after an HSM instance is added to the cluster.
	ClusterCsr *string `pulumi:"clusterCsr"`
	// The HSM certificate issued (signed) by the HSM hardware.
	HsmCertificate *string `pulumi:"hsmCertificate"`
	// The HSM hardware certificate issued (signed) by the hardware manufacturer.
	ManufacturerHardwareCertificate *string `pulumi:"manufacturerHardwareCertificate"`
}

type ClusterClusterCertificateArgs

type ClusterClusterCertificateArgs struct {
	// The HSM hardware certificate issued (signed) by AWS CloudHSM.
	AwsHardwareCertificate pulumi.StringPtrInput `pulumi:"awsHardwareCertificate"`
	// The cluster certificate issued (signed) by the issuing certificate authority (CA) of the cluster's owner.
	ClusterCertificate pulumi.StringPtrInput `pulumi:"clusterCertificate"`
	// The certificate signing request (CSR). Available only in `UNINITIALIZED` state after an HSM instance is added to the cluster.
	ClusterCsr pulumi.StringPtrInput `pulumi:"clusterCsr"`
	// The HSM certificate issued (signed) by the HSM hardware.
	HsmCertificate pulumi.StringPtrInput `pulumi:"hsmCertificate"`
	// The HSM hardware certificate issued (signed) by the hardware manufacturer.
	ManufacturerHardwareCertificate pulumi.StringPtrInput `pulumi:"manufacturerHardwareCertificate"`
}

func (ClusterClusterCertificateArgs) ElementType

func (ClusterClusterCertificateArgs) ToClusterClusterCertificateOutput

func (i ClusterClusterCertificateArgs) ToClusterClusterCertificateOutput() ClusterClusterCertificateOutput

func (ClusterClusterCertificateArgs) ToClusterClusterCertificateOutputWithContext

func (i ClusterClusterCertificateArgs) ToClusterClusterCertificateOutputWithContext(ctx context.Context) ClusterClusterCertificateOutput

type ClusterClusterCertificateArray

type ClusterClusterCertificateArray []ClusterClusterCertificateInput

func (ClusterClusterCertificateArray) ElementType

func (ClusterClusterCertificateArray) ToClusterClusterCertificateArrayOutput

func (i ClusterClusterCertificateArray) ToClusterClusterCertificateArrayOutput() ClusterClusterCertificateArrayOutput

func (ClusterClusterCertificateArray) ToClusterClusterCertificateArrayOutputWithContext

func (i ClusterClusterCertificateArray) ToClusterClusterCertificateArrayOutputWithContext(ctx context.Context) ClusterClusterCertificateArrayOutput

type ClusterClusterCertificateArrayInput

type ClusterClusterCertificateArrayInput interface {
	pulumi.Input

	ToClusterClusterCertificateArrayOutput() ClusterClusterCertificateArrayOutput
	ToClusterClusterCertificateArrayOutputWithContext(context.Context) ClusterClusterCertificateArrayOutput
}

ClusterClusterCertificateArrayInput is an input type that accepts ClusterClusterCertificateArray and ClusterClusterCertificateArrayOutput values. You can construct a concrete instance of `ClusterClusterCertificateArrayInput` via:

ClusterClusterCertificateArray{ ClusterClusterCertificateArgs{...} }

type ClusterClusterCertificateArrayOutput

type ClusterClusterCertificateArrayOutput struct{ *pulumi.OutputState }

func (ClusterClusterCertificateArrayOutput) ElementType

func (ClusterClusterCertificateArrayOutput) Index

func (ClusterClusterCertificateArrayOutput) ToClusterClusterCertificateArrayOutput

func (o ClusterClusterCertificateArrayOutput) ToClusterClusterCertificateArrayOutput() ClusterClusterCertificateArrayOutput

func (ClusterClusterCertificateArrayOutput) ToClusterClusterCertificateArrayOutputWithContext

func (o ClusterClusterCertificateArrayOutput) ToClusterClusterCertificateArrayOutputWithContext(ctx context.Context) ClusterClusterCertificateArrayOutput

type ClusterClusterCertificateInput

type ClusterClusterCertificateInput interface {
	pulumi.Input

	ToClusterClusterCertificateOutput() ClusterClusterCertificateOutput
	ToClusterClusterCertificateOutputWithContext(context.Context) ClusterClusterCertificateOutput
}

ClusterClusterCertificateInput is an input type that accepts ClusterClusterCertificateArgs and ClusterClusterCertificateOutput values. You can construct a concrete instance of `ClusterClusterCertificateInput` via:

ClusterClusterCertificateArgs{...}

type ClusterClusterCertificateOutput

type ClusterClusterCertificateOutput struct{ *pulumi.OutputState }

func (ClusterClusterCertificateOutput) AwsHardwareCertificate

func (o ClusterClusterCertificateOutput) AwsHardwareCertificate() pulumi.StringPtrOutput

The HSM hardware certificate issued (signed) by AWS CloudHSM.

func (ClusterClusterCertificateOutput) ClusterCertificate

The cluster certificate issued (signed) by the issuing certificate authority (CA) of the cluster's owner.

func (ClusterClusterCertificateOutput) ClusterCsr

The certificate signing request (CSR). Available only in `UNINITIALIZED` state after an HSM instance is added to the cluster.

func (ClusterClusterCertificateOutput) ElementType

func (ClusterClusterCertificateOutput) HsmCertificate

The HSM certificate issued (signed) by the HSM hardware.

func (ClusterClusterCertificateOutput) ManufacturerHardwareCertificate

func (o ClusterClusterCertificateOutput) ManufacturerHardwareCertificate() pulumi.StringPtrOutput

The HSM hardware certificate issued (signed) by the hardware manufacturer.

func (ClusterClusterCertificateOutput) ToClusterClusterCertificateOutput

func (o ClusterClusterCertificateOutput) ToClusterClusterCertificateOutput() ClusterClusterCertificateOutput

func (ClusterClusterCertificateOutput) ToClusterClusterCertificateOutputWithContext

func (o ClusterClusterCertificateOutput) ToClusterClusterCertificateOutputWithContext(ctx context.Context) ClusterClusterCertificateOutput

type ClusterInput

type ClusterInput interface {
	pulumi.Input

	ToClusterOutput() ClusterOutput
	ToClusterOutputWithContext(ctx context.Context) ClusterOutput
}

type ClusterMap

type ClusterMap map[string]ClusterInput

func (ClusterMap) ElementType

func (ClusterMap) ElementType() reflect.Type

func (ClusterMap) ToClusterMapOutput

func (i ClusterMap) ToClusterMapOutput() ClusterMapOutput

func (ClusterMap) ToClusterMapOutputWithContext

func (i ClusterMap) ToClusterMapOutputWithContext(ctx context.Context) ClusterMapOutput

type ClusterMapInput

type ClusterMapInput interface {
	pulumi.Input

	ToClusterMapOutput() ClusterMapOutput
	ToClusterMapOutputWithContext(context.Context) ClusterMapOutput
}

ClusterMapInput is an input type that accepts ClusterMap and ClusterMapOutput values. You can construct a concrete instance of `ClusterMapInput` via:

ClusterMap{ "key": ClusterArgs{...} }

type ClusterMapOutput

type ClusterMapOutput struct{ *pulumi.OutputState }

func (ClusterMapOutput) ElementType

func (ClusterMapOutput) ElementType() reflect.Type

func (ClusterMapOutput) MapIndex

func (ClusterMapOutput) ToClusterMapOutput

func (o ClusterMapOutput) ToClusterMapOutput() ClusterMapOutput

func (ClusterMapOutput) ToClusterMapOutputWithContext

func (o ClusterMapOutput) ToClusterMapOutputWithContext(ctx context.Context) ClusterMapOutput

type ClusterOutput

type ClusterOutput struct{ *pulumi.OutputState }

func (ClusterOutput) ClusterCertificates

func (o ClusterOutput) ClusterCertificates() ClusterClusterCertificateArrayOutput

The list of cluster certificates.

func (ClusterOutput) ClusterId

func (o ClusterOutput) ClusterId() pulumi.StringOutput

The id of the CloudHSM cluster.

func (ClusterOutput) ClusterState

func (o ClusterOutput) ClusterState() pulumi.StringOutput

The state of the CloudHSM cluster.

func (ClusterOutput) ElementType

func (ClusterOutput) ElementType() reflect.Type

func (ClusterOutput) HsmType

func (o ClusterOutput) HsmType() pulumi.StringOutput

The type of HSM module in the cluster. Currently, `hsm1.medium` and `hsm2m.medium` are supported.

func (ClusterOutput) Mode added in v6.52.0

The mode to use in the cluster. The allowed values are `FIPS` and `NON_FIPS`. This field is required if `hsmType` is `hsm2m.medium`.

func (ClusterOutput) SecurityGroupId

func (o ClusterOutput) SecurityGroupId() pulumi.StringOutput

The ID of the security group associated with the CloudHSM cluster.

func (ClusterOutput) SourceBackupIdentifier

func (o ClusterOutput) SourceBackupIdentifier() pulumi.StringPtrOutput

ID of Cloud HSM v2 cluster backup to be restored.

func (ClusterOutput) SubnetIds

func (o ClusterOutput) SubnetIds() pulumi.StringArrayOutput

The IDs of subnets in which cluster will operate.

func (ClusterOutput) Tags

A map of tags to assign to the resource. .If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.

func (ClusterOutput) TagsAll deprecated

func (o ClusterOutput) TagsAll() pulumi.StringMapOutput

A map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block.

Deprecated: Please use `tags` instead.

func (ClusterOutput) ToClusterOutput

func (o ClusterOutput) ToClusterOutput() ClusterOutput

func (ClusterOutput) ToClusterOutputWithContext

func (o ClusterOutput) ToClusterOutputWithContext(ctx context.Context) ClusterOutput

func (ClusterOutput) VpcId

func (o ClusterOutput) VpcId() pulumi.StringOutput

The id of the VPC that the CloudHSM cluster resides in.

type ClusterState

type ClusterState struct {
	// The list of cluster certificates.
	ClusterCertificates ClusterClusterCertificateArrayInput
	// The id of the CloudHSM cluster.
	ClusterId pulumi.StringPtrInput
	// The state of the CloudHSM cluster.
	ClusterState pulumi.StringPtrInput
	// The type of HSM module in the cluster. Currently, `hsm1.medium` and `hsm2m.medium` are supported.
	HsmType pulumi.StringPtrInput
	// The mode to use in the cluster. The allowed values are `FIPS` and `NON_FIPS`. This field is required if `hsmType` is `hsm2m.medium`.
	Mode pulumi.StringPtrInput
	// The ID of the security group associated with the CloudHSM cluster.
	SecurityGroupId pulumi.StringPtrInput
	// ID of Cloud HSM v2 cluster backup to be restored.
	SourceBackupIdentifier pulumi.StringPtrInput
	// The IDs of subnets in which cluster will operate.
	SubnetIds pulumi.StringArrayInput
	// A map of tags to assign to the resource. .If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.
	Tags pulumi.StringMapInput
	// A map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block.
	//
	// Deprecated: Please use `tags` instead.
	TagsAll pulumi.StringMapInput
	// The id of the VPC that the CloudHSM cluster resides in.
	VpcId pulumi.StringPtrInput
}

func (ClusterState) ElementType

func (ClusterState) ElementType() reflect.Type

type GetClusterClusterCertificate

type GetClusterClusterCertificate struct {
	// The HSM hardware certificate issued (signed) by AWS CloudHSM.
	AwsHardwareCertificate string `pulumi:"awsHardwareCertificate"`
	// The cluster certificate issued (signed) by the issuing certificate authority (CA) of the cluster's owner.
	ClusterCertificate string `pulumi:"clusterCertificate"`
	// The certificate signing request (CSR). Available only in UNINITIALIZED state.
	ClusterCsr string `pulumi:"clusterCsr"`
	// The HSM certificate issued (signed) by the HSM hardware.
	HsmCertificate string `pulumi:"hsmCertificate"`
	// The HSM hardware certificate issued (signed) by the hardware manufacturer.
	// The number of available cluster certificates may vary depending on state of the cluster.
	ManufacturerHardwareCertificate string `pulumi:"manufacturerHardwareCertificate"`
}

type GetClusterClusterCertificateArgs

type GetClusterClusterCertificateArgs struct {
	// The HSM hardware certificate issued (signed) by AWS CloudHSM.
	AwsHardwareCertificate pulumi.StringInput `pulumi:"awsHardwareCertificate"`
	// The cluster certificate issued (signed) by the issuing certificate authority (CA) of the cluster's owner.
	ClusterCertificate pulumi.StringInput `pulumi:"clusterCertificate"`
	// The certificate signing request (CSR). Available only in UNINITIALIZED state.
	ClusterCsr pulumi.StringInput `pulumi:"clusterCsr"`
	// The HSM certificate issued (signed) by the HSM hardware.
	HsmCertificate pulumi.StringInput `pulumi:"hsmCertificate"`
	// The HSM hardware certificate issued (signed) by the hardware manufacturer.
	// The number of available cluster certificates may vary depending on state of the cluster.
	ManufacturerHardwareCertificate pulumi.StringInput `pulumi:"manufacturerHardwareCertificate"`
}

func (GetClusterClusterCertificateArgs) ElementType

func (GetClusterClusterCertificateArgs) ToGetClusterClusterCertificateOutput

func (i GetClusterClusterCertificateArgs) ToGetClusterClusterCertificateOutput() GetClusterClusterCertificateOutput

func (GetClusterClusterCertificateArgs) ToGetClusterClusterCertificateOutputWithContext

func (i GetClusterClusterCertificateArgs) ToGetClusterClusterCertificateOutputWithContext(ctx context.Context) GetClusterClusterCertificateOutput

type GetClusterClusterCertificateArray

type GetClusterClusterCertificateArray []GetClusterClusterCertificateInput

func (GetClusterClusterCertificateArray) ElementType

func (GetClusterClusterCertificateArray) ToGetClusterClusterCertificateArrayOutput

func (i GetClusterClusterCertificateArray) ToGetClusterClusterCertificateArrayOutput() GetClusterClusterCertificateArrayOutput

func (GetClusterClusterCertificateArray) ToGetClusterClusterCertificateArrayOutputWithContext

func (i GetClusterClusterCertificateArray) ToGetClusterClusterCertificateArrayOutputWithContext(ctx context.Context) GetClusterClusterCertificateArrayOutput

type GetClusterClusterCertificateArrayInput

type GetClusterClusterCertificateArrayInput interface {
	pulumi.Input

	ToGetClusterClusterCertificateArrayOutput() GetClusterClusterCertificateArrayOutput
	ToGetClusterClusterCertificateArrayOutputWithContext(context.Context) GetClusterClusterCertificateArrayOutput
}

GetClusterClusterCertificateArrayInput is an input type that accepts GetClusterClusterCertificateArray and GetClusterClusterCertificateArrayOutput values. You can construct a concrete instance of `GetClusterClusterCertificateArrayInput` via:

GetClusterClusterCertificateArray{ GetClusterClusterCertificateArgs{...} }

type GetClusterClusterCertificateArrayOutput

type GetClusterClusterCertificateArrayOutput struct{ *pulumi.OutputState }

func (GetClusterClusterCertificateArrayOutput) ElementType

func (GetClusterClusterCertificateArrayOutput) Index

func (GetClusterClusterCertificateArrayOutput) ToGetClusterClusterCertificateArrayOutput

func (o GetClusterClusterCertificateArrayOutput) ToGetClusterClusterCertificateArrayOutput() GetClusterClusterCertificateArrayOutput

func (GetClusterClusterCertificateArrayOutput) ToGetClusterClusterCertificateArrayOutputWithContext

func (o GetClusterClusterCertificateArrayOutput) ToGetClusterClusterCertificateArrayOutputWithContext(ctx context.Context) GetClusterClusterCertificateArrayOutput

type GetClusterClusterCertificateInput

type GetClusterClusterCertificateInput interface {
	pulumi.Input

	ToGetClusterClusterCertificateOutput() GetClusterClusterCertificateOutput
	ToGetClusterClusterCertificateOutputWithContext(context.Context) GetClusterClusterCertificateOutput
}

GetClusterClusterCertificateInput is an input type that accepts GetClusterClusterCertificateArgs and GetClusterClusterCertificateOutput values. You can construct a concrete instance of `GetClusterClusterCertificateInput` via:

GetClusterClusterCertificateArgs{...}

type GetClusterClusterCertificateOutput

type GetClusterClusterCertificateOutput struct{ *pulumi.OutputState }

func (GetClusterClusterCertificateOutput) AwsHardwareCertificate

func (o GetClusterClusterCertificateOutput) AwsHardwareCertificate() pulumi.StringOutput

The HSM hardware certificate issued (signed) by AWS CloudHSM.

func (GetClusterClusterCertificateOutput) ClusterCertificate

The cluster certificate issued (signed) by the issuing certificate authority (CA) of the cluster's owner.

func (GetClusterClusterCertificateOutput) ClusterCsr

The certificate signing request (CSR). Available only in UNINITIALIZED state.

func (GetClusterClusterCertificateOutput) ElementType

func (GetClusterClusterCertificateOutput) HsmCertificate

The HSM certificate issued (signed) by the HSM hardware.

func (GetClusterClusterCertificateOutput) ManufacturerHardwareCertificate

func (o GetClusterClusterCertificateOutput) ManufacturerHardwareCertificate() pulumi.StringOutput

The HSM hardware certificate issued (signed) by the hardware manufacturer. The number of available cluster certificates may vary depending on state of the cluster.

func (GetClusterClusterCertificateOutput) ToGetClusterClusterCertificateOutput

func (o GetClusterClusterCertificateOutput) ToGetClusterClusterCertificateOutput() GetClusterClusterCertificateOutput

func (GetClusterClusterCertificateOutput) ToGetClusterClusterCertificateOutputWithContext

func (o GetClusterClusterCertificateOutput) ToGetClusterClusterCertificateOutputWithContext(ctx context.Context) GetClusterClusterCertificateOutput

type Hsm

type Hsm struct {
	pulumi.CustomResourceState

	// The IDs of AZ in which HSM module will be located. Conflicts with `subnetId`.
	AvailabilityZone pulumi.StringOutput `pulumi:"availabilityZone"`
	// The ID of Cloud HSM v2 cluster to which HSM will be added.
	ClusterId pulumi.StringOutput `pulumi:"clusterId"`
	// The id of the ENI interface allocated for HSM module.
	HsmEniId pulumi.StringOutput `pulumi:"hsmEniId"`
	// The id of the HSM module.
	HsmId pulumi.StringOutput `pulumi:"hsmId"`
	// The state of the HSM module.
	HsmState pulumi.StringOutput `pulumi:"hsmState"`
	// The IP address of HSM module. Must be within the CIDR of selected subnet.
	IpAddress pulumi.StringOutput `pulumi:"ipAddress"`
	// The ID of subnet in which HSM module will be located. Conflicts with `availabilityZone`.
	SubnetId pulumi.StringOutput `pulumi:"subnetId"`
}

Creates an HSM module in Amazon CloudHSM v2 cluster.

## Example Usage

The following example below creates an HSM module in CloudHSM cluster.

```go package main

import (

"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/cloudhsmv2"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"

)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		cluster, err := cloudhsmv2.LookupCluster(ctx, &cloudhsmv2.LookupClusterArgs{
			ClusterId: cloudhsmClusterId,
		}, nil)
		if err != nil {
			return err
		}
		_, err = cloudhsmv2.NewHsm(ctx, "cloudhsm_v2_hsm", &cloudhsmv2.HsmArgs{
			SubnetId:  pulumi.String(cluster.SubnetIds[0]),
			ClusterId: pulumi.String(cluster.ClusterId),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

```

## Import

Using `pulumi import`, import HSM modules using their HSM ID. For example:

```sh $ pulumi import aws:cloudhsmv2/hsm:Hsm bar hsm-quo8dahtaca ```

func GetHsm

func GetHsm(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *HsmState, opts ...pulumi.ResourceOption) (*Hsm, error)

GetHsm gets an existing Hsm resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewHsm

func NewHsm(ctx *pulumi.Context,
	name string, args *HsmArgs, opts ...pulumi.ResourceOption) (*Hsm, error)

NewHsm registers a new resource with the given unique name, arguments, and options.

func (*Hsm) ElementType

func (*Hsm) ElementType() reflect.Type

func (*Hsm) ToHsmOutput

func (i *Hsm) ToHsmOutput() HsmOutput

func (*Hsm) ToHsmOutputWithContext

func (i *Hsm) ToHsmOutputWithContext(ctx context.Context) HsmOutput

type HsmArgs

type HsmArgs struct {
	// The IDs of AZ in which HSM module will be located. Conflicts with `subnetId`.
	AvailabilityZone pulumi.StringPtrInput
	// The ID of Cloud HSM v2 cluster to which HSM will be added.
	ClusterId pulumi.StringInput
	// The IP address of HSM module. Must be within the CIDR of selected subnet.
	IpAddress pulumi.StringPtrInput
	// The ID of subnet in which HSM module will be located. Conflicts with `availabilityZone`.
	SubnetId pulumi.StringPtrInput
}

The set of arguments for constructing a Hsm resource.

func (HsmArgs) ElementType

func (HsmArgs) ElementType() reflect.Type

type HsmArray

type HsmArray []HsmInput

func (HsmArray) ElementType

func (HsmArray) ElementType() reflect.Type

func (HsmArray) ToHsmArrayOutput

func (i HsmArray) ToHsmArrayOutput() HsmArrayOutput

func (HsmArray) ToHsmArrayOutputWithContext

func (i HsmArray) ToHsmArrayOutputWithContext(ctx context.Context) HsmArrayOutput

type HsmArrayInput

type HsmArrayInput interface {
	pulumi.Input

	ToHsmArrayOutput() HsmArrayOutput
	ToHsmArrayOutputWithContext(context.Context) HsmArrayOutput
}

HsmArrayInput is an input type that accepts HsmArray and HsmArrayOutput values. You can construct a concrete instance of `HsmArrayInput` via:

HsmArray{ HsmArgs{...} }

type HsmArrayOutput

type HsmArrayOutput struct{ *pulumi.OutputState }

func (HsmArrayOutput) ElementType

func (HsmArrayOutput) ElementType() reflect.Type

func (HsmArrayOutput) Index

func (HsmArrayOutput) ToHsmArrayOutput

func (o HsmArrayOutput) ToHsmArrayOutput() HsmArrayOutput

func (HsmArrayOutput) ToHsmArrayOutputWithContext

func (o HsmArrayOutput) ToHsmArrayOutputWithContext(ctx context.Context) HsmArrayOutput

type HsmInput

type HsmInput interface {
	pulumi.Input

	ToHsmOutput() HsmOutput
	ToHsmOutputWithContext(ctx context.Context) HsmOutput
}

type HsmMap

type HsmMap map[string]HsmInput

func (HsmMap) ElementType

func (HsmMap) ElementType() reflect.Type

func (HsmMap) ToHsmMapOutput

func (i HsmMap) ToHsmMapOutput() HsmMapOutput

func (HsmMap) ToHsmMapOutputWithContext

func (i HsmMap) ToHsmMapOutputWithContext(ctx context.Context) HsmMapOutput

type HsmMapInput

type HsmMapInput interface {
	pulumi.Input

	ToHsmMapOutput() HsmMapOutput
	ToHsmMapOutputWithContext(context.Context) HsmMapOutput
}

HsmMapInput is an input type that accepts HsmMap and HsmMapOutput values. You can construct a concrete instance of `HsmMapInput` via:

HsmMap{ "key": HsmArgs{...} }

type HsmMapOutput

type HsmMapOutput struct{ *pulumi.OutputState }

func (HsmMapOutput) ElementType

func (HsmMapOutput) ElementType() reflect.Type

func (HsmMapOutput) MapIndex

func (o HsmMapOutput) MapIndex(k pulumi.StringInput) HsmOutput

func (HsmMapOutput) ToHsmMapOutput

func (o HsmMapOutput) ToHsmMapOutput() HsmMapOutput

func (HsmMapOutput) ToHsmMapOutputWithContext

func (o HsmMapOutput) ToHsmMapOutputWithContext(ctx context.Context) HsmMapOutput

type HsmOutput

type HsmOutput struct{ *pulumi.OutputState }

func (HsmOutput) AvailabilityZone

func (o HsmOutput) AvailabilityZone() pulumi.StringOutput

The IDs of AZ in which HSM module will be located. Conflicts with `subnetId`.

func (HsmOutput) ClusterId

func (o HsmOutput) ClusterId() pulumi.StringOutput

The ID of Cloud HSM v2 cluster to which HSM will be added.

func (HsmOutput) ElementType

func (HsmOutput) ElementType() reflect.Type

func (HsmOutput) HsmEniId

func (o HsmOutput) HsmEniId() pulumi.StringOutput

The id of the ENI interface allocated for HSM module.

func (HsmOutput) HsmId

func (o HsmOutput) HsmId() pulumi.StringOutput

The id of the HSM module.

func (HsmOutput) HsmState

func (o HsmOutput) HsmState() pulumi.StringOutput

The state of the HSM module.

func (HsmOutput) IpAddress

func (o HsmOutput) IpAddress() pulumi.StringOutput

The IP address of HSM module. Must be within the CIDR of selected subnet.

func (HsmOutput) SubnetId

func (o HsmOutput) SubnetId() pulumi.StringOutput

The ID of subnet in which HSM module will be located. Conflicts with `availabilityZone`.

func (HsmOutput) ToHsmOutput

func (o HsmOutput) ToHsmOutput() HsmOutput

func (HsmOutput) ToHsmOutputWithContext

func (o HsmOutput) ToHsmOutputWithContext(ctx context.Context) HsmOutput

type HsmState

type HsmState struct {
	// The IDs of AZ in which HSM module will be located. Conflicts with `subnetId`.
	AvailabilityZone pulumi.StringPtrInput
	// The ID of Cloud HSM v2 cluster to which HSM will be added.
	ClusterId pulumi.StringPtrInput
	// The id of the ENI interface allocated for HSM module.
	HsmEniId pulumi.StringPtrInput
	// The id of the HSM module.
	HsmId pulumi.StringPtrInput
	// The state of the HSM module.
	HsmState pulumi.StringPtrInput
	// The IP address of HSM module. Must be within the CIDR of selected subnet.
	IpAddress pulumi.StringPtrInput
	// The ID of subnet in which HSM module will be located. Conflicts with `availabilityZone`.
	SubnetId pulumi.StringPtrInput
}

func (HsmState) ElementType

func (HsmState) ElementType() reflect.Type

type LookupClusterArgs

type LookupClusterArgs struct {
	// ID of Cloud HSM v2 cluster.
	ClusterId string `pulumi:"clusterId"`
	// State of the cluster to be found.
	ClusterState *string `pulumi:"clusterState"`
}

A collection of arguments for invoking getCluster.

type LookupClusterOutputArgs

type LookupClusterOutputArgs struct {
	// ID of Cloud HSM v2 cluster.
	ClusterId pulumi.StringInput `pulumi:"clusterId"`
	// State of the cluster to be found.
	ClusterState pulumi.StringPtrInput `pulumi:"clusterState"`
}

A collection of arguments for invoking getCluster.

func (LookupClusterOutputArgs) ElementType

func (LookupClusterOutputArgs) ElementType() reflect.Type

type LookupClusterResult

type LookupClusterResult struct {
	// The list of cluster certificates.
	ClusterCertificates []GetClusterClusterCertificate `pulumi:"clusterCertificates"`
	ClusterId           string                         `pulumi:"clusterId"`
	ClusterState        string                         `pulumi:"clusterState"`
	// The provider-assigned unique ID for this managed resource.
	Id string `pulumi:"id"`
	// ID of the security group associated with the CloudHSM cluster.
	SecurityGroupId string `pulumi:"securityGroupId"`
	// IDs of subnets in which cluster operates.
	SubnetIds []string `pulumi:"subnetIds"`
	// ID of the VPC that the CloudHSM cluster resides in.
	VpcId string `pulumi:"vpcId"`
}

A collection of values returned by getCluster.

func LookupCluster

func LookupCluster(ctx *pulumi.Context, args *LookupClusterArgs, opts ...pulumi.InvokeOption) (*LookupClusterResult, error)

Use this data source to get information about a CloudHSM v2 cluster

## Example Usage

```go package main

import (

"github.com/pulumi/pulumi-aws/sdk/v6/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
	})
}

```

type LookupClusterResultOutput

type LookupClusterResultOutput struct{ *pulumi.OutputState }

A collection of values returned by getCluster.

func (LookupClusterResultOutput) ClusterCertificates

The list of cluster certificates.

func (LookupClusterResultOutput) ClusterId

func (LookupClusterResultOutput) ClusterState

func (LookupClusterResultOutput) ElementType

func (LookupClusterResultOutput) ElementType() reflect.Type

func (LookupClusterResultOutput) Id

The provider-assigned unique ID for this managed resource.

func (LookupClusterResultOutput) SecurityGroupId

func (o LookupClusterResultOutput) SecurityGroupId() pulumi.StringOutput

ID of the security group associated with the CloudHSM cluster.

func (LookupClusterResultOutput) SubnetIds

IDs of subnets in which cluster operates.

func (LookupClusterResultOutput) ToLookupClusterResultOutput

func (o LookupClusterResultOutput) ToLookupClusterResultOutput() LookupClusterResultOutput

func (LookupClusterResultOutput) ToLookupClusterResultOutputWithContext

func (o LookupClusterResultOutput) ToLookupClusterResultOutputWithContext(ctx context.Context) LookupClusterResultOutput

func (LookupClusterResultOutput) VpcId

ID of the VPC that the CloudHSM cluster resides in.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL