CfnHostKeyProps Struct
Properties for defining a CfnHostKey.
| Source | |
|---|---|
| Type last changed |
Example
ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_transfer as transfer } from 'aws-cdk-lib';
const cfnHostKeyProps: transfer.CfnHostKeyProps = {
serverId: 'serverId',
// the properties below are optional
description: 'description',
hostKeyBody: 'hostKeyBody',
kmsKey: 'kmsKey',
storageType: 'storageType',
tags: [{
key: 'key',
value: 'value',
}],
};
python
from aws_cdk import CfnTag
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_transfer as transfer
cfn_host_key_props = transfer.CfnHostKeyProps(
server_id="serverId",
# the properties below are optional
description="description",
host_key_body="hostKeyBody",
kms_key="kmsKey",
storage_type="storageType",
tags=[CfnTag(
key="key",
value="value"
)]
)
java
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.transfer.*;
CfnHostKeyProps cfnHostKeyProps = CfnHostKeyProps.builder()
.serverId("serverId")
// the properties below are optional
.description("description")
.hostKeyBody("hostKeyBody")
.kmsKey("kmsKey")
.storageType("storageType")
.tags(List.of(CfnTag.builder()
.key("key")
.value("value")
.build()))
.build();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.Transfer;
var cfnHostKeyProps = new CfnHostKeyProps {
ServerId = "serverId",
// the properties below are optional
Description = "description",
HostKeyBody = "hostKeyBody",
KmsKey = "kmsKey",
StorageType = "storageType",
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} }
};
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
cfnHostKeyProps := &CfnHostKeyProps{
ServerId: jsii.String("serverId"),
// the properties below are optional
Description: jsii.String("description"),
HostKeyBody: jsii.String("hostKeyBody"),
KmsKey: jsii.String("kmsKey"),
StorageType: jsii.String("storageType"),
Tags: []CfnTag{
&CfnTag{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
}
Properties
descriptionoptionalstringdescriptionoptionalstrdescriptionoptionalStringDescriptionoptionalstringDescriptionoptional*string #The text description for this host key.
hostKeyBodyoptionalstringhost_key_bodyoptionalstrhostKeyBodyoptionalStringHostKeyBodyoptionalstringHostKeyBodyoptional*string #The private key portion of an SSH key pair.
Transfer Family accepts RSA, ECDSA, and ED25519 keys.
kmsKeyoptionalstringkms_keyoptionalstrkmsKeyoptionalStringKmsKeyoptionalstringKmsKeyoptional*string #The Amazon Resource Name (ARN) of a customer managed key used to encrypt the Secrets Manager secret that holds the host key.
Applies only when StorageType is SECRETS_MANAGER. If omitted, the AWS managed key is used.
The identifier of the server that contains the host key.
storageTypeoptionalstringstorage_typeoptionalstrstorageTypeoptionalStringStorageTypeoptionalstringStorageTypeoptional*string #The type of storage used for the host key.
SERVICE_MANAGED keys are stored within the Transfer Family service. SECRETS_MANAGER keys are stored in an AWS Secrets Manager secret in your account.