CfnLocationObjectStoragePropsMixin

class aws_cdk.cfn_property_mixins.aws_datasync.CfnLocationObjectStoragePropsMixin(props, *, strategy=None)

Bases: Mixin

The AWS::DataSync::LocationObjectStorage resource specifies an endpoint for a self-managed object storage bucket.

For more information about self-managed object storage locations, see Creating a Location for Object Storage .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationobjectstorage.html
CloudformationResource:: AWS::DataSync::LocationObjectStorage
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_datasync as datasync
import aws_cdk as cdk

# merge_strategy: cdk.IMergeStrategy

cfn_location_object_storage_props_mixin = datasync.CfnLocationObjectStoragePropsMixin(datasync.CfnLocationObjectStorageMixinProps(
    access_key="accessKey",
    agent_arns=["agentArns"],
    bucket_name="bucketName",
    cmk_secret_config=datasync.CfnLocationObjectStoragePropsMixin.CmkSecretConfigProperty(
        kms_key_arn="kmsKeyArn",
        secret_arn="secretArn"
    ),
    custom_secret_config=datasync.CfnLocationObjectStoragePropsMixin.CustomSecretConfigProperty(
        secret_access_role_arn="secretAccessRoleArn",
        secret_arn="secretArn"
    ),
    federated_identity=datasync.CfnLocationObjectStoragePropsMixin.ObjectStorageFederatedIdentityConfigProperty(
        aws_iam_role="awsIamRole",
        external_identity=datasync.CfnLocationObjectStoragePropsMixin.ObjectStorageExternalIdentityConfigProperty(
            google_oidc=datasync.CfnLocationObjectStoragePropsMixin.GoogleOidcConfigProperty(
                identity_pool_name="identityPoolName",
                identity_provider_name="identityProviderName",
                project_name="projectName",
                project_number="projectNumber"
            )
        )
    ),
    secret_key="secretKey",
    server_certificate="serverCertificate",
    server_hostname="serverHostname",
    server_port=123,
    server_protocol="serverProtocol",
    subdirectory="subdirectory",
    tags=[cdk.CfnTag(
        key="key",
        value="value"
    )]
),
    strategy=merge_strategy
)

Create a mixin to apply properties to AWS::DataSync::LocationObjectStorage.

Parameters:

props (Union[CfnLocationObjectStorageMixinProps, 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 = ['accessKey', 'agentArns', 'bucketName', 'cmkSecretConfig', 'customSecretConfig', 'federatedIdentity', 'secretKey', 'serverCertificate', 'serverHostname', 'serverPort', 'serverProtocol', 'subdirectory', '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.

CmkSecretConfigProperty

class CfnLocationObjectStoragePropsMixin.CmkSecretConfigProperty(*, kms_key_arn=None, secret_arn=None)

Bases: object

Specifies configuration information for a DataSync-managed secret, such as an authentication token, secret key, password, or Kerberos keytab that DataSync uses to access a specific storage location, with a customer-managed AWS KMS key .

You can use either CmkSecretConfig or CustomSecretConfig to provide credentials for a CreateLocation request. Do not provide both parameters for the same request.

Parameters:

kms_key_arn (Optional[str]) – Specifies the ARN for the customer-managed AWS KMS key that DataSync uses to encrypt the DataSync-managed secret stored for SecretArn . DataSync provides this key to AWS Secrets Manager .
secret_arn (Optional[str]) – Specifies the ARN for the DataSync-managed AWS Secrets Manager secret that that is used to access a specific storage location. This property is generated by DataSync and is read-only. DataSync encrypts this secret with the KMS key that you specify for KmsKeyArn .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-locationobjectstorage-cmksecretconfig.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_datasync as datasync

cmk_secret_config_property = datasync.CfnLocationObjectStoragePropsMixin.CmkSecretConfigProperty(
    kms_key_arn="kmsKeyArn",
    secret_arn="secretArn"
)

Attributes

kms_key_arn

Specifies the ARN for the customer-managed AWS KMS key that DataSync uses to encrypt the DataSync-managed secret stored for SecretArn .

DataSync provides this key to AWS Secrets Manager .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-locationobjectstorage-cmksecretconfig.html#cfn-datasync-locationobjectstorage-cmksecretconfig-kmskeyarn

secret_arn

Specifies the ARN for the DataSync-managed AWS Secrets Manager secret that that is used to access a specific storage location.

This property is generated by DataSync and is read-only. DataSync encrypts this secret with the KMS key that you specify for KmsKeyArn .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-locationobjectstorage-cmksecretconfig.html#cfn-datasync-locationobjectstorage-cmksecretconfig-secretarn

CustomSecretConfigProperty

class CfnLocationObjectStoragePropsMixin.CustomSecretConfigProperty(*, secret_access_role_arn=None, secret_arn=None)

Bases: object

Specifies configuration information for a customer-managed Secrets Manager secret where a storage location credentials is stored in Secrets Manager as plain text (for authentication token, secret key, or password) or as binary (for Kerberos keytab).

This configuration includes the secret ARN, and the ARN for an IAM role that provides access to the secret. .. epigraph:

You can use either ``CmkSecretConfig`` or ``CustomSecretConfig`` to provide credentials for a ``CreateLocation`` request. Do not provide both parameters for the same request.

Parameters:

secret_access_role_arn (Optional[str]) – Specifies the ARN for the AWS Identity and Access Management role that DataSync uses to access the secret specified for SecretArn .
secret_arn (Optional[str]) – Specifies the ARN for an AWS Secrets Manager secret.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-locationobjectstorage-customsecretconfig.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_datasync as datasync

custom_secret_config_property = datasync.CfnLocationObjectStoragePropsMixin.CustomSecretConfigProperty(
    secret_access_role_arn="secretAccessRoleArn",
    secret_arn="secretArn"
)

Attributes

secret_access_role_arn

Specifies the ARN for the AWS Identity and Access Management role that DataSync uses to access the secret specified for SecretArn .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-locationobjectstorage-customsecretconfig.html#cfn-datasync-locationobjectstorage-customsecretconfig-secretaccessrolearn

secret_arn

Specifies the ARN for an AWS Secrets Manager secret.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-locationobjectstorage-customsecretconfig.html#cfn-datasync-locationobjectstorage-customsecretconfig-secretarn

GoogleOidcConfigProperty

class CfnLocationObjectStoragePropsMixin.GoogleOidcConfigProperty(*, identity_pool_name=None, identity_provider_name=None, project_name=None, project_number=None)

Bases: object

Specifies the Google Cloud workload identity federation configuration that DataSync uses to obtain an access token for your Google Cloud Storage bucket.

Parameters:

identity_pool_name (Optional[str]) – The name of the Google Cloud workload identity pool that DataSync federates with.
identity_provider_name (Optional[str]) – The name of the OIDC identity provider configured in the Google Cloud workload identity pool.
project_name (Optional[str]) – The human-readable Google Cloud project name.
project_number (Optional[str]) – The numeric Google Cloud project ID, as a string.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-locationobjectstorage-googleoidcconfig.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_datasync as datasync

google_oidc_config_property = datasync.CfnLocationObjectStoragePropsMixin.GoogleOidcConfigProperty(
    identity_pool_name="identityPoolName",
    identity_provider_name="identityProviderName",
    project_name="projectName",
    project_number="projectNumber"
)

Attributes

identity_pool_name

The name of the Google Cloud workload identity pool that DataSync federates with.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-locationobjectstorage-googleoidcconfig.html#cfn-datasync-locationobjectstorage-googleoidcconfig-identitypoolname

identity_provider_name

The name of the OIDC identity provider configured in the Google Cloud workload identity pool.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-locationobjectstorage-googleoidcconfig.html#cfn-datasync-locationobjectstorage-googleoidcconfig-identityprovidername

project_name

The human-readable Google Cloud project name.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-locationobjectstorage-googleoidcconfig.html#cfn-datasync-locationobjectstorage-googleoidcconfig-projectname

project_number

The numeric Google Cloud project ID, as a string.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-locationobjectstorage-googleoidcconfig.html#cfn-datasync-locationobjectstorage-googleoidcconfig-projectnumber

ManagedSecretConfigProperty

class CfnLocationObjectStoragePropsMixin.ManagedSecretConfigProperty(*, secret_arn=None)

Bases: object

Specifies configuration information for a DataSync-managed secret, such as an authentication token or set of credentials that DataSync uses to access a specific transfer location.

DataSync uses the default AWS -managed KMS key to encrypt this secret in AWS Secrets Manager .

Parameters:: secret_arn (Optional[str]) – Specifies the ARN for an AWS Secrets Manager secret.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-locationobjectstorage-managedsecretconfig.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_datasync as datasync

managed_secret_config_property = datasync.CfnLocationObjectStoragePropsMixin.ManagedSecretConfigProperty(
    secret_arn="secretArn"
)

Attributes

secret_arn

Specifies the ARN for an AWS Secrets Manager secret.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-locationobjectstorage-managedsecretconfig.html#cfn-datasync-locationobjectstorage-managedsecretconfig-secretarn

ObjectStorageExternalIdentityConfigProperty

class CfnLocationObjectStoragePropsMixin.ObjectStorageExternalIdentityConfigProperty(*, google_oidc=None)

Bases: object

Specifies the external (non-AWS) identity provider that DataSync federates with to access your object storage location.

Parameters:: google_oidc (Union[IResolvable, GoogleOidcConfigProperty, Dict[str, Any], None]) – Specifies the Google Cloud workload identity federation configuration that DataSync uses to obtain an access token for your Google Cloud Storage bucket.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-locationobjectstorage-objectstorageexternalidentityconfig.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_datasync as datasync

object_storage_external_identity_config_property = datasync.CfnLocationObjectStoragePropsMixin.ObjectStorageExternalIdentityConfigProperty(
    google_oidc=datasync.CfnLocationObjectStoragePropsMixin.GoogleOidcConfigProperty(
        identity_pool_name="identityPoolName",
        identity_provider_name="identityProviderName",
        project_name="projectName",
        project_number="projectNumber"
    )
)

Attributes

google_oidc

Specifies the Google Cloud workload identity federation configuration that DataSync uses to obtain an access token for your Google Cloud Storage bucket.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-locationobjectstorage-objectstorageexternalidentityconfig.html#cfn-datasync-locationobjectstorage-objectstorageexternalidentityconfig-googleoidc

ObjectStorageFederatedIdentityConfigProperty

class CfnLocationObjectStoragePropsMixin.ObjectStorageFederatedIdentityConfigProperty(*, aws_iam_role=None, external_identity=None)

Bases: object

Specifies the identity federation configuration that DataSync uses to access your object storage location using an OpenID Connect (OIDC) token.

Parameters:

aws_iam_role (Optional[str]) – Specifies the ARN of the AWS Identity and Access Management (IAM) role that DataSync assumes to mint the OIDC token used to authenticate with the identity provider.
external_identity (Union[IResolvable, ObjectStorageExternalIdentityConfigProperty, Dict[str, Any], None]) – Specifies the external (non-AWS) identity provider that DataSync federates with to access your object storage location.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-locationobjectstorage-objectstoragefederatedidentityconfig.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_datasync as datasync

object_storage_federated_identity_config_property = datasync.CfnLocationObjectStoragePropsMixin.ObjectStorageFederatedIdentityConfigProperty(
    aws_iam_role="awsIamRole",
    external_identity=datasync.CfnLocationObjectStoragePropsMixin.ObjectStorageExternalIdentityConfigProperty(
        google_oidc=datasync.CfnLocationObjectStoragePropsMixin.GoogleOidcConfigProperty(
            identity_pool_name="identityPoolName",
            identity_provider_name="identityProviderName",
            project_name="projectName",
            project_number="projectNumber"
        )
    )
)

Attributes

aws_iam_role

Specifies the ARN of the AWS Identity and Access Management (IAM) role that DataSync assumes to mint the OIDC token used to authenticate with the identity provider.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-locationobjectstorage-objectstoragefederatedidentityconfig.html#cfn-datasync-locationobjectstorage-objectstoragefederatedidentityconfig-awsiamrole

external_identity

Specifies the external (non-AWS) identity provider that DataSync federates with to access your object storage location.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-locationobjectstorage-objectstoragefederatedidentityconfig.html#cfn-datasync-locationobjectstorage-objectstoragefederatedidentityconfig-externalidentity