Class CfnProfile

Creates the local or partner profile to use for AS2 transfers.

Inheritance

object

CfnElement

CfnRefElement

CfnResource

CfnProfile

Implements

IInspectable

IProfileRef

IConstruct

IDependable

IEnvironmentAware

ITaggable

Inherited Members

CfnResource.IsCfnResource(object)

CfnResource.AddDeletionOverride(string)

CfnResource.AddDependency(CfnResource)

CfnResource.AddDependsOn(CfnResource)

CfnResource.AddMetadata(string, object)

CfnResource.AddOverride(string, object)

CfnResource.AddPropertyDeletionOverride(string)

CfnResource.AddPropertyOverride(string, object)

CfnResource.ApplyRemovalPolicy(RemovalPolicy?, IRemovalPolicyOptions)

CfnResource.CfnPropertyName(string)

CfnResource.GetAtt(string, ResolutionTypeHint?)

CfnResource.GetMetadata(string)

CfnResource.ObtainDependencies()

CfnResource.ObtainResourceDependencies()

CfnResource.RemoveDependency(CfnResource)

CfnResource.ReplaceDependency(CfnResource, CfnResource)

CfnResource.ShouldSynthesize()

CfnResource.ToString()

CfnResource.ValidateProperties(object)

CfnResource.CfnOptions

CfnResource.CfnResourceType

CfnResource.Env

CfnResource.UpdatedProperites

CfnResource.UpdatedProperties

CfnRefElement.Ref

CfnElement.IsCfnElement(object)

CfnElement.OverrideLogicalId(string)

CfnElement.With(params IMixin[])

CfnElement.CreationStack

CfnElement.LogicalId

CfnElement.Stack

Namespace: Amazon.CDK.AWS.Transfer

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnProfile : CfnResource, IInspectable, IProfileRef, IConstruct, IDependable, IEnvironmentAware, ITaggable

Syntax (vb)

Public Class CfnProfile Inherits CfnResource Implements IInspectable, IProfileRef, IConstruct, IDependable, IEnvironmentAware, ITaggable

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-profile.html

CloudformationResource: AWS::Transfer::Profile

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 AWS::Transfer::Profile.

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.
AttrArn	The Amazon Resource Name associated with the profile, in the form arn:aws:transfer:region:account-id:profile/profile-id/ .
AttrProfileId	The unique identifier for the AS2 profile, returned after the API call succeeds.
CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.
CertificateIds	An array of identifiers for the imported certificates.
CfnProperties	Creates the local or partner profile to use for AS2 transfers.
CfnPropertyNames	Creates the local or partner profile to use for AS2 transfers.
ProfileRef	A reference to a Profile resource.
ProfileType	Indicates whether to list only LOCAL type profiles or only PARTNER type profiles.
Tags	Tag Manager which manages the tags for this resource.
TagsRaw	Key-value pairs that can be used to group and search for profiles.

Methods

ArnForProfile(IProfileRef)	Creates the local or partner profile to use for AS2 transfers.
FromProfileArn(Construct, string, string)	Creates a new IProfileRef from an ARN.
FromProfileId(Construct, string, string)	Creates a new IProfileRef from a profileId.
Inspect(TreeInspector)	Examines the CloudFormation resource and discloses attributes.
IsCfnProfile(object)	Checks whether the given object is a CfnProfile.
RenderProperties(IDictionary<string, object>)	Creates the local or partner profile to use for AS2 transfers.

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 string

Construct identifier for this resource (unique in its scope).

props ICfnProfileProps

Resource properties.

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-profile.html

CloudformationResource: AWS::Transfer::Profile

ExampleMetadata: fixture=_generated

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

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-profile.html

CloudformationResource: AWS::Transfer::Profile

ExampleMetadata: fixture=_generated

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

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

string

Remarks

CloudformationAttribute: ProfileId

CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

public static string CFN_RESOURCE_TYPE_NAME { get; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-profile.html

CloudformationResource: AWS::Transfer::Profile

ExampleMetadata: fixture=_generated

CertificateIds

An array of identifiers for the imported certificates.

public virtual string[]? CertificateIds { get; set; }

Property Value

string[]

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-profile.html

CloudformationResource: AWS::Transfer::Profile

ExampleMetadata: fixture=_generated

CfnProperties

Creates the local or partner profile to use for AS2 transfers.

protected override IDictionary<string, object> CfnProperties { get; }

Property Value

IDictionary<string, object>

Overrides

CfnResource.CfnProperties

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-profile.html

CloudformationResource: AWS::Transfer::Profile

ExampleMetadata: fixture=_generated

CfnPropertyNames

Creates the local or partner profile to use for AS2 transfers.

protected override IDictionary<string, string> CfnPropertyNames { get; }

Property Value

IDictionary<string, string>

Overrides

CfnResource.CfnPropertyNames

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-profile.html

CloudformationResource: AWS::Transfer::Profile

ExampleMetadata: fixture=_generated

ProfileRef

A reference to a Profile resource.

public virtual IProfileReference ProfileRef { get; }

Property Value

IProfileReference

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-profile.html

CloudformationResource: AWS::Transfer::Profile

ExampleMetadata: fixture=_generated

ProfileType

Indicates whether to list only LOCAL type profiles or only PARTNER type profiles.

public virtual string ProfileType { get; set; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-profile.html

CloudformationResource: AWS::Transfer::Profile

ExampleMetadata: fixture=_generated

Tags

Tag Manager which manages the tags for this resource.

public virtual TagManager Tags { get; }

Property Value

TagManager

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-profile.html

CloudformationResource: AWS::Transfer::Profile

ExampleMetadata: fixture=_generated

TagsRaw

Key-value pairs that can be used to group and search for profiles.

public virtual ICfnTag[]? TagsRaw { get; set; }

Property Value

ICfnTag[]

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-profile.html

CloudformationResource: AWS::Transfer::Profile

ExampleMetadata: fixture=_generated

Methods

ArnForProfile(IProfileRef)

Creates the local or partner profile to use for AS2 transfers.

public static string ArnForProfile(IProfileRef resource)

Parameters

resource IProfileRef

Returns

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-profile.html

CloudformationResource: AWS::Transfer::Profile

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"
                 } }
             });

FromProfileArn(Construct, string, string)

Creates a new IProfileRef from an ARN.

public static IProfileRef FromProfileArn(Construct scope, string id, string arn)

Parameters

scope Construct

id string

arn string

Returns

IProfileRef

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-profile.html

CloudformationResource: AWS::Transfer::Profile

ExampleMetadata: fixture=_generated

FromProfileId(Construct, string, string)

Creates a new IProfileRef from a profileId.

public static IProfileRef FromProfileId(Construct scope, string id, string profileId)

Parameters

scope Construct

id string

profileId string

Returns

IProfileRef

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-profile.html

CloudformationResource: AWS::Transfer::Profile

ExampleMetadata: fixture=_generated

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.

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-profile.html

CloudformationResource: AWS::Transfer::Profile

ExampleMetadata: fixture=_generated

IsCfnProfile(object)

Checks whether the given object is a CfnProfile.

public static bool IsCfnProfile(object x)

Parameters

x object

Returns

bool

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-profile.html

CloudformationResource: AWS::Transfer::Profile

ExampleMetadata: fixture=_generated

RenderProperties(IDictionary<string, object>)

Creates the local or partner profile to use for AS2 transfers.

protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)

Parameters

props IDictionary<string, object>

Returns

IDictionary<string, object>

Overrides

CfnResource.RenderProperties(IDictionary<string, object>)

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-profile.html

CloudformationResource: AWS::Transfer::Profile

ExampleMetadata: fixture=_generated

Implements

IInspectable

IProfileRef

Constructs.IConstruct

Constructs.IDependable

IEnvironmentAware

ITaggable