aws-cdk-lib.aws_events.CfnConnection.AuthParametersProperty

AuthParametersProperty Struct

Tthe authorization parameters to use for the connection.

Source

Generated code

Type last changed

v2.172.0 · 7 Dec 2024

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_events as events } from 'aws-cdk-lib';
const authParametersProperty: events.CfnConnection.AuthParametersProperty = {
  apiKeyAuthParameters: {
    apiKeyName: 'apiKeyName',
    apiKeyValue: 'apiKeyValue',
  },
  basicAuthParameters: {
    password: 'password',
    username: 'username',
  },
  connectivityParameters: {
    resourceParameters: {
      resourceConfigurationArn: 'resourceConfigurationArn',

      // the properties below are optional
      resourceAssociationArn: 'resourceAssociationArn',
    },
  },
  invocationHttpParameters: {
    bodyParameters: [{
      key: 'key',
      value: 'value',

      // the properties below are optional
      isValueSecret: false,
    }],
    headerParameters: [{
      key: 'key',
      value: 'value',

      // the properties below are optional
      isValueSecret: false,
    }],
    queryStringParameters: [{
      key: 'key',
      value: 'value',

      // the properties below are optional
      isValueSecret: false,
    }],
  },
  oAuthParameters: {
    authorizationEndpoint: 'authorizationEndpoint',
    clientParameters: {
      clientId: 'clientId',
      clientSecret: 'clientSecret',
    },
    httpMethod: 'httpMethod',

    // the properties below are optional
    oAuthHttpParameters: {
      bodyParameters: [{
        key: 'key',
        value: 'value',

        // the properties below are optional
        isValueSecret: false,
      }],
      headerParameters: [{
        key: 'key',
        value: 'value',

        // the properties below are optional
        isValueSecret: false,
      }],
      queryStringParameters: [{
        key: 'key',
        value: 'value',

        // the properties below are optional
        isValueSecret: false,
      }],
    },
  },
};

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_events as events

auth_parameters_property = events.CfnConnection.AuthParametersProperty(
    api_key_auth_parameters=events.CfnConnection.ApiKeyAuthParametersProperty(
        api_key_name="apiKeyName",
        api_key_value="apiKeyValue"
    ),
    basic_auth_parameters=events.CfnConnection.BasicAuthParametersProperty(
        password="password",
        username="username"
    ),
    connectivity_parameters=events.CfnConnection.ConnectivityParametersProperty(
        resource_parameters=events.CfnConnection.ResourceParametersProperty(
            resource_configuration_arn="resourceConfigurationArn",

            # the properties below are optional
            resource_association_arn="resourceAssociationArn"
        )
    ),
    invocation_http_parameters=events.CfnConnection.ConnectionHttpParametersProperty(
        body_parameters=[events.CfnConnection.ParameterProperty(
            key="key",
            value="value",

            # the properties below are optional
            is_value_secret=False
        )],
        header_parameters=[events.CfnConnection.ParameterProperty(
            key="key",
            value="value",

            # the properties below are optional
            is_value_secret=False
        )],
        query_string_parameters=[events.CfnConnection.ParameterProperty(
            key="key",
            value="value",

            # the properties below are optional
            is_value_secret=False
        )]
    ),
    o_auth_parameters=events.CfnConnection.OAuthParametersProperty(
        authorization_endpoint="authorizationEndpoint",
        client_parameters=events.CfnConnection.ClientParametersProperty(
            client_id="clientId",
            client_secret="clientSecret"
        ),
        http_method="httpMethod",

        # the properties below are optional
        o_auth_http_parameters=events.CfnConnection.ConnectionHttpParametersProperty(
            body_parameters=[events.CfnConnection.ParameterProperty(
                key="key",
                value="value",

                # the properties below are optional
                is_value_secret=False
            )],
            header_parameters=[events.CfnConnection.ParameterProperty(
                key="key",
                value="value",

                # the properties below are optional
                is_value_secret=False
            )],
            query_string_parameters=[events.CfnConnection.ParameterProperty(
                key="key",
                value="value",

                # the properties below are optional
                is_value_secret=False
            )]
        )
    )
)

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.events.*;

AuthParametersProperty authParametersProperty = AuthParametersProperty.builder()
        .apiKeyAuthParameters(ApiKeyAuthParametersProperty.builder()
                .apiKeyName("apiKeyName")
                .apiKeyValue("apiKeyValue")
                .build())
        .basicAuthParameters(BasicAuthParametersProperty.builder()
                .password("password")
                .username("username")
                .build())
        .connectivityParameters(ConnectivityParametersProperty.builder()
                .resourceParameters(ResourceParametersProperty.builder()
                        .resourceConfigurationArn("resourceConfigurationArn")

                        // the properties below are optional
                        .resourceAssociationArn("resourceAssociationArn")
                        .build())
                .build())
        .invocationHttpParameters(ConnectionHttpParametersProperty.builder()
                .bodyParameters(List.of(ParameterProperty.builder()
                        .key("key")
                        .value("value")

                        // the properties below are optional
                        .isValueSecret(false)
                        .build()))
                .headerParameters(List.of(ParameterProperty.builder()
                        .key("key")
                        .value("value")

                        // the properties below are optional
                        .isValueSecret(false)
                        .build()))
                .queryStringParameters(List.of(ParameterProperty.builder()
                        .key("key")
                        .value("value")

                        // the properties below are optional
                        .isValueSecret(false)
                        .build()))
                .build())
        .oAuthParameters(OAuthParametersProperty.builder()
                .authorizationEndpoint("authorizationEndpoint")
                .clientParameters(ClientParametersProperty.builder()
                        .clientId("clientId")
                        .clientSecret("clientSecret")
                        .build())
                .httpMethod("httpMethod")

                // the properties below are optional
                .oAuthHttpParameters(ConnectionHttpParametersProperty.builder()
                        .bodyParameters(List.of(ParameterProperty.builder()
                                .key("key")
                                .value("value")

                                // the properties below are optional
                                .isValueSecret(false)
                                .build()))
                        .headerParameters(List.of(ParameterProperty.builder()
                                .key("key")
                                .value("value")

                                // the properties below are optional
                                .isValueSecret(false)
                                .build()))
                        .queryStringParameters(List.of(ParameterProperty.builder()
                                .key("key")
                                .value("value")

                                // the properties below are optional
                                .isValueSecret(false)
                                .build()))
                        .build())
                .build())
        .build();

// Install: dotnet add package Amazon.CDK.Lib
// 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
            } }
        }
    }
};

// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

authParametersProperty := &AuthParametersProperty{
	ApiKeyAuthParameters: &ApiKeyAuthParametersProperty{
		ApiKeyName: jsii.String("apiKeyName"),
		ApiKeyValue: jsii.String("apiKeyValue"),
	},
	BasicAuthParameters: &BasicAuthParametersProperty{
		Password: jsii.String("password"),
		Username: jsii.String("username"),
	},
	ConnectivityParameters: &ConnectivityParametersProperty{
		ResourceParameters: &ResourceParametersProperty{
			ResourceConfigurationArn: jsii.String("resourceConfigurationArn"),

			// the properties below are optional
			ResourceAssociationArn: jsii.String("resourceAssociationArn"),
		},
	},
	InvocationHttpParameters: &ConnectionHttpParametersProperty{
		BodyParameters: []interface{}{
			&ParameterProperty{
				Key: jsii.String("key"),
				Value: jsii.String("value"),

				// the properties below are optional
				IsValueSecret: jsii.Boolean(false),
			},
		},
		HeaderParameters: []interface{}{
			&ParameterProperty{
				Key: jsii.String("key"),
				Value: jsii.String("value"),

				// the properties below are optional
				IsValueSecret: jsii.Boolean(false),
			},
		},
		QueryStringParameters: []interface{}{
			&ParameterProperty{
				Key: jsii.String("key"),
				Value: jsii.String("value"),

				// the properties below are optional
				IsValueSecret: jsii.Boolean(false),
			},
		},
	},
	OAuthParameters: &OAuthParametersProperty{
		AuthorizationEndpoint: jsii.String("authorizationEndpoint"),
		ClientParameters: &ClientParametersProperty{
			ClientId: jsii.String("clientId"),
			ClientSecret: jsii.String("clientSecret"),
		},
		HttpMethod: jsii.String("httpMethod"),

		// the properties below are optional
		OAuthHttpParameters: &ConnectionHttpParametersProperty{
			BodyParameters: []interface{}{
				&ParameterProperty{
					Key: jsii.String("key"),
					Value: jsii.String("value"),

					// the properties below are optional
					IsValueSecret: jsii.Boolean(false),
				},
			},
			HeaderParameters: []interface{}{
				&ParameterProperty{
					Key: jsii.String("key"),
					Value: jsii.String("value"),

					// the properties below are optional
					IsValueSecret: jsii.Boolean(false),
				},
			},
			QueryStringParameters: []interface{}{
				&ParameterProperty{
					Key: jsii.String("key"),
					Value: jsii.String("value"),

					// the properties below are optional
					IsValueSecret: jsii.Boolean(false),
				},
			},
		},
	},
}

Properties

apiKeyAuthParameters?optionalIResolvable | CfnConnection.ApiKeyAuthParametersPropertyapi_key_auth_parameters?optionaltyping.Union[IResolvable, ApiKeyAuthParametersProperty]apiKeyAuthParameters?optionalIResolvableApiKeyAuthParameters?optionalIResolvableApiKeyAuthParameters?optionalinterface{}#

The API Key parameters to use for authorization.

basicAuthParameters?optionalIResolvable | CfnConnection.BasicAuthParametersPropertybasic_auth_parameters?optionaltyping.Union[IResolvable, BasicAuthParametersProperty]basicAuthParameters?optionalIResolvableBasicAuthParameters?optionalIResolvableBasicAuthParameters?optionalinterface{}#

The authorization parameters for Basic authorization.

connectivityParameters?optionalIResolvable | CfnConnection.ConnectivityParametersPropertyconnectivity_parameters?optionaltyping.Union[IResolvable, ConnectivityParametersProperty]connectivityParameters?optionalIResolvableConnectivityParameters?optionalIResolvableConnectivityParameters?optionalinterface{}#

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

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

invocationHttpParameters?optionalIResolvable | CfnConnection.ConnectionHttpParametersPropertyinvocation_http_parameters?optionaltyping.Union[IResolvable, ConnectionHttpParametersProperty]invocationHttpParameters?optionalIResolvableInvocationHttpParameters?optionalIResolvableInvocationHttpParameters?optionalinterface{}#

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

oAuthParameters?optionalIResolvable | CfnConnection.OAuthParametersPropertyo_auth_parameters?optionaltyping.Union[IResolvable, OAuthParametersProperty]oAuthParameters?optionalIResolvableOAuthParameters?optionalIResolvableOAuthParameters?optionalinterface{}#

The OAuth parameters to use for authorization.