CfnSecurityConfiguration

class aws_cdk.aws_glue.CfnSecurityConfiguration(scope, id, *, encryption_configuration, name)

Bases: CfnResource

A CloudFormation AWS::Glue::SecurityConfiguration.

Creates a new security configuration. A security configuration is a set of security properties that can be used by AWS Glue . You can use a security configuration to encrypt data at rest. For information about using security configurations in AWS Glue , see Encrypting Data Written by Crawlers, Jobs, and Development Endpoints .

CloudformationResource:: AWS::Glue::SecurityConfiguration
Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-securityconfiguration.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_glue as glue

cfn_security_configuration = glue.CfnSecurityConfiguration(self, "MyCfnSecurityConfiguration",
    encryption_configuration=glue.CfnSecurityConfiguration.EncryptionConfigurationProperty(
        cloud_watch_encryption=glue.CfnSecurityConfiguration.CloudWatchEncryptionProperty(
            cloud_watch_encryption_mode="cloudWatchEncryptionMode",
            kms_key_arn="kmsKeyArn"
        ),
        job_bookmarks_encryption=glue.CfnSecurityConfiguration.JobBookmarksEncryptionProperty(
            job_bookmarks_encryption_mode="jobBookmarksEncryptionMode",
            kms_key_arn="kmsKeyArn"
        ),
        s3_encryptions=[glue.CfnSecurityConfiguration.S3EncryptionProperty(
            kms_key_arn="kmsKeyArn",
            s3_encryption_mode="s3EncryptionMode"
        )]
    ),
    name="name"
)

Create a new AWS::Glue::SecurityConfiguration.

Parameters:

scope (Construct) –
- scope in which this resource is defined.
id (str) –
- scoped id of the resource.
encryption_configuration (Union[IResolvable, EncryptionConfigurationProperty, Dict[str, Any]]) – The encryption configuration associated with this security configuration.
name (str) – The name of the security configuration.

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

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

add_override(path, value)

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use addPropertyOverride or prefix path with “Properties.” (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example:

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 to addOverride will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

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: true
default (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:: Reference

get_metadata(key)

Retrieve a value value from the CloudFormation Resource Metadata.

Parameters:

key (str) –

See:

Return type:

Any

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

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::Glue::SecurityConfiguration'

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.

encryption_configuration

The encryption configuration associated with this security configuration.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-securityconfiguration.html#cfn-glue-securityconfiguration-encryptionconfiguration

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 security configuration.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-securityconfiguration.html#cfn-glue-securityconfiguration-name

node: The construct tree node associated with this construct.

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

stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

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

CloudWatchEncryptionProperty

class CfnSecurityConfiguration.CloudWatchEncryptionProperty(*, cloud_watch_encryption_mode=None, kms_key_arn=None)

Bases: object

Specifies how Amazon CloudWatch data should be encrypted.

Parameters:

cloud_watch_encryption_mode (Optional[str]) – The encryption mode to use for CloudWatch data.
kms_key_arn (Optional[str]) – The Amazon Resource Name (ARN) of the KMS key to be used to encrypt the data.

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-securityconfiguration-cloudwatchencryption.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_glue as glue

cloud_watch_encryption_property = glue.CfnSecurityConfiguration.CloudWatchEncryptionProperty(
    cloud_watch_encryption_mode="cloudWatchEncryptionMode",
    kms_key_arn="kmsKeyArn"
)

Attributes

cloud_watch_encryption_mode

The encryption mode to use for CloudWatch data.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-securityconfiguration-cloudwatchencryption.html#cfn-glue-securityconfiguration-cloudwatchencryption-cloudwatchencryptionmode

kms_key_arn

The Amazon Resource Name (ARN) of the KMS key to be used to encrypt the data.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-securityconfiguration-cloudwatchencryption.html#cfn-glue-securityconfiguration-cloudwatchencryption-kmskeyarn

EncryptionConfigurationProperty

class CfnSecurityConfiguration.EncryptionConfigurationProperty(*, cloud_watch_encryption=None, job_bookmarks_encryption=None, s3_encryptions=None)

Bases: object

Specifies an encryption configuration.

Parameters:

cloud_watch_encryption (Union[IResolvable, CloudWatchEncryptionProperty, Dict[str, Any], None]) – The encryption configuration for Amazon CloudWatch.
job_bookmarks_encryption (Union[IResolvable, JobBookmarksEncryptionProperty, Dict[str, Any], None]) – The encryption configuration for job bookmarks.
s3_encryptions (Union[IResolvable, Sequence[Union[IResolvable, S3EncryptionProperty, Dict[str, Any]]], None]) – The encyption configuration for Amazon Simple Storage Service (Amazon S3) data.

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-securityconfiguration-encryptionconfiguration.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_glue as glue

encryption_configuration_property = glue.CfnSecurityConfiguration.EncryptionConfigurationProperty(
    cloud_watch_encryption=glue.CfnSecurityConfiguration.CloudWatchEncryptionProperty(
        cloud_watch_encryption_mode="cloudWatchEncryptionMode",
        kms_key_arn="kmsKeyArn"
    ),
    job_bookmarks_encryption=glue.CfnSecurityConfiguration.JobBookmarksEncryptionProperty(
        job_bookmarks_encryption_mode="jobBookmarksEncryptionMode",
        kms_key_arn="kmsKeyArn"
    ),
    s3_encryptions=[glue.CfnSecurityConfiguration.S3EncryptionProperty(
        kms_key_arn="kmsKeyArn",
        s3_encryption_mode="s3EncryptionMode"
    )]
)

Attributes

cloud_watch_encryption

The encryption configuration for Amazon CloudWatch.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-securityconfiguration-encryptionconfiguration.html#cfn-glue-securityconfiguration-encryptionconfiguration-cloudwatchencryption

job_bookmarks_encryption

The encryption configuration for job bookmarks.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-securityconfiguration-encryptionconfiguration.html#cfn-glue-securityconfiguration-encryptionconfiguration-jobbookmarksencryption

s3_encryptions

The encyption configuration for Amazon Simple Storage Service (Amazon S3) data.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-securityconfiguration-encryptionconfiguration.html#cfn-glue-securityconfiguration-encryptionconfiguration-s3encryptions

JobBookmarksEncryptionProperty

class CfnSecurityConfiguration.JobBookmarksEncryptionProperty(*, job_bookmarks_encryption_mode=None, kms_key_arn=None)

Bases: object

Specifies how job bookmark data should be encrypted.

Parameters:

job_bookmarks_encryption_mode (Optional[str]) – The encryption mode to use for job bookmarks data.
kms_key_arn (Optional[str]) – The Amazon Resource Name (ARN) of the KMS key to be used to encrypt the data.

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-securityconfiguration-jobbookmarksencryption.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_glue as glue

job_bookmarks_encryption_property = glue.CfnSecurityConfiguration.JobBookmarksEncryptionProperty(
    job_bookmarks_encryption_mode="jobBookmarksEncryptionMode",
    kms_key_arn="kmsKeyArn"
)

Attributes

job_bookmarks_encryption_mode

The encryption mode to use for job bookmarks data.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-securityconfiguration-jobbookmarksencryption.html#cfn-glue-securityconfiguration-jobbookmarksencryption-jobbookmarksencryptionmode

kms_key_arn

The Amazon Resource Name (ARN) of the KMS key to be used to encrypt the data.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-securityconfiguration-jobbookmarksencryption.html#cfn-glue-securityconfiguration-jobbookmarksencryption-kmskeyarn

S3EncryptionProperty

class CfnSecurityConfiguration.S3EncryptionProperty(*, kms_key_arn=None, s3_encryption_mode=None)

Bases: object

Specifies how Amazon Simple Storage Service (Amazon S3) data should be encrypted.

Parameters:

kms_key_arn (Optional[str]) – The Amazon Resource Name (ARN) of the KMS key to be used to encrypt the data.
s3_encryption_mode (Optional[str]) – The encryption mode to use for Amazon S3 data.

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-securityconfiguration-s3encryption.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_glue as glue

s3_encryption_property = glue.CfnSecurityConfiguration.S3EncryptionProperty(
    kms_key_arn="kmsKeyArn",
    s3_encryption_mode="s3EncryptionMode"
)

Attributes

kms_key_arn

The Amazon Resource Name (ARN) of the KMS key to be used to encrypt the data.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-securityconfiguration-s3encryption.html#cfn-glue-securityconfiguration-s3encryption-kmskeyarn

s3_encryption_mode

The encryption mode to use for Amazon S3 data.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-securityconfiguration-s3encryption.html#cfn-glue-securityconfiguration-s3encryption-s3encryptionmode