package awsevents import ( _init_ "github.com/aws/aws-cdk-go/awscdk/v2/jsii" _jsii_ "github.com/aws/jsii-runtime-go/runtime" "github.com/aws/aws-cdk-go/awscdk/v2" "github.com/aws/aws-cdk-go/awscdk/v2/awsevents/internal" "github.com/aws/constructs-go/constructs/v10" ) // Creates an API destination, which is an HTTP invocation endpoint configured as a target for events. // // When using ApiDesinations with OAuth authentication we recommend these best practices: // // - Create a secret in Secrets Manager with your OAuth credentials. // - Reference that secret in your CloudFormation template for `AWS::Events::Connection` using CloudFormation dynamic reference syntax. For more information, see [Secrets Manager secrets](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/dynamic-references.html#dynamic-references-secretsmanager) . // // When the Connection resource is created the secret will be passed to EventBridge and stored in the customer account using “Service Linked Secrets,” effectively creating two secrets. This will minimize the cost because the original secret is only accessed when a CloudFormation template is created or updated, not every time an event is sent to the ApiDestination. The secret stored in the customer account by EventBridge is the one used for each event sent to the ApiDestination and AWS is responsible for the fees. // // > The secret stored in the customer account by EventBridge can’t be updated directly, only when a CloudFormation template is updated. // // For examples of CloudFormation templates that use secrets, see [Examples](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-connection.html#aws-resource-events-connection--examples) . // // Example: // // 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" // // cfnApiDestination := awscdk.Aws_events.NewCfnApiDestination(this, jsii.String("MyCfnApiDestination"), &CfnApiDestinationProps{ // ConnectionArn: jsii.String("connectionArn"), // HttpMethod: jsii.String("httpMethod"), // InvocationEndpoint: jsii.String("invocationEndpoint"), // // // the properties below are optional // Description: jsii.String("description"), // InvocationRateLimitPerSecond: jsii.Number(123), // Name: jsii.String("name"), // }) // // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-apidestination.html // type CfnApiDestination interface { awscdk.CfnResource awscdk.IInspectable // The ARN of the API destination that was created by the request. AttrArn() *string // Options for this resource, such as condition, update policy etc. CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} // AWS resource type. CfnResourceType() *string // The ARN of the connection to use for the API destination. ConnectionArn() *string SetConnectionArn(val *string) // Returns: the stack trace of the point where this Resource was created from, sourced // from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most // node +internal+ entries filtered. CreationStack() *[]*string // A description for the API destination to create. Description() *string SetDescription(val *string) // The method to use for the request to the HTTP invocation endpoint. HttpMethod() *string SetHttpMethod(val *string) // The URL to the HTTP invocation endpoint for the API destination. InvocationEndpoint() *string SetInvocationEndpoint(val *string) // The maximum number of requests per second to send to the HTTP invocation endpoint. InvocationRateLimitPerSecond() *float64 SetInvocationRateLimitPerSecond(val *float64) // The logical ID for this CloudFormation stack element. // // The logical ID of the element // is calculated from the path of the resource node in the construct tree. // // To override this value, use `overrideLogicalId(newLogicalId)`. // // Returns: the logical ID as a stringified token. This value will only get // resolved during synthesis. LogicalId() *string // The name for the API destination to create. Name() *string SetName(val *string) // The tree node. Node() constructs.Node // Return a string that will be resolved to a CloudFormation `{ Ref }` for this element. // // If, by any chance, the intrinsic reference of a resource is not a string, you could // coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`. Ref() *string // The stack in which this element is defined. // // CfnElements must be defined within a stack scope (directly or indirectly). Stack() awscdk.Stack // Deprecated. // Deprecated: use `updatedProperties` // // Return properties modified after initiation // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperites() *map[string]interface{} // Return properties modified after initiation. // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperties() *map[string]interface{} // Syntactic sugar for `addOverride(path, undefined)`. AddDeletionOverride(path *string) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // // This can be used for resources across stacks (or nested stack) boundaries // and the dependency will automatically be transferred to the relevant scope. AddDependency(target awscdk.CfnResource) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // Deprecated: use addDependency. AddDependsOn(target awscdk.CfnResource) // Add a value to the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // AddMetadata(key *string, value interface{}) // Adds an override to the synthesized CloudFormation resource. // // To add a // property override, either use `addPropertyOverride` or prefix `path` with // "Properties." (i.e. `Properties.TopicName`). // // If the override is nested, separate each nested level using a dot (.) in the path parameter. // If there is an array as part of the nesting, specify the index in the path. // // To include a literal `.` in the property name, prefix with a `\`. In most // programming languages you will need to write this as `"\\."` because the // `\` itself will need to be escaped. // // For example, // ```typescript // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']); // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE'); // ``` // would add the overrides // ```json // "Properties": { // "GlobalSecondaryIndexes": [ // { // "Projection": { // "NonKeyAttributes": [ "myattribute" ] // ... // } // ... // }, // { // "ProjectionType": "INCLUDE" // ... // }, // ] // ... // } // ``` // // The `value` argument to `addOverride` will not be processed or translated // in any way. Pass raw JSON values in here with the correct capitalization // for CloudFormation. If you pass CDK classes or structs, they will be // rendered with lowercased key names, and CloudFormation will reject the // template. AddOverride(path *string, value interface{}) // Adds an override that deletes the value of a property from the resource definition. AddPropertyDeletionOverride(propertyPath *string) // Adds an override to a resource property. // // Syntactic sugar for `addOverride("Properties.<...>", value)`. AddPropertyOverride(propertyPath *string, value interface{}) // Sets the deletion policy of the resource based on the removal policy specified. // // The Removal Policy controls what happens to this resource when it stops // being managed by CloudFormation, either because you've removed it from the // CDK application or because you've made a change that requires the resource // to be replaced. // // The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS // account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some // cases, a snapshot can be taken of the resource prior to deletion // (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy // can be found in the following link:. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options // ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions) // Returns a token for an runtime attribute of this resource. // // Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility // in case there is no generated attribute. GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference // Retrieve a value value from the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // GetMetadata(key *string) interface{} // Examines the CloudFormation resource and discloses attributes. Inspect(inspector awscdk.TreeInspector) // Retrieves an array of resources this resource depends on. // // This assembles dependencies on resources across stacks (including nested stacks) // automatically. ObtainDependencies() *[]interface{} // Get a shallow copy of dependencies between this resource and other resources in the same stack. ObtainResourceDependencies() *[]awscdk.CfnResource // Overrides the auto-generated logical ID with a specific ID. OverrideLogicalId(newLogicalId *string) // Indicates that this resource no longer depends on another resource. // // This can be used for resources across stacks (including nested stacks) // and the dependency will automatically be removed from the relevant scope. RemoveDependency(target awscdk.CfnResource) RenderProperties(props *map[string]interface{}) *map[string]interface{} // Replaces one dependency with another. ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource) // Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template. // // Returns: `true` if the resource should be included or `false` is the resource // should be omitted. ShouldSynthesize() *bool // Returns a string representation of this construct. // // Returns: a string representation of this resource. ToString() *string ValidateProperties(_properties interface{}) } // The jsii proxy struct for CfnApiDestination type jsiiProxy_CfnApiDestination struct { internal.Type__awscdkCfnResource internal.Type__awscdkIInspectable } func (j *jsiiProxy_CfnApiDestination) AttrArn() *string { var returns *string _jsii_.Get( j, "attrArn", &returns, ) return returns } func (j *jsiiProxy_CfnApiDestination) CfnOptions() awscdk.ICfnResourceOptions { var returns awscdk.ICfnResourceOptions _jsii_.Get( j, "cfnOptions", &returns, ) return returns } func (j *jsiiProxy_CfnApiDestination) CfnProperties() *map[string]interface{} { var returns *map[string]interface{} _jsii_.Get( j, "cfnProperties", &returns, ) return returns } func (j *jsiiProxy_CfnApiDestination) CfnResourceType() *string { var returns *string _jsii_.Get( j, "cfnResourceType", &returns, ) return returns } func (j *jsiiProxy_CfnApiDestination) ConnectionArn() *string { var returns *string _jsii_.Get( j, "connectionArn", &returns, ) return returns } func (j *jsiiProxy_CfnApiDestination) CreationStack() *[]*string { var returns *[]*string _jsii_.Get( j, "creationStack", &returns, ) return returns } func (j *jsiiProxy_CfnApiDestination) Description() *string { var returns *string _jsii_.Get( j, "description", &returns, ) return returns } func (j *jsiiProxy_CfnApiDestination) HttpMethod() *string { var returns *string _jsii_.Get( j, "httpMethod", &returns, ) return returns } func (j *jsiiProxy_CfnApiDestination) InvocationEndpoint() *string { var returns *string _jsii_.Get( j, "invocationEndpoint", &returns, ) return returns } func (j *jsiiProxy_CfnApiDestination) InvocationRateLimitPerSecond() *float64 { var returns *float64 _jsii_.Get( j, "invocationRateLimitPerSecond", &returns, ) return returns } func (j *jsiiProxy_CfnApiDestination) LogicalId() *string { var returns *string _jsii_.Get( j, "logicalId", &returns, ) return returns } func (j *jsiiProxy_CfnApiDestination) Name() *string { var returns *string _jsii_.Get( j, "name", &returns, ) return returns } func (j *jsiiProxy_CfnApiDestination) Node() constructs.Node { var returns constructs.Node _jsii_.Get( j, "node", &returns, ) return returns } func (j *jsiiProxy_CfnApiDestination) Ref() *string { var returns *string _jsii_.Get( j, "ref", &returns, ) return returns } func (j *jsiiProxy_CfnApiDestination) Stack() awscdk.Stack { var returns awscdk.Stack _jsii_.Get( j, "stack", &returns, ) return returns } func (j *jsiiProxy_CfnApiDestination) UpdatedProperites() *map[string]interface{} { var returns *map[string]interface{} _jsii_.Get( j, "updatedProperites", &returns, ) return returns } func (j *jsiiProxy_CfnApiDestination) UpdatedProperties() *map[string]interface{} { var returns *map[string]interface{} _jsii_.Get( j, "updatedProperties", &returns, ) return returns } func NewCfnApiDestination(scope constructs.Construct, id *string, props *CfnApiDestinationProps) CfnApiDestination { _init_.Initialize() if err := validateNewCfnApiDestinationParameters(scope, id, props); err != nil { panic(err) } j := jsiiProxy_CfnApiDestination{} _jsii_.Create( "aws-cdk-lib.aws_events.CfnApiDestination", []interface{}{scope, id, props}, &j, ) return &j } func NewCfnApiDestination_Override(c CfnApiDestination, scope constructs.Construct, id *string, props *CfnApiDestinationProps) { _init_.Initialize() _jsii_.Create( "aws-cdk-lib.aws_events.CfnApiDestination", []interface{}{scope, id, props}, c, ) } func (j *jsiiProxy_CfnApiDestination)SetConnectionArn(val *string) { if err := j.validateSetConnectionArnParameters(val); err != nil { panic(err) } _jsii_.Set( j, "connectionArn", val, ) } func (j *jsiiProxy_CfnApiDestination)SetDescription(val *string) { _jsii_.Set( j, "description", val, ) } func (j *jsiiProxy_CfnApiDestination)SetHttpMethod(val *string) { if err := j.validateSetHttpMethodParameters(val); err != nil { panic(err) } _jsii_.Set( j, "httpMethod", val, ) } func (j *jsiiProxy_CfnApiDestination)SetInvocationEndpoint(val *string) { if err := j.validateSetInvocationEndpointParameters(val); err != nil { panic(err) } _jsii_.Set( j, "invocationEndpoint", val, ) } func (j *jsiiProxy_CfnApiDestination)SetInvocationRateLimitPerSecond(val *float64) { _jsii_.Set( j, "invocationRateLimitPerSecond", val, ) } func (j *jsiiProxy_CfnApiDestination)SetName(val *string) { _jsii_.Set( j, "name", val, ) } // Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template). // // Uses duck-typing instead of `instanceof` to allow stack elements from different // versions of this library to be included in the same stack. // // Returns: The construct as a stack element or undefined if it is not a stack element. func CfnApiDestination_IsCfnElement(x interface{}) *bool { _init_.Initialize() if err := validateCfnApiDestination_IsCfnElementParameters(x); err != nil { panic(err) } var returns *bool _jsii_.StaticInvoke( "aws-cdk-lib.aws_events.CfnApiDestination", "isCfnElement", []interface{}{x}, &returns, ) return returns } // Check whether the given construct is a CfnResource. func CfnApiDestination_IsCfnResource(construct constructs.IConstruct) *bool { _init_.Initialize() if err := validateCfnApiDestination_IsCfnResourceParameters(construct); err != nil { panic(err) } var returns *bool _jsii_.StaticInvoke( "aws-cdk-lib.aws_events.CfnApiDestination", "isCfnResource", []interface{}{construct}, &returns, ) return returns } // Checks if `x` is a construct. // // Use this method instead of `instanceof` to properly detect `Construct` // instances, even when the construct library is symlinked. // // Explanation: in JavaScript, multiple copies of the `constructs` library on // disk are seen as independent, completely different libraries. As a // consequence, the class `Construct` in each copy of the `constructs` library // is seen as a different class, and an instance of one class will not test as // `instanceof` the other class. `npm install` will not create installations // like this, but users may manually symlink construct libraries together or // use a monorepo tool: in those cases, multiple copies of the `constructs` // library can be accidentally installed, and `instanceof` will behave // unpredictably. It is safest to avoid using `instanceof`, and using // this type-testing method instead. // // Returns: true if `x` is an object created from a class which extends `Construct`. func CfnApiDestination_IsConstruct(x interface{}) *bool { _init_.Initialize() if err := validateCfnApiDestination_IsConstructParameters(x); err != nil { panic(err) } var returns *bool _jsii_.StaticInvoke( "aws-cdk-lib.aws_events.CfnApiDestination", "isConstruct", []interface{}{x}, &returns, ) return returns } func CfnApiDestination_CFN_RESOURCE_TYPE_NAME() *string { _init_.Initialize() var returns *string _jsii_.StaticGet( "aws-cdk-lib.aws_events.CfnApiDestination", "CFN_RESOURCE_TYPE_NAME", &returns, ) return returns } func (c *jsiiProxy_CfnApiDestination) AddDeletionOverride(path *string) { if err := c.validateAddDeletionOverrideParameters(path); err != nil { panic(err) } _jsii_.InvokeVoid( c, "addDeletionOverride", []interface{}{path}, ) } func (c *jsiiProxy_CfnApiDestination) AddDependency(target awscdk.CfnResource) { if err := c.validateAddDependencyParameters(target); err != nil { panic(err) } _jsii_.InvokeVoid( c, "addDependency", []interface{}{target}, ) } func (c *jsiiProxy_CfnApiDestination) AddDependsOn(target awscdk.CfnResource) { if err := c.validateAddDependsOnParameters(target); err != nil { panic(err) } _jsii_.InvokeVoid( c, "addDependsOn", []interface{}{target}, ) } func (c *jsiiProxy_CfnApiDestination) AddMetadata(key *string, value interface{}) { if err := c.validateAddMetadataParameters(key, value); err != nil { panic(err) } _jsii_.InvokeVoid( c, "addMetadata", []interface{}{key, value}, ) } func (c *jsiiProxy_CfnApiDestination) AddOverride(path *string, value interface{}) { if err := c.validateAddOverrideParameters(path, value); err != nil { panic(err) } _jsii_.InvokeVoid( c, "addOverride", []interface{}{path, value}, ) } func (c *jsiiProxy_CfnApiDestination) AddPropertyDeletionOverride(propertyPath *string) { if err := c.validateAddPropertyDeletionOverrideParameters(propertyPath); err != nil { panic(err) } _jsii_.InvokeVoid( c, "addPropertyDeletionOverride", []interface{}{propertyPath}, ) } func (c *jsiiProxy_CfnApiDestination) AddPropertyOverride(propertyPath *string, value interface{}) { if err := c.validateAddPropertyOverrideParameters(propertyPath, value); err != nil { panic(err) } _jsii_.InvokeVoid( c, "addPropertyOverride", []interface{}{propertyPath, value}, ) } func (c *jsiiProxy_CfnApiDestination) ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions) { if err := c.validateApplyRemovalPolicyParameters(options); err != nil { panic(err) } _jsii_.InvokeVoid( c, "applyRemovalPolicy", []interface{}{policy, options}, ) } func (c *jsiiProxy_CfnApiDestination) GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference { if err := c.validateGetAttParameters(attributeName); err != nil { panic(err) } var returns awscdk.Reference _jsii_.Invoke( c, "getAtt", []interface{}{attributeName, typeHint}, &returns, ) return returns } func (c *jsiiProxy_CfnApiDestination) GetMetadata(key *string) interface{} { if err := c.validateGetMetadataParameters(key); err != nil { panic(err) } var returns interface{} _jsii_.Invoke( c, "getMetadata", []interface{}{key}, &returns, ) return returns } func (c *jsiiProxy_CfnApiDestination) Inspect(inspector awscdk.TreeInspector) { if err := c.validateInspectParameters(inspector); err != nil { panic(err) } _jsii_.InvokeVoid( c, "inspect", []interface{}{inspector}, ) } func (c *jsiiProxy_CfnApiDestination) ObtainDependencies() *[]interface{} { var returns *[]interface{} _jsii_.Invoke( c, "obtainDependencies", nil, // no parameters &returns, ) return returns } func (c *jsiiProxy_CfnApiDestination) ObtainResourceDependencies() *[]awscdk.CfnResource { var returns *[]awscdk.CfnResource _jsii_.Invoke( c, "obtainResourceDependencies", nil, // no parameters &returns, ) return returns } func (c *jsiiProxy_CfnApiDestination) OverrideLogicalId(newLogicalId *string) { if err := c.validateOverrideLogicalIdParameters(newLogicalId); err != nil { panic(err) } _jsii_.InvokeVoid( c, "overrideLogicalId", []interface{}{newLogicalId}, ) } func (c *jsiiProxy_CfnApiDestination) RemoveDependency(target awscdk.CfnResource) { if err := c.validateRemoveDependencyParameters(target); err != nil { panic(err) } _jsii_.InvokeVoid( c, "removeDependency", []interface{}{target}, ) } func (c *jsiiProxy_CfnApiDestination) RenderProperties(props *map[string]interface{}) *map[string]interface{} { if err := c.validateRenderPropertiesParameters(props); err != nil { panic(err) } var returns *map[string]interface{} _jsii_.Invoke( c, "renderProperties", []interface{}{props}, &returns, ) return returns } func (c *jsiiProxy_CfnApiDestination) ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource) { if err := c.validateReplaceDependencyParameters(target, newTarget); err != nil { panic(err) } _jsii_.InvokeVoid( c, "replaceDependency", []interface{}{target, newTarget}, ) } func (c *jsiiProxy_CfnApiDestination) ShouldSynthesize() *bool { var returns *bool _jsii_.Invoke( c, "shouldSynthesize", nil, // no parameters &returns, ) return returns } func (c *jsiiProxy_CfnApiDestination) ToString() *string { var returns *string _jsii_.Invoke( c, "toString", nil, // no parameters &returns, ) return returns } func (c *jsiiProxy_CfnApiDestination) ValidateProperties(_properties interface{}) { if err := c.validateValidatePropertiesParameters(_properties); err != nil { panic(err) } _jsii_.InvokeVoid( c, "validateProperties", []interface{}{_properties}, ) }