Class CfnConnection.OAuthParametersProperty
Contains the OAuth authorization parameters to use for the connection.
Implements
Inherited Members
Namespace: Amazon.CDK.AWS.Events
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnConnection.OAuthParametersProperty : CfnConnection.IOAuthParametersProperty
Syntax (vb)
Public Class CfnConnection.OAuthParametersProperty Implements CfnConnection.IOAuthParametersProperty
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 oAuthParametersProperty = 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
| OAuthParametersProperty() | Contains the OAuth authorization parameters to use for the connection. |
Properties
| AuthorizationEndpoint | The URL to the authorization endpoint when OAuth is specified as the authorization type. |
| ClientParameters | The client parameters for OAuth authorization. |
| HttpMethod | The method to use for the authorization request. |
| OAuthHttpParameters | Details about the additional parameters to use for the connection. |
Constructors
OAuthParametersProperty()
Contains the OAuth authorization parameters to use for the connection.
public OAuthParametersProperty()
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 oAuthParametersProperty = 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
} }
}
};
Properties
AuthorizationEndpoint
The URL to the authorization endpoint when OAuth is specified as the authorization type.
public string AuthorizationEndpoint { get; set; }
Property Value
Remarks
ClientParameters
The client parameters for OAuth authorization.
public object ClientParameters { get; set; }
Property Value
Remarks
HttpMethod
The method to use for the authorization request.
public string HttpMethod { get; set; }
Property Value
Remarks
OAuthHttpParameters
Details about the additional parameters to use for the connection.
public object? OAuthHttpParameters { get; set; }