Class CfnProfile
A CloudFormation AWS::Transfer::Profile
.
Inherited Members
Namespace: Amazon.CDK.AWS.Transfer
Assembly: Amazon.CDK.AWS.Transfer.dll
Syntax (csharp)
public class CfnProfile : CfnResource, IConstruct, IDependable, IInspectable
Syntax (vb)
Public Class CfnProfile
Inherits CfnResource
Implements IConstruct, IDependable, IInspectable
Remarks
Creates the local or partner profile to use for AS2 transfers.
CloudformationResource: AWS::Transfer::Profile
Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-profile.html
ExampleMetadata: fixture=_generated
Examples
// 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 cfnProfile = new CfnProfile(this, "MyCfnProfile", new CfnProfileProps {
As2Id = "as2Id",
ProfileType = "profileType",
// the properties below are optional
CertificateIds = new [] { "certificateIds" },
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} }
});
Synopsis
Constructors
CfnProfile(Construct, String, ICfnProfileProps) | Create a new |
CfnProfile(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnProfile(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
Properties
As2Id | The |
AttrArn | The Amazon Resource Name associated with the profile, in the form |
AttrProfileId | The unique identifier for the AS2 profile, returned after the API call succeeds. |
CertificateIds | An array of identifiers for the imported certificates. |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
ProfileType | Indicates whether to list only |
Tags | Key-value pairs that can be used to group and search for profiles. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnProfile(Construct, String, ICfnProfileProps)
Create a new AWS::Transfer::Profile
.
public CfnProfile(Construct scope, string id, ICfnProfileProps props)
Parameters
- scope Construct
- scope in which this resource is defined.
- id System.String
- scoped id of the resource.
- props ICfnProfileProps
- resource properties.
CfnProfile(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnProfile(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnProfile(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnProfile(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
Properties
As2Id
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.
public virtual string As2Id { get; set; }
Property Value
System.String
Remarks
AttrArn
The Amazon Resource Name associated with the profile, in the form arn:aws:transfer:region:account-id:profile/profile-id/
.
public virtual string AttrArn { get; }
Property Value
System.String
Remarks
CloudformationAttribute: Arn
AttrProfileId
The unique identifier for the AS2 profile, returned after the API call succeeds.
public virtual string AttrProfileId { get; }
Property Value
System.String
Remarks
CloudformationAttribute: ProfileId
CertificateIds
An array of identifiers for the imported certificates.
public virtual string[] CertificateIds { get; set; }
Property Value
System.String[]
Remarks
You use this identifier for working with profiles and partner profiles.
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
ProfileType
Indicates whether to list only LOCAL
type profiles or only PARTNER
type profiles.
public virtual string ProfileType { get; set; }
Property Value
System.String
Remarks
If not supplied in the request, the command lists all types of profiles.
Tags
Key-value pairs that can be used to group and search for profiles.
public virtual TagManager Tags { get; }
Property Value
Remarks
Methods
Inspect(TreeInspector)
Examines the CloudFormation resource and discloses attributes.
public virtual void Inspect(TreeInspector inspector)
Parameters
- inspector TreeInspector
- tree inspector to collect and process attributes.
RenderProperties(IDictionary<String, Object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>