Skip to content
GitmoapAPIBeta
Schema

CreateProviderConnectionRequest

Creates a provider connection. Credentials are checked against the provider's auth_schema and stored securely; they are never returned.

Shape

  • nameProviderConnectionName (string)
  • provider_idProviderId (string)
  • auth_modeConnectionAuthModestatic_credentialsoidc_federationoptionalHow the connection authenticates. Defaults to static_credentials.
  • config_overridesobjectoptional
  • credentialsobjectoptionalThe provider's credentials, in the shape its auth_schema describes. Required for static_credentials; refused for oidc_federation.
  • federation_targetOidcFederationTarget or nulloptionalThe federation target. Required for oidc_federation; absent for static_credentials.
    • The OidcFederationTarget schema
    • cloudaws
    • role_arnRoleArn (string)The IAM role the pipeline assumes.
    • audiencestring or nulloptionalThe audience of the identity token. Defaults to sts.amazonaws.com.
    • regionAwsRegion (string) or nulloptionalThe AWS region for the provider's calls.

Example

Synthesized example
{
"name": "payments-api",
"provider_id": "75cb00f0-8a3b-4729-ae0b-4bc4d7e9de83",
"auth_mode": "static_credentials",
"config_overrides": {},
"credentials": {},
"federation_target": {
"cloud": "aws",
"role_arn": "role-arn-a0ae",
"audience": "audience-5d6a",
"region": "region-cdec"
}
}

Graph

Used inside

No schema contains this one.

Contains

Used by

Sent by 2 operations
Returned by 0 operations

No operation returns it directly.