software.amazon.awscdk.services.transfer

Class CfnProfile

java.lang.Object

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:

IConstruct, IDependable, IInspectable

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-22T19:35:40.269Z")
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 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 java.lang.String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnProfile(Construct scope, java.lang.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
java.lang.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) .
java.lang.String	getAttrArn()
java.lang.String	getAttrProfileId()
java.util.List<java.lang.String>	getCertificateIds() An array of identifiers for the imported certificates.
protected java.util.Map<java.lang.String,java.lang.Object>	getCfnProperties()
java.lang.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 java.util.Map<java.lang.String,java.lang.Object>	renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
void	setAs2Id(java.lang.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(java.util.List<java.lang.String> value) An array of identifiers for the imported certificates.
void	setProfileType(java.lang.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 java.lang.Object

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

Field Detail

CFN_RESOURCE_TYPE_NAME

public static final java.lang.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

public CfnProfile(Construct scope,
                  java.lang.String id,
                  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

public void inspect(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

protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrArn

public java.lang.String getAttrArn()

getAttrProfileId

public java.lang.String getAttrProfileId()

getCfnProperties

protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

public TagManager getTags()

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

getAs2Id

public java.lang.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

public void setAs2Id(java.lang.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

public java.lang.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

public void setProfileType(java.lang.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

public java.util.List<java.lang.String> getCertificateIds()

An array of identifiers for the imported certificates.

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

setCertificateIds

public void setCertificateIds(java.util.List<java.lang.String> value)

An array of identifiers for the imported certificates.

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