io.cloudshiftdev.awscdk.services.transfer.CfnAgreementProps.kt Maven / Gradle / Ivy
@file:Suppress("RedundantVisibilityModifier","RedundantUnitReturnType","RemoveRedundantQualifierName","unused","UnusedImport","ClassName","REDUNDANT_PROJECTION","DEPRECATION")
package io.cloudshiftdev.awscdk.services.transfer
import io.cloudshiftdev.awscdk.CfnTag
import io.cloudshiftdev.awscdk.common.CdkDslMarker
import io.cloudshiftdev.awscdk.common.CdkObject
import io.cloudshiftdev.awscdk.common.CdkObjectWrappers
import kotlin.String
import kotlin.Unit
import kotlin.collections.List
/**
* Properties for defining a `CfnAgreement`.
*
* Example:
*
* ```
* // The code below shows an example of how to instantiate this type.
* // The values are placeholders you should change.
* import io.cloudshiftdev.awscdk.services.transfer.*;
* CfnAgreementProps cfnAgreementProps = CfnAgreementProps.builder()
* .accessRole("accessRole")
* .baseDirectory("baseDirectory")
* .localProfileId("localProfileId")
* .partnerProfileId("partnerProfileId")
* .serverId("serverId")
* // the properties below are optional
* .description("description")
* .status("status")
* .tags(List.of(CfnTag.builder()
* .key("key")
* .value("value")
* .build()))
* .build();
* ```
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-agreement.html)
*/
public interface CfnAgreementProps {
/**
* Connectors are used to send files using either the AS2 or SFTP protocol.
*
* For the access role, provide the Amazon Resource Name (ARN) of the AWS Identity and Access
* Management role to use.
*
* *For AS2 connectors*
*
* With AS2, you can send files by calling `StartFileTransfer` and specifying the file paths in
* the request parameter, `SendFilePaths` . We use the file’s parent directory (for example, for
* `--send-file-paths /bucket/dir/file.txt` , parent directory is `/bucket/dir/` ) to temporarily
* store a processed AS2 message file, store the MDN when we receive them from the partner, and write
* a final JSON file containing relevant metadata of the transmission. So, the `AccessRole` needs to
* provide read and write access to the parent directory of the file location used in the
* `StartFileTransfer` request. Additionally, you need to provide read and write access to the parent
* directory of the files that you intend to send with `StartFileTransfer` .
*
* If you are using Basic authentication for your AS2 connector, the access role requires the
* `secretsmanager:GetSecretValue` permission for the secret. If the secret is encrypted using a
* customer-managed key instead of the AWS managed key in Secrets Manager, then the role also needs
* the `kms:Decrypt` permission for that key.
*
* *For SFTP connectors*
*
* Make sure that the access role provides read and write access to the parent directory of the
* file location that's used in the `StartFileTransfer` request. Additionally, make sure that the
* role provides `secretsmanager:GetSecretValue` permission to AWS Secrets Manager .
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-agreement.html#cfn-transfer-agreement-accessrole)
*/
public fun accessRole(): String
/**
* The landing directory (folder) for files that are transferred by using the AS2 protocol.
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-agreement.html#cfn-transfer-agreement-basedirectory)
*/
public fun baseDirectory(): String
/**
* The name or short description that's used to identify the agreement.
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-agreement.html#cfn-transfer-agreement-description)
*/
public fun description(): String? = unwrap(this).getDescription()
/**
* A unique identifier for the AS2 local profile.
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-agreement.html#cfn-transfer-agreement-localprofileid)
*/
public fun localProfileId(): String
/**
* A unique identifier for the partner profile used in the agreement.
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-agreement.html#cfn-transfer-agreement-partnerprofileid)
*/
public fun partnerProfileId(): String
/**
* A system-assigned unique identifier for a server instance.
*
* This identifier indicates the specific server that the agreement uses.
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-agreement.html#cfn-transfer-agreement-serverid)
*/
public fun serverId(): String
/**
* The current status of the agreement, either `ACTIVE` or `INACTIVE` .
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-agreement.html#cfn-transfer-agreement-status)
*/
public fun status(): String? = unwrap(this).getStatus()
/**
* Key-value pairs that can be used to group and search for agreements.
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-agreement.html#cfn-transfer-agreement-tags)
*/
public fun tags(): List = unwrap(this).getTags()?.map(CfnTag::wrap) ?: emptyList()
/**
* A builder for [CfnAgreementProps]
*/
@CdkDslMarker
public interface Builder {
/**
* @param accessRole Connectors are used to send files using either the AS2 or SFTP protocol.
* For the access role, provide the Amazon Resource Name (ARN) of the AWS Identity and Access
* Management role to use.
*
* *For AS2 connectors*
*
* With AS2, you can send files by calling `StartFileTransfer` and specifying the file paths in
* the request parameter, `SendFilePaths` . We use the file’s parent directory (for example, for
* `--send-file-paths /bucket/dir/file.txt` , parent directory is `/bucket/dir/` ) to temporarily
* store a processed AS2 message file, store the MDN when we receive them from the partner, and
* write a final JSON file containing relevant metadata of the transmission. So, the `AccessRole`
* needs to provide read and write access to the parent directory of the file location used in the
* `StartFileTransfer` request. Additionally, you need to provide read and write access to the
* parent directory of the files that you intend to send with `StartFileTransfer` .
*
* If you are using Basic authentication for your AS2 connector, the access role requires the
* `secretsmanager:GetSecretValue` permission for the secret. If the secret is encrypted using a
* customer-managed key instead of the AWS managed key in Secrets Manager, then the role also needs
* the `kms:Decrypt` permission for that key.
*
* *For SFTP connectors*
*
* Make sure that the access role provides read and write access to the parent directory of the
* file location that's used in the `StartFileTransfer` request. Additionally, make sure that the
* role provides `secretsmanager:GetSecretValue` permission to AWS Secrets Manager .
*/
public fun accessRole(accessRole: String)
/**
* @param baseDirectory The landing directory (folder) for files that are transferred by using
* the AS2 protocol.
*/
public fun baseDirectory(baseDirectory: String)
/**
* @param description The name or short description that's used to identify the agreement.
*/
public fun description(description: String)
/**
* @param localProfileId A unique identifier for the AS2 local profile.
*/
public fun localProfileId(localProfileId: String)
/**
* @param partnerProfileId A unique identifier for the partner profile used in the agreement.
*/
public fun partnerProfileId(partnerProfileId: String)
/**
* @param serverId A system-assigned unique identifier for a server instance.
* This identifier indicates the specific server that the agreement uses.
*/
public fun serverId(serverId: String)
/**
* @param status The current status of the agreement, either `ACTIVE` or `INACTIVE` .
*/
public fun status(status: String)
/**
* @param tags Key-value pairs that can be used to group and search for agreements.
*/
public fun tags(tags: List)
/**
* @param tags Key-value pairs that can be used to group and search for agreements.
*/
public fun tags(vararg tags: CfnTag)
}
private class BuilderImpl : Builder {
private val cdkBuilder: software.amazon.awscdk.services.transfer.CfnAgreementProps.Builder =
software.amazon.awscdk.services.transfer.CfnAgreementProps.builder()
/**
* @param accessRole Connectors are used to send files using either the AS2 or SFTP protocol.
* For the access role, provide the Amazon Resource Name (ARN) of the AWS Identity and Access
* Management role to use.
*
* *For AS2 connectors*
*
* With AS2, you can send files by calling `StartFileTransfer` and specifying the file paths in
* the request parameter, `SendFilePaths` . We use the file’s parent directory (for example, for
* `--send-file-paths /bucket/dir/file.txt` , parent directory is `/bucket/dir/` ) to temporarily
* store a processed AS2 message file, store the MDN when we receive them from the partner, and
* write a final JSON file containing relevant metadata of the transmission. So, the `AccessRole`
* needs to provide read and write access to the parent directory of the file location used in the
* `StartFileTransfer` request. Additionally, you need to provide read and write access to the
* parent directory of the files that you intend to send with `StartFileTransfer` .
*
* If you are using Basic authentication for your AS2 connector, the access role requires the
* `secretsmanager:GetSecretValue` permission for the secret. If the secret is encrypted using a
* customer-managed key instead of the AWS managed key in Secrets Manager, then the role also needs
* the `kms:Decrypt` permission for that key.
*
* *For SFTP connectors*
*
* Make sure that the access role provides read and write access to the parent directory of the
* file location that's used in the `StartFileTransfer` request. Additionally, make sure that the
* role provides `secretsmanager:GetSecretValue` permission to AWS Secrets Manager .
*/
override fun accessRole(accessRole: String) {
cdkBuilder.accessRole(accessRole)
}
/**
* @param baseDirectory The landing directory (folder) for files that are transferred by using
* the AS2 protocol.
*/
override fun baseDirectory(baseDirectory: String) {
cdkBuilder.baseDirectory(baseDirectory)
}
/**
* @param description The name or short description that's used to identify the agreement.
*/
override fun description(description: String) {
cdkBuilder.description(description)
}
/**
* @param localProfileId A unique identifier for the AS2 local profile.
*/
override fun localProfileId(localProfileId: String) {
cdkBuilder.localProfileId(localProfileId)
}
/**
* @param partnerProfileId A unique identifier for the partner profile used in the agreement.
*/
override fun partnerProfileId(partnerProfileId: String) {
cdkBuilder.partnerProfileId(partnerProfileId)
}
/**
* @param serverId A system-assigned unique identifier for a server instance.
* This identifier indicates the specific server that the agreement uses.
*/
override fun serverId(serverId: String) {
cdkBuilder.serverId(serverId)
}
/**
* @param status The current status of the agreement, either `ACTIVE` or `INACTIVE` .
*/
override fun status(status: String) {
cdkBuilder.status(status)
}
/**
* @param tags Key-value pairs that can be used to group and search for agreements.
*/
override fun tags(tags: List) {
cdkBuilder.tags(tags.map(CfnTag.Companion::unwrap))
}
/**
* @param tags Key-value pairs that can be used to group and search for agreements.
*/
override fun tags(vararg tags: CfnTag): Unit = tags(tags.toList())
public fun build(): software.amazon.awscdk.services.transfer.CfnAgreementProps =
cdkBuilder.build()
}
private class Wrapper(
cdkObject: software.amazon.awscdk.services.transfer.CfnAgreementProps,
) : CdkObject(cdkObject),
CfnAgreementProps {
/**
* Connectors are used to send files using either the AS2 or SFTP protocol.
*
* For the access role, provide the Amazon Resource Name (ARN) of the AWS Identity and Access
* Management role to use.
*
* *For AS2 connectors*
*
* With AS2, you can send files by calling `StartFileTransfer` and specifying the file paths in
* the request parameter, `SendFilePaths` . We use the file’s parent directory (for example, for
* `--send-file-paths /bucket/dir/file.txt` , parent directory is `/bucket/dir/` ) to temporarily
* store a processed AS2 message file, store the MDN when we receive them from the partner, and
* write a final JSON file containing relevant metadata of the transmission. So, the `AccessRole`
* needs to provide read and write access to the parent directory of the file location used in the
* `StartFileTransfer` request. Additionally, you need to provide read and write access to the
* parent directory of the files that you intend to send with `StartFileTransfer` .
*
* If you are using Basic authentication for your AS2 connector, the access role requires the
* `secretsmanager:GetSecretValue` permission for the secret. If the secret is encrypted using a
* customer-managed key instead of the AWS managed key in Secrets Manager, then the role also needs
* the `kms:Decrypt` permission for that key.
*
* *For SFTP connectors*
*
* Make sure that the access role provides read and write access to the parent directory of the
* file location that's used in the `StartFileTransfer` request. Additionally, make sure that the
* role provides `secretsmanager:GetSecretValue` permission to AWS Secrets Manager .
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-agreement.html#cfn-transfer-agreement-accessrole)
*/
override fun accessRole(): String = unwrap(this).getAccessRole()
/**
* The landing directory (folder) for files that are transferred by using the AS2 protocol.
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-agreement.html#cfn-transfer-agreement-basedirectory)
*/
override fun baseDirectory(): String = unwrap(this).getBaseDirectory()
/**
* The name or short description that's used to identify the agreement.
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-agreement.html#cfn-transfer-agreement-description)
*/
override fun description(): String? = unwrap(this).getDescription()
/**
* A unique identifier for the AS2 local profile.
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-agreement.html#cfn-transfer-agreement-localprofileid)
*/
override fun localProfileId(): String = unwrap(this).getLocalProfileId()
/**
* A unique identifier for the partner profile used in the agreement.
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-agreement.html#cfn-transfer-agreement-partnerprofileid)
*/
override fun partnerProfileId(): String = unwrap(this).getPartnerProfileId()
/**
* A system-assigned unique identifier for a server instance.
*
* This identifier indicates the specific server that the agreement uses.
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-agreement.html#cfn-transfer-agreement-serverid)
*/
override fun serverId(): String = unwrap(this).getServerId()
/**
* The current status of the agreement, either `ACTIVE` or `INACTIVE` .
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-agreement.html#cfn-transfer-agreement-status)
*/
override fun status(): String? = unwrap(this).getStatus()
/**
* Key-value pairs that can be used to group and search for agreements.
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-agreement.html#cfn-transfer-agreement-tags)
*/
override fun tags(): List = unwrap(this).getTags()?.map(CfnTag::wrap) ?: emptyList()
}
public companion object {
public operator fun invoke(block: Builder.() -> Unit = {}): CfnAgreementProps {
val builderImpl = BuilderImpl()
return Wrapper(builderImpl.apply(block).build())
}
internal fun wrap(cdkObject: software.amazon.awscdk.services.transfer.CfnAgreementProps):
CfnAgreementProps = CdkObjectWrappers.wrap(cdkObject) as? CfnAgreementProps ?:
Wrapper(cdkObject)
internal fun unwrap(wrapped: CfnAgreementProps):
software.amazon.awscdk.services.transfer.CfnAgreementProps = (wrapped as
CdkObject).cdkObject as software.amazon.awscdk.services.transfer.CfnAgreementProps
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy