software.amazon.awscdk.services.transfer

Class CfnProfile

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.CfnElement

software.amazon.awscdk.core.CfnRefElement

software.amazon.awscdk.core.CfnResource

software.amazon.awscdk.services.transfer.CfnProfile

All Implemented Interfaces:

IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct

@Generated(value="jsii-pacmak/1.73.0 (build 6faeda3)",
           date="2023-01-31T18:36:50.582Z")
 @Stability(value=Stable)
public class CfnProfile
extends CfnResource
implements IInspectable

A CloudFormation `AWS::Transfer::Profile`.

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

Example:

 // 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.*;
 CfnProfile cfnProfile = CfnProfile.Builder.create(this, "MyCfnProfile")
         .as2Id("as2Id")
         .profileType("profileType")
         // the properties below are optional
         .certificateIds(List.of("certificateIds"))
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnProfile.Builder A fluent builder for CfnProfile.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnProfile(Construct scope, String id, CfnProfileProps props) Create a new `AWS::Transfer::Profile`.
protected	CfnProfile(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnProfile(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
String	getAs2Id() The `As2Id` is the *AS2-name* , as defined in the [RFC 4130](https://docs.aws.amazon.com/https://datatracker.ietf.org/doc/html/rfc4130) .
String	getAttrArn()
String	getAttrProfileId()
List<String>	getCertificateIds() An array of identifiers for the imported certificates.
protected Map<String,Object>	getCfnProperties()
String	getProfileType() Indicates whether to list only `LOCAL` type profiles or only `PARTNER` type profiles.
TagManager	getTags() Key-value pairs that can be used to group and search for profiles.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setAs2Id(String value) The `As2Id` is the *AS2-name* , as defined in the [RFC 4130](https://docs.aws.amazon.com/https://datatracker.ietf.org/doc/html/rfc4130) .
void	setCertificateIds(List<String> value) An array of identifiers for the imported certificates.
void	setProfileType(String value) Indicates whether to list only `LOCAL` type profiles or only `PARTNER` type profiles.

Methods inherited from class software.amazon.awscdk.core.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.core.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.core.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnProfile

protected CfnProfile(software.amazon.jsii.JsiiObjectRef objRef)

CfnProfile

protected CfnProfile(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnProfile

@Stability(value=Stable)
public CfnProfile(@NotNull
                                           Construct scope,
                                           @NotNull
                                           String id,
                                           @NotNull
                                           CfnProfileProps props)

Create a new `AWS::Transfer::Profile`.

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

props - - resource properties. This parameter is required.

Method Detail

inspect

@Stability(value=Stable)
public void inspect(@NotNull
                                             TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrArn

@Stability(value=Stable)
 @NotNull
public String getAttrArn()

getAttrProfileId

@Stability(value=Stable)
 @NotNull
public String getAttrProfileId()

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

@Stability(value=Stable)
 @NotNull
public TagManager getTags()

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

getAs2Id

@Stability(value=Stable)
 @NotNull
public String getAs2Id()

The `As2Id` is the *AS2-name* , as defined in the [RFC 4130](https://docs.aws.amazon.com/https://datatracker.ietf.org/doc/html/rfc4130) . 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.

setAs2Id

@Stability(value=Stable)
public void setAs2Id(@NotNull
                                              String value)

The `As2Id` is the *AS2-name* , as defined in the [RFC 4130](https://docs.aws.amazon.com/https://datatracker.ietf.org/doc/html/rfc4130) . 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.

getProfileType

@Stability(value=Stable)
 @NotNull
public String getProfileType()

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.

setProfileType

@Stability(value=Stable)
public void setProfileType(@NotNull
                                                    String value)

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.

getCertificateIds

@Stability(value=Stable)
 @Nullable
public List<String> getCertificateIds()

An array of identifiers for the imported certificates.

You use this identifier for working with profiles and partner profiles.

setCertificateIds

@Stability(value=Stable)
public void setCertificateIds(@Nullable
                                                       List<String> value)

An array of identifiers for the imported certificates.

You use this identifier for working with profiles and partner profiles.