Class CfnConnection.AuthParametersProperty
Contains the authorization parameters to use for the connection.
Inheritance
System.Object
CfnConnection.AuthParametersProperty
Implements
Namespace: Amazon.CDK.AWS.Events
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class AuthParametersProperty : Object, CfnConnection.IAuthParametersProperty
Syntax (vb)
Public Class AuthParametersProperty
Inherits Object
Implements CfnConnection.IAuthParametersProperty
Remarks
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"
},
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
Constructors
AuthParametersProperty() |
Properties
ApiKeyAuthParameters | The API Key parameters to use for authorization. |
BasicAuthParameters | The authorization parameters for Basic authorization. |
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. |
Constructors
AuthParametersProperty()
public AuthParametersProperty()
Properties
ApiKeyAuthParameters
The API Key parameters to use for authorization.
public object ApiKeyAuthParameters { get; set; }
Property Value
System.Object
Remarks
BasicAuthParameters
The authorization parameters for Basic authorization.
public object BasicAuthParameters { get; set; }
Property Value
System.Object
Remarks
InvocationHttpParameters
Additional parameters for the connection that are passed through with every invocation to the HTTP endpoint.
public object InvocationHttpParameters { get; set; }
Property Value
System.Object
Remarks
OAuthParameters
The OAuth parameters to use for authorization.
public object OAuthParameters { get; set; }
Property Value
System.Object