Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi IDP Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. datasync
  5. getLocationObjectStorage

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.30.0 published on Monday, Jun 16, 2025 by Pulumi
pulumi/pulumi-aws-native

aws-native.datasync.getLocationObjectStorage

Explore with Pulumi AI

aws-native logo

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.30.0 published on Monday, Jun 16, 2025 by Pulumi
pulumi/pulumi-aws-native

    Resource Type definition for AWS::DataSync::LocationObjectStorage.

    Using getLocationObjectStorage

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getLocationObjectStorage(args: GetLocationObjectStorageArgs, opts?: InvokeOptions): Promise<GetLocationObjectStorageResult>
function getLocationObjectStorageOutput(args: GetLocationObjectStorageOutputArgs, opts?: InvokeOptions): Output<GetLocationObjectStorageResult>
    def get_location_object_storage(location_arn: Optional[str] = None,
                                opts: Optional[InvokeOptions] = None) -> GetLocationObjectStorageResult
def get_location_object_storage_output(location_arn: Optional[pulumi.Input[str]] = None,
                                opts: Optional[InvokeOptions] = None) -> Output[GetLocationObjectStorageResult]
    func LookupLocationObjectStorage(ctx *Context, args *LookupLocationObjectStorageArgs, opts ...InvokeOption) (*LookupLocationObjectStorageResult, error)
func LookupLocationObjectStorageOutput(ctx *Context, args *LookupLocationObjectStorageOutputArgs, opts ...InvokeOption) LookupLocationObjectStorageResultOutput

    > Note: This function is named LookupLocationObjectStorage in the Go SDK.

    public static class GetLocationObjectStorage 
{
    public static Task<GetLocationObjectStorageResult> InvokeAsync(GetLocationObjectStorageArgs args, InvokeOptions? opts = null)
    public static Output<GetLocationObjectStorageResult> Invoke(GetLocationObjectStorageInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetLocationObjectStorageResult> getLocationObjectStorage(GetLocationObjectStorageArgs args, InvokeOptions options)
public static Output<GetLocationObjectStorageResult> getLocationObjectStorage(GetLocationObjectStorageArgs args, InvokeOptions options)

    fn::invoke:
  function: aws-native:datasync:getLocationObjectStorage
  arguments:
    # arguments dictionary

    The following arguments are supported:

    LocationArn string
    The Amazon Resource Name (ARN) of the location that is created.
    LocationArn string
    The Amazon Resource Name (ARN) of the location that is created.
    locationArn String
    The Amazon Resource Name (ARN) of the location that is created.
    locationArn string
    The Amazon Resource Name (ARN) of the location that is created.
    location_arn str
    The Amazon Resource Name (ARN) of the location that is created.
    locationArn String
    The Amazon Resource Name (ARN) of the location that is created.

    getLocationObjectStorage Result

    The following output properties are available:

    AccessKey string
    Optional. The access key is used if credentials are required to access the self-managed object storage server.
    AgentArns List<string>
    Specifies the Amazon Resource Names (ARNs) of the DataSync agents that can connect with your object storage system. If you are setting up an agentless cross-cloud transfer, you do not need to specify a value for this parameter.
    CmkSecretConfig Pulumi.AwsNative.DataSync.Outputs.LocationObjectStorageCmkSecretConfig

    Specifies configuration information for a DataSync-managed secret, which includes the SecretKey that DataSync uses to access a specific object storage location, with a customer-managed AWS KMS key .

    When you include this paramater as part of a CreateLocationObjectStorage request, you provide only the KMS key ARN. DataSync uses this KMS key together with the value you specify for the SecretKey parameter to create a DataSync-managed secret to store the location access credentials.

    Make sure the DataSync has permission to access the KMS key that you specify.

    You can use either CmkSecretConfig (with SecretKey ) or CustomSecretConfig (without SecretKey ) to provide credentials for a CreateLocationObjectStorage request. Do not provide both parameters for the same request.

    CustomSecretConfig Pulumi.AwsNative.DataSync.Outputs.LocationObjectStorageCustomSecretConfig

    Specifies configuration information for a customer-managed Secrets Manager secret where the secret key for a specific object storage location is stored in plain text. This configuration includes the secret ARN, and the ARN for an IAM role that provides access to the secret.

    You can use either CmkSecretConfig (with SecretKey ) or CustomSecretConfig (without SecretKey ) to provide credentials for a CreateLocationObjectStorage request. Do not provide both parameters for the same request.

    LocationArn string
    The Amazon Resource Name (ARN) of the location that is created.
    LocationUri string
    The URL of the object storage location that was described.
    ManagedSecretConfig Pulumi.AwsNative.DataSync.Outputs.LocationObjectStorageManagedSecretConfig
    ServerCertificate string
    X.509 PEM content containing a certificate authority or chain to trust.
    ServerPort int
    The port that your self-managed server accepts inbound network traffic on.
    ServerProtocol Pulumi.AwsNative.DataSync.LocationObjectStorageServerProtocol
    The protocol that the object storage server uses to communicate.
    Tags List<Pulumi.AwsNative.Outputs.Tag>
    An array of key-value pairs to apply to this resource.
    AccessKey string
    Optional. The access key is used if credentials are required to access the self-managed object storage server.
    AgentArns []string
    Specifies the Amazon Resource Names (ARNs) of the DataSync agents that can connect with your object storage system. If you are setting up an agentless cross-cloud transfer, you do not need to specify a value for this parameter.
    CmkSecretConfig LocationObjectStorageCmkSecretConfig

    Specifies configuration information for a DataSync-managed secret, which includes the SecretKey that DataSync uses to access a specific object storage location, with a customer-managed AWS KMS key .

    When you include this paramater as part of a CreateLocationObjectStorage request, you provide only the KMS key ARN. DataSync uses this KMS key together with the value you specify for the SecretKey parameter to create a DataSync-managed secret to store the location access credentials.

    Make sure the DataSync has permission to access the KMS key that you specify.

    You can use either CmkSecretConfig (with SecretKey ) or CustomSecretConfig (without SecretKey ) to provide credentials for a CreateLocationObjectStorage request. Do not provide both parameters for the same request.

    CustomSecretConfig LocationObjectStorageCustomSecretConfig

    Specifies configuration information for a customer-managed Secrets Manager secret where the secret key for a specific object storage location is stored in plain text. This configuration includes the secret ARN, and the ARN for an IAM role that provides access to the secret.

    You can use either CmkSecretConfig (with SecretKey ) or CustomSecretConfig (without SecretKey ) to provide credentials for a CreateLocationObjectStorage request. Do not provide both parameters for the same request.

    LocationArn string
    The Amazon Resource Name (ARN) of the location that is created.
    LocationUri string
    The URL of the object storage location that was described.
    ManagedSecretConfig LocationObjectStorageManagedSecretConfig
    ServerCertificate string
    X.509 PEM content containing a certificate authority or chain to trust.
    ServerPort int
    The port that your self-managed server accepts inbound network traffic on.
    ServerProtocol LocationObjectStorageServerProtocol
    The protocol that the object storage server uses to communicate.
    Tags Tag
    An array of key-value pairs to apply to this resource.
    accessKey String
    Optional. The access key is used if credentials are required to access the self-managed object storage server.
    agentArns List<String>
    Specifies the Amazon Resource Names (ARNs) of the DataSync agents that can connect with your object storage system. If you are setting up an agentless cross-cloud transfer, you do not need to specify a value for this parameter.
    cmkSecretConfig LocationObjectStorageCmkSecretConfig

    Specifies configuration information for a DataSync-managed secret, which includes the SecretKey that DataSync uses to access a specific object storage location, with a customer-managed AWS KMS key .

    When you include this paramater as part of a CreateLocationObjectStorage request, you provide only the KMS key ARN. DataSync uses this KMS key together with the value you specify for the SecretKey parameter to create a DataSync-managed secret to store the location access credentials.

    Make sure the DataSync has permission to access the KMS key that you specify.

    You can use either CmkSecretConfig (with SecretKey ) or CustomSecretConfig (without SecretKey ) to provide credentials for a CreateLocationObjectStorage request. Do not provide both parameters for the same request.

    customSecretConfig LocationObjectStorageCustomSecretConfig

    Specifies configuration information for a customer-managed Secrets Manager secret where the secret key for a specific object storage location is stored in plain text. This configuration includes the secret ARN, and the ARN for an IAM role that provides access to the secret.

    You can use either CmkSecretConfig (with SecretKey ) or CustomSecretConfig (without SecretKey ) to provide credentials for a CreateLocationObjectStorage request. Do not provide both parameters for the same request.

    locationArn String
    The Amazon Resource Name (ARN) of the location that is created.
    locationUri String
    The URL of the object storage location that was described.
    managedSecretConfig LocationObjectStorageManagedSecretConfig
    serverCertificate String
    X.509 PEM content containing a certificate authority or chain to trust.
    serverPort Integer
    The port that your self-managed server accepts inbound network traffic on.
    serverProtocol LocationObjectStorageServerProtocol
    The protocol that the object storage server uses to communicate.
    tags List<Tag>
    An array of key-value pairs to apply to this resource.
    accessKey string
    Optional. The access key is used if credentials are required to access the self-managed object storage server.
    agentArns string[]
    Specifies the Amazon Resource Names (ARNs) of the DataSync agents that can connect with your object storage system. If you are setting up an agentless cross-cloud transfer, you do not need to specify a value for this parameter.
    cmkSecretConfig LocationObjectStorageCmkSecretConfig

    Specifies configuration information for a DataSync-managed secret, which includes the SecretKey that DataSync uses to access a specific object storage location, with a customer-managed AWS KMS key .

    When you include this paramater as part of a CreateLocationObjectStorage request, you provide only the KMS key ARN. DataSync uses this KMS key together with the value you specify for the SecretKey parameter to create a DataSync-managed secret to store the location access credentials.

    Make sure the DataSync has permission to access the KMS key that you specify.

    You can use either CmkSecretConfig (with SecretKey ) or CustomSecretConfig (without SecretKey ) to provide credentials for a CreateLocationObjectStorage request. Do not provide both parameters for the same request.

    customSecretConfig LocationObjectStorageCustomSecretConfig

    Specifies configuration information for a customer-managed Secrets Manager secret where the secret key for a specific object storage location is stored in plain text. This configuration includes the secret ARN, and the ARN for an IAM role that provides access to the secret.

    You can use either CmkSecretConfig (with SecretKey ) or CustomSecretConfig (without SecretKey ) to provide credentials for a CreateLocationObjectStorage request. Do not provide both parameters for the same request.

    locationArn string
    The Amazon Resource Name (ARN) of the location that is created.
    locationUri string
    The URL of the object storage location that was described.
    managedSecretConfig LocationObjectStorageManagedSecretConfig
    serverCertificate string
    X.509 PEM content containing a certificate authority or chain to trust.
    serverPort number
    The port that your self-managed server accepts inbound network traffic on.
    serverProtocol LocationObjectStorageServerProtocol
    The protocol that the object storage server uses to communicate.
    tags Tag[]
    An array of key-value pairs to apply to this resource.
    access_key str
    Optional. The access key is used if credentials are required to access the self-managed object storage server.
    agent_arns Sequence[str]
    Specifies the Amazon Resource Names (ARNs) of the DataSync agents that can connect with your object storage system. If you are setting up an agentless cross-cloud transfer, you do not need to specify a value for this parameter.
    cmk_secret_config LocationObjectStorageCmkSecretConfig

    Specifies configuration information for a DataSync-managed secret, which includes the SecretKey that DataSync uses to access a specific object storage location, with a customer-managed AWS KMS key .

    When you include this paramater as part of a CreateLocationObjectStorage request, you provide only the KMS key ARN. DataSync uses this KMS key together with the value you specify for the SecretKey parameter to create a DataSync-managed secret to store the location access credentials.

    Make sure the DataSync has permission to access the KMS key that you specify.

    You can use either CmkSecretConfig (with SecretKey ) or CustomSecretConfig (without SecretKey ) to provide credentials for a CreateLocationObjectStorage request. Do not provide both parameters for the same request.

    custom_secret_config LocationObjectStorageCustomSecretConfig

    Specifies configuration information for a customer-managed Secrets Manager secret where the secret key for a specific object storage location is stored in plain text. This configuration includes the secret ARN, and the ARN for an IAM role that provides access to the secret.

    You can use either CmkSecretConfig (with SecretKey ) or CustomSecretConfig (without SecretKey ) to provide credentials for a CreateLocationObjectStorage request. Do not provide both parameters for the same request.

    location_arn str
    The Amazon Resource Name (ARN) of the location that is created.
    location_uri str
    The URL of the object storage location that was described.
    managed_secret_config LocationObjectStorageManagedSecretConfig
    server_certificate str
    X.509 PEM content containing a certificate authority or chain to trust.
    server_port int
    The port that your self-managed server accepts inbound network traffic on.
    server_protocol LocationObjectStorageServerProtocol
    The protocol that the object storage server uses to communicate.
    tags Sequence[root_Tag]
    An array of key-value pairs to apply to this resource.
    accessKey String
    Optional. The access key is used if credentials are required to access the self-managed object storage server.
    agentArns List<String>
    Specifies the Amazon Resource Names (ARNs) of the DataSync agents that can connect with your object storage system. If you are setting up an agentless cross-cloud transfer, you do not need to specify a value for this parameter.
    cmkSecretConfig Property Map

    Specifies configuration information for a DataSync-managed secret, which includes the SecretKey that DataSync uses to access a specific object storage location, with a customer-managed AWS KMS key .

    When you include this paramater as part of a CreateLocationObjectStorage request, you provide only the KMS key ARN. DataSync uses this KMS key together with the value you specify for the SecretKey parameter to create a DataSync-managed secret to store the location access credentials.

    Make sure the DataSync has permission to access the KMS key that you specify.

    You can use either CmkSecretConfig (with SecretKey ) or CustomSecretConfig (without SecretKey ) to provide credentials for a CreateLocationObjectStorage request. Do not provide both parameters for the same request.

    customSecretConfig Property Map

    Specifies configuration information for a customer-managed Secrets Manager secret where the secret key for a specific object storage location is stored in plain text. This configuration includes the secret ARN, and the ARN for an IAM role that provides access to the secret.

    You can use either CmkSecretConfig (with SecretKey ) or CustomSecretConfig (without SecretKey ) to provide credentials for a CreateLocationObjectStorage request. Do not provide both parameters for the same request.

    locationArn String
    The Amazon Resource Name (ARN) of the location that is created.
    locationUri String
    The URL of the object storage location that was described.
    managedSecretConfig Property Map
    serverCertificate String
    X.509 PEM content containing a certificate authority or chain to trust.
    serverPort Number
    The port that your self-managed server accepts inbound network traffic on.
    serverProtocol "HTTPS" | "HTTP"
    The protocol that the object storage server uses to communicate.
    tags List<Property Map>
    An array of key-value pairs to apply to this resource.

    Supporting Types

    LocationObjectStorageCmkSecretConfig

    KmsKeyArn string
    Specifies the ARN for the customer-managed AWS KMS key used to encrypt the secret specified for SecretArn. DataSync provides this key to AWS Secrets Manager.
    SecretArn string
    Specifies the ARN for an AWS Secrets Manager secret, managed by DataSync.
    KmsKeyArn string
    Specifies the ARN for the customer-managed AWS KMS key used to encrypt the secret specified for SecretArn. DataSync provides this key to AWS Secrets Manager.
    SecretArn string
    Specifies the ARN for an AWS Secrets Manager secret, managed by DataSync.
    kmsKeyArn String
    Specifies the ARN for the customer-managed AWS KMS key used to encrypt the secret specified for SecretArn. DataSync provides this key to AWS Secrets Manager.
    secretArn String
    Specifies the ARN for an AWS Secrets Manager secret, managed by DataSync.
    kmsKeyArn string
    Specifies the ARN for the customer-managed AWS KMS key used to encrypt the secret specified for SecretArn. DataSync provides this key to AWS Secrets Manager.
    secretArn string
    Specifies the ARN for an AWS Secrets Manager secret, managed by DataSync.
    kms_key_arn str
    Specifies the ARN for the customer-managed AWS KMS key used to encrypt the secret specified for SecretArn. DataSync provides this key to AWS Secrets Manager.
    secret_arn str
    Specifies the ARN for an AWS Secrets Manager secret, managed by DataSync.
    kmsKeyArn String
    Specifies the ARN for the customer-managed AWS KMS key used to encrypt the secret specified for SecretArn. DataSync provides this key to AWS Secrets Manager.
    secretArn String
    Specifies the ARN for an AWS Secrets Manager secret, managed by DataSync.

    LocationObjectStorageCustomSecretConfig

    SecretAccessRoleArn string
    Specifies the ARN for the AWS Identity and Access Management role that DataSync uses to access the secret specified for SecretArn.
    SecretArn string
    Specifies the ARN for a customer created AWS Secrets Manager secret.
    SecretAccessRoleArn string
    Specifies the ARN for the AWS Identity and Access Management role that DataSync uses to access the secret specified for SecretArn.
    SecretArn string
    Specifies the ARN for a customer created AWS Secrets Manager secret.
    secretAccessRoleArn String
    Specifies the ARN for the AWS Identity and Access Management role that DataSync uses to access the secret specified for SecretArn.
    secretArn String
    Specifies the ARN for a customer created AWS Secrets Manager secret.
    secretAccessRoleArn string
    Specifies the ARN for the AWS Identity and Access Management role that DataSync uses to access the secret specified for SecretArn.
    secretArn string
    Specifies the ARN for a customer created AWS Secrets Manager secret.
    secret_access_role_arn str
    Specifies the ARN for the AWS Identity and Access Management role that DataSync uses to access the secret specified for SecretArn.
    secret_arn str
    Specifies the ARN for a customer created AWS Secrets Manager secret.
    secretAccessRoleArn String
    Specifies the ARN for the AWS Identity and Access Management role that DataSync uses to access the secret specified for SecretArn.
    secretArn String
    Specifies the ARN for a customer created AWS Secrets Manager secret.

    LocationObjectStorageManagedSecretConfig

    SecretArn string
    Specifies the ARN for an AWS Secrets Manager secret.
    SecretArn string
    Specifies the ARN for an AWS Secrets Manager secret.
    secretArn String
    Specifies the ARN for an AWS Secrets Manager secret.
    secretArn string
    Specifies the ARN for an AWS Secrets Manager secret.
    secret_arn str
    Specifies the ARN for an AWS Secrets Manager secret.
    secretArn String
    Specifies the ARN for an AWS Secrets Manager secret.

    LocationObjectStorageServerProtocol

    Tag

    Key string
    The key name of the tag
    Value string
    The value of the tag
    Key string
    The key name of the tag
    Value string
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key str
    The key name of the tag
    value str
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    We recommend new projects start with resources from the AWS provider.

    AWS Cloud Control v1.30.0 published on Monday, Jun 16, 2025 by Pulumi
    pulumi/pulumi-aws-native