Interface CfnConnection.IAuthParametersProperty

Tthe authorization parameters to use for the connection.

Namespace: Amazon.CDK.AWS.Events

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public interface CfnConnection.IAuthParametersProperty

Syntax (vb)

Public Interface CfnConnection.IAuthParametersProperty

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-connection-authparameters.html

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.Events;

             var authParametersProperty = new AuthParametersProperty {
                 ApiKeyAuthParameters = new ApiKeyAuthParametersProperty {
                     ApiKeyName = "apiKeyName",
                     ApiKeyValue = "apiKeyValue"
                 },
                 BasicAuthParameters = new BasicAuthParametersProperty {
                     Password = "password",
                     Username = "username"
                 },
                 ConnectivityParameters = new ConnectivityParametersProperty {
                     ResourceParameters = new ResourceParametersProperty {
                         ResourceConfigurationArn = "resourceConfigurationArn",

                         // the properties below are optional
                         ResourceAssociationArn = "resourceAssociationArn"
                     }
                 },
                 InvocationHttpParameters = new ConnectionHttpParametersProperty {
                     BodyParameters = new [] { new ParameterProperty {
                         Key = "key",
                         Value = "value",

                         // the properties below are optional
                         IsValueSecret = false
                     } },
                     HeaderParameters = new [] { new ParameterProperty {
                         Key = "key",
                         Value = "value",

                         // the properties below are optional
                         IsValueSecret = false
                     } },
                     QueryStringParameters = new [] { new ParameterProperty {
                         Key = "key",
                         Value = "value",

                         // the properties below are optional
                         IsValueSecret = false
                     } }
                 },
                 OAuthParameters = new OAuthParametersProperty {
                     AuthorizationEndpoint = "authorizationEndpoint",
                     ClientParameters = new ClientParametersProperty {
                         ClientId = "clientId",
                         ClientSecret = "clientSecret"
                     },
                     HttpMethod = "httpMethod",

                     // the properties below are optional
                     OAuthHttpParameters = new ConnectionHttpParametersProperty {
                         BodyParameters = new [] { new ParameterProperty {
                             Key = "key",
                             Value = "value",

                             // the properties below are optional
                             IsValueSecret = false
                         } },
                         HeaderParameters = new [] { new ParameterProperty {
                             Key = "key",
                             Value = "value",

                             // the properties below are optional
                             IsValueSecret = false
                         } },
                         QueryStringParameters = new [] { new ParameterProperty {
                             Key = "key",
                             Value = "value",

                             // the properties below are optional
                             IsValueSecret = false
                         } }
                     }
                 }
             };

Synopsis

Properties

ApiKeyAuthParameters	The API Key parameters to use for authorization.
BasicAuthParameters	The authorization parameters for Basic authorization.
ConnectivityParameters	For private OAuth authentication endpoints. The parameters EventBridge uses to authenticate against the endpoint.
InvocationHttpParameters	Additional parameters for the connection that are passed through with every invocation to the HTTP endpoint.
OAuthParameters	The OAuth parameters to use for authorization.

Properties

ApiKeyAuthParameters

The API Key parameters to use for authorization.

object? ApiKeyAuthParameters { get; }

Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-connection-authparameters.html#cfn-events-connection-authparameters-apikeyauthparameters

Type union: either IResolvable or CfnConnection.IApiKeyAuthParametersProperty

BasicAuthParameters

The authorization parameters for Basic authorization.

object? BasicAuthParameters { get; }

Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-connection-authparameters.html#cfn-events-connection-authparameters-basicauthparameters

Type union: either IResolvable or CfnConnection.IBasicAuthParametersProperty

ConnectivityParameters

For private OAuth authentication endpoints. The parameters EventBridge uses to authenticate against the endpoint.

object? ConnectivityParameters { get; }

Property Value

object

Remarks

For more information, see Authorization methods for connections in the Amazon EventBridge User Guide .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-connection-authparameters.html#cfn-events-connection-authparameters-connectivityparameters

Type union: either IResolvable or CfnConnection.IConnectivityParametersProperty

InvocationHttpParameters

Additional parameters for the connection that are passed through with every invocation to the HTTP endpoint.

object? InvocationHttpParameters { get; }

Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-connection-authparameters.html#cfn-events-connection-authparameters-invocationhttpparameters

Type union: either IResolvable or CfnConnection.IConnectionHttpParametersProperty

OAuthParameters

The OAuth parameters to use for authorization.

object? OAuthParameters { get; }

Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-connection-authparameters.html#cfn-events-connection-authparameters-oauthparameters

Type union: either IResolvable or CfnConnection.IOAuthParametersProperty