Interface ICfnConnectionProps

Properties for defining a CfnConnection.

Namespace: Amazon.CDK.AWS.Events
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public interface ICfnConnectionProps
Syntax (vb)
Public Interface ICfnConnectionProps
Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-connection.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 cfnConnectionProps = new CfnConnectionProps {
    AuthorizationType = "authorizationType",
    AuthParameters = 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
                } }
            }
        }
    },
    Description = "description",
    InvocationConnectivityParameters = new InvocationConnectivityParametersProperty {
        ResourceParameters = new ResourceParametersProperty {
            ResourceConfigurationArn = "resourceConfigurationArn",

            // the properties below are optional
            ResourceAssociationArn = "resourceAssociationArn"
        }
    },
    Name = "name"
};

Synopsis

Properties

AuthorizationType

The type of authorization to use for the connection.
AuthParameters

The authorization parameters to use to authorize with the endpoint.
Description

A description for the connection to create.
InvocationConnectivityParameters

For connections to private APIs, the parameters to use for invoking the API.
Name

The name for the connection to create.

Properties

AuthorizationType

The type of authorization to use for the connection.

virtual string AuthorizationType { get; }
Property Value

System.String

Remarks

OAUTH tokens are refreshed when a 401 or 407 response is returned.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-connection.html#cfn-events-connection-authorizationtype

AuthParameters

The authorization parameters to use to authorize with the endpoint.

virtual object AuthParameters { get; }
Property Value

System.Object

Remarks

You must include only authorization parameters for the AuthorizationType you specify.

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

Description

A description for the connection to create.

virtual string Description { get; }
Property Value

System.String

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-connection.html#cfn-events-connection-description

InvocationConnectivityParameters

For connections to private APIs, the parameters to use for invoking the API.

virtual object InvocationConnectivityParameters { get; }
Property Value

System.Object

Remarks

For more information, see Connecting to private APIs in the Amazon EventBridge User Guide .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-connection.html#cfn-events-connection-invocationconnectivityparameters

Name

The name for the connection to create.

virtual string Name { get; }
Property Value

System.String

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-connection.html#cfn-events-connection-name