Class: AWSCDK::RTBFabric::CfnResponderGateway
- Inherits:
-
CfnResource
- Object
- CfnResource
- AWSCDK::RTBFabric::CfnResponderGateway
- Includes:
- IInspectable, ITaggableV2, Interfaces::AWSRtbfabric::IResponderGatewayRef
- Defined in:
- rtb_fabric/cfn_responder_gateway.rb
Overview
Creates a responder gateway.
A domain name or managed endpoint is required.
Class Method Summary collapse
- .arn_for_responder_gateway(resource) ⇒ String
-
.CFN_RESOURCE_TYPE_NAME ⇒ String
The CloudFormation resource type name for this resource class.
-
.is_cfn_responder_gateway(x) ⇒ Boolean
Checks whether the given object is a CfnResponderGateway.
- .jsii_overridable_methods ⇒ Object
Instance Method Summary collapse
- #acm_certificate_arn ⇒ String?
- #acm_certificate_arn=(value) ⇒ Object
-
#add_deletion_override(path) ⇒ void
Syntactic sugar for
addOverride(path, undefined). -
#add_dependency(target) ⇒ void
Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
-
#add_depends_on(target) ⇒ void
deprecated
Deprecated.
use addDependency
-
#add_metadata(key, value) ⇒ void
Add a value to the CloudFormation Resource Metadata.
-
#add_override(path, value) ⇒ void
Adds an override to the synthesized CloudFormation resource.
-
#add_property_deletion_override(property_path) ⇒ void
Adds an override that deletes the value of a property from the resource definition.
-
#add_property_override(property_path, value) ⇒ void
Adds an override to a resource property.
-
#apply_cross_stack_reference_strength(strength) ⇒ void
Sets the cross-stack reference strength for this resource.
-
#apply_removal_policy(policy = nil, options = nil) ⇒ void
Sets the deletion policy of the resource based on the removal policy specified.
- #attr_arn ⇒ String
- #attr_certificate_association_status ⇒ String
- #attr_created_timestamp ⇒ String
- #attr_external_inbound_endpoint ⇒ String
- #attr_gateway_id ⇒ String
- #attr_responder_gateway_status ⇒ String
- #attr_updated_timestamp ⇒ String
-
#cdk_tag_manager ⇒ AWSCDK::TagManager
Tag Manager which manages the tags for this resource.
-
#cfn_options ⇒ AWSCDK::ICfnResourceOptions
Options for this resource, such as condition, update policy etc.
- #cfn_properties ⇒ Hash{String => Object}
- #cfn_property_name(cdk_property_name) ⇒ String?
- #cfn_property_names ⇒ Hash{String => String}
-
#cfn_resource_type ⇒ String
AWS resource type.
- #creation_stack ⇒ Array<String>
-
#description ⇒ String?
An optional description for the responder gateway.
- #description=(value) ⇒ Object
-
#domain_name ⇒ String?
The domain name for the responder gateway.
- #domain_name=(value) ⇒ Object
- #env ⇒ AWSCDK::Interfaces::ResourceEnvironment
- #gateway_type ⇒ String?
- #gateway_type=(value) ⇒ Object
-
#get_att(attribute_name, type_hint = nil) ⇒ AWSCDK::Reference
Returns a token for an runtime attribute of this resource.
-
#get_metadata(key) ⇒ Object
Retrieve a value value from the CloudFormation Resource Metadata.
-
#initialize(scope, id, props) ⇒ CfnResponderGateway
constructor
Create a new
AWS::RTBFabric::ResponderGateway. -
#inspect(inspector) ⇒ void
Examines the CloudFormation resource and discloses attributes.
- #listener_config ⇒ AWSCDK::IResolvable, ...
- #listener_config=(value) ⇒ Object
-
#logical_id ⇒ String
The logical ID for this CloudFormation stack element.
-
#managed_endpoint_configuration ⇒ AWSCDK::IResolvable, ...
The configuration for the managed endpoint.
- #managed_endpoint_configuration=(value) ⇒ Object
-
#node ⇒ Constructs::Node
The tree node.
-
#obtain_dependencies ⇒ Array<AWSCDK::CfnResource, AWSCDK::Stack>
Retrieves an array of resources this resource depends on.
-
#obtain_resource_dependencies ⇒ Array<AWSCDK::CfnResource>
Get a shallow copy of dependencies between this resource and other resources in the same stack.
-
#override_logical_id(new_logical_id) ⇒ void
Overrides the auto-generated logical ID with a specific ID.
-
#port ⇒ Numeric
The networking port to use.
- #port=(value) ⇒ Object
-
#protocol ⇒ String
The networking protocol to use.
- #protocol=(value) ⇒ Object
-
#ref ⇒ String
Return a string that will be resolved to a CloudFormation
{ Ref }for this element. -
#remove_dependency(target) ⇒ void
Indicates that this resource no longer depends on another resource.
- #render_properties(props) ⇒ Hash{String => Object}
-
#replace_dependency(target, new_target) ⇒ void
Replaces one dependency with another.
-
#responder_gateway_ref ⇒ AWSCDK::Interfaces::AWSRtbfabric::ResponderGatewayReference
A reference to a ResponderGateway resource.
-
#security_group_ids ⇒ Array<String>
The unique identifiers of the security groups.
- #security_group_ids=(value) ⇒ Object
-
#should_synthesize ⇒ Boolean
Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.
-
#stack ⇒ AWSCDK::Stack
The stack in which this element is defined.
-
#subnet_ids ⇒ Array<String>
The unique identifiers of the subnets.
- #subnet_ids=(value) ⇒ Object
-
#tags ⇒ Array<AWSCDK::CfnTag>?
A map of the key-value pairs of the tag or tags to assign to the resource.
- #tags=(value) ⇒ Object
-
#to_string ⇒ String
Returns a string representation of this construct.
-
#trust_store_configuration ⇒ AWSCDK::IResolvable, ...
The configuration of the trust store.
- #trust_store_configuration=(value) ⇒ Object
-
#updated_properites ⇒ Hash{String => Object}
deprecated
Deprecated.
use
updatedPropertiesReturn properties modified after initiation Resources that expose mutable properties should override this function to collect and return the properties object for this resource. -
#updated_properties ⇒ Hash{String => Object}
Return properties modified after initiation.
- #validate_properties(_properties) ⇒ void
-
#vpc_id ⇒ String
The unique identifier of the Virtual Private Cloud (VPC).
- #vpc_id=(value) ⇒ Object
-
#with(*mixins) ⇒ Constructs::IConstruct
Applies one or more mixins to this construct.
Constructor Details
#initialize(scope, id, props) ⇒ CfnResponderGateway
Create a new AWS::RTBFabric::ResponderGateway.
20 21 22 23 24 25 26 |
# File 'rtb_fabric/cfn_responder_gateway.rb', line 20 def initialize(scope, id, props) props = props.is_a?(Hash) ? ::AWSCDK::RTBFabric::CfnResponderGatewayProps.new(**props.transform_keys(&:to_sym)) : props Jsii::Type.check_type(scope, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLkNvbnN0cnVjdCJ9")), "scope") Jsii::Type.check_type(id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "id") Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfcnRiZmFicmljLkNmblJlc3BvbmRlckdhdGV3YXlQcm9wcyJ9")), "props") Jsii::Object.instance_method(:initialize).bind(self).call(scope, id, props) end |
Class Method Details
.arn_for_responder_gateway(resource) ⇒ String
92 93 94 95 |
# File 'rtb_fabric/cfn_responder_gateway.rb', line 92 def self.arn_for_responder_gateway(resource) Jsii::Type.check_type(resource, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19ydGJmYWJyaWMuSVJlc3BvbmRlckdhdGV3YXlSZWYifQ==")), "resource") Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_rtbfabric.CfnResponderGateway", "arnForResponderGateway", [resource]) end |
.CFN_RESOURCE_TYPE_NAME ⇒ String
The CloudFormation resource type name for this resource class.
199 200 201 |
# File 'rtb_fabric/cfn_responder_gateway.rb', line 199 def self.CFN_RESOURCE_TYPE_NAME() Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_rtbfabric.CfnResponderGateway", "CFN_RESOURCE_TYPE_NAME") end |
.is_cfn_responder_gateway(x) ⇒ Boolean
Checks whether the given object is a CfnResponderGateway.
101 102 103 104 |
# File 'rtb_fabric/cfn_responder_gateway.rb', line 101 def self.is_cfn_responder_gateway(x) Jsii::Type.check_type(x, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "x") Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_rtbfabric.CfnResponderGateway", "isCfnResponderGateway", [x]) end |
.jsii_overridable_methods ⇒ Object
28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 |
# File 'rtb_fabric/cfn_responder_gateway.rb', line 28 def self.jsii_overridable_methods { :node => { kind: :property, name: "node", is_optional: false }, :creation_stack => { kind: :property, name: "creationStack", is_optional: false }, :logical_id => { kind: :property, name: "logicalId", is_optional: false }, :stack => { kind: :property, name: "stack", is_optional: false }, :ref => { kind: :property, name: "ref", is_optional: false }, :cfn_options => { kind: :property, name: "cfnOptions", is_optional: false }, :cfn_properties => { kind: :property, name: "cfnProperties", is_optional: false }, :cfn_property_names => { kind: :property, name: "cfnPropertyNames", is_optional: false }, :cfn_resource_type => { kind: :property, name: "cfnResourceType", is_optional: false }, :env => { kind: :property, name: "env", is_optional: false }, :updated_properites => { kind: :property, name: "updatedProperites", is_optional: false }, :updated_properties => { kind: :property, name: "updatedProperties", is_optional: false }, :attr_arn => { kind: :property, name: "attrArn", is_optional: false }, :attr_certificate_association_status => { kind: :property, name: "attrCertificateAssociationStatus", is_optional: false }, :attr_created_timestamp => { kind: :property, name: "attrCreatedTimestamp", is_optional: false }, :attr_external_inbound_endpoint => { kind: :property, name: "attrExternalInboundEndpoint", is_optional: false }, :attr_gateway_id => { kind: :property, name: "attrGatewayId", is_optional: false }, :attr_responder_gateway_status => { kind: :property, name: "attrResponderGatewayStatus", is_optional: false }, :attr_updated_timestamp => { kind: :property, name: "attrUpdatedTimestamp", is_optional: false }, :cdk_tag_manager => { kind: :property, name: "cdkTagManager", is_optional: false }, :responder_gateway_ref => { kind: :property, name: "responderGatewayRef", is_optional: false }, :port => { kind: :property, name: "port", is_optional: false }, :protocol => { kind: :property, name: "protocol", is_optional: false }, :security_group_ids => { kind: :property, name: "securityGroupIds", is_optional: false }, :subnet_ids => { kind: :property, name: "subnetIds", is_optional: false }, :vpc_id => { kind: :property, name: "vpcId", is_optional: false }, :acm_certificate_arn => { kind: :property, name: "acmCertificateArn", is_optional: true }, :description => { kind: :property, name: "description", is_optional: true }, :domain_name => { kind: :property, name: "domainName", is_optional: true }, :gateway_type => { kind: :property, name: "gatewayType", is_optional: true }, :listener_config => { kind: :property, name: "listenerConfig", is_optional: true }, :managed_endpoint_configuration => { kind: :property, name: "managedEndpointConfiguration", is_optional: true }, :tags => { kind: :property, name: "tags", is_optional: true }, :trust_store_configuration => { kind: :property, name: "trustStoreConfiguration", is_optional: true }, :to_string => { kind: :method, name: "toString", is_optional: false }, :with => { kind: :method, name: "with", is_optional: false }, :override_logical_id => { kind: :method, name: "overrideLogicalId", is_optional: false }, :add_deletion_override => { kind: :method, name: "addDeletionOverride", is_optional: false }, :add_dependency => { kind: :method, name: "addDependency", is_optional: false }, :add_depends_on => { kind: :method, name: "addDependsOn", is_optional: false }, :add_metadata => { kind: :method, name: "addMetadata", is_optional: false }, :add_override => { kind: :method, name: "addOverride", is_optional: false }, :add_property_deletion_override => { kind: :method, name: "addPropertyDeletionOverride", is_optional: false }, :add_property_override => { kind: :method, name: "addPropertyOverride", is_optional: false }, :apply_cross_stack_reference_strength => { kind: :method, name: "applyCrossStackReferenceStrength", is_optional: false }, :apply_removal_policy => { kind: :method, name: "applyRemovalPolicy", is_optional: false }, :cfn_property_name => { kind: :method, name: "cfnPropertyName", is_optional: false }, :get_att => { kind: :method, name: "getAtt", is_optional: false }, :get_metadata => { kind: :method, name: "getMetadata", is_optional: false }, :obtain_dependencies => { kind: :method, name: "obtainDependencies", is_optional: false }, :obtain_resource_dependencies => { kind: :method, name: "obtainResourceDependencies", is_optional: false }, :remove_dependency => { kind: :method, name: "removeDependency", is_optional: false }, :render_properties => { kind: :method, name: "renderProperties", is_optional: false }, :replace_dependency => { kind: :method, name: "replaceDependency", is_optional: false }, :should_synthesize => { kind: :method, name: "shouldSynthesize", is_optional: false }, :validate_properties => { kind: :method, name: "validateProperties", is_optional: false }, :inspect => { kind: :method, name: "inspect", is_optional: false }, } end |
Instance Method Details
#acm_certificate_arn ⇒ String?
313 314 315 |
# File 'rtb_fabric/cfn_responder_gateway.rb', line 313 def acm_certificate_arn() jsii_get_property("acmCertificateArn") end |
#acm_certificate_arn=(value) ⇒ Object
317 318 319 320 |
# File 'rtb_fabric/cfn_responder_gateway.rb', line 317 def acm_certificate_arn=(value) Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "acmCertificateArn") unless value.nil? jsii_set_property("acmCertificateArn", value) end |
#add_deletion_override(path) ⇒ void
This method returns an undefined value.
Syntactic sugar for addOverride(path, undefined).
442 443 444 445 |
# File 'rtb_fabric/cfn_responder_gateway.rb', line 442 def add_deletion_override(path) Jsii::Type.check_type(path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "path") jsii_call_method("addDeletionOverride", [path]) end |
#add_dependency(target) ⇒ void
This method returns an undefined value.
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.
454 455 456 457 |
# File 'rtb_fabric/cfn_responder_gateway.rb', line 454 def add_dependency(target) Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target") jsii_call_method("addDependency", [target]) end |
#add_depends_on(target) ⇒ void
use addDependency
This method returns an undefined value.
Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
464 465 466 467 |
# File 'rtb_fabric/cfn_responder_gateway.rb', line 464 def add_depends_on(target) Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target") jsii_call_method("addDependsOn", [target]) end |
#add_metadata(key, value) ⇒ void
This method returns an undefined value.
Add a value to the CloudFormation Resource Metadata.
475 476 477 478 479 |
# File 'rtb_fabric/cfn_responder_gateway.rb', line 475 def (key, value) Jsii::Type.check_type(key, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "key") Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value") jsii_call_method("addMetadata", [key, value]) end |
#add_override(path, value) ⇒ void
This method returns an undefined value.
Adds an override to the synthesized CloudFormation resource.
To add a
property override, either use add_property_override 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,
# Example automatically generated from non-compiling source. May contain errors.
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"])
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")
would add the overrides
"Properties": {
"GlobalSecondaryIndexes": [
{
"Projection": {
"NonKeyAttributes": [ "myattribute" ]
...
}
...
},
{
"ProjectionType": "INCLUDE"
...
},
]
...
}
The value argument to add_override 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.
532 533 534 535 536 |
# File 'rtb_fabric/cfn_responder_gateway.rb', line 532 def add_override(path, value) Jsii::Type.check_type(path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "path") Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value") jsii_call_method("addOverride", [path, value]) end |
#add_property_deletion_override(property_path) ⇒ void
This method returns an undefined value.
Adds an override that deletes the value of a property from the resource definition.
542 543 544 545 |
# File 'rtb_fabric/cfn_responder_gateway.rb', line 542 def add_property_deletion_override(property_path) Jsii::Type.check_type(property_path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "propertyPath") jsii_call_method("addPropertyDeletionOverride", [property_path]) end |
#add_property_override(property_path, value) ⇒ void
This method returns an undefined value.
Adds an override to a resource property.
Syntactic sugar for addOverride("Properties.<...>", value).
554 555 556 557 558 |
# File 'rtb_fabric/cfn_responder_gateway.rb', line 554 def add_property_override(property_path, value) Jsii::Type.check_type(property_path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "propertyPath") Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value") jsii_call_method("addPropertyOverride", [property_path, value]) end |
#apply_cross_stack_reference_strength(strength) ⇒ void
This method returns an undefined value.
Sets the cross-stack reference strength for this resource.
When set, any cross-stack reference to this resource will use the specified strength instead of the global default from the consuming stack's context.
567 568 569 570 |
# File 'rtb_fabric/cfn_responder_gateway.rb', line 567 def apply_cross_stack_reference_strength(strength) Jsii::Type.check_type(strength, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZWZlcmVuY2VTdHJlbmd0aCJ9")), "strength") jsii_call_method("applyCrossStackReferenceStrength", [strength]) end |
#apply_removal_policy(policy = nil, options = nil) ⇒ void
This method returns an undefined value.
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:
589 590 591 592 593 594 |
# File 'rtb_fabric/cfn_responder_gateway.rb', line 589 def apply_removal_policy(policy = nil, = nil) Jsii::Type.check_type(policy, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZW1vdmFsUG9saWN5In0=")), "policy") unless policy.nil? = .is_a?(Hash) ? ::AWSCDK::RemovalPolicyOptions.new(**.transform_keys(&:to_sym)) : Jsii::Type.check_type(, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZW1vdmFsUG9saWN5T3B0aW9ucyJ9")), "options") unless .nil? jsii_call_method("applyRemovalPolicy", [policy, ]) end |
#attr_arn ⇒ String
204 205 206 |
# File 'rtb_fabric/cfn_responder_gateway.rb', line 204 def attr_arn() jsii_get_property("attrArn") end |
#attr_certificate_association_status ⇒ String
209 210 211 |
# File 'rtb_fabric/cfn_responder_gateway.rb', line 209 def attr_certificate_association_status() jsii_get_property("attrCertificateAssociationStatus") end |
#attr_created_timestamp ⇒ String
214 215 216 |
# File 'rtb_fabric/cfn_responder_gateway.rb', line 214 def () jsii_get_property("attrCreatedTimestamp") end |
#attr_external_inbound_endpoint ⇒ String
219 220 221 |
# File 'rtb_fabric/cfn_responder_gateway.rb', line 219 def attr_external_inbound_endpoint() jsii_get_property("attrExternalInboundEndpoint") end |
#attr_gateway_id ⇒ String
224 225 226 |
# File 'rtb_fabric/cfn_responder_gateway.rb', line 224 def attr_gateway_id() jsii_get_property("attrGatewayId") end |
#attr_responder_gateway_status ⇒ String
229 230 231 |
# File 'rtb_fabric/cfn_responder_gateway.rb', line 229 def attr_responder_gateway_status() jsii_get_property("attrResponderGatewayStatus") end |
#attr_updated_timestamp ⇒ String
234 235 236 |
# File 'rtb_fabric/cfn_responder_gateway.rb', line 234 def () jsii_get_property("attrUpdatedTimestamp") end |
#cdk_tag_manager ⇒ AWSCDK::TagManager
Tag Manager which manages the tags for this resource.
241 242 243 |
# File 'rtb_fabric/cfn_responder_gateway.rb', line 241 def cdk_tag_manager() jsii_get_property("cdkTagManager") end |
#cfn_options ⇒ AWSCDK::ICfnResourceOptions
Options for this resource, such as condition, update policy etc.
152 153 154 |
# File 'rtb_fabric/cfn_responder_gateway.rb', line 152 def () jsii_get_property("cfnOptions") end |
#cfn_properties ⇒ Hash{String => Object}
157 158 159 |
# File 'rtb_fabric/cfn_responder_gateway.rb', line 157 def cfn_properties() jsii_get_property("cfnProperties") end |
#cfn_property_name(cdk_property_name) ⇒ String?
598 599 600 601 |
# File 'rtb_fabric/cfn_responder_gateway.rb', line 598 def cfn_property_name(cdk_property_name) Jsii::Type.check_type(cdk_property_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "cdkPropertyName") jsii_call_method("cfnPropertyName", [cdk_property_name]) end |
#cfn_property_names ⇒ Hash{String => String}
162 163 164 |
# File 'rtb_fabric/cfn_responder_gateway.rb', line 162 def cfn_property_names() jsii_get_property("cfnPropertyNames") end |
#cfn_resource_type ⇒ String
AWS resource type.
169 170 171 |
# File 'rtb_fabric/cfn_responder_gateway.rb', line 169 def cfn_resource_type() jsii_get_property("cfnResourceType") end |
#creation_stack ⇒ Array<String>
114 115 116 |
# File 'rtb_fabric/cfn_responder_gateway.rb', line 114 def creation_stack() jsii_get_property("creationStack") end |
#description ⇒ String?
An optional description for the responder gateway.
325 326 327 |
# File 'rtb_fabric/cfn_responder_gateway.rb', line 325 def description() jsii_get_property("description") end |
#description=(value) ⇒ Object
329 330 331 332 |
# File 'rtb_fabric/cfn_responder_gateway.rb', line 329 def description=(value) Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "description") unless value.nil? jsii_set_property("description", value) end |
#domain_name ⇒ String?
The domain name for the responder gateway.
337 338 339 |
# File 'rtb_fabric/cfn_responder_gateway.rb', line 337 def domain_name() jsii_get_property("domainName") end |
#domain_name=(value) ⇒ Object
341 342 343 344 |
# File 'rtb_fabric/cfn_responder_gateway.rb', line 341 def domain_name=(value) Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "domainName") unless value.nil? jsii_set_property("domainName", value) end |
#env ⇒ AWSCDK::Interfaces::ResourceEnvironment
174 175 176 |
# File 'rtb_fabric/cfn_responder_gateway.rb', line 174 def env() jsii_get_property("env") end |
#gateway_type ⇒ String?
347 348 349 |
# File 'rtb_fabric/cfn_responder_gateway.rb', line 347 def gateway_type() jsii_get_property("gatewayType") end |
#gateway_type=(value) ⇒ Object
351 352 353 354 |
# File 'rtb_fabric/cfn_responder_gateway.rb', line 351 def gateway_type=(value) Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "gatewayType") unless value.nil? jsii_set_property("gatewayType", value) end |
#get_att(attribute_name, type_hint = nil) ⇒ AWSCDK::Reference
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.
611 612 613 614 615 |
# File 'rtb_fabric/cfn_responder_gateway.rb', line 611 def get_att(attribute_name, type_hint = nil) Jsii::Type.check_type(attribute_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "attributeName") Jsii::Type.check_type(type_hint, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZXNvbHV0aW9uVHlwZUhpbnQifQ==")), "typeHint") unless type_hint.nil? jsii_call_method("getAtt", [attribute_name, type_hint]) end |
#get_metadata(key) ⇒ Object
Retrieve a value value from the CloudFormation Resource Metadata.
622 623 624 625 |
# File 'rtb_fabric/cfn_responder_gateway.rb', line 622 def (key) Jsii::Type.check_type(key, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "key") jsii_call_method("getMetadata", [key]) end |
#inspect(inspector) ⇒ void
This method returns an undefined value.
Examines the CloudFormation resource and discloses attributes.
692 693 694 695 |
# File 'rtb_fabric/cfn_responder_gateway.rb', line 692 def inspect(inspector) Jsii::Type.check_type(inspector, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5UcmVlSW5zcGVjdG9yIn0=")), "inspector") jsii_call_method("inspect", [inspector]) end |
#listener_config ⇒ AWSCDK::IResolvable, ...
357 358 359 |
# File 'rtb_fabric/cfn_responder_gateway.rb', line 357 def listener_config() jsii_get_property("listenerConfig") end |
#listener_config=(value) ⇒ Object
361 362 363 364 365 |
# File 'rtb_fabric/cfn_responder_gateway.rb', line 361 def listener_config=(value) value = value.is_a?(Hash) ? ::AWSCDK::RTBFabric::CfnResponderGateway::ListenerConfigProperty.new(**value.transform_keys(&:to_sym)) : value Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19ydGJmYWJyaWMuQ2ZuUmVzcG9uZGVyR2F0ZXdheS5MaXN0ZW5lckNvbmZpZ1Byb3BlcnR5In1dfX0=")), "listenerConfig") unless value.nil? jsii_set_property("listenerConfig", value) end |
#logical_id ⇒ String
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 override_logical_id(new_logical_id).
126 127 128 |
# File 'rtb_fabric/cfn_responder_gateway.rb', line 126 def logical_id() jsii_get_property("logicalId") end |
#managed_endpoint_configuration ⇒ AWSCDK::IResolvable, ...
The configuration for the managed endpoint.
370 371 372 |
# File 'rtb_fabric/cfn_responder_gateway.rb', line 370 def managed_endpoint_configuration() jsii_get_property("managedEndpointConfiguration") end |
#managed_endpoint_configuration=(value) ⇒ Object
374 375 376 377 378 |
# File 'rtb_fabric/cfn_responder_gateway.rb', line 374 def managed_endpoint_configuration=(value) value = value.is_a?(Hash) ? ::AWSCDK::RTBFabric::CfnResponderGateway::ManagedEndpointConfigurationProperty.new(**value.transform_keys(&:to_sym)) : value Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19ydGJmYWJyaWMuQ2ZuUmVzcG9uZGVyR2F0ZXdheS5NYW5hZ2VkRW5kcG9pbnRDb25maWd1cmF0aW9uUHJvcGVydHkifV19fQ==")), "managedEndpointConfiguration") unless value.nil? jsii_set_property("managedEndpointConfiguration", value) end |
#node ⇒ Constructs::Node
The tree node.
109 110 111 |
# File 'rtb_fabric/cfn_responder_gateway.rb', line 109 def node() jsii_get_property("node") end |
#obtain_dependencies ⇒ Array<AWSCDK::CfnResource, AWSCDK::Stack>
Retrieves an array of resources this resource depends on.
This assembles dependencies on resources across stacks (including nested stacks) automatically.
633 634 635 |
# File 'rtb_fabric/cfn_responder_gateway.rb', line 633 def obtain_dependencies() jsii_call_method("obtainDependencies", []) end |
#obtain_resource_dependencies ⇒ Array<AWSCDK::CfnResource>
Get a shallow copy of dependencies between this resource and other resources in the same stack.
640 641 642 |
# File 'rtb_fabric/cfn_responder_gateway.rb', line 640 def obtain_resource_dependencies() jsii_call_method("obtainResourceDependencies", []) end |
#override_logical_id(new_logical_id) ⇒ void
This method returns an undefined value.
Overrides the auto-generated logical ID with a specific ID.
433 434 435 436 |
# File 'rtb_fabric/cfn_responder_gateway.rb', line 433 def override_logical_id(new_logical_id) Jsii::Type.check_type(new_logical_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "newLogicalId") jsii_call_method("overrideLogicalId", [new_logical_id]) end |
#port ⇒ Numeric
The networking port to use.
255 256 257 |
# File 'rtb_fabric/cfn_responder_gateway.rb', line 255 def port() jsii_get_property("port") end |
#port=(value) ⇒ Object
259 260 261 262 |
# File 'rtb_fabric/cfn_responder_gateway.rb', line 259 def port=(value) Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "port") jsii_set_property("port", value) end |
#protocol ⇒ String
The networking protocol to use.
267 268 269 |
# File 'rtb_fabric/cfn_responder_gateway.rb', line 267 def protocol() jsii_get_property("protocol") end |
#protocol=(value) ⇒ Object
271 272 273 274 |
# File 'rtb_fabric/cfn_responder_gateway.rb', line 271 def protocol=(value) Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "protocol") jsii_set_property("protocol", value) end |
#ref ⇒ String
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 }).
145 146 147 |
# File 'rtb_fabric/cfn_responder_gateway.rb', line 145 def ref() jsii_get_property("ref") end |
#remove_dependency(target) ⇒ void
This method returns an undefined value.
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.
651 652 653 654 |
# File 'rtb_fabric/cfn_responder_gateway.rb', line 651 def remove_dependency(target) Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target") jsii_call_method("removeDependency", [target]) end |
#render_properties(props) ⇒ Hash{String => Object}
658 659 660 661 |
# File 'rtb_fabric/cfn_responder_gateway.rb', line 658 def render_properties(props) Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6ImFueSJ9LCJraW5kIjoibWFwIn19")), "props") jsii_call_method("renderProperties", [props]) end |
#replace_dependency(target, new_target) ⇒ void
This method returns an undefined value.
Replaces one dependency with another.
668 669 670 671 672 |
# File 'rtb_fabric/cfn_responder_gateway.rb', line 668 def replace_dependency(target, new_target) Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target") Jsii::Type.check_type(new_target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "newTarget") jsii_call_method("replaceDependency", [target, new_target]) end |
#responder_gateway_ref ⇒ AWSCDK::Interfaces::AWSRtbfabric::ResponderGatewayReference
A reference to a ResponderGateway resource.
248 249 250 |
# File 'rtb_fabric/cfn_responder_gateway.rb', line 248 def responder_gateway_ref() jsii_get_property("responderGatewayRef") end |
#security_group_ids ⇒ Array<String>
The unique identifiers of the security groups.
279 280 281 |
# File 'rtb_fabric/cfn_responder_gateway.rb', line 279 def security_group_ids() jsii_get_property("securityGroupIds") end |
#security_group_ids=(value) ⇒ Object
283 284 285 286 |
# File 'rtb_fabric/cfn_responder_gateway.rb', line 283 def security_group_ids=(value) Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "securityGroupIds") jsii_set_property("securityGroupIds", value) end |
#should_synthesize ⇒ Boolean
Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.
677 678 679 |
# File 'rtb_fabric/cfn_responder_gateway.rb', line 677 def should_synthesize() jsii_call_method("shouldSynthesize", []) end |
#stack ⇒ AWSCDK::Stack
The stack in which this element is defined.
CfnElements must be defined within a stack scope (directly or indirectly).
135 136 137 |
# File 'rtb_fabric/cfn_responder_gateway.rb', line 135 def stack() jsii_get_property("stack") end |
#subnet_ids ⇒ Array<String>
The unique identifiers of the subnets.
291 292 293 |
# File 'rtb_fabric/cfn_responder_gateway.rb', line 291 def subnet_ids() jsii_get_property("subnetIds") end |
#subnet_ids=(value) ⇒ Object
295 296 297 298 |
# File 'rtb_fabric/cfn_responder_gateway.rb', line 295 def subnet_ids=(value) Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "subnetIds") jsii_set_property("subnetIds", value) end |
#tags ⇒ Array<AWSCDK::CfnTag>?
A map of the key-value pairs of the tag or tags to assign to the resource.
383 384 385 |
# File 'rtb_fabric/cfn_responder_gateway.rb', line 383 def () jsii_get_property("tags") end |
#tags=(value) ⇒ Object
387 388 389 390 391 |
# File 'rtb_fabric/cfn_responder_gateway.rb', line 387 def (value) value = value.is_a?(Array) ? value.map { |jsii_v0| jsii_v0.is_a?(Hash) ? ::AWSCDK::CfnTag.new(**jsii_v0.transform_keys(&:to_sym)) : jsii_v0 } : value Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7ImZxbiI6ImF3cy1jZGstbGliLkNmblRhZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "tags") unless value.nil? jsii_set_property("tags", value) end |
#to_string ⇒ String
Returns a string representation of this construct.
409 410 411 |
# File 'rtb_fabric/cfn_responder_gateway.rb', line 409 def to_string() jsii_call_method("toString", []) end |
#trust_store_configuration ⇒ AWSCDK::IResolvable, ...
The configuration of the trust store.
396 397 398 |
# File 'rtb_fabric/cfn_responder_gateway.rb', line 396 def trust_store_configuration() jsii_get_property("trustStoreConfiguration") end |
#trust_store_configuration=(value) ⇒ Object
400 401 402 403 404 |
# File 'rtb_fabric/cfn_responder_gateway.rb', line 400 def trust_store_configuration=(value) value = value.is_a?(Hash) ? ::AWSCDK::RTBFabric::CfnResponderGateway::TrustStoreConfigurationProperty.new(**value.transform_keys(&:to_sym)) : value Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19ydGJmYWJyaWMuQ2ZuUmVzcG9uZGVyR2F0ZXdheS5UcnVzdFN0b3JlQ29uZmlndXJhdGlvblByb3BlcnR5In1dfX0=")), "trustStoreConfiguration") unless value.nil? jsii_set_property("trustStoreConfiguration", value) end |
#updated_properites ⇒ Hash{String => Object}
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.
Deprecated.
182 183 184 |
# File 'rtb_fabric/cfn_responder_gateway.rb', line 182 def updated_properites() jsii_get_property("updatedProperites") end |
#updated_properties ⇒ Hash{String => Object}
Return properties modified after initiation.
Resources that expose mutable properties should override this function to collect and return the properties object for this resource.
192 193 194 |
# File 'rtb_fabric/cfn_responder_gateway.rb', line 192 def updated_properties() jsii_get_property("updatedProperties") end |
#validate_properties(_properties) ⇒ void
This method returns an undefined value.
683 684 685 686 |
# File 'rtb_fabric/cfn_responder_gateway.rb', line 683 def validate_properties(_properties) Jsii::Type.check_type(_properties, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "_properties") jsii_call_method("validateProperties", [_properties]) end |
#vpc_id ⇒ String
The unique identifier of the Virtual Private Cloud (VPC).
303 304 305 |
# File 'rtb_fabric/cfn_responder_gateway.rb', line 303 def vpc_id() jsii_get_property("vpcId") end |
#vpc_id=(value) ⇒ Object
307 308 309 310 |
# File 'rtb_fabric/cfn_responder_gateway.rb', line 307 def vpc_id=(value) Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "vpcId") jsii_set_property("vpcId", value) 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.
Use multiple with() calls if subsequent mixins should apply to added
constructs.
422 423 424 425 426 427 |
# File 'rtb_fabric/cfn_responder_gateway.rb', line 422 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 |