CfnConnectorPropsMixin

class aws_cdk.cfn_property_mixins.aws_securityhub.CfnConnectorPropsMixin(props, *, strategy=None)

Bases: Mixin

Creates a connector to a third-party cloud provider in Security Hub CSPM.

A connector establishes a connection between Security Hub CSPM and a third-party cloud provider, enabling Security Hub CSPM to ingest security findings and resource data from the connected environment.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-securityhub-connector.html
CloudformationResource:: AWS::SecurityHub::Connector
Mixin:: true
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.cfn_property_mixins import aws_securityhub as securityhub
import aws_cdk as cdk

# merge_strategy: cdk.IMergeStrategy

cfn_connector_props_mixin = securityhub.CfnConnectorPropsMixin(securityhub.CfnConnectorMixinProps(
    description="description",
    name="name",
    provider=securityhub.CfnConnectorPropsMixin.ProviderProperty(
        azure=securityhub.CfnConnectorPropsMixin.AzureProviderConfigurationProperty(
            aws_config_connector_arn="awsConfigConnectorArn",
            azure_regions=["azureRegions"],
            scope_configuration=securityhub.CfnConnectorPropsMixin.AzureScopeConfigurationProperty(
                scope_type="scopeType",
                scope_values=["scopeValues"]
            )
        )
    ),
    tags={
        "tags_key": "tags"
    }
),
    strategy=merge_strategy
)

Create a mixin to apply properties to AWS::SecurityHub::Connector.

Parameters:

props (Union[CfnConnectorMixinProps, Dict[str, Any]]) – L1 properties to apply.
strategy (Optional[IMergeStrategy]) – Strategy for merging nested properties. Default: - PropertyMergeStrategy.combine()

Methods

apply_to(construct)

Apply the mixin properties to the construct.

Parameters:: construct (IConstruct)
Return type:: None

supports(construct)

Check if this mixin supports the given construct.

Parameters:: construct (IConstruct)
Return type:: bool

Attributes

CFN_PROPERTY_KEYS = ['description', 'name', 'provider', 'tags']

Static Methods

classmethod is_mixin(x)

Checks if x is a Mixin.

Parameters:: x (Any) – Any object.
Return type:: bool
Returns:: true if x is an object created from a class which extends Mixin.

AzureProviderConfigurationProperty

class CfnConnectorPropsMixin.AzureProviderConfigurationProperty(*, aws_config_connector_arn=None, azure_regions=None, scope_configuration=None)

Bases: object

The configuration for connecting to an Azure environment.

Parameters:

aws_config_connector_arn (Optional[str]) – The ARN of the multi-cloud configuration connector used to establish the connection to Azure.
azure_regions (Optional[Sequence[str]]) – The list of Azure regions to monitor.
scope_configuration (Union[IResolvable, AzureScopeConfigurationProperty, Dict[str, Any], None]) – The scope configuration for an Azure connector, defining the tenant or subscription scope.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-connector-azureproviderconfiguration.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.cfn_property_mixins import aws_securityhub as securityhub

azure_provider_configuration_property = securityhub.CfnConnectorPropsMixin.AzureProviderConfigurationProperty(
    aws_config_connector_arn="awsConfigConnectorArn",
    azure_regions=["azureRegions"],
    scope_configuration=securityhub.CfnConnectorPropsMixin.AzureScopeConfigurationProperty(
        scope_type="scopeType",
        scope_values=["scopeValues"]
    )
)

Attributes

aws_config_connector_arn

The ARN of the multi-cloud configuration connector used to establish the connection to Azure.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-connector-azureproviderconfiguration.html#cfn-securityhub-connector-azureproviderconfiguration-awsconfigconnectorarn

azure_regions

The list of Azure regions to monitor.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-connector-azureproviderconfiguration.html#cfn-securityhub-connector-azureproviderconfiguration-azureregions

scope_configuration

The scope configuration for an Azure connector, defining the tenant or subscription scope.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-connector-azureproviderconfiguration.html#cfn-securityhub-connector-azureproviderconfiguration-scopeconfiguration

AzureScopeConfigurationProperty

class CfnConnectorPropsMixin.AzureScopeConfigurationProperty(*, scope_type=None, scope_values=None)

Bases: object

The scope configuration for an Azure connector, defining the tenant or subscription scope.

Parameters:

scope_type (Optional[str]) – The type of scope. Valid values are tenant and subscription.
scope_values (Optional[Sequence[str]]) – The list of scope values, such as subscription IDs, when the scope type is subscription.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-connector-azurescopeconfiguration.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.cfn_property_mixins import aws_securityhub as securityhub

azure_scope_configuration_property = securityhub.CfnConnectorPropsMixin.AzureScopeConfigurationProperty(
    scope_type="scopeType",
    scope_values=["scopeValues"]
)

Attributes

scope_type

The type of scope.

Valid values are tenant and subscription.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-connector-azurescopeconfiguration.html#cfn-securityhub-connector-azurescopeconfiguration-scopetype

scope_values

The list of scope values, such as subscription IDs, when the scope type is subscription.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-connector-azurescopeconfiguration.html#cfn-securityhub-connector-azurescopeconfiguration-scopevalues

HealthIssueProperty

class CfnConnectorPropsMixin.HealthIssueProperty(*, code=None, message=None)

Bases: object

Represents a specific health issue detected for a connector.

Parameters:

code (Optional[str]) – The code identifying the type of health issue.
message (Optional[str]) – A human-readable message that describes the health issue.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-connector-healthissue.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.cfn_property_mixins import aws_securityhub as securityhub

health_issue_property = securityhub.CfnConnectorPropsMixin.HealthIssueProperty(
    code="code",
    message="message"
)

Attributes

code

The code identifying the type of health issue.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-connector-healthissue.html#cfn-securityhub-connector-healthissue-code

message

A human-readable message that describes the health issue.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-connector-healthissue.html#cfn-securityhub-connector-healthissue-message

ProviderProperty

class CfnConnectorPropsMixin.ProviderProperty(*, azure=None)

Bases: object

The CSPM provider configuration for the connector.

Parameters:: azure (Union[IResolvable, AzureProviderConfigurationProperty, Dict[str, Any], None]) – The configuration for connecting to an Azure environment.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-connector-provider.html
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.cfn_property_mixins import aws_securityhub as securityhub

provider_property = securityhub.CfnConnectorPropsMixin.ProviderProperty(
    azure=securityhub.CfnConnectorPropsMixin.AzureProviderConfigurationProperty(
        aws_config_connector_arn="awsConfigConnectorArn",
        azure_regions=["azureRegions"],
        scope_configuration=securityhub.CfnConnectorPropsMixin.AzureScopeConfigurationProperty(
            scope_type="scopeType",
            scope_values=["scopeValues"]
        )
    )
)

Attributes

azure

The configuration for connecting to an Azure environment.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-connector-provider.html#cfn-securityhub-connector-provider-azure