1. Packages
  2. ElasticCloud (EC)
  3. API Docs
  4. SnapshotRepository
ElasticCloud (EC) v0.7.1 published on Friday, Jan 19, 2024 by Pulumi

ec.SnapshotRepository

Explore with Pulumi AI

ec logo
ElasticCloud (EC) v0.7.1 published on Friday, Jan 19, 2024 by Pulumi

    Manages Elastic Cloud Enterprise snapshot repositories.

    This resource can only be used with Elastic Cloud Enterprise For Elastic Cloud SaaS please use the elasticstack_elasticsearch_snapshot_repository.

    Example Usage

    Coming soon!

    Coming soon!

    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.ec.SnapshotRepository;
    import com.pulumi.ec.SnapshotRepositoryArgs;
    import com.pulumi.ec.inputs.SnapshotRepositoryS3Args;
    import java.util.List;
    import java.util.ArrayList;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            var this_ = new SnapshotRepository("this", SnapshotRepositoryArgs.builder()        
                .s3(SnapshotRepositoryS3Args.builder()
                    .access_key("my-access-key")
                    .bucket("my-bucket")
                    .secret_key("my-secret-key")
                    .build())
                .build());
    
        }
    }
    

    Coming soon!

    Coming soon!

    resources:
      this:
        type: ec:SnapshotRepository
        properties:
          s3:
            access_key: my-access-key
            bucket: my-bucket
            secret_key: my-secret-key
    

    Create SnapshotRepository Resource

    new SnapshotRepository(name: string, args?: SnapshotRepositoryArgs, opts?: CustomResourceOptions);
    @overload
    def SnapshotRepository(resource_name: str,
                           opts: Optional[ResourceOptions] = None,
                           generic: Optional[SnapshotRepositoryGenericArgs] = None,
                           name: Optional[str] = None,
                           s3: Optional[SnapshotRepositoryS3Args] = None)
    @overload
    def SnapshotRepository(resource_name: str,
                           args: Optional[SnapshotRepositoryArgs] = None,
                           opts: Optional[ResourceOptions] = None)
    func NewSnapshotRepository(ctx *Context, name string, args *SnapshotRepositoryArgs, opts ...ResourceOption) (*SnapshotRepository, error)
    public SnapshotRepository(string name, SnapshotRepositoryArgs? args = null, CustomResourceOptions? opts = null)
    public SnapshotRepository(String name, SnapshotRepositoryArgs args)
    public SnapshotRepository(String name, SnapshotRepositoryArgs args, CustomResourceOptions options)
    
    type: ec:SnapshotRepository
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    name string
    The unique name of the resource.
    args SnapshotRepositoryArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args SnapshotRepositoryArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args SnapshotRepositoryArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args SnapshotRepositoryArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args SnapshotRepositoryArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    SnapshotRepository Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The SnapshotRepository resource accepts the following input properties:

    Generic Pulumi.ElasticCloud.Inputs.SnapshotRepositoryGeneric
    Generic repository settings.
    Name string
    The name of the snapshot repository configuration.
    S3 Pulumi.ElasticCloud.Inputs.SnapshotRepositoryS3
    S3 repository settings.
    Generic SnapshotRepositoryGenericArgs
    Generic repository settings.
    Name string
    The name of the snapshot repository configuration.
    S3 SnapshotRepositoryS3Args
    S3 repository settings.
    generic SnapshotRepositoryGeneric
    Generic repository settings.
    name String
    The name of the snapshot repository configuration.
    s3 SnapshotRepositoryS3
    S3 repository settings.
    generic SnapshotRepositoryGeneric
    Generic repository settings.
    name string
    The name of the snapshot repository configuration.
    s3 SnapshotRepositoryS3
    S3 repository settings.
    generic SnapshotRepositoryGenericArgs
    Generic repository settings.
    name str
    The name of the snapshot repository configuration.
    s3 SnapshotRepositoryS3Args
    S3 repository settings.
    generic Property Map
    Generic repository settings.
    name String
    The name of the snapshot repository configuration.
    s3 Property Map
    S3 repository settings.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the SnapshotRepository resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing SnapshotRepository Resource

    Get an existing SnapshotRepository resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: SnapshotRepositoryState, opts?: CustomResourceOptions): SnapshotRepository
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            generic: Optional[SnapshotRepositoryGenericArgs] = None,
            name: Optional[str] = None,
            s3: Optional[SnapshotRepositoryS3Args] = None) -> SnapshotRepository
    func GetSnapshotRepository(ctx *Context, name string, id IDInput, state *SnapshotRepositoryState, opts ...ResourceOption) (*SnapshotRepository, error)
    public static SnapshotRepository Get(string name, Input<string> id, SnapshotRepositoryState? state, CustomResourceOptions? opts = null)
    public static SnapshotRepository get(String name, Output<String> id, SnapshotRepositoryState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    Generic Pulumi.ElasticCloud.Inputs.SnapshotRepositoryGeneric
    Generic repository settings.
    Name string
    The name of the snapshot repository configuration.
    S3 Pulumi.ElasticCloud.Inputs.SnapshotRepositoryS3
    S3 repository settings.
    Generic SnapshotRepositoryGenericArgs
    Generic repository settings.
    Name string
    The name of the snapshot repository configuration.
    S3 SnapshotRepositoryS3Args
    S3 repository settings.
    generic SnapshotRepositoryGeneric
    Generic repository settings.
    name String
    The name of the snapshot repository configuration.
    s3 SnapshotRepositoryS3
    S3 repository settings.
    generic SnapshotRepositoryGeneric
    Generic repository settings.
    name string
    The name of the snapshot repository configuration.
    s3 SnapshotRepositoryS3
    S3 repository settings.
    generic SnapshotRepositoryGenericArgs
    Generic repository settings.
    name str
    The name of the snapshot repository configuration.
    s3 SnapshotRepositoryS3Args
    S3 repository settings.
    generic Property Map
    Generic repository settings.
    name String
    The name of the snapshot repository configuration.
    s3 Property Map
    S3 repository settings.

    Supporting Types

    SnapshotRepositoryGeneric, SnapshotRepositoryGenericArgs

    Settings string
    An arbitrary JSON object containing the repository settings.
    Type string
    Repository type
    Settings string
    An arbitrary JSON object containing the repository settings.
    Type string
    Repository type
    settings String
    An arbitrary JSON object containing the repository settings.
    type String
    Repository type
    settings string
    An arbitrary JSON object containing the repository settings.
    type string
    Repository type
    settings str
    An arbitrary JSON object containing the repository settings.
    type str
    Repository type
    settings String
    An arbitrary JSON object containing the repository settings.
    type String
    Repository type

    SnapshotRepositoryS3, SnapshotRepositoryS3Args

    Bucket string
    Name of the S3 bucket to use for snapshots.
    AccessKey string
    An S3 access key. If set, the secret_key setting must also be specified. If unset, the client will use the instance or container role instead.
    Endpoint string
    The S3 service endpoint to connect to. This defaults to s3.amazonaws.com but the AWS documentation lists alternative S3 endpoints. If you are using an S3-compatible service then you should set this to the service’s endpoint.
    PathStyleAccess bool
    Whether to force the use of the path style access pattern. If true, the path style access pattern will be used. If false, the access pattern will be automatically determined by the AWS Java SDK (See AWS documentation for details). Defaults to false.
    Region string
    Allows specifying the signing region to use. Specifying this setting manually should not be necessary for most use cases. Generally, the SDK will correctly guess the signing region to use. It should be considered an expert level setting to support S3-compatible APIs that require v4 signatures and use a region other than the default us-east-1. Defaults to empty string which means that the SDK will try to automatically determine the correct signing region.
    SecretKey string
    An S3 secret key. If set, the access_key setting must also be specified.
    ServerSideEncryption bool
    When set to true files are encrypted on server side using AES256 algorithm. Defaults to false.
    Bucket string
    Name of the S3 bucket to use for snapshots.
    AccessKey string
    An S3 access key. If set, the secret_key setting must also be specified. If unset, the client will use the instance or container role instead.
    Endpoint string
    The S3 service endpoint to connect to. This defaults to s3.amazonaws.com but the AWS documentation lists alternative S3 endpoints. If you are using an S3-compatible service then you should set this to the service’s endpoint.
    PathStyleAccess bool
    Whether to force the use of the path style access pattern. If true, the path style access pattern will be used. If false, the access pattern will be automatically determined by the AWS Java SDK (See AWS documentation for details). Defaults to false.
    Region string
    Allows specifying the signing region to use. Specifying this setting manually should not be necessary for most use cases. Generally, the SDK will correctly guess the signing region to use. It should be considered an expert level setting to support S3-compatible APIs that require v4 signatures and use a region other than the default us-east-1. Defaults to empty string which means that the SDK will try to automatically determine the correct signing region.
    SecretKey string
    An S3 secret key. If set, the access_key setting must also be specified.
    ServerSideEncryption bool
    When set to true files are encrypted on server side using AES256 algorithm. Defaults to false.
    bucket String
    Name of the S3 bucket to use for snapshots.
    accessKey String
    An S3 access key. If set, the secret_key setting must also be specified. If unset, the client will use the instance or container role instead.
    endpoint String
    The S3 service endpoint to connect to. This defaults to s3.amazonaws.com but the AWS documentation lists alternative S3 endpoints. If you are using an S3-compatible service then you should set this to the service’s endpoint.
    pathStyleAccess Boolean
    Whether to force the use of the path style access pattern. If true, the path style access pattern will be used. If false, the access pattern will be automatically determined by the AWS Java SDK (See AWS documentation for details). Defaults to false.
    region String
    Allows specifying the signing region to use. Specifying this setting manually should not be necessary for most use cases. Generally, the SDK will correctly guess the signing region to use. It should be considered an expert level setting to support S3-compatible APIs that require v4 signatures and use a region other than the default us-east-1. Defaults to empty string which means that the SDK will try to automatically determine the correct signing region.
    secretKey String
    An S3 secret key. If set, the access_key setting must also be specified.
    serverSideEncryption Boolean
    When set to true files are encrypted on server side using AES256 algorithm. Defaults to false.
    bucket string
    Name of the S3 bucket to use for snapshots.
    accessKey string
    An S3 access key. If set, the secret_key setting must also be specified. If unset, the client will use the instance or container role instead.
    endpoint string
    The S3 service endpoint to connect to. This defaults to s3.amazonaws.com but the AWS documentation lists alternative S3 endpoints. If you are using an S3-compatible service then you should set this to the service’s endpoint.
    pathStyleAccess boolean
    Whether to force the use of the path style access pattern. If true, the path style access pattern will be used. If false, the access pattern will be automatically determined by the AWS Java SDK (See AWS documentation for details). Defaults to false.
    region string
    Allows specifying the signing region to use. Specifying this setting manually should not be necessary for most use cases. Generally, the SDK will correctly guess the signing region to use. It should be considered an expert level setting to support S3-compatible APIs that require v4 signatures and use a region other than the default us-east-1. Defaults to empty string which means that the SDK will try to automatically determine the correct signing region.
    secretKey string
    An S3 secret key. If set, the access_key setting must also be specified.
    serverSideEncryption boolean
    When set to true files are encrypted on server side using AES256 algorithm. Defaults to false.
    bucket str
    Name of the S3 bucket to use for snapshots.
    access_key str
    An S3 access key. If set, the secret_key setting must also be specified. If unset, the client will use the instance or container role instead.
    endpoint str
    The S3 service endpoint to connect to. This defaults to s3.amazonaws.com but the AWS documentation lists alternative S3 endpoints. If you are using an S3-compatible service then you should set this to the service’s endpoint.
    path_style_access bool
    Whether to force the use of the path style access pattern. If true, the path style access pattern will be used. If false, the access pattern will be automatically determined by the AWS Java SDK (See AWS documentation for details). Defaults to false.
    region str
    Allows specifying the signing region to use. Specifying this setting manually should not be necessary for most use cases. Generally, the SDK will correctly guess the signing region to use. It should be considered an expert level setting to support S3-compatible APIs that require v4 signatures and use a region other than the default us-east-1. Defaults to empty string which means that the SDK will try to automatically determine the correct signing region.
    secret_key str
    An S3 secret key. If set, the access_key setting must also be specified.
    server_side_encryption bool
    When set to true files are encrypted on server side using AES256 algorithm. Defaults to false.
    bucket String
    Name of the S3 bucket to use for snapshots.
    accessKey String
    An S3 access key. If set, the secret_key setting must also be specified. If unset, the client will use the instance or container role instead.
    endpoint String
    The S3 service endpoint to connect to. This defaults to s3.amazonaws.com but the AWS documentation lists alternative S3 endpoints. If you are using an S3-compatible service then you should set this to the service’s endpoint.
    pathStyleAccess Boolean
    Whether to force the use of the path style access pattern. If true, the path style access pattern will be used. If false, the access pattern will be automatically determined by the AWS Java SDK (See AWS documentation for details). Defaults to false.
    region String
    Allows specifying the signing region to use. Specifying this setting manually should not be necessary for most use cases. Generally, the SDK will correctly guess the signing region to use. It should be considered an expert level setting to support S3-compatible APIs that require v4 signatures and use a region other than the default us-east-1. Defaults to empty string which means that the SDK will try to automatically determine the correct signing region.
    secretKey String
    An S3 secret key. If set, the access_key setting must also be specified.
    serverSideEncryption Boolean
    When set to true files are encrypted on server side using AES256 algorithm. Defaults to false.

    Import

    You can import snapshot repositories using the name, for example

     $ pulumi import ec:index/snapshotRepository:SnapshotRepository this my-snapshot-repository
    

    Package Details

    Repository
    ec pulumi/pulumi-ec
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the ec Terraform Provider.
    ec logo
    ElasticCloud (EC) v0.7.1 published on Friday, Jan 19, 2024 by Pulumi