Class CfnConnection
Creates a connection.
Implements
Inherited Members
Namespace: Amazon.CDK.AWS.Events
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnConnection : CfnResource, IInspectable
Syntax (vb)
Public Class CfnConnection
Inherits CfnResource
Implements IInspectable
Remarks
A connection defines the authorization type and credentials to use for authorization with an API destination HTTP endpoint.
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-connection.html
CloudformationResource: AWS::Events::Connection
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 cfnConnection = new CfnConnection(this, "MyCfnConnection", new CfnConnectionProps {
AuthorizationType = "authorizationType",
// the properties below are optional
AuthParameters = 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
} }
}
}
},
Description = "description",
Name = "name"
});
Synopsis
Constructors
CfnConnection(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnConnection(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
CfnConnection(Construct, String, ICfnConnectionProps) |
Properties
AttrArn | The ARN of the connection that was created by the request. |
AttrSecretArn | The ARN for the secret created for the connection. |
AuthorizationType | The type of authorization to use for the connection. |
AuthParameters | A |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
Description | A description for the connection to create. |
Name | The name for the connection to create. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnConnection(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnConnection(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnConnection(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnConnection(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
CfnConnection(Construct, String, ICfnConnectionProps)
public CfnConnection(Construct scope, string id, ICfnConnectionProps props)
Parameters
- scope Constructs.Construct
Scope in which this resource is defined.
- id System.String
Construct identifier for this resource (unique in its scope).
- props ICfnConnectionProps
Resource properties.
Properties
AttrArn
The ARN of the connection that was created by the request.
public virtual string AttrArn { get; }
Property Value
System.String
Remarks
CloudformationAttribute: Arn
AttrSecretArn
The ARN for the secret created for the connection.
public virtual string AttrSecretArn { get; }
Property Value
System.String
Remarks
CloudformationAttribute: SecretArn
AuthorizationType
The type of authorization to use for the connection.
public virtual string AuthorizationType { get; set; }
Property Value
System.String
AuthParameters
A CreateConnectionAuthRequestParameters
object that contains the authorization parameters to use to authorize with the endpoint.
public virtual object AuthParameters { get; set; }
Property Value
System.Object
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
Description
A description for the connection to create.
public virtual string Description { get; set; }
Property Value
System.String
Name
The name for the connection to create.
public virtual string Name { get; set; }
Property Value
System.String
Methods
Inspect(TreeInspector)
Examines the CloudFormation resource and discloses attributes.
public virtual void Inspect(TreeInspector inspector)
Parameters
- inspector TreeInspector
tree inspector to collect and process attributes.
RenderProperties(IDictionary<String, Object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>