CfnEnvironment
- class aws_cdk.aws_m2.CfnEnvironment(scope, id, *, engine_type, instance_type, name, description=None, engine_version=None, high_availability_config=None, kms_key_id=None, preferred_maintenance_window=None, publicly_accessible=None, security_group_ids=None, storage_configurations=None, subnet_ids=None, tags=None)
Bases:
CfnResource
A CloudFormation
AWS::M2::Environment
.Specifies a runtime environment for a given runtime engine.
- CloudformationResource:
AWS::M2::Environment
- Link:
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-m2-environment.html
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.aws_m2 as m2 cfn_environment = m2.CfnEnvironment(self, "MyCfnEnvironment", engine_type="engineType", instance_type="instanceType", name="name", # the properties below are optional description="description", engine_version="engineVersion", high_availability_config=m2.CfnEnvironment.HighAvailabilityConfigProperty( desired_capacity=123 ), kms_key_id="kmsKeyId", preferred_maintenance_window="preferredMaintenanceWindow", publicly_accessible=False, security_group_ids=["securityGroupIds"], storage_configurations=[m2.CfnEnvironment.StorageConfigurationProperty( efs=m2.CfnEnvironment.EfsStorageConfigurationProperty( file_system_id="fileSystemId", mount_point="mountPoint" ), fsx=m2.CfnEnvironment.FsxStorageConfigurationProperty( file_system_id="fileSystemId", mount_point="mountPoint" ) )], subnet_ids=["subnetIds"], tags={ "tags_key": "tags" } )
Create a new
AWS::M2::Environment
.- Parameters:
scope (
Construct
) –scope in which this resource is defined.
id (
str
) –scoped id of the resource.
engine_type (
str
) – The target platform for the runtime environment.instance_type (
str
) – The instance type of the runtime environment.name (
str
) – The name of the runtime environment.description (
Optional
[str
]) – The description of the runtime environment.engine_version (
Optional
[str
]) – The version of the runtime engine.high_availability_config (
Union
[IResolvable
,HighAvailabilityConfigProperty
,Dict
[str
,Any
],None
]) – Defines the details of a high availability configuration.kms_key_id (
Optional
[str
]) – The identifier of a customer managed key.preferred_maintenance_window (
Optional
[str
]) – Configures the maintenance window you want for the runtime environment. If you do not provide a value, a random system-generated value will be assigned.publicly_accessible (
Union
[bool
,IResolvable
,None
]) – Specifies whether the runtime environment is publicly accessible.security_group_ids (
Optional
[Sequence
[str
]]) – The list of security groups for the VPC associated with this runtime environment.storage_configurations (
Union
[IResolvable
,Sequence
[Union
[IResolvable
,StorageConfigurationProperty
,Dict
[str
,Any
]]],None
]) – Defines the storage configuration for a runtime environment.subnet_ids (
Optional
[Sequence
[str
]]) – The list of subnets associated with the VPC for this runtime environment.tags (
Optional
[Mapping
[str
,str
]]) – An array of key-value pairs to apply to this resource. For more information, see Tag .
Methods
- add_deletion_override(path)
Syntactic sugar for
addOverride(path, undefined)
.- Parameters:
path (
str
) – The path of the value to delete.- Return type:
None
- add_depends_on(target)
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.
- Parameters:
target (
CfnResource
)- Return type:
None
- add_metadata(key, value)
Add a value to the CloudFormation Resource Metadata.
- Parameters:
key (
str
)value (
Any
)
- See:
- Return type:
None
Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.
- add_override(path, value)
Adds an override to the synthesized CloudFormation resource.
To add a property override, either use
addPropertyOverride
or prefixpath
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:
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"]) cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")
would add the overrides Example:
"Properties": { "GlobalSecondaryIndexes": [ { "Projection": { "NonKeyAttributes": [ "myattribute" ] ... } ... }, { "ProjectionType": "INCLUDE" ... }, ] ... }
The
value
argument toaddOverride
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.- Parameters:
path (
str
) –The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.
value (
Any
) –The value. Could be primitive or complex.
- Return type:
None
- add_property_deletion_override(property_path)
Adds an override that deletes the value of a property from the resource definition.
- Parameters:
property_path (
str
) – The path to the property.- Return type:
None
- add_property_override(property_path, value)
Adds an override to a resource property.
Syntactic sugar for
addOverride("Properties.<...>", value)
.- Parameters:
property_path (
str
) – The path of the property.value (
Any
) – The value.
- Return type:
None
- apply_removal_policy(policy=None, *, apply_to_update_replace_policy=None, default=None)
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
).- Parameters:
policy (
Optional
[RemovalPolicy
])apply_to_update_replace_policy (
Optional
[bool
]) – Apply the same deletion policy to the resource’s “UpdateReplacePolicy”. Default: truedefault (
Optional
[RemovalPolicy
]) – The default policy to apply in case the removal policy is not defined. Default: - Default value is resource specific. To determine the default value for a resoure, please consult that specific resource’s documentation.
- Return type:
None
- get_att(attribute_name)
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.- Parameters:
attribute_name (
str
) – The name of the attribute.- Return type:
- get_metadata(key)
Retrieve a value value from the CloudFormation Resource Metadata.
- Parameters:
key (
str
)- See:
- Return type:
Any
Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.
- inspect(inspector)
Examines the CloudFormation resource and discloses attributes.
- Parameters:
inspector (
TreeInspector
) –tree inspector to collect and process attributes.
- Return type:
None
- override_logical_id(new_logical_id)
Overrides the auto-generated logical ID with a specific ID.
- Parameters:
new_logical_id (
str
) – The new logical ID to use for this stack element.- Return type:
None
- to_string()
Returns a string representation of this construct.
- Return type:
str
- Returns:
a string representation of this resource
Attributes
- CFN_RESOURCE_TYPE_NAME = 'AWS::M2::Environment'
- attr_environment_arn
The Amazon Resource Name (ARN) of the runtime environment.
- CloudformationAttribute:
EnvironmentArn
- attr_environment_id
The unique identifier of the runtime environment.
- CloudformationAttribute:
EnvironmentId
- cfn_options
Options for this resource, such as condition, update policy etc.
- cfn_resource_type
AWS resource type.
- creation_stack
return:
the stack trace of the point where this Resource was created from, sourced from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most node +internal+ entries filtered.
- description
The description of the runtime environment.
- engine_type
The target platform for the runtime environment.
- engine_version
The version of the runtime engine.
- high_availability_config
Defines the details of a high availability configuration.
- instance_type
The instance type of the runtime environment.
- kms_key_id
The identifier of a customer managed key.
- logical_id
The logical ID for this CloudFormation stack element.
The logical ID of the element is calculated from the path of the resource node in the construct tree.
To override this value, use
overrideLogicalId(newLogicalId)
.- Returns:
the logical ID as a stringified token. This value will only get resolved during synthesis.
- name
The name of the runtime environment.
- node
The construct tree node associated with this construct.
- preferred_maintenance_window
Configures the maintenance window you want for the runtime environment.
If you do not provide a value, a random system-generated value will be assigned.
- publicly_accessible
Specifies whether the runtime environment is publicly accessible.
- ref
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 })
.
- security_group_ids
The list of security groups for the VPC associated with this runtime environment.
- stack
The stack in which this element is defined.
CfnElements must be defined within a stack scope (directly or indirectly).
- storage_configurations
Defines the storage configuration for a runtime environment.
- subnet_ids
The list of subnets associated with the VPC for this runtime environment.
Static Methods
- classmethod is_cfn_element(x)
Returns
true
if a construct is a stack element (i.e. part of the synthesized cloudformation template).Uses duck-typing instead of
instanceof
to allow stack elements from different versions of this library to be included in the same stack.- Parameters:
x (
Any
)- Return type:
bool
- Returns:
The construct as a stack element or undefined if it is not a stack element.
- classmethod is_cfn_resource(construct)
Check whether the given construct is a CfnResource.
- Parameters:
construct (
IConstruct
)- Return type:
bool
- classmethod is_construct(x)
Return whether the given object is a Construct.
- Parameters:
x (
Any
)- Return type:
bool
EfsStorageConfigurationProperty
- class CfnEnvironment.EfsStorageConfigurationProperty(*, file_system_id, mount_point)
Bases:
object
Defines the storage configuration for an Amazon EFS file system.
- Parameters:
file_system_id (
str
) – The file system identifier.mount_point (
str
) – The mount point for the file system.
- Link:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.aws_m2 as m2 efs_storage_configuration_property = m2.CfnEnvironment.EfsStorageConfigurationProperty( file_system_id="fileSystemId", mount_point="mountPoint" )
Attributes
- file_system_id
The file system identifier.
- mount_point
The mount point for the file system.
FsxStorageConfigurationProperty
- class CfnEnvironment.FsxStorageConfigurationProperty(*, file_system_id, mount_point)
Bases:
object
Defines the storage configuration for an Amazon FSx file system.
- Parameters:
file_system_id (
str
) – The file system identifier.mount_point (
str
) – The mount point for the file system.
- Link:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.aws_m2 as m2 fsx_storage_configuration_property = m2.CfnEnvironment.FsxStorageConfigurationProperty( file_system_id="fileSystemId", mount_point="mountPoint" )
Attributes
- file_system_id
The file system identifier.
- mount_point
The mount point for the file system.
HighAvailabilityConfigProperty
- class CfnEnvironment.HighAvailabilityConfigProperty(*, desired_capacity)
Bases:
object
Defines the details of a high availability configuration.
- Parameters:
desired_capacity (
Union
[int
,float
]) – The number of instances in a high availability configuration.- Link:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.aws_m2 as m2 high_availability_config_property = m2.CfnEnvironment.HighAvailabilityConfigProperty( desired_capacity=123 )
Attributes
- desired_capacity
The number of instances in a high availability configuration.
StorageConfigurationProperty
- class CfnEnvironment.StorageConfigurationProperty(*, efs=None, fsx=None)
Bases:
object
Defines the storage configuration for a runtime environment.
- Parameters:
efs (
Union
[IResolvable
,EfsStorageConfigurationProperty
,Dict
[str
,Any
],None
]) – Defines the storage configuration for an Amazon EFS file system.fsx (
Union
[IResolvable
,FsxStorageConfigurationProperty
,Dict
[str
,Any
],None
]) – Defines the storage configuration for an Amazon FSx file system.
- Link:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.aws_m2 as m2 storage_configuration_property = m2.CfnEnvironment.StorageConfigurationProperty( efs=m2.CfnEnvironment.EfsStorageConfigurationProperty( file_system_id="fileSystemId", mount_point="mountPoint" ), fsx=m2.CfnEnvironment.FsxStorageConfigurationProperty( file_system_id="fileSystemId", mount_point="mountPoint" ) )
Attributes
- efs
Defines the storage configuration for an Amazon EFS file system.
- fsx
Defines the storage configuration for an Amazon FSx file system.