CfnProfileProps Struct
Properties for defining a CfnProfile.
| 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 cfnProfileProps: transfer.CfnProfileProps = {
as2Id: 'as2Id',
profileType: 'profileType',
// the properties below are optional
certificateIds: ['certificateIds'],
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_profile_props = transfer.CfnProfileProps(
as2_id="as2Id",
profile_type="profileType",
# the properties below are optional
certificate_ids=["certificateIds"],
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.*;
CfnProfileProps cfnProfileProps = CfnProfileProps.builder()
.as2Id("as2Id")
.profileType("profileType")
// the properties below are optional
.certificateIds(List.of("certificateIds"))
.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 cfnProfileProps = new CfnProfileProps {
As2Id = "as2Id",
ProfileType = "profileType",
// the properties below are optional
CertificateIds = new [] { "certificateIds" },
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"
cfnProfileProps := &CfnProfileProps{
As2Id: jsii.String("as2Id"),
ProfileType: jsii.String("profileType"),
// the properties below are optional
CertificateIds: []*string{
jsii.String("certificateIds"),
},
Tags: []CfnTag{
&CfnTag{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
}
Properties
The `As2Id` is the *AS2-name* , as defined in the RFC 4130 . For inbound transfers, this is the `AS2-From` header for the AS2 messages sent from the partner. For outbound connectors, this is the `AS2-To` header for the AS2 messages sent to the partner using the `StartFileTransfer` API operation. This ID cannot include spaces.
certificateIdsoptionalstring[]certificate_idsoptionaltyping.List[str]certificateIdsoptionalList<String>CertificateIdsoptionalstring[]CertificateIdsoptional*[]*string #An array of identifiers for the imported certificates.
You use this identifier for working with profiles and partner profiles.
Indicates whether to list only `LOCAL` type profiles or only `PARTNER` type profiles.
If not supplied in the request, the command lists all types of profiles.