1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
|
// Code generated by smithy-go-codegen DO NOT EDIT.
package transfer
import (
"context"
"fmt"
awsmiddleware "github.com/aws/aws-sdk-go-v2/aws/middleware"
"github.com/aws/aws-sdk-go-v2/service/transfer/types"
"github.com/aws/smithy-go/middleware"
smithyhttp "github.com/aws/smithy-go/transport/http"
)
// Creates the connector, which captures the parameters for a connection for the
// AS2 or SFTP protocol. For AS2, the connector is required for sending files to an
// externally hosted AS2 server. For SFTP, the connector is required when sending
// files to an SFTP server or receiving files from an SFTP server. For more details
// about connectors, see [Configure AS2 connectors]and [Create SFTP connectors].
//
// You must specify exactly one configuration object: either for AS2 ( As2Config )
// or SFTP ( SftpConfig ).
//
// [Configure AS2 connectors]: https://docs.aws.amazon.com/transfer/latest/userguide/configure-as2-connector.html
// [Create SFTP connectors]: https://docs.aws.amazon.com/transfer/latest/userguide/configure-sftp-connector.html
func (c *Client) CreateConnector(ctx context.Context, params *CreateConnectorInput, optFns ...func(*Options)) (*CreateConnectorOutput, error) {
if params == nil {
params = &CreateConnectorInput{}
}
result, metadata, err := c.invokeOperation(ctx, "CreateConnector", params, optFns, c.addOperationCreateConnectorMiddlewares)
if err != nil {
return nil, err
}
out := result.(*CreateConnectorOutput)
out.ResultMetadata = metadata
return out, nil
}
type CreateConnectorInput struct {
// 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 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 Amazon Web
// Services 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 Secrets Manager.
//
// This member is required.
AccessRole *string
// The URL of the partner's AS2 or SFTP endpoint.
//
// This member is required.
Url *string
// A structure that contains the parameters for an AS2 connector object.
As2Config *types.As2ConnectorConfig
// The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role
// that allows a connector to turn on CloudWatch logging for Amazon S3 events. When
// set, you can view connector activity in your CloudWatch logs.
LoggingRole *string
// Specifies the name of the security policy for the connector.
SecurityPolicyName *string
// A structure that contains the parameters for an SFTP connector object.
SftpConfig *types.SftpConnectorConfig
// Key-value pairs that can be used to group and search for connectors. Tags are
// metadata attached to connectors for any purpose.
Tags []types.Tag
noSmithyDocumentSerde
}
type CreateConnectorOutput struct {
// The unique identifier for the connector, returned after the API call succeeds.
//
// This member is required.
ConnectorId *string
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
noSmithyDocumentSerde
}
func (c *Client) addOperationCreateConnectorMiddlewares(stack *middleware.Stack, options Options) (err error) {
if err := stack.Serialize.Add(&setOperationInputMiddleware{}, middleware.After); err != nil {
return err
}
err = stack.Serialize.Add(&awsAwsjson11_serializeOpCreateConnector{}, middleware.After)
if err != nil {
return err
}
err = stack.Deserialize.Add(&awsAwsjson11_deserializeOpCreateConnector{}, middleware.After)
if err != nil {
return err
}
if err := addProtocolFinalizerMiddlewares(stack, options, "CreateConnector"); err != nil {
return fmt.Errorf("add protocol finalizers: %v", err)
}
if err = addlegacyEndpointContextSetter(stack, options); err != nil {
return err
}
if err = addSetLoggerMiddleware(stack, options); err != nil {
return err
}
if err = addClientRequestID(stack); err != nil {
return err
}
if err = addComputeContentLength(stack); err != nil {
return err
}
if err = addResolveEndpointMiddleware(stack, options); err != nil {
return err
}
if err = addComputePayloadSHA256(stack); err != nil {
return err
}
if err = addRetry(stack, options); err != nil {
return err
}
if err = addRawResponseToMetadata(stack); err != nil {
return err
}
if err = addRecordResponseTiming(stack); err != nil {
return err
}
if err = addClientUserAgent(stack, options); err != nil {
return err
}
if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = addSetLegacyContextSigningOptionsMiddleware(stack); err != nil {
return err
}
if err = addTimeOffsetBuild(stack, c); err != nil {
return err
}
if err = addUserAgentRetryMode(stack, options); err != nil {
return err
}
if err = addOpCreateConnectorValidationMiddleware(stack); err != nil {
return err
}
if err = stack.Initialize.Add(newServiceMetadataMiddleware_opCreateConnector(options.Region), middleware.Before); err != nil {
return err
}
if err = addRecursionDetection(stack); err != nil {
return err
}
if err = addRequestIDRetrieverMiddleware(stack); err != nil {
return err
}
if err = addResponseErrorMiddleware(stack); err != nil {
return err
}
if err = addRequestResponseLogging(stack, options); err != nil {
return err
}
if err = addDisableHTTPSMiddleware(stack, options); err != nil {
return err
}
return nil
}
func newServiceMetadataMiddleware_opCreateConnector(region string) *awsmiddleware.RegisterServiceMetadata {
return &awsmiddleware.RegisterServiceMetadata{
Region: region,
ServiceID: ServiceID,
OperationName: "CreateConnector",
}
}
|
