Module: AWSCDK::Events::IAPIDestination

Includes:
IResource, Interfaces::AWSEvents::IAPIDestinationRef
Included in:
APIDestination
Defined in:
events/iapi_destination.rb

Overview

Interface for API Destinations.

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.jsii_overridable_methods ⇒ Object 



98
99
100
101
102
103
104
105
106
107
108
109
110
 
# File 'events/iapi_destination.rb', line 98

def self.jsii_overridable_methods
  {
    :node => { kind: :property, name: "node", is_optional: false },
    :env => { kind: :property, name: "env", is_optional: false },
    :stack => { kind: :property, name: "stack", is_optional: false },
    :api_destination_ref => { kind: :property, name: "apiDestinationRef", is_optional: false },
    :api_destination_arn => { kind: :property, name: "apiDestinationArn", is_optional: false },
    :api_destination_name => { kind: :property, name: "apiDestinationName", is_optional: false },
    :api_destination_arn_for_policy => { kind: :property, name: "apiDestinationArnForPolicy", is_optional: true },
    :with => { kind: :method, name: "with", is_optional: false },
    :apply_removal_policy => { kind: :method, name: "applyRemovalPolicy", is_optional: false },
  }
end

Instance Method Details

#api_destination_arn ⇒ String

The ARN of the Api Destination created.

Returns:

  • (String) 


48
49
50
 
# File 'events/iapi_destination.rb', line 48

def api_destination_arn()
  jsii_get_property("apiDestinationArn")
end

#api_destination_arn_for_policy ⇒ String?

The Amazon Resource Name (ARN) of an API destination in resource format, so it can be used in the Resource element of IAM permission policy statements.

Returns:

  • (String, nil)

See Also:



63
64
65
 
# File 'events/iapi_destination.rb', line 63

def api_destination_arn_for_policy()
  jsii_get_property("apiDestinationArnForPolicy")
end

#api_destination_name ⇒ String

The Name of the Api Destination created.

Returns:

  • (String) 


55
56
57
 
# File 'events/iapi_destination.rb', line 55

def api_destination_name()
  jsii_get_property("apiDestinationName")
end

#api_destination_ref ⇒ AWSCDK::Interfaces::AWSEvents::APIDestinationReference

A reference to a ApiDestination resource.

Returns:



41
42
43
 
# File 'events/iapi_destination.rb', line 41

def api_destination_ref()
  jsii_get_property("apiDestinationRef")
end

#apply_removal_policy(policy) ⇒ void

This method returns an undefined value.

Apply the given removal policy to this resource.

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).

Parameters:



93
94
95
96
 
# File 'events/iapi_destination.rb', line 93

def apply_removal_policy(policy)
  Jsii::Type.check_type(policy, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZW1vdmFsUG9saWN5In0=")), "policy")
  jsii_call_method("applyRemovalPolicy", [policy])
end

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

The environment this resource belongs to.

For resources that are created and managed in a Stack (those created by creating new class instances like new Role(), new Bucket(), etc.), this is always the same as the environment of the stack they belong to.

For referenced resources (those obtained from referencing methods like Role.fromRoleArn(), Bucket.fromBucketName(), etc.), they might be different than the stack they were imported into.

Returns:



27
28
29
 
# File 'events/iapi_destination.rb', line 27

def env()
  jsii_get_property("env")
end

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


12
13
14
 
# File 'events/iapi_destination.rb', line 12

def node()
  jsii_get_property("node")
end

#stack ⇒ AWSCDK::Stack

The stack in which this resource is defined.

Returns:



34
35
36
 
# File 'events/iapi_destination.rb', line 34

def stack()
  jsii_get_property("stack")
end

#with(*mixins) ⇒ Constructs::IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited.

Parameters:

  • mixins (Array<Constructs::IMixin>) —

    The mixins to apply.

Returns:

  • (Constructs::IConstruct) —

    This construct for chaining



74
75
76
77
78
79
 
# File 'events/iapi_destination.rb', line 74

def with(*mixins)
  mixins.each_with_index do |item, index|
    Jsii::Type.check_type(item, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLklNaXhpbiJ9")), "mixins[#{index}]")
  end
  jsii_call_method("with", [*mixins])
end