Class: AWSCDK::MWAA::CfnEnvironment
- Inherits:
-
CfnResource
- Object
- CfnResource
- AWSCDK::MWAA::CfnEnvironment
- Includes:
- IInspectable, ITaggable, Interfaces::AWSMWAA::IEnvironmentRef
- Defined in:
- mwaa/cfn_environment.rb
Overview
The AWS::MWAA::Environment resource creates an Amazon Managed Workflows for Apache Airflow (MWAA) environment.
Class Method Summary collapse
- .arn_for_environment(resource) ⇒ String
-
.CFN_RESOURCE_TYPE_NAME ⇒ String
The CloudFormation resource type name for this resource class.
-
.from_environment_arn(scope, id, arn) ⇒ AWSCDK::Interfaces::AWSMWAA::IEnvironmentRef
Creates a new IEnvironmentRef from an ARN.
-
.from_environment_name(scope, id, environment_name) ⇒ AWSCDK::Interfaces::AWSMWAA::IEnvironmentRef
Creates a new IEnvironmentRef from a environmentName.
-
.is_cfn_environment(x) ⇒ Boolean
Checks whether the given object is a CfnEnvironment.
- .jsii_overridable_methods ⇒ Object
Instance Method Summary collapse
-
#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.
-
#airflow_configuration_options ⇒ Object
A list of key-value pairs containing the Airflow configuration options for your environment.
- #airflow_configuration_options=(value) ⇒ Object
-
#airflow_version ⇒ String?
The version of Apache Airflow to use for the environment.
- #airflow_version=(value) ⇒ Object
-
#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
The ARN for the Amazon MWAA environment.
-
#attr_celery_executor_queue ⇒ String
The queue ARN for the environment's Celery Executor .
-
#attr_database_vpc_endpoint_service ⇒ String
The VPC endpoint for the environment's Amazon RDS database.
-
#attr_logging_configuration_dag_processing_logs_cloud_watch_log_group_arn ⇒ String
The ARN for the CloudWatch Logs group where the Apache Airflow DAG processing logs are published.
-
#attr_logging_configuration_scheduler_logs_cloud_watch_log_group_arn ⇒ String
The ARN for the CloudWatch Logs group where the Apache Airflow Scheduler logs are published.
-
#attr_logging_configuration_task_logs_cloud_watch_log_group_arn ⇒ String
The ARN for the CloudWatch Logs group where the Apache Airflow task logs are published.
-
#attr_logging_configuration_webserver_logs_cloud_watch_log_group_arn ⇒ String
The ARN for the CloudWatch Logs group where the Apache Airflow Web server logs are published.
-
#attr_logging_configuration_worker_logs_cloud_watch_log_group_arn ⇒ String
The ARN for the CloudWatch Logs group where the Apache Airflow Worker logs are published.
-
#attr_webserver_url ⇒ String
The URL of your Apache Airflow UI.
-
#attr_webserver_vpc_endpoint_service ⇒ String
The VPC endpoint for the environment's web server.
-
#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>
-
#dag_s3_path ⇒ String?
The relative path to the DAGs folder on your Amazon S3 bucket.
- #dag_s3_path=(value) ⇒ Object
-
#endpoint_management ⇒ String?
Defines whether the VPC endpoints configured for the environment are created, and managed, by the customer or by Amazon MWAA.
- #endpoint_management=(value) ⇒ Object
- #env ⇒ AWSCDK::Interfaces::ResourceEnvironment
-
#environment_class ⇒ String?
The environment class type.
- #environment_class=(value) ⇒ Object
-
#environment_ref ⇒ AWSCDK::Interfaces::AWSMWAA::EnvironmentReference
A reference to a Environment resource.
-
#execution_role_arn ⇒ String?
The Amazon Resource Name (ARN) of the execution role in IAM that allows MWAA to access AWS resources in your environment.
- #execution_role_arn=(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) ⇒ CfnEnvironment
constructor
Create a new
AWS::MWAA::Environment. -
#inspect(inspector) ⇒ void
Examines the CloudFormation resource and discloses attributes.
-
#kms_key ⇒ String?
The AWS Key Management Service (KMS) key to encrypt and decrypt the data in your environment.
- #kms_key=(value) ⇒ Object
-
#logging_configuration ⇒ AWSCDK::IResolvable, ...
The Apache Airflow logs being sent to CloudWatch Logs:
DagProcessingLogs,SchedulerLogs,TaskLogs,WebserverLogs,WorkerLogs. - #logging_configuration=(value) ⇒ Object
-
#logical_id ⇒ String
The logical ID for this CloudFormation stack element.
-
#max_webservers ⇒ Numeric?
The maximum number of web servers that you want to run in your environment.
- #max_webservers=(value) ⇒ Object
-
#max_workers ⇒ Numeric?
The maximum number of workers that you want to run in your environment.
- #max_workers=(value) ⇒ Object
-
#min_webservers ⇒ Numeric?
The minimum number of web servers that you want to run in your environment.
- #min_webservers=(value) ⇒ Object
-
#min_workers ⇒ Numeric?
The minimum number of workers that you want to run in your environment.
- #min_workers=(value) ⇒ Object
-
#name ⇒ String
The name of your Amazon MWAA environment.
- #name=(value) ⇒ Object
-
#network_configuration ⇒ AWSCDK::IResolvable, ...
The VPC networking components used to secure and enable network traffic between the AWS resources for your environment.
- #network_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.
-
#plugins_s3_object_version ⇒ String?
The version of the plugins.zip file on your Amazon S3 bucket.
- #plugins_s3_object_version=(value) ⇒ Object
-
#plugins_s3_path ⇒ String?
The relative path to the
plugins.zipfile on your Amazon S3 bucket. - #plugins_s3_path=(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.
-
#requirements_s3_object_version ⇒ String?
The version of the requirements.txt file on your Amazon S3 bucket.
- #requirements_s3_object_version=(value) ⇒ Object
-
#requirements_s3_path ⇒ String?
The relative path to the
requirements.txtfile on your Amazon S3 bucket. - #requirements_s3_path=(value) ⇒ Object
-
#schedulers ⇒ Numeric?
The number of schedulers that you want to run in your environment.
- #schedulers=(value) ⇒ Object
-
#should_synthesize ⇒ Boolean
Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.
-
#source_bucket_arn ⇒ String?
The Amazon Resource Name (ARN) of the Amazon S3 bucket where your DAG code and supporting files are stored.
- #source_bucket_arn=(value) ⇒ Object
-
#stack ⇒ AWSCDK::Stack
The stack in which this element is defined.
-
#startup_script_s3_object_version ⇒ String?
The version of the startup shell script in your Amazon S3 bucket.
- #startup_script_s3_object_version=(value) ⇒ Object
-
#startup_script_s3_path ⇒ String?
The relative path to the startup shell script in your Amazon S3 bucket.
- #startup_script_s3_path=(value) ⇒ Object
-
#tags ⇒ AWSCDK::TagManager
Tag Manager which manages the tags for this resource.
-
#tags_raw ⇒ Object
The key-value tag pairs associated to your environment.
- #tags_raw=(value) ⇒ Object
-
#to_string ⇒ String
Returns a string representation of this construct.
-
#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
-
#webserver_access_mode ⇒ String?
The Apache Airflow Web server access mode.
- #webserver_access_mode=(value) ⇒ Object
-
#weekly_maintenance_window_start ⇒ String?
The day and time of the week to start weekly maintenance updates of your environment in the following format:
DAY:HH:MM. - #weekly_maintenance_window_start=(value) ⇒ Object
-
#with(*mixins) ⇒ Constructs::IConstruct
Applies one or more mixins to this construct.
-
#worker_replacement_strategy ⇒ String?
The worker replacement strategy to use when updating the environment.
- #worker_replacement_strategy=(value) ⇒ Object
Constructor Details
#initialize(scope, id, props) ⇒ CfnEnvironment
Create a new AWS::MWAA::Environment.
18 19 20 21 22 23 24 |
# File 'mwaa/cfn_environment.rb', line 18 def initialize(scope, id, props) props = props.is_a?(Hash) ? ::AWSCDK::MWAA::CfnEnvironmentProps.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("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfbXdhYS5DZm5FbnZpcm9ubWVudFByb3BzIn0=")), "props") Jsii::Object.instance_method(:initialize).bind(self).call(scope, id, props) end |
Class Method Details
.arn_for_environment(resource) ⇒ String
106 107 108 109 |
# File 'mwaa/cfn_environment.rb', line 106 def self.arn_for_environment(resource) Jsii::Type.check_type(resource, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19td2FhLklFbnZpcm9ubWVudFJlZiJ9")), "resource") Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_mwaa.CfnEnvironment", "arnForEnvironment", [resource]) end |
.CFN_RESOURCE_TYPE_NAME ⇒ String
The CloudFormation resource type name for this resource class.
239 240 241 |
# File 'mwaa/cfn_environment.rb', line 239 def self.CFN_RESOURCE_TYPE_NAME() Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_mwaa.CfnEnvironment", "CFN_RESOURCE_TYPE_NAME") end |
.from_environment_arn(scope, id, arn) ⇒ AWSCDK::Interfaces::AWSMWAA::IEnvironmentRef
Creates a new IEnvironmentRef from an ARN.
117 118 119 120 121 122 |
# File 'mwaa/cfn_environment.rb', line 117 def self.from_environment_arn(scope, id, arn) 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(arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "arn") Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_mwaa.CfnEnvironment", "fromEnvironmentArn", [scope, id, arn]) end |
.from_environment_name(scope, id, environment_name) ⇒ AWSCDK::Interfaces::AWSMWAA::IEnvironmentRef
Creates a new IEnvironmentRef from a environmentName.
130 131 132 133 134 135 |
# File 'mwaa/cfn_environment.rb', line 130 def self.from_environment_name(scope, id, environment_name) 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(environment_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "environmentName") Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_mwaa.CfnEnvironment", "fromEnvironmentName", [scope, id, environment_name]) end |
.is_cfn_environment(x) ⇒ Boolean
Checks whether the given object is a CfnEnvironment.
141 142 143 144 |
# File 'mwaa/cfn_environment.rb', line 141 def self.is_cfn_environment(x) Jsii::Type.check_type(x, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "x") Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_mwaa.CfnEnvironment", "isCfnEnvironment", [x]) end |
.jsii_overridable_methods ⇒ Object
26 27 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 89 90 91 92 93 94 95 96 97 98 99 100 101 102 |
# File 'mwaa/cfn_environment.rb', line 26 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_celery_executor_queue => { kind: :property, name: "attrCeleryExecutorQueue", is_optional: false }, :attr_database_vpc_endpoint_service => { kind: :property, name: "attrDatabaseVpcEndpointService", is_optional: false }, :attr_logging_configuration_dag_processing_logs_cloud_watch_log_group_arn => { kind: :property, name: "attrLoggingConfigurationDagProcessingLogsCloudWatchLogGroupArn", is_optional: false }, :attr_logging_configuration_scheduler_logs_cloud_watch_log_group_arn => { kind: :property, name: "attrLoggingConfigurationSchedulerLogsCloudWatchLogGroupArn", is_optional: false }, :attr_logging_configuration_task_logs_cloud_watch_log_group_arn => { kind: :property, name: "attrLoggingConfigurationTaskLogsCloudWatchLogGroupArn", is_optional: false }, :attr_logging_configuration_webserver_logs_cloud_watch_log_group_arn => { kind: :property, name: "attrLoggingConfigurationWebserverLogsCloudWatchLogGroupArn", is_optional: false }, :attr_logging_configuration_worker_logs_cloud_watch_log_group_arn => { kind: :property, name: "attrLoggingConfigurationWorkerLogsCloudWatchLogGroupArn", is_optional: false }, :attr_webserver_url => { kind: :property, name: "attrWebserverUrl", is_optional: false }, :attr_webserver_vpc_endpoint_service => { kind: :property, name: "attrWebserverVpcEndpointService", is_optional: false }, :environment_ref => { kind: :property, name: "environmentRef", is_optional: false }, :tags => { kind: :property, name: "tags", is_optional: false }, :airflow_configuration_options => { kind: :property, name: "airflowConfigurationOptions", is_optional: false }, :name => { kind: :property, name: "name", is_optional: false }, :tags_raw => { kind: :property, name: "tagsRaw", is_optional: false }, :airflow_version => { kind: :property, name: "airflowVersion", is_optional: true }, :dag_s3_path => { kind: :property, name: "dagS3Path", is_optional: true }, :endpoint_management => { kind: :property, name: "endpointManagement", is_optional: true }, :environment_class => { kind: :property, name: "environmentClass", is_optional: true }, :execution_role_arn => { kind: :property, name: "executionRoleArn", is_optional: true }, :kms_key => { kind: :property, name: "kmsKey", is_optional: true }, :logging_configuration => { kind: :property, name: "loggingConfiguration", is_optional: true }, :max_webservers => { kind: :property, name: "maxWebservers", is_optional: true }, :max_workers => { kind: :property, name: "maxWorkers", is_optional: true }, :min_webservers => { kind: :property, name: "minWebservers", is_optional: true }, :min_workers => { kind: :property, name: "minWorkers", is_optional: true }, :network_configuration => { kind: :property, name: "networkConfiguration", is_optional: true }, :plugins_s3_object_version => { kind: :property, name: "pluginsS3ObjectVersion", is_optional: true }, :plugins_s3_path => { kind: :property, name: "pluginsS3Path", is_optional: true }, :requirements_s3_object_version => { kind: :property, name: "requirementsS3ObjectVersion", is_optional: true }, :requirements_s3_path => { kind: :property, name: "requirementsS3Path", is_optional: true }, :schedulers => { kind: :property, name: "schedulers", is_optional: true }, :source_bucket_arn => { kind: :property, name: "sourceBucketArn", is_optional: true }, :startup_script_s3_object_version => { kind: :property, name: "startupScriptS3ObjectVersion", is_optional: true }, :startup_script_s3_path => { kind: :property, name: "startupScriptS3Path", is_optional: true }, :webserver_access_mode => { kind: :property, name: "webserverAccessMode", is_optional: true }, :weekly_maintenance_window_start => { kind: :property, name: "weeklyMaintenanceWindowStart", is_optional: true }, :worker_replacement_strategy => { kind: :property, name: "workerReplacementStrategy", 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
#add_deletion_override(path) ⇒ void
This method returns an undefined value.
Syntactic sugar for addOverride(path, undefined).
683 684 685 686 |
# File 'mwaa/cfn_environment.rb', line 683 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.
695 696 697 698 |
# File 'mwaa/cfn_environment.rb', line 695 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.
705 706 707 708 |
# File 'mwaa/cfn_environment.rb', line 705 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.
716 717 718 719 720 |
# File 'mwaa/cfn_environment.rb', line 716 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.
773 774 775 776 777 |
# File 'mwaa/cfn_environment.rb', line 773 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.
783 784 785 786 |
# File 'mwaa/cfn_environment.rb', line 783 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).
795 796 797 798 799 |
# File 'mwaa/cfn_environment.rb', line 795 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 |
#airflow_configuration_options ⇒ Object
A list of key-value pairs containing the Airflow configuration options for your environment.
330 331 332 |
# File 'mwaa/cfn_environment.rb', line 330 def () jsii_get_property("airflowConfigurationOptions") end |
#airflow_configuration_options=(value) ⇒ Object
334 335 336 337 |
# File 'mwaa/cfn_environment.rb', line 334 def (value) Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "airflowConfigurationOptions") jsii_set_property("airflowConfigurationOptions", value) end |
#airflow_version ⇒ String?
The version of Apache Airflow to use for the environment.
368 369 370 |
# File 'mwaa/cfn_environment.rb', line 368 def airflow_version() jsii_get_property("airflowVersion") end |
#airflow_version=(value) ⇒ Object
372 373 374 375 |
# File 'mwaa/cfn_environment.rb', line 372 def airflow_version=(value) Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "airflowVersion") unless value.nil? jsii_set_property("airflowVersion", 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.
808 809 810 811 |
# File 'mwaa/cfn_environment.rb', line 808 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:
830 831 832 833 834 835 |
# File 'mwaa/cfn_environment.rb', line 830 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
The ARN for the Amazon MWAA environment.
246 247 248 |
# File 'mwaa/cfn_environment.rb', line 246 def attr_arn() jsii_get_property("attrArn") end |
#attr_celery_executor_queue ⇒ String
The queue ARN for the environment's Celery Executor . Amazon MWAA uses a Celery Executor to distribute tasks across multiple workers. When you create an environment in a shared VPC, you must provide access to the Celery Executor queue from your VPC.
253 254 255 |
# File 'mwaa/cfn_environment.rb', line 253 def attr_celery_executor_queue() jsii_get_property("attrCeleryExecutorQueue") end |
#attr_database_vpc_endpoint_service ⇒ String
The VPC endpoint for the environment's Amazon RDS database.
260 261 262 |
# File 'mwaa/cfn_environment.rb', line 260 def attr_database_vpc_endpoint_service() jsii_get_property("attrDatabaseVpcEndpointService") end |
#attr_logging_configuration_dag_processing_logs_cloud_watch_log_group_arn ⇒ String
The ARN for the CloudWatch Logs group where the Apache Airflow DAG processing logs are published.
267 268 269 |
# File 'mwaa/cfn_environment.rb', line 267 def attr_logging_configuration_dag_processing_logs_cloud_watch_log_group_arn() jsii_get_property("attrLoggingConfigurationDagProcessingLogsCloudWatchLogGroupArn") end |
#attr_logging_configuration_scheduler_logs_cloud_watch_log_group_arn ⇒ String
The ARN for the CloudWatch Logs group where the Apache Airflow Scheduler logs are published.
274 275 276 |
# File 'mwaa/cfn_environment.rb', line 274 def attr_logging_configuration_scheduler_logs_cloud_watch_log_group_arn() jsii_get_property("attrLoggingConfigurationSchedulerLogsCloudWatchLogGroupArn") end |
#attr_logging_configuration_task_logs_cloud_watch_log_group_arn ⇒ String
The ARN for the CloudWatch Logs group where the Apache Airflow task logs are published.
281 282 283 |
# File 'mwaa/cfn_environment.rb', line 281 def attr_logging_configuration_task_logs_cloud_watch_log_group_arn() jsii_get_property("attrLoggingConfigurationTaskLogsCloudWatchLogGroupArn") end |
#attr_logging_configuration_webserver_logs_cloud_watch_log_group_arn ⇒ String
The ARN for the CloudWatch Logs group where the Apache Airflow Web server logs are published.
288 289 290 |
# File 'mwaa/cfn_environment.rb', line 288 def attr_logging_configuration_webserver_logs_cloud_watch_log_group_arn() jsii_get_property("attrLoggingConfigurationWebserverLogsCloudWatchLogGroupArn") end |
#attr_logging_configuration_worker_logs_cloud_watch_log_group_arn ⇒ String
The ARN for the CloudWatch Logs group where the Apache Airflow Worker logs are published.
295 296 297 |
# File 'mwaa/cfn_environment.rb', line 295 def attr_logging_configuration_worker_logs_cloud_watch_log_group_arn() jsii_get_property("attrLoggingConfigurationWorkerLogsCloudWatchLogGroupArn") end |
#attr_webserver_url ⇒ String
The URL of your Apache Airflow UI.
302 303 304 |
# File 'mwaa/cfn_environment.rb', line 302 def attr_webserver_url() jsii_get_property("attrWebserverUrl") end |
#attr_webserver_vpc_endpoint_service ⇒ String
The VPC endpoint for the environment's web server.
309 310 311 |
# File 'mwaa/cfn_environment.rb', line 309 def attr_webserver_vpc_endpoint_service() jsii_get_property("attrWebserverVpcEndpointService") end |
#cfn_options ⇒ AWSCDK::ICfnResourceOptions
Options for this resource, such as condition, update policy etc.
192 193 194 |
# File 'mwaa/cfn_environment.rb', line 192 def () jsii_get_property("cfnOptions") end |
#cfn_properties ⇒ Hash{String => Object}
197 198 199 |
# File 'mwaa/cfn_environment.rb', line 197 def cfn_properties() jsii_get_property("cfnProperties") end |
#cfn_property_name(cdk_property_name) ⇒ String?
839 840 841 842 |
# File 'mwaa/cfn_environment.rb', line 839 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}
202 203 204 |
# File 'mwaa/cfn_environment.rb', line 202 def cfn_property_names() jsii_get_property("cfnPropertyNames") end |
#cfn_resource_type ⇒ String
AWS resource type.
209 210 211 |
# File 'mwaa/cfn_environment.rb', line 209 def cfn_resource_type() jsii_get_property("cfnResourceType") end |
#creation_stack ⇒ Array<String>
154 155 156 |
# File 'mwaa/cfn_environment.rb', line 154 def creation_stack() jsii_get_property("creationStack") end |
#dag_s3_path ⇒ String?
The relative path to the DAGs folder on your Amazon S3 bucket.
380 381 382 |
# File 'mwaa/cfn_environment.rb', line 380 def dag_s3_path() jsii_get_property("dagS3Path") end |
#dag_s3_path=(value) ⇒ Object
384 385 386 387 |
# File 'mwaa/cfn_environment.rb', line 384 def dag_s3_path=(value) Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "dagS3Path") unless value.nil? jsii_set_property("dagS3Path", value) end |
#endpoint_management ⇒ String?
Defines whether the VPC endpoints configured for the environment are created, and managed, by the customer or by Amazon MWAA.
392 393 394 |
# File 'mwaa/cfn_environment.rb', line 392 def endpoint_management() jsii_get_property("endpointManagement") end |
#endpoint_management=(value) ⇒ Object
396 397 398 399 |
# File 'mwaa/cfn_environment.rb', line 396 def endpoint_management=(value) Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "endpointManagement") unless value.nil? jsii_set_property("endpointManagement", value) end |
#env ⇒ AWSCDK::Interfaces::ResourceEnvironment
214 215 216 |
# File 'mwaa/cfn_environment.rb', line 214 def env() jsii_get_property("env") end |
#environment_class ⇒ String?
The environment class type.
404 405 406 |
# File 'mwaa/cfn_environment.rb', line 404 def environment_class() jsii_get_property("environmentClass") end |
#environment_class=(value) ⇒ Object
408 409 410 411 |
# File 'mwaa/cfn_environment.rb', line 408 def environment_class=(value) Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "environmentClass") unless value.nil? jsii_set_property("environmentClass", value) end |
#environment_ref ⇒ AWSCDK::Interfaces::AWSMWAA::EnvironmentReference
A reference to a Environment resource.
316 317 318 |
# File 'mwaa/cfn_environment.rb', line 316 def environment_ref() jsii_get_property("environmentRef") end |
#execution_role_arn ⇒ String?
The Amazon Resource Name (ARN) of the execution role in IAM that allows MWAA to access AWS resources in your environment.
416 417 418 |
# File 'mwaa/cfn_environment.rb', line 416 def execution_role_arn() jsii_get_property("executionRoleArn") end |
#execution_role_arn=(value) ⇒ Object
420 421 422 423 |
# File 'mwaa/cfn_environment.rb', line 420 def execution_role_arn=(value) Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "executionRoleArn") unless value.nil? jsii_set_property("executionRoleArn", 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.
852 853 854 855 856 |
# File 'mwaa/cfn_environment.rb', line 852 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.
863 864 865 866 |
# File 'mwaa/cfn_environment.rb', line 863 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.
933 934 935 936 |
# File 'mwaa/cfn_environment.rb', line 933 def inspect(inspector) Jsii::Type.check_type(inspector, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5UcmVlSW5zcGVjdG9yIn0=")), "inspector") jsii_call_method("inspect", [inspector]) end |
#kms_key ⇒ String?
The AWS Key Management Service (KMS) key to encrypt and decrypt the data in your environment.
428 429 430 |
# File 'mwaa/cfn_environment.rb', line 428 def kms_key() jsii_get_property("kmsKey") end |
#kms_key=(value) ⇒ Object
432 433 434 435 |
# File 'mwaa/cfn_environment.rb', line 432 def kms_key=(value) Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "kmsKey") unless value.nil? jsii_set_property("kmsKey", value) end |
#logging_configuration ⇒ AWSCDK::IResolvable, ...
The Apache Airflow logs being sent to CloudWatch Logs: DagProcessingLogs , SchedulerLogs , TaskLogs , WebserverLogs , WorkerLogs .
440 441 442 |
# File 'mwaa/cfn_environment.rb', line 440 def logging_configuration() jsii_get_property("loggingConfiguration") end |
#logging_configuration=(value) ⇒ Object
444 445 446 447 448 |
# File 'mwaa/cfn_environment.rb', line 444 def logging_configuration=(value) value = value.is_a?(Hash) ? ::AWSCDK::MWAA::CfnEnvironment::LoggingConfigurationProperty.new(**value.transform_keys(&:to_sym)) : value Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19td2FhLkNmbkVudmlyb25tZW50LkxvZ2dpbmdDb25maWd1cmF0aW9uUHJvcGVydHkifV19fQ==")), "loggingConfiguration") unless value.nil? jsii_set_property("loggingConfiguration", 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).
166 167 168 |
# File 'mwaa/cfn_environment.rb', line 166 def logical_id() jsii_get_property("logicalId") end |
#max_webservers ⇒ Numeric?
The maximum number of web servers that you want to run in your environment.
453 454 455 |
# File 'mwaa/cfn_environment.rb', line 453 def max_webservers() jsii_get_property("maxWebservers") end |
#max_webservers=(value) ⇒ Object
457 458 459 460 |
# File 'mwaa/cfn_environment.rb', line 457 def max_webservers=(value) Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "maxWebservers") unless value.nil? jsii_set_property("maxWebservers", value) end |
#max_workers ⇒ Numeric?
The maximum number of workers that you want to run in your environment.
465 466 467 |
# File 'mwaa/cfn_environment.rb', line 465 def max_workers() jsii_get_property("maxWorkers") end |
#max_workers=(value) ⇒ Object
469 470 471 472 |
# File 'mwaa/cfn_environment.rb', line 469 def max_workers=(value) Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "maxWorkers") unless value.nil? jsii_set_property("maxWorkers", value) end |
#min_webservers ⇒ Numeric?
The minimum number of web servers that you want to run in your environment.
477 478 479 |
# File 'mwaa/cfn_environment.rb', line 477 def min_webservers() jsii_get_property("minWebservers") end |
#min_webservers=(value) ⇒ Object
481 482 483 484 |
# File 'mwaa/cfn_environment.rb', line 481 def min_webservers=(value) Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "minWebservers") unless value.nil? jsii_set_property("minWebservers", value) end |
#min_workers ⇒ Numeric?
The minimum number of workers that you want to run in your environment.
489 490 491 |
# File 'mwaa/cfn_environment.rb', line 489 def min_workers() jsii_get_property("minWorkers") end |
#min_workers=(value) ⇒ Object
493 494 495 496 |
# File 'mwaa/cfn_environment.rb', line 493 def min_workers=(value) Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "minWorkers") unless value.nil? jsii_set_property("minWorkers", value) end |
#name ⇒ String
The name of your Amazon MWAA environment.
342 343 344 |
# File 'mwaa/cfn_environment.rb', line 342 def name() jsii_get_property("name") end |
#name=(value) ⇒ Object
346 347 348 349 |
# File 'mwaa/cfn_environment.rb', line 346 def name=(value) Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "name") jsii_set_property("name", value) end |
#network_configuration ⇒ AWSCDK::IResolvable, ...
The VPC networking components used to secure and enable network traffic between the AWS resources for your environment.
501 502 503 |
# File 'mwaa/cfn_environment.rb', line 501 def network_configuration() jsii_get_property("networkConfiguration") end |
#network_configuration=(value) ⇒ Object
505 506 507 508 509 |
# File 'mwaa/cfn_environment.rb', line 505 def network_configuration=(value) value = value.is_a?(Hash) ? ::AWSCDK::MWAA::CfnEnvironment::NetworkConfigurationProperty.new(**value.transform_keys(&:to_sym)) : value Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19td2FhLkNmbkVudmlyb25tZW50Lk5ldHdvcmtDb25maWd1cmF0aW9uUHJvcGVydHkifV19fQ==")), "networkConfiguration") unless value.nil? jsii_set_property("networkConfiguration", value) end |
#node ⇒ Constructs::Node
The tree node.
149 150 151 |
# File 'mwaa/cfn_environment.rb', line 149 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.
874 875 876 |
# File 'mwaa/cfn_environment.rb', line 874 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.
881 882 883 |
# File 'mwaa/cfn_environment.rb', line 881 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.
674 675 676 677 |
# File 'mwaa/cfn_environment.rb', line 674 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 |
#plugins_s3_object_version ⇒ String?
The version of the plugins.zip file on your Amazon S3 bucket. To learn more, see Installing custom plugins .
514 515 516 |
# File 'mwaa/cfn_environment.rb', line 514 def plugins_s3_object_version() jsii_get_property("pluginsS3ObjectVersion") end |
#plugins_s3_object_version=(value) ⇒ Object
518 519 520 521 |
# File 'mwaa/cfn_environment.rb', line 518 def plugins_s3_object_version=(value) Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "pluginsS3ObjectVersion") unless value.nil? jsii_set_property("pluginsS3ObjectVersion", value) end |
#plugins_s3_path ⇒ String?
The relative path to the plugins.zip file on your Amazon S3 bucket. For example, plugins.zip . To learn more, see Installing custom plugins .
526 527 528 |
# File 'mwaa/cfn_environment.rb', line 526 def plugins_s3_path() jsii_get_property("pluginsS3Path") end |
#plugins_s3_path=(value) ⇒ Object
530 531 532 533 |
# File 'mwaa/cfn_environment.rb', line 530 def plugins_s3_path=(value) Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "pluginsS3Path") unless value.nil? jsii_set_property("pluginsS3Path", 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 }).
185 186 187 |
# File 'mwaa/cfn_environment.rb', line 185 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.
892 893 894 895 |
# File 'mwaa/cfn_environment.rb', line 892 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}
899 900 901 902 |
# File 'mwaa/cfn_environment.rb', line 899 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.
909 910 911 912 913 |
# File 'mwaa/cfn_environment.rb', line 909 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 |
#requirements_s3_object_version ⇒ String?
The version of the requirements.txt file on your Amazon S3 bucket. To learn more, see Installing Python dependencies .
538 539 540 |
# File 'mwaa/cfn_environment.rb', line 538 def requirements_s3_object_version() jsii_get_property("requirementsS3ObjectVersion") end |
#requirements_s3_object_version=(value) ⇒ Object
542 543 544 545 |
# File 'mwaa/cfn_environment.rb', line 542 def requirements_s3_object_version=(value) Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "requirementsS3ObjectVersion") unless value.nil? jsii_set_property("requirementsS3ObjectVersion", value) end |
#requirements_s3_path ⇒ String?
The relative path to the requirements.txt file on your Amazon S3 bucket. For example, requirements.txt . To learn more, see Installing Python dependencies .
550 551 552 |
# File 'mwaa/cfn_environment.rb', line 550 def requirements_s3_path() jsii_get_property("requirementsS3Path") end |
#requirements_s3_path=(value) ⇒ Object
554 555 556 557 |
# File 'mwaa/cfn_environment.rb', line 554 def requirements_s3_path=(value) Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "requirementsS3Path") unless value.nil? jsii_set_property("requirementsS3Path", value) end |
#schedulers ⇒ Numeric?
The number of schedulers that you want to run in your environment.
Valid values:.
564 565 566 |
# File 'mwaa/cfn_environment.rb', line 564 def schedulers() jsii_get_property("schedulers") end |
#schedulers=(value) ⇒ Object
568 569 570 571 |
# File 'mwaa/cfn_environment.rb', line 568 def schedulers=(value) Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "schedulers") unless value.nil? jsii_set_property("schedulers", value) end |
#should_synthesize ⇒ Boolean
Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.
918 919 920 |
# File 'mwaa/cfn_environment.rb', line 918 def should_synthesize() jsii_call_method("shouldSynthesize", []) end |
#source_bucket_arn ⇒ String?
The Amazon Resource Name (ARN) of the Amazon S3 bucket where your DAG code and supporting files are stored.
576 577 578 |
# File 'mwaa/cfn_environment.rb', line 576 def source_bucket_arn() jsii_get_property("sourceBucketArn") end |
#source_bucket_arn=(value) ⇒ Object
580 581 582 583 |
# File 'mwaa/cfn_environment.rb', line 580 def source_bucket_arn=(value) Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "sourceBucketArn") unless value.nil? jsii_set_property("sourceBucketArn", value) end |
#stack ⇒ AWSCDK::Stack
The stack in which this element is defined.
CfnElements must be defined within a stack scope (directly or indirectly).
175 176 177 |
# File 'mwaa/cfn_environment.rb', line 175 def stack() jsii_get_property("stack") end |
#startup_script_s3_object_version ⇒ String?
The version of the startup shell script in your Amazon S3 bucket.
588 589 590 |
# File 'mwaa/cfn_environment.rb', line 588 def startup_script_s3_object_version() jsii_get_property("startupScriptS3ObjectVersion") end |
#startup_script_s3_object_version=(value) ⇒ Object
592 593 594 595 |
# File 'mwaa/cfn_environment.rb', line 592 def startup_script_s3_object_version=(value) Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "startupScriptS3ObjectVersion") unless value.nil? jsii_set_property("startupScriptS3ObjectVersion", value) end |
#startup_script_s3_path ⇒ String?
The relative path to the startup shell script in your Amazon S3 bucket.
For example, s3://mwaa-environment/startup.sh .
602 603 604 |
# File 'mwaa/cfn_environment.rb', line 602 def startup_script_s3_path() jsii_get_property("startupScriptS3Path") end |
#startup_script_s3_path=(value) ⇒ Object
606 607 608 609 |
# File 'mwaa/cfn_environment.rb', line 606 def startup_script_s3_path=(value) Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "startupScriptS3Path") unless value.nil? jsii_set_property("startupScriptS3Path", value) end |
#tags ⇒ AWSCDK::TagManager
Tag Manager which manages the tags for this resource.
323 324 325 |
# File 'mwaa/cfn_environment.rb', line 323 def () jsii_get_property("tags") end |
#tags_raw ⇒ Object
The key-value tag pairs associated to your environment.
For example, "Environment": "Staging" . To learn more, see Tagging .
356 357 358 |
# File 'mwaa/cfn_environment.rb', line 356 def () jsii_get_property("tagsRaw") end |
#tags_raw=(value) ⇒ Object
360 361 362 363 |
# File 'mwaa/cfn_environment.rb', line 360 def (value) Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "tagsRaw") jsii_set_property("tagsRaw", value) end |
#to_string ⇒ String
Returns a string representation of this construct.
650 651 652 |
# File 'mwaa/cfn_environment.rb', line 650 def to_string() jsii_call_method("toString", []) 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.
222 223 224 |
# File 'mwaa/cfn_environment.rb', line 222 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.
232 233 234 |
# File 'mwaa/cfn_environment.rb', line 232 def updated_properties() jsii_get_property("updatedProperties") end |
#validate_properties(_properties) ⇒ void
This method returns an undefined value.
924 925 926 927 |
# File 'mwaa/cfn_environment.rb', line 924 def validate_properties(_properties) Jsii::Type.check_type(_properties, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "_properties") jsii_call_method("validateProperties", [_properties]) end |
#webserver_access_mode ⇒ String?
The Apache Airflow Web server access mode.
614 615 616 |
# File 'mwaa/cfn_environment.rb', line 614 def webserver_access_mode() jsii_get_property("webserverAccessMode") end |
#webserver_access_mode=(value) ⇒ Object
618 619 620 621 |
# File 'mwaa/cfn_environment.rb', line 618 def webserver_access_mode=(value) Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "webserverAccessMode") unless value.nil? jsii_set_property("webserverAccessMode", value) end |
#weekly_maintenance_window_start ⇒ String?
The day and time of the week to start weekly maintenance updates of your environment in the following format: DAY:HH:MM .
626 627 628 |
# File 'mwaa/cfn_environment.rb', line 626 def weekly_maintenance_window_start() jsii_get_property("weeklyMaintenanceWindowStart") end |
#weekly_maintenance_window_start=(value) ⇒ Object
630 631 632 633 |
# File 'mwaa/cfn_environment.rb', line 630 def weekly_maintenance_window_start=(value) Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "weeklyMaintenanceWindowStart") unless value.nil? jsii_set_property("weeklyMaintenanceWindowStart", 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.
663 664 665 666 667 668 |
# File 'mwaa/cfn_environment.rb', line 663 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 |
#worker_replacement_strategy ⇒ String?
The worker replacement strategy to use when updating the environment.
638 639 640 |
# File 'mwaa/cfn_environment.rb', line 638 def worker_replacement_strategy() jsii_get_property("workerReplacementStrategy") end |
#worker_replacement_strategy=(value) ⇒ Object
642 643 644 645 |
# File 'mwaa/cfn_environment.rb', line 642 def worker_replacement_strategy=(value) Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "workerReplacementStrategy") unless value.nil? jsii_set_property("workerReplacementStrategy", value) end |