« blib/lib/Paws/Appflow/ConnectorProfileProperties.pm
↑ Summary
blib/lib/Paws/Appflow/CreateConnectorProfileResponse.pm »
| 1 | |||
| 2 | package Paws::Appflow::CreateConnectorProfile; | ||
| 3 | use Moose; | ||
| 4 | has ConnectionMode => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'connectionMode', required => 1); | ||
| 5 | has ConnectorProfileConfig => (is => 'ro', isa => 'Paws::Appflow::ConnectorProfileConfig', traits => ['NameInRequest'], request_name => 'connectorProfileConfig', required => 1); | ||
| 6 | has ConnectorProfileName => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'connectorProfileName', required => 1); | ||
| 7 | has ConnectorType => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'connectorType', required => 1); | ||
| 8 | has KmsArn => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'kmsArn'); | ||
| 9 | |||
| 10 | use MooseX::ClassAttribute; | ||
| 11 | |||
| 12 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'CreateConnectorProfile'); | ||
| 13 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/create-connector-profile'); | ||
| 14 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'POST'); | ||
| 15 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::Appflow::CreateConnectorProfileResponse'); | ||
| 16 | 1; | ||
| 17 | |||
| 18 | ### main pod documentation begin ### | ||
| 19 | |||
| 20 | =head1 NAME | ||
| 21 | |||
| 22 | Paws::Appflow::CreateConnectorProfile - Arguments for method CreateConnectorProfile on L<Paws::Appflow> | ||
| 23 | |||
| 24 | =head1 DESCRIPTION | ||
| 25 | |||
| 26 | This class represents the parameters used for calling the method CreateConnectorProfile on the | ||
| 27 | L<Amazon Appflow|Paws::Appflow> service. Use the attributes of this class | ||
| 28 | as arguments to method CreateConnectorProfile. | ||
| 29 | |||
| 30 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateConnectorProfile. | ||
| 31 | |||
| 32 | =head1 SYNOPSIS | ||
| 33 | |||
| 34 | my $appflow = Paws->service('Appflow'); | ||
| 35 | my $CreateConnectorProfileResponse = $appflow->CreateConnectorProfile( | ||
| 36 | ConnectionMode => 'Public', | ||
| 37 | ConnectorProfileConfig => { | ||
| 38 | ConnectorProfileCredentials => { | ||
| 39 | Amplitude => { | ||
| 40 | ApiKey => 'MyApiKey', # max: 256 | ||
| 41 | SecretKey => 'MySecretKey', # max: 256 | ||
| 42 | |||
| 43 | }, # OPTIONAL | ||
| 44 | Datadog => { | ||
| 45 | ApiKey => 'MyApiKey', # max: 256 | ||
| 46 | ApplicationKey => 'MyApplicationKey', # max: 512 | ||
| 47 | |||
| 48 | }, # OPTIONAL | ||
| 49 | Dynatrace => { | ||
| 50 | ApiToken => 'MyApiToken', # max: 256 | ||
| 51 | |||
| 52 | }, # OPTIONAL | ||
| 53 | GoogleAnalytics => { | ||
| 54 | ClientId => 'MyClientId', # max: 512 | ||
| 55 | ClientSecret => 'MyClientSecret', # max: 512 | ||
| 56 | AccessToken => 'MyAccessToken', # max: 512; OPTIONAL | ||
| 57 | OAuthRequest => { | ||
| 58 | AuthCode => 'MyAuthCode', # max: 512; OPTIONAL | ||
| 59 | RedirectUri => 'MyRedirectUri', # max: 512; OPTIONAL | ||
| 60 | }, # OPTIONAL | ||
| 61 | RefreshToken => 'MyRefreshToken', # max: 512; OPTIONAL | ||
| 62 | }, # OPTIONAL | ||
| 63 | Honeycode => { | ||
| 64 | AccessToken => 'MyAccessToken', # max: 512; OPTIONAL | ||
| 65 | OAuthRequest => { | ||
| 66 | AuthCode => 'MyAuthCode', # max: 512; OPTIONAL | ||
| 67 | RedirectUri => 'MyRedirectUri', # max: 512; OPTIONAL | ||
| 68 | }, # OPTIONAL | ||
| 69 | RefreshToken => 'MyRefreshToken', # max: 512; OPTIONAL | ||
| 70 | }, # OPTIONAL | ||
| 71 | InforNexus => { | ||
| 72 | AccessKeyId => 'MyAccessKeyId', # max: 256 | ||
| 73 | Datakey => 'MyKey', # max: 512 | ||
| 74 | SecretAccessKey => 'MyKey', # max: 512 | ||
| 75 | UserId => 'MyUsername', # max: 512 | ||
| 76 | |||
| 77 | }, # OPTIONAL | ||
| 78 | Marketo => { | ||
| 79 | ClientId => 'MyClientId', # max: 512 | ||
| 80 | ClientSecret => 'MyClientSecret', # max: 512 | ||
| 81 | AccessToken => 'MyAccessToken', # max: 512; OPTIONAL | ||
| 82 | OAuthRequest => { | ||
| 83 | AuthCode => 'MyAuthCode', # max: 512; OPTIONAL | ||
| 84 | RedirectUri => 'MyRedirectUri', # max: 512; OPTIONAL | ||
| 85 | }, # OPTIONAL | ||
| 86 | }, # OPTIONAL | ||
| 87 | Redshift => { | ||
| 88 | Password => 'MyPassword', # max: 512 | ||
| 89 | Username => 'MyUsername', # max: 512 | ||
| 90 | |||
| 91 | }, # OPTIONAL | ||
| 92 | Salesforce => { | ||
| 93 | AccessToken => 'MyAccessToken', # max: 512; OPTIONAL | ||
| 94 | ClientCredentialsArn => | ||
| 95 | 'MyClientCredentialsArn', # min: 20, max: 2048; OPTIONAL | ||
| 96 | OAuthRequest => { | ||
| 97 | AuthCode => 'MyAuthCode', # max: 512; OPTIONAL | ||
| 98 | RedirectUri => 'MyRedirectUri', # max: 512; OPTIONAL | ||
| 99 | }, # OPTIONAL | ||
| 100 | RefreshToken => 'MyRefreshToken', # max: 512; OPTIONAL | ||
| 101 | }, # OPTIONAL | ||
| 102 | ServiceNow => { | ||
| 103 | Password => 'MyPassword', # max: 512 | ||
| 104 | Username => 'MyUsername', # max: 512 | ||
| 105 | |||
| 106 | }, # OPTIONAL | ||
| 107 | Singular => { | ||
| 108 | ApiKey => 'MyApiKey', # max: 256 | ||
| 109 | |||
| 110 | }, # OPTIONAL | ||
| 111 | Slack => { | ||
| 112 | ClientId => 'MyClientId', # max: 512 | ||
| 113 | ClientSecret => 'MyClientSecret', # max: 512 | ||
| 114 | AccessToken => 'MyAccessToken', # max: 512; OPTIONAL | ||
| 115 | OAuthRequest => { | ||
| 116 | AuthCode => 'MyAuthCode', # max: 512; OPTIONAL | ||
| 117 | RedirectUri => 'MyRedirectUri', # max: 512; OPTIONAL | ||
| 118 | }, # OPTIONAL | ||
| 119 | }, # OPTIONAL | ||
| 120 | Snowflake => { | ||
| 121 | Password => 'MyPassword', # max: 512 | ||
| 122 | Username => 'MyUsername', # max: 512 | ||
| 123 | |||
| 124 | }, # OPTIONAL | ||
| 125 | Trendmicro => { | ||
| 126 | ApiSecretKey => 'MyApiSecretKey', # max: 256 | ||
| 127 | |||
| 128 | }, # OPTIONAL | ||
| 129 | Veeva => { | ||
| 130 | Password => 'MyPassword', # max: 512 | ||
| 131 | Username => 'MyUsername', # max: 512 | ||
| 132 | |||
| 133 | }, # OPTIONAL | ||
| 134 | Zendesk => { | ||
| 135 | ClientId => 'MyClientId', # max: 512 | ||
| 136 | ClientSecret => 'MyClientSecret', # max: 512 | ||
| 137 | AccessToken => 'MyAccessToken', # max: 512; OPTIONAL | ||
| 138 | OAuthRequest => { | ||
| 139 | AuthCode => 'MyAuthCode', # max: 512; OPTIONAL | ||
| 140 | RedirectUri => 'MyRedirectUri', # max: 512; OPTIONAL | ||
| 141 | }, # OPTIONAL | ||
| 142 | }, # OPTIONAL | ||
| 143 | }, | ||
| 144 | ConnectorProfileProperties => { | ||
| 145 | Amplitude => { | ||
| 146 | |||
| 147 | }, # OPTIONAL | ||
| 148 | Datadog => { | ||
| 149 | InstanceUrl => 'MyInstanceUrl', # max: 256 | ||
| 150 | |||
| 151 | }, # OPTIONAL | ||
| 152 | Dynatrace => { | ||
| 153 | InstanceUrl => 'MyInstanceUrl', # max: 256 | ||
| 154 | |||
| 155 | }, # OPTIONAL | ||
| 156 | GoogleAnalytics => { | ||
| 157 | |||
| 158 | }, # OPTIONAL | ||
| 159 | Honeycode => { | ||
| 160 | |||
| 161 | }, # OPTIONAL | ||
| 162 | InforNexus => { | ||
| 163 | InstanceUrl => 'MyInstanceUrl', # max: 256 | ||
| 164 | |||
| 165 | }, # OPTIONAL | ||
| 166 | Marketo => { | ||
| 167 | InstanceUrl => 'MyInstanceUrl', # max: 256 | ||
| 168 | |||
| 169 | }, # OPTIONAL | ||
| 170 | Redshift => { | ||
| 171 | BucketName => 'MyBucketName', # min: 3, max: 63 | ||
| 172 | DatabaseUrl => 'MyDatabaseUrl', # max: 512 | ||
| 173 | RoleArn => 'MyRoleArn', # max: 512 | ||
| 174 | BucketPrefix => 'MyBucketPrefix', # max: 512; OPTIONAL | ||
| 175 | }, # OPTIONAL | ||
| 176 | Salesforce => { | ||
| 177 | InstanceUrl => 'MyInstanceUrl', # max: 256 | ||
| 178 | IsSandboxEnvironment => 1, # OPTIONAL | ||
| 179 | }, # OPTIONAL | ||
| 180 | ServiceNow => { | ||
| 181 | InstanceUrl => 'MyInstanceUrl', # max: 256 | ||
| 182 | |||
| 183 | }, # OPTIONAL | ||
| 184 | Singular => { | ||
| 185 | |||
| 186 | }, # OPTIONAL | ||
| 187 | Slack => { | ||
| 188 | InstanceUrl => 'MyInstanceUrl', # max: 256 | ||
| 189 | |||
| 190 | }, # OPTIONAL | ||
| 191 | Snowflake => { | ||
| 192 | BucketName => 'MyBucketName', # min: 3, max: 63 | ||
| 193 | Stage => 'MyStage', # max: 512 | ||
| 194 | Warehouse => 'MyWarehouse', # max: 512 | ||
| 195 | AccountName => 'MyAccountName', # max: 512; OPTIONAL | ||
| 196 | BucketPrefix => 'MyBucketPrefix', # max: 512; OPTIONAL | ||
| 197 | PrivateLinkServiceName => | ||
| 198 | 'MyPrivateLinkServiceName', # max: 512; OPTIONAL | ||
| 199 | Region => 'MyRegion', # max: 64; OPTIONAL | ||
| 200 | }, # OPTIONAL | ||
| 201 | Trendmicro => { | ||
| 202 | |||
| 203 | }, # OPTIONAL | ||
| 204 | Veeva => { | ||
| 205 | InstanceUrl => 'MyInstanceUrl', # max: 256 | ||
| 206 | |||
| 207 | }, # OPTIONAL | ||
| 208 | Zendesk => { | ||
| 209 | InstanceUrl => 'MyInstanceUrl', # max: 256 | ||
| 210 | |||
| 211 | }, # OPTIONAL | ||
| 212 | }, | ||
| 213 | |||
| 214 | }, | ||
| 215 | ConnectorProfileName => 'MyConnectorProfileName', | ||
| 216 | ConnectorType => 'Salesforce', | ||
| 217 | KmsArn => 'MyKMSArn', # OPTIONAL | ||
| 218 | ); | ||
| 219 | |||
| 220 | # Results: | ||
| 221 | my $ConnectorProfileArn = | ||
| 222 | $CreateConnectorProfileResponse->ConnectorProfileArn; | ||
| 223 | |||
| 224 | # Returns a L<Paws::Appflow::CreateConnectorProfileResponse> object. | ||
| 225 | |||
| 226 | Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. | ||
| 227 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/appflow/CreateConnectorProfile> | ||
| 228 | |||
| 229 | =head1 ATTRIBUTES | ||
| 230 | |||
| 231 | |||
| 232 | =head2 B<REQUIRED> ConnectionMode => Str | ||
| 233 | |||
| 234 | Indicates the connection mode and specifies whether it is public or | ||
| 235 | private. Private flows use AWS PrivateLink to route data over AWS | ||
| 236 | infrastructure without exposing it to the public internet. | ||
| 237 | |||
| 238 | Valid values are: C<"Public">, C<"Private"> | ||
| 239 | |||
| 240 | =head2 B<REQUIRED> ConnectorProfileConfig => L<Paws::Appflow::ConnectorProfileConfig> | ||
| 241 | |||
| 242 | Defines the connector-specific configuration and credentials. | ||
| 243 | |||
| 244 | |||
| 245 | |||
| 246 | =head2 B<REQUIRED> ConnectorProfileName => Str | ||
| 247 | |||
| 248 | The name of the connector profile. The name is unique for each | ||
| 249 | C<ConnectorProfile> in your AWS account. | ||
| 250 | |||
| 251 | |||
| 252 | |||
| 253 | =head2 B<REQUIRED> ConnectorType => Str | ||
| 254 | |||
| 255 | The type of connector, such as Salesforce, Amplitude, and so on. | ||
| 256 | |||
| 257 | Valid values are: C<"Salesforce">, C<"Singular">, C<"Slack">, C<"Redshift">, C<"S3">, C<"Marketo">, C<"Googleanalytics">, C<"Zendesk">, C<"Servicenow">, C<"Datadog">, C<"Trendmicro">, C<"Snowflake">, C<"Dynatrace">, C<"Infornexus">, C<"Amplitude">, C<"Veeva">, C<"EventBridge">, C<"LookoutMetrics">, C<"Upsolver">, C<"Honeycode">, C<"CustomerProfiles"> | ||
| 258 | |||
| 259 | =head2 KmsArn => Str | ||
| 260 | |||
| 261 | The ARN (Amazon Resource Name) of the Key Management Service (KMS) key | ||
| 262 | you provide for encryption. This is required if you do not want to use | ||
| 263 | the Amazon AppFlow-managed KMS key. If you don't provide anything here, | ||
| 264 | Amazon AppFlow uses the Amazon AppFlow-managed KMS key. | ||
| 265 | |||
| 266 | |||
| 267 | |||
| 268 | |||
| 269 | =head1 SEE ALSO | ||
| 270 | |||
| 271 | This class forms part of L<Paws>, documenting arguments for method CreateConnectorProfile in L<Paws::Appflow> | ||
| 272 | |||
| 273 | =head1 BUGS and CONTRIBUTIONS | ||
| 274 | |||
| 275 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 276 | |||
| 277 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 278 | |||
| 279 | =cut | ||
| 280 |