Skip to content
v2.278.0

CfnLocationSMB L1 construct ​

The AWS::DataSync::LocationSMB resource specifies a Server Message Block (SMB) location that AWS DataSync can use as a transfer source or destination.

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_datasync as datasync } from 'aws-cdk-lib';
const cfnLocationSMB = new datasync.CfnLocationSMB(this, 'MyCfnLocationSMB', {
  agentArns: ['agentArns'],

  // the properties below are optional
  authenticationType: 'authenticationType',
  cmkSecretConfig: {
    kmsKeyArn: 'kmsKeyArn',
    secretArn: 'secretArn',
  },
  customSecretConfig: {
    secretAccessRoleArn: 'secretAccessRoleArn',
    secretArn: 'secretArn',
  },
  dnsIpAddresses: ['dnsIpAddresses'],
  domain: 'domain',
  kerberosKeytab: 'kerberosKeytab',
  kerberosKrb5Conf: 'kerberosKrb5Conf',
  kerberosPrincipal: 'kerberosPrincipal',
  mountOptions: {
    version: 'version',
  },
  password: 'password',
  serverHostname: 'serverHostname',
  subdirectory: 'subdirectory',
  tags: [{
    key: 'key',
    value: 'value',
  }],
  user: 'user',
});
python
from aws_cdk import CfnTag
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_datasync as datasync

cfn_location_smb = datasync.CfnLocationSMB(self, "MyCfnLocationSMB",
    agent_arns=["agentArns"],

    # the properties below are optional
    authentication_type="authenticationType",
    cmk_secret_config=datasync.CfnLocationSMB.CmkSecretConfigProperty(
        kms_key_arn="kmsKeyArn",
        secret_arn="secretArn"
    ),
    custom_secret_config=datasync.CfnLocationSMB.CustomSecretConfigProperty(
        secret_access_role_arn="secretAccessRoleArn",
        secret_arn="secretArn"
    ),
    dns_ip_addresses=["dnsIpAddresses"],
    domain="domain",
    kerberos_keytab="kerberosKeytab",
    kerberos_krb5_conf="kerberosKrb5Conf",
    kerberos_principal="kerberosPrincipal",
    mount_options=datasync.CfnLocationSMB.MountOptionsProperty(
        version="version"
    ),
    password="password",
    server_hostname="serverHostname",
    subdirectory="subdirectory",
    tags=[CfnTag(
        key="key",
        value="value"
    )],
    user="user"
)
java
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.datasync.*;

CfnLocationSMB cfnLocationSMB = CfnLocationSMB.Builder.create(this, "MyCfnLocationSMB")
        .agentArns(List.of("agentArns"))

        // the properties below are optional
        .authenticationType("authenticationType")
        .cmkSecretConfig(CmkSecretConfigProperty.builder()
                .kmsKeyArn("kmsKeyArn")
                .secretArn("secretArn")
                .build())
        .customSecretConfig(CustomSecretConfigProperty.builder()
                .secretAccessRoleArn("secretAccessRoleArn")
                .secretArn("secretArn")
                .build())
        .dnsIpAddresses(List.of("dnsIpAddresses"))
        .domain("domain")
        .kerberosKeytab("kerberosKeytab")
        .kerberosKrb5Conf("kerberosKrb5Conf")
        .kerberosPrincipal("kerberosPrincipal")
        .mountOptions(MountOptionsProperty.builder()
                .version("version")
                .build())
        .password("password")
        .serverHostname("serverHostname")
        .subdirectory("subdirectory")
        .tags(List.of(CfnTag.builder()
                .key("key")
                .value("value")
                .build()))
        .user("user")
        .build();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.DataSync;

var cfnLocationSMB = new CfnLocationSMB(this, "MyCfnLocationSMB", new CfnLocationSMBProps {
    AgentArns = new [] { "agentArns" },

    // the properties below are optional
    AuthenticationType = "authenticationType",
    CmkSecretConfig = new CmkSecretConfigProperty {
        KmsKeyArn = "kmsKeyArn",
        SecretArn = "secretArn"
    },
    CustomSecretConfig = new CustomSecretConfigProperty {
        SecretAccessRoleArn = "secretAccessRoleArn",
        SecretArn = "secretArn"
    },
    DnsIpAddresses = new [] { "dnsIpAddresses" },
    Domain = "domain",
    KerberosKeytab = "kerberosKeytab",
    KerberosKrb5Conf = "kerberosKrb5Conf",
    KerberosPrincipal = "kerberosPrincipal",
    MountOptions = new MountOptionsProperty {
        Version = "version"
    },
    Password = "password",
    ServerHostname = "serverHostname",
    Subdirectory = "subdirectory",
    Tags = new [] { new CfnTag {
        Key = "key",
        Value = "value"
    } },
    User = "user"
});
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

cfnLocationSMB := awscdk.Aws_datasync.NewCfnLocationSMB(this, jsii.String("MyCfnLocationSMB"), &CfnLocationSMBProps{
	AgentArns: []*string{
		jsii.String("agentArns"),
	},

	// the properties below are optional
	AuthenticationType: jsii.String("authenticationType"),
	CmkSecretConfig: &CmkSecretConfigProperty{
		KmsKeyArn: jsii.String("kmsKeyArn"),
		SecretArn: jsii.String("secretArn"),
	},
	CustomSecretConfig: &CustomSecretConfigProperty{
		SecretAccessRoleArn: jsii.String("secretAccessRoleArn"),
		SecretArn: jsii.String("secretArn"),
	},
	DnsIpAddresses: []*string{
		jsii.String("dnsIpAddresses"),
	},
	Domain: jsii.String("domain"),
	KerberosKeytab: jsii.String("kerberosKeytab"),
	KerberosKrb5Conf: jsii.String("kerberosKrb5Conf"),
	KerberosPrincipal: jsii.String("kerberosPrincipal"),
	MountOptions: &MountOptionsProperty{
		Version: jsii.String("version"),
	},
	Password: jsii.String("password"),
	ServerHostname: jsii.String("serverHostname"),
	Subdirectory: jsii.String("subdirectory"),
	Tags: []CfnTag{
		&CfnTag{
			Key: jsii.String("key"),
			Value: jsii.String("value"),
		},
	},
	User: jsii.String("user"),
})

Initializer ​

ts
new CfnLocationSMB(scope: Construct, id: string, props: CfnLocationSMBProps)
python
CfnLocationSMB(scope: Construct, id: str, props: CfnLocationSMBProps)
java
new CfnLocationSMB(Construct scope, String id, CfnLocationSMBProps props)
csharp
new CfnLocationSMB(Construct scope, string id, CfnLocationSMBProps props)
go
NewCfnLocationSMB(Scope Construct, Id *string, Props CfnLocationSMBProps)

Construct Props ​

agentArnsstring[]agent_arnstyping.List[str]agentArnsList<String>AgentArnsstring[]AgentArns*[]*string required #
Specifies the DataSync agent (or agents) that can connect to your SMB file server.

You specify an agent by using its Amazon Resource Name (ARN).

authenticationTypeoptionalstringauthentication_typeoptionalstrauthenticationTypeoptionalStringAuthenticationTypeoptionalstringAuthenticationTypeoptional*string #
The authentication mode used to determine identity of user.
cmkSecretConfigoptionalIResolvable | CfnLocationSMB.CmkSecretConfigPropertycmk_secret_configoptionaltyping.Union[IResolvable, CmkSecretConfigProperty]cmkSecretConfigoptionalIResolvableCmkSecretConfigoptionalIResolvableCmkSecretConfigoptionalinterface{} #
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.

customSecretConfigoptionalIResolvable | CfnLocationSMB.CustomSecretConfigPropertycustom_secret_configoptionaltyping.Union[IResolvable, CustomSecretConfigProperty]customSecretConfigoptionalIResolvableCustomSecretConfigoptionalIResolvableCustomSecretConfigoptionalinterface{} #
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).
notes

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

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

dnsIpAddressesoptionalstring[]dns_ip_addressesoptionaltyping.List[str]dnsIpAddressesoptionalList<String>DnsIpAddressesoptionalstring[]DnsIpAddressesoptional*[]*string #
Specifies the IPv4 addresses for the DNS servers that your SMB file server belongs to.

This parameter applies only if AuthenticationType is set to KERBEROS. If you have multiple domains in your environment, configuring this parameter makes sure that DataSync connects to the right SMB file server.

domainoptionalstringdomainoptionalstrdomainoptionalStringDomainoptionalstringDomainoptional*string #
Specifies the Windows domain name that your SMB file server belongs to.

This parameter applies only if AuthenticationType is set to NTLM .

If you have multiple domains in your environment, configuring this parameter makes sure that DataSync connects to the right file server.

kerberosKeytaboptionalstringkerberos_keytaboptionalstrkerberosKeytaboptionalStringKerberosKeytaboptionalstringKerberosKeytaboptional*string #
The Base64 string representation of the Keytab file.
notes

Specifies your Kerberos key table (keytab) file, which includes mappings between your service principal name (SPN) and encryption keys. To avoid task execution errors, make sure that the SPN in the keytab file matches exactly what you specify for KerberosPrincipal and in your krb5.conf file.

kerberosKrb5Confoptionalstringkerberos_krb5_confoptionalstrkerberosKrb5ConfoptionalStringKerberosKrb5ConfoptionalstringKerberosKrb5Confoptional*string #
The string representation of the Krb5Conf file, or the presigned URL to access the Krb5.conf file within an S3 bucket. Specifies a Kerberos configuration file (krb5.conf) that defines your Kerberos realm configuration. To avoid task execution errors, make sure that the service principal name (SPN) in the krb5.conf file matches exactly what you specify for KerberosPrincipal and in your keytab file.
kerberosPrincipaloptionalstringkerberos_principaloptionalstrkerberosPrincipaloptionalStringKerberosPrincipaloptionalstringKerberosPrincipaloptional*string #
Specifies a service principal name (SPN), which is an identity in your Kerberos realm that has permission to access the files, folders, and file metadata in your SMB file server.
notes

SPNs are case sensitive and must include a prepended cifs/. For example, an SPN might look like cifs/kerberosuser@EXAMPLE.COM. Your task execution will fail if the SPN that you provide for this parameter doesn't match exactly what's in your keytab or krb5.conf files.

mountOptionsoptionalIResolvable | CfnLocationSMB.MountOptionsPropertymount_optionsoptionaltyping.Union[IResolvable, MountOptionsProperty]mountOptionsoptionalIResolvableMountOptionsoptionalIResolvableMountOptionsoptionalinterface{} #
Specifies the version of the SMB protocol that DataSync uses to access your SMB file server.
passwordoptionalstringpasswordoptionalstrpasswordoptionalStringPasswordoptionalstringPasswordoptional*string #
Specifies the password of the user who can mount your SMB file server and has permission to access the files and folders involved in your transfer.

This parameter applies only if AuthenticationType is set to NTLM .

serverHostnameoptionalstringserver_hostnameoptionalstrserverHostnameoptionalStringServerHostnameoptionalstringServerHostnameoptional*string #
Specifies the domain name or IP address (IPv4 or IPv6) of the SMB file server that your DataSync agent connects to.

If you're using Kerberos authentication, you must specify a domain name.

subdirectoryoptionalstringsubdirectoryoptionalstrsubdirectoryoptionalStringSubdirectoryoptionalstringSubdirectoryoptional*string #
Specifies the name of the share exported by your SMB file server where DataSync will read or write data.
notes

You can include a subdirectory in the share path (for example, /path/to/subdirectory ). Make sure that other SMB clients in your network can also mount this path.

To copy all data in the subdirectory, DataSync must be able to mount the SMB share and access all of its data. For more information, see Providing DataSync access to SMB file servers .

tagsoptionalCfnTag[]tagsoptionaltyping.List[CfnTag]tagsoptionalList<CfnTag>TagsoptionalCfnTag[]Tagsoptional*[]CfnTag #
Specifies labels that help you categorize, filter, and search for your AWS resources.

We recommend creating at least a name tag for your location.

useroptionalstringuseroptionalstruseroptionalStringUseroptionalstringUseroptional*string #
Specifies the user that can mount and access the files, folders, and file metadata in your SMB file server.
notes

This parameter applies only if AuthenticationType is set to NTLM .

For information about choosing a user with the right level of access for your transfer, see Providing DataSync access to SMB file servers .

Properties ​

agentArnsstring[]agent_arnstyping.List[str]agentArnsList<String>AgentArnsstring[]AgentArns*[]*string #
Specifies the DataSync agent (or agents) that can connect to your SMB file server.
attrCmkSecretConfigSecretArnstringattr_cmk_secret_config_secret_arnstrattrCmkSecretConfigSecretArnStringAttrCmkSecretConfigSecretArnstringAttrCmkSecretConfigSecretArn*string #
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 .

attrLocationArnstringattr_location_arnstrattrLocationArnStringAttrLocationArnstringAttrLocationArn*string #
The Amazon Resource Name (ARN) of the specified SMB location.
attrLocationUristringattr_location_uristrattrLocationUriStringAttrLocationUristringAttrLocationUri*string #
The URI of the specified SMB location.
attrManagedSecretConfigIResolvableattr_managed_secret_configIResolvableattrManagedSecretConfigIResolvableAttrManagedSecretConfigIResolvableAttrManagedSecretConfigIResolvable #
Specifies configuration information for a DataSync-managed secret, such as a password 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.

authenticationTypemay be undefinedstringauthentication_typemay be undefinedstrauthenticationTypemay be undefinedStringAuthenticationTypemay be undefinedstringAuthenticationTypemay be undefined*string #
The authentication mode used to determine identity of user.
CFN_RESOURCE_TYPE_NAMEstringCFN_RESOURCE_TYPE_NAMEstrCFN_RESOURCE_TYPE_NAMEStringCFN_RESOURCE_TYPE_NAMEstringCFN_RESOURCE_TYPE_NAME*string static #
The CloudFormation resource type name for this resource class.
Options for this resource, such as condition, update policy etc.
cfnResourceTypestringcfn_resource_typestrcfnResourceTypeStringCfnResourceTypestringCfnResourceType*string #
AWS resource type.
cmkSecretConfigmay be undefinedIResolvable | CfnLocationSMB.CmkSecretConfigPropertycmk_secret_configmay be undefinedtyping.Union[IResolvable, CmkSecretConfigProperty]cmkSecretConfigmay be undefinedIResolvableCmkSecretConfigmay be undefinedIResolvableCmkSecretConfigmay be undefinedinterface{} #
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 .
creationStackstring[]creation_stacktyping.List[str]creationStackList<String>CreationStackstring[]CreationStack*[]*string #
customSecretConfigmay be undefinedIResolvable | CfnLocationSMB.CustomSecretConfigPropertycustom_secret_configmay be undefinedtyping.Union[IResolvable, CustomSecretConfigProperty]customSecretConfigmay be undefinedIResolvableCustomSecretConfigmay be undefinedIResolvableCustomSecretConfigmay be undefinedinterface{} #
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).
dnsIpAddressesmay be undefinedstring[]dns_ip_addressesmay be undefinedtyping.List[str]dnsIpAddressesmay be undefinedList<String>DnsIpAddressesmay be undefinedstring[]DnsIpAddressesmay be undefined*[]*string #
Specifies the IPv4 addresses for the DNS servers that your SMB file server belongs to.
domainmay be undefinedstringdomainmay be undefinedstrdomainmay be undefinedStringDomainmay be undefinedstringDomainmay be undefined*string #
Specifies the Windows domain name that your SMB file server belongs to.
kerberosKeytabmay be undefinedstringkerberos_keytabmay be undefinedstrkerberosKeytabmay be undefinedStringKerberosKeytabmay be undefinedstringKerberosKeytabmay be undefined*string #
The Base64 string representation of the Keytab file.
kerberosKrb5Confmay be undefinedstringkerberos_krb5_confmay be undefinedstrkerberosKrb5Confmay be undefinedStringKerberosKrb5Confmay be undefinedstringKerberosKrb5Confmay be undefined*string #
The string representation of the Krb5Conf file, or the presigned URL to access the Krb5.conf file within an S3 bucket. Specifies a Kerberos configuration file (krb5.conf) that defines your Kerberos realm configuration. To avoid task execution errors, make sure that the service principal name (SPN) in the krb5.conf file matches exactly what you specify for KerberosPrincipal and in your keytab file.
kerberosPrincipalmay be undefinedstringkerberos_principalmay be undefinedstrkerberosPrincipalmay be undefinedStringKerberosPrincipalmay be undefinedstringKerberosPrincipalmay be undefined*string #
Specifies a service principal name (SPN), which is an identity in your Kerberos realm that has permission to access the files, folders, and file metadata in your SMB file server.
locationSmbRefLocationSMBReferencelocation_smb_refLocationSMBReferencelocationSmbRefLocationSMBReferenceLocationSmbRefLocationSMBReferenceLocationSmbRefLocationSMBReference #
A reference to a LocationSMB resource.
logicalIdstringlogical_idstrlogicalIdStringLogicalIdstringLogicalId*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 overrideLogicalId(newLogicalId).

mountOptionsmay be undefinedIResolvable | CfnLocationSMB.MountOptionsPropertymount_optionsmay be undefinedtyping.Union[IResolvable, MountOptionsProperty]mountOptionsmay be undefinedIResolvableMountOptionsmay be undefinedIResolvableMountOptionsmay be undefinedinterface{} #
Specifies the version of the SMB protocol that DataSync uses to access your SMB file server.
nodeNodenodeNodenodeNodeNodeNodeNodeNode #
The tree node.
passwordmay be undefinedstringpasswordmay be undefinedstrpasswordmay be undefinedStringPasswordmay be undefinedstringPasswordmay be undefined*string #
Specifies the password of the user who can mount your SMB file server and has permission to access the files and folders involved in your transfer.
refstringrefstrrefStringRefstringRef*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 }).

serverHostnamemay be undefinedstringserver_hostnamemay be undefinedstrserverHostnamemay be undefinedStringServerHostnamemay be undefinedstringServerHostnamemay be undefined*string #
Specifies the domain name or IP address (IPv4 or IPv6) of the SMB file server that your DataSync agent connects to.
stackStackstackStackstackStackStackStackStackStack #
The stack in which this element is defined.

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

subdirectorymay be undefinedstringsubdirectorymay be undefinedstrsubdirectorymay be undefinedStringSubdirectorymay be undefinedstringSubdirectorymay be undefined*string #
Specifies the name of the share exported by your SMB file server where DataSync will read or write data.
Tag Manager which manages the tags for this resource.
tagsRawmay be undefinedCfnTag[]tags_rawmay be undefinedtyping.List[CfnTag]tagsRawmay be undefinedList<CfnTag>TagsRawmay be undefinedCfnTag[]TagsRawmay be undefined*[]CfnTag #
Specifies labels that help you categorize, filter, and search for your AWS resources.
usermay be undefinedstringusermay be undefinedstrusermay be undefinedStringUsermay be undefinedstringUsermay be undefined*string #
Specifies the user that can mount and access the files, folders, and file metadata in your SMB file server.

Methods ​

addDeletionOverride(path: string): voiddef add_deletion_override(self, path: str) -> Nonepublic void addDeletionOverride(String path)public void AddDeletionOverride(string path)func AddDeletionOverride(Path *string) #
Syntactic sugar for `addOverride(path, undefined)`.
1 parameter

Parameters

  • pathpathpathpathPath — The path of the value to delete.
addDependency(target: CfnResource): voiddef add_dependency(self, target: CfnResource) -> Nonepublic void addDependency(CfnResource target)public void AddDependency(CfnResource target)func AddDependency(Target CfnResource) deprecated #
Use `addResourceDependency` instead.

This method has been renamed to addResourceDependency to more clearly set it apart from construct.node.addDependency. See the documentation of that function for more details.

addDependsOn(target: CfnResource): voiddef add_depends_on(self, target: CfnResource) -> Nonepublic void addDependsOn(CfnResource target)public void AddDependsOn(CfnResource target)func AddDependsOn(Target CfnResource) deprecated #
Use `addResourceDependency` instead.
notes

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

This method has been renamed to addResourceDependency, which makes it more clear that this method operates at a different level from the construct-level construct.node.addDependency() mechanism.

addMetadata(key: string, value: any): voiddef add_metadata(self, key: str, value: Any) -> Nonepublic void addMetadata(String key, Object value)public void AddMetadata(string key, object value)func AddMetadata(Key *string, Value interface{}) #
Add a value to the CloudFormation Resource Metadata.
addOverride(path: string, value: any): voiddef add_override(self, path: str, value: Any) -> Nonepublic void addOverride(String path, Object value)public void AddOverride(string path, object value)func AddOverride(Path *string, Value interface{}) #
Adds an override to the synthesized CloudFormation resource.
notes · 2 parameters

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,

typescript
cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');

would add the overrides

json
"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

  • pathpathpathpathPath — - The path of the property, you can use dot notation to override values in complex types.
  • valuevaluevaluevalueValue — - The value.
addPropertyDeletionOverride(propertyPath: string): voiddef add_property_deletion_override(self, property_path: str) -> Nonepublic void addPropertyDeletionOverride(String propertyPath)public void AddPropertyDeletionOverride(string propertyPath)func AddPropertyDeletionOverride(PropertyPath *string) #
Adds an override that deletes the value of a property from the resource definition.
1 parameter

Parameters

  • propertyPathproperty_pathpropertyPathpropertyPathPropertyPath — The path to the property.
addPropertyOverride(propertyPath: string, value: any): voiddef add_property_override(self, property_path: str, value: Any) -> Nonepublic void addPropertyOverride(String propertyPath, Object value)public void AddPropertyOverride(string propertyPath, object value)func AddPropertyOverride(PropertyPath *string, Value interface{}) #
Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

2 parameters

Parameters

  • propertyPathproperty_pathpropertyPathpropertyPathPropertyPath — The path of the property.
  • valuevaluevaluevalueValue — The value.
addResourceDependency(target: CfnResource, reason?: string): voiddef add_resource_dependency(self, target: CfnResource, reason: typing.Optional[str] = None) -> Nonepublic void addResourceDependency(CfnResource target, String reason)public void AddResourceDependency(CfnResource target, string? reason = null)func AddResourceDependency(Target CfnResource, Reason *string) #
Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
notes

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

This method only adds dependencies between L1 resources. If you are looking for a generic construct-to-construct dependency mechanism that works for all constructs including L2s, use construct.node.addDependency instead.

applyCrossStackReferenceStrength(strength: ReferenceStrength): voiddef apply_cross_stack_reference_strength(self, strength: ReferenceStrength) -> Nonepublic void applyCrossStackReferenceStrength(ReferenceStrength strength)public void ApplyCrossStackReferenceStrength(ReferenceStrength strength)func ApplyCrossStackReferenceStrength(Strength ReferenceStrength) #
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.

1 parameter

Parameters

  • strengthstrengthstrengthstrengthStrength — - The reference strength to use for this resource.
applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): voiddef apply_removal_policy(self, policy: typing.Optional[RemovalPolicy] = None, options: typing.Optional[RemovalPolicyOptions] = None) -> Nonepublic void applyRemovalPolicy(RemovalPolicy policy, RemovalPolicyOptions options)public void ApplyRemovalPolicy(RemovalPolicy? policy = null, RemovalPolicyOptions? options = null)func ApplyRemovalPolicy(Policy RemovalPolicy, Options RemovalPolicyOptions) #
Sets the deletion policy of the resource based on the removal policy specified.
notes

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:

cfnPropertyName(cdkPropertyName: string): stringdef cfn_property_name(self, cdk_property_name: str) -> strpublic String cfnPropertyName(String cdkPropertyName)public string CfnPropertyName(string cdkPropertyName)func CfnPropertyName(CdkPropertyName *string) *string #
getAtt(attributeName: string, typeHint?: ResolutionTypeHint): Referencedef get_att(self, attribute_name: str, type_hint: typing.Optional[ResolutionTypeHint] = None) -> Referencepublic Reference getAtt(String attributeName, ResolutionTypeHint typeHint)public Reference GetAtt(string attributeName, ResolutionTypeHint? typeHint = null)func GetAtt(AttributeName *string, TypeHint ResolutionTypeHint) 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.

1 parameter

Parameters

  • attributeNameattribute_nameattributeNameattributeNameAttributeName — The name of the attribute.
getMetadata(key: string): anydef get_metadata(self, key: str) -> Anypublic Object getMetadata(String key)public object GetMetadata(string key)func GetMetadata(Key *string) interface{} #
Retrieve a value value from the CloudFormation Resource Metadata.
inspect(inspector: TreeInspector): voiddef inspect(self, inspector: TreeInspector) -> Nonepublic void inspect(TreeInspector inspector)public void Inspect(TreeInspector inspector)func Inspect(Inspector TreeInspector) #
Examines the CloudFormation resource and discloses attributes.
1 parameter

Parameters

  • inspectorinspectorinspectorinspectorInspector — tree inspector to collect and process attributes.
isCfnElement(x: any): boolean@staticmethod def is_cfn_element(x: Any) -> boolpublic static Boolean isCfnElement(Object x)public static bool IsCfnElement(object x)func IsCfnElement(X interface{}) *bool static #
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.

returns

Returns: The construct as a stack element or undefined if it is not a stack element.

isCfnLocationSMB(x: any): boolean@staticmethod def is_cfn_location_smb(x: Any) -> boolpublic static Boolean isCfnLocationSMB(Object x)public static bool IsCfnLocationSMB(object x)func IsCfnLocationSMB(X interface{}) *bool static #
Checks whether the given object is a CfnLocationSMB.
isCfnResource(x: any): boolean@staticmethod def is_cfn_resource(x: Any) -> boolpublic static Boolean isCfnResource(Object x)public static bool IsCfnResource(object x)func IsCfnResource(X interface{}) *bool static #
Check whether the given object is a CfnResource.
isConstruct(x: any): boolean@staticmethod def is_construct(x: Any) -> boolpublic static Boolean isConstruct(Object x)public static bool IsConstruct(object x)func IsConstruct(X interface{}) *bool static #
Checks if `x` is a construct.
notes · 1 parameter · returns

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

Parameters

  • xxxxX — Any object.

Returns: true if x is an object created from a class which extends Construct.

obtainDependencies(): Stack | CfnResource[]def obtain_dependencies(self, ) -> typing.List[typing.Union[Stack, CfnResource]]public List<Stack> obtainDependencies()public Stack[] ObtainDependencies()func ObtainDependencies() *[]interface{} #
Retrieves an array of resources and stacks this resource depends on.

For resources depended on directly, returns the CfnResource object. For dependencies on other stacks, returns the Stack object. The order of the array is not guaranteed.

overrideLogicalId(newLogicalId: string): voiddef override_logical_id(self, new_logical_id: str) -> Nonepublic void overrideLogicalId(String newLogicalId)public void OverrideLogicalId(string newLogicalId)func OverrideLogicalId(NewLogicalId *string) #
Overrides the auto-generated logical ID with a specific ID.
1 parameter

Parameters

  • newLogicalIdnew_logical_idnewLogicalIdnewLogicalIdNewLogicalId — The new logical ID to use for this stack element.
removeDependency(target: CfnResource): voiddef remove_dependency(self, target: CfnResource) -> Nonepublic void removeDependency(CfnResource target)public void RemoveDependency(CfnResource target)func RemoveDependency(Target CfnResource) deprecated #
Use `removeResourceDependency` instead

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.

removeResourceDependency(target: CfnResource): voiddef remove_resource_dependency(self, target: CfnResource) -> Nonepublic void removeResourceDependency(CfnResource target)public void RemoveResourceDependency(CfnResource target)func RemoveResourceDependency(Target CfnResource) #
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.

replaceDependency(target: CfnResource, newTarget: CfnResource): voiddef replace_dependency(self, target: CfnResource, new_target: CfnResource) -> Nonepublic void replaceDependency(CfnResource target, CfnResource newTarget)public void ReplaceDependency(CfnResource target, CfnResource newTarget)func ReplaceDependency(Target CfnResource, NewTarget CfnResource) #
Replaces one dependency with another.
2 parameters

Parameters

  • targettargettargettargetTarget — The dependency to replace.
  • newTargetnew_targetnewTargetnewTargetNewTarget — The new dependency to add.
toString(): stringdef to_string(self, ) -> strpublic String toString()public string ToString()func ToString() *string #
Returns a string representation of this construct.
returns

Returns: a string representation of this resource

with(...mixins: IMixin[]): IConstructdef with(self, mixins: IMixin) -> IConstructpublic IConstruct with(IMixin mixins)public IConstruct With(IMixin mixins)func With(Mixins IMixin) 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.