powerscale.S3Key
Explore with Pulumi AI
This resource is used to manage the S3 Key Entity of PowerScale Array. PowerScale S3 keys are used to sign the requests you send to the S3 protocol. We can Create, Update and Delete the S3 Key using this resource.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as powerscale from "@pulumi/powerscale";
//Copyright (c) 2024 Dell Inc., or its subsidiaries. All Rights Reserved.
//
//Licensed under the Mozilla Public License Version 2.0 (the "License");
//you may not use this file except in compliance with the License.
//You may obtain a copy of the License at
//
// http://mozilla.org/MPL/2.0/
//
//
//Unless required by applicable law or agreed to in writing, software
//distributed under the License is distributed on an "AS IS" BASIS,
//WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
//See the License for the specific language governing permissions and
//limitations under the License.
// Available actions: Create, Update and Delete
// After `pulumi up` of this example file it will generate the s3 key for the user.
// For more information, Please check the terraform state file.
// PowerScale S3 key to generate the keys for users to sign the requests you send to the S3 protocol.
const skm = new powerscale.S3Key("skm", {
user: "tf_user",
zone: "System",
existingKeyExpiryTime: 10,
});
export const key = skm;
import pulumi
import pulumi_powerscale as powerscale
#Copyright (c) 2024 Dell Inc., or its subsidiaries. All Rights Reserved.
#
#Licensed under the Mozilla Public License Version 2.0 (the "License");
#you may not use this file except in compliance with the License.
#You may obtain a copy of the License at
#
# http://mozilla.org/MPL/2.0/
#
#
#Unless required by applicable law or agreed to in writing, software
#distributed under the License is distributed on an "AS IS" BASIS,
#WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
#See the License for the specific language governing permissions and
#limitations under the License.
# Available actions: Create, Update and Delete
# After `pulumi up` of this example file it will generate the s3 key for the user.
# For more information, Please check the terraform state file.
# PowerScale S3 key to generate the keys for users to sign the requests you send to the S3 protocol.
skm = powerscale.S3Key("skm",
user="tf_user",
zone="System",
existing_key_expiry_time=10)
pulumi.export("key", skm)
package main
import (
"github.com/pulumi/pulumi-terraform-provider/sdks/go/powerscale/powerscale"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
// Copyright (c) 2024 Dell Inc., or its subsidiaries. All Rights Reserved.
//
// Licensed under the Mozilla Public License Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://mozilla.org/MPL/2.0/
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
// Available actions: Create, Update and Delete
// After `pulumi up` of this example file it will generate the s3 key for the user.
// For more information, Please check the terraform state file.
// PowerScale S3 key to generate the keys for users to sign the requests you send to the S3 protocol.
skm, err := powerscale.NewS3Key(ctx, "skm", &powerscale.S3KeyArgs{
User: pulumi.String("tf_user"),
Zone: pulumi.String("System"),
ExistingKeyExpiryTime: pulumi.Float64(10),
})
if err != nil {
return err
}
ctx.Export("key", skm)
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Powerscale = Pulumi.Powerscale;
return await Deployment.RunAsync(() =>
{
//Copyright (c) 2024 Dell Inc., or its subsidiaries. All Rights Reserved.
//
//Licensed under the Mozilla Public License Version 2.0 (the "License");
//you may not use this file except in compliance with the License.
//You may obtain a copy of the License at
//
// http://mozilla.org/MPL/2.0/
//
//
//Unless required by applicable law or agreed to in writing, software
//distributed under the License is distributed on an "AS IS" BASIS,
//WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
//See the License for the specific language governing permissions and
//limitations under the License.
// Available actions: Create, Update and Delete
// After `pulumi up` of this example file it will generate the s3 key for the user.
// For more information, Please check the terraform state file.
// PowerScale S3 key to generate the keys for users to sign the requests you send to the S3 protocol.
var skm = new Powerscale.S3Key("skm", new()
{
User = "tf_user",
Zone = "System",
ExistingKeyExpiryTime = 10,
});
return new Dictionary<string, object?>
{
["key"] = skm,
};
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.powerscale.S3Key;
import com.pulumi.powerscale.S3KeyArgs;
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) {
//Copyright (c) 2024 Dell Inc., or its subsidiaries. All Rights Reserved.
//
//Licensed under the Mozilla Public License Version 2.0 (the "License");
//you may not use this file except in compliance with the License.
//You may obtain a copy of the License at
//
// http://mozilla.org/MPL/2.0/
//
//
//Unless required by applicable law or agreed to in writing, software
//distributed under the License is distributed on an "AS IS" BASIS,
//WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
//See the License for the specific language governing permissions and
//limitations under the License.
// Available actions: Create, Update and Delete
// After `pulumi up` of this example file it will generate the s3 key for the user.
// For more information, Please check the terraform state file.
// PowerScale S3 key to generate the keys for users to sign the requests you send to the S3 protocol.
var skm = new S3Key("skm", S3KeyArgs.builder()
.user("tf_user")
.zone("System")
.existingKeyExpiryTime(10)
.build());
ctx.export("key", skm);
}
}
resources:
# /*
# Copyright (c) 2024 Dell Inc., or its subsidiaries. All Rights Reserved.
# Licensed under the Mozilla Public License Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
# http://mozilla.org/MPL/2.0/
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
# */
# Available actions: Create, Update and Delete
# After `pulumi up` of this example file it will generate the s3 key for the user.
# For more information, Please check the terraform state file.
# PowerScale S3 key to generate the keys for users to sign the requests you send to the S3 protocol.
skm:
type: powerscale:S3Key
properties:
user: tf_user
zone: System
existingKeyExpiryTime: 10
outputs:
key: ${skm}
Create S3Key Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new S3Key(name: string, args: S3KeyArgs, opts?: CustomResourceOptions);
@overload
def S3Key(resource_name: str,
args: S3KeyArgs,
opts: Optional[ResourceOptions] = None)
@overload
def S3Key(resource_name: str,
opts: Optional[ResourceOptions] = None,
user: Optional[str] = None,
zone: Optional[str] = None,
existing_key_expiry_time: Optional[float] = None)
func NewS3Key(ctx *Context, name string, args S3KeyArgs, opts ...ResourceOption) (*S3Key, error)
public S3Key(string name, S3KeyArgs args, CustomResourceOptions? opts = null)
type: powerscale:S3Key
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args S3KeyArgs
- 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 S3KeyArgs
- 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 S3KeyArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args S3KeyArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args S3KeyArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var s3keyResource = new Powerscale.S3Key("s3keyResource", new()
{
User = "string",
Zone = "string",
ExistingKeyExpiryTime = 0,
});
example, err := powerscale.NewS3Key(ctx, "s3keyResource", &powerscale.S3KeyArgs{
User: pulumi.String("string"),
Zone: pulumi.String("string"),
ExistingKeyExpiryTime: pulumi.Float64(0),
})
var s3keyResource = new S3Key("s3keyResource", S3KeyArgs.builder()
.user("string")
.zone("string")
.existingKeyExpiryTime(0)
.build());
s3key_resource = powerscale.S3Key("s3keyResource",
user="string",
zone="string",
existing_key_expiry_time=0)
const s3keyResource = new powerscale.S3Key("s3keyResource", {
user: "string",
zone: "string",
existingKeyExpiryTime: 0,
});
type: powerscale:S3Key
properties:
existingKeyExpiryTime: 0
user: string
zone: string
S3Key Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The S3Key resource accepts the following input properties:
- User string
- The username to create the S3 key. This resource will be recreated if the value of this field is changed.
- Zone string
- The zone of the user. This resource will be recreated if the value of this field is changed.
- Existing
Key doubleExpiry Time - The expiry of the old secret key in minutes. Optional. It will be applicable only if oldsecretkey is exist.
- User string
- The username to create the S3 key. This resource will be recreated if the value of this field is changed.
- Zone string
- The zone of the user. This resource will be recreated if the value of this field is changed.
- Existing
Key float64Expiry Time - The expiry of the old secret key in minutes. Optional. It will be applicable only if oldsecretkey is exist.
- user String
- The username to create the S3 key. This resource will be recreated if the value of this field is changed.
- zone String
- The zone of the user. This resource will be recreated if the value of this field is changed.
- existing
Key DoubleExpiry Time - The expiry of the old secret key in minutes. Optional. It will be applicable only if oldsecretkey is exist.
- user string
- The username to create the S3 key. This resource will be recreated if the value of this field is changed.
- zone string
- The zone of the user. This resource will be recreated if the value of this field is changed.
- existing
Key numberExpiry Time - The expiry of the old secret key in minutes. Optional. It will be applicable only if oldsecretkey is exist.
- user str
- The username to create the S3 key. This resource will be recreated if the value of this field is changed.
- zone str
- The zone of the user. This resource will be recreated if the value of this field is changed.
- existing_
key_ floatexpiry_ time - The expiry of the old secret key in minutes. Optional. It will be applicable only if oldsecretkey is exist.
- user String
- The username to create the S3 key. This resource will be recreated if the value of this field is changed.
- zone String
- The zone of the user. This resource will be recreated if the value of this field is changed.
- existing
Key NumberExpiry Time - The expiry of the old secret key in minutes. Optional. It will be applicable only if oldsecretkey is exist.
Outputs
All input properties are implicitly available as output properties. Additionally, the S3Key resource produces the following output properties:
- Access
Id string - Unique identifier of the S3 key.
- Id string
- The provider-assigned unique ID for this managed resource.
- Old
Key doubleExpiry - The expiry of the old key. Computed.
- Old
Key doubleTimestamp - The timestamp of the old key. Computed.
- Old
Secret stringKey - The secret key of the old key. Computed.
- Secret
Key string - The secret key of the key. Computed.
- Secret
Key doubleTimestamp - The timestamp of the secret key. Computed.
- Access
Id string - Unique identifier of the S3 key.
- Id string
- The provider-assigned unique ID for this managed resource.
- Old
Key float64Expiry - The expiry of the old key. Computed.
- Old
Key float64Timestamp - The timestamp of the old key. Computed.
- Old
Secret stringKey - The secret key of the old key. Computed.
- Secret
Key string - The secret key of the key. Computed.
- Secret
Key float64Timestamp - The timestamp of the secret key. Computed.
- access
Id String - Unique identifier of the S3 key.
- id String
- The provider-assigned unique ID for this managed resource.
- old
Key DoubleExpiry - The expiry of the old key. Computed.
- old
Key DoubleTimestamp - The timestamp of the old key. Computed.
- old
Secret StringKey - The secret key of the old key. Computed.
- secret
Key String - The secret key of the key. Computed.
- secret
Key DoubleTimestamp - The timestamp of the secret key. Computed.
- access
Id string - Unique identifier of the S3 key.
- id string
- The provider-assigned unique ID for this managed resource.
- old
Key numberExpiry - The expiry of the old key. Computed.
- old
Key numberTimestamp - The timestamp of the old key. Computed.
- old
Secret stringKey - The secret key of the old key. Computed.
- secret
Key string - The secret key of the key. Computed.
- secret
Key numberTimestamp - The timestamp of the secret key. Computed.
- access_
id str - Unique identifier of the S3 key.
- id str
- The provider-assigned unique ID for this managed resource.
- old_
key_ floatexpiry - The expiry of the old key. Computed.
- old_
key_ floattimestamp - The timestamp of the old key. Computed.
- old_
secret_ strkey - The secret key of the old key. Computed.
- secret_
key str - The secret key of the key. Computed.
- secret_
key_ floattimestamp - The timestamp of the secret key. Computed.
- access
Id String - Unique identifier of the S3 key.
- id String
- The provider-assigned unique ID for this managed resource.
- old
Key NumberExpiry - The expiry of the old key. Computed.
- old
Key NumberTimestamp - The timestamp of the old key. Computed.
- old
Secret StringKey - The secret key of the old key. Computed.
- secret
Key String - The secret key of the key. Computed.
- secret
Key NumberTimestamp - The timestamp of the secret key. Computed.
Look up Existing S3Key Resource
Get an existing S3Key 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?: S3KeyState, opts?: CustomResourceOptions): S3Key
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
access_id: Optional[str] = None,
existing_key_expiry_time: Optional[float] = None,
old_key_expiry: Optional[float] = None,
old_key_timestamp: Optional[float] = None,
old_secret_key: Optional[str] = None,
secret_key: Optional[str] = None,
secret_key_timestamp: Optional[float] = None,
user: Optional[str] = None,
zone: Optional[str] = None) -> S3Key
func GetS3Key(ctx *Context, name string, id IDInput, state *S3KeyState, opts ...ResourceOption) (*S3Key, error)
public static S3Key Get(string name, Input<string> id, S3KeyState? state, CustomResourceOptions? opts = null)
public static S3Key get(String name, Output<String> id, S3KeyState state, CustomResourceOptions options)
resources: _: type: powerscale:S3Key get: id: ${id}
- 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.
- Access
Id string - Unique identifier of the S3 key.
- Existing
Key doubleExpiry Time - The expiry of the old secret key in minutes. Optional. It will be applicable only if oldsecretkey is exist.
- Old
Key doubleExpiry - The expiry of the old key. Computed.
- Old
Key doubleTimestamp - The timestamp of the old key. Computed.
- Old
Secret stringKey - The secret key of the old key. Computed.
- Secret
Key string - The secret key of the key. Computed.
- Secret
Key doubleTimestamp - The timestamp of the secret key. Computed.
- User string
- The username to create the S3 key. This resource will be recreated if the value of this field is changed.
- Zone string
- The zone of the user. This resource will be recreated if the value of this field is changed.
- Access
Id string - Unique identifier of the S3 key.
- Existing
Key float64Expiry Time - The expiry of the old secret key in minutes. Optional. It will be applicable only if oldsecretkey is exist.
- Old
Key float64Expiry - The expiry of the old key. Computed.
- Old
Key float64Timestamp - The timestamp of the old key. Computed.
- Old
Secret stringKey - The secret key of the old key. Computed.
- Secret
Key string - The secret key of the key. Computed.
- Secret
Key float64Timestamp - The timestamp of the secret key. Computed.
- User string
- The username to create the S3 key. This resource will be recreated if the value of this field is changed.
- Zone string
- The zone of the user. This resource will be recreated if the value of this field is changed.
- access
Id String - Unique identifier of the S3 key.
- existing
Key DoubleExpiry Time - The expiry of the old secret key in minutes. Optional. It will be applicable only if oldsecretkey is exist.
- old
Key DoubleExpiry - The expiry of the old key. Computed.
- old
Key DoubleTimestamp - The timestamp of the old key. Computed.
- old
Secret StringKey - The secret key of the old key. Computed.
- secret
Key String - The secret key of the key. Computed.
- secret
Key DoubleTimestamp - The timestamp of the secret key. Computed.
- user String
- The username to create the S3 key. This resource will be recreated if the value of this field is changed.
- zone String
- The zone of the user. This resource will be recreated if the value of this field is changed.
- access
Id string - Unique identifier of the S3 key.
- existing
Key numberExpiry Time - The expiry of the old secret key in minutes. Optional. It will be applicable only if oldsecretkey is exist.
- old
Key numberExpiry - The expiry of the old key. Computed.
- old
Key numberTimestamp - The timestamp of the old key. Computed.
- old
Secret stringKey - The secret key of the old key. Computed.
- secret
Key string - The secret key of the key. Computed.
- secret
Key numberTimestamp - The timestamp of the secret key. Computed.
- user string
- The username to create the S3 key. This resource will be recreated if the value of this field is changed.
- zone string
- The zone of the user. This resource will be recreated if the value of this field is changed.
- access_
id str - Unique identifier of the S3 key.
- existing_
key_ floatexpiry_ time - The expiry of the old secret key in minutes. Optional. It will be applicable only if oldsecretkey is exist.
- old_
key_ floatexpiry - The expiry of the old key. Computed.
- old_
key_ floattimestamp - The timestamp of the old key. Computed.
- old_
secret_ strkey - The secret key of the old key. Computed.
- secret_
key str - The secret key of the key. Computed.
- secret_
key_ floattimestamp - The timestamp of the secret key. Computed.
- user str
- The username to create the S3 key. This resource will be recreated if the value of this field is changed.
- zone str
- The zone of the user. This resource will be recreated if the value of this field is changed.
- access
Id String - Unique identifier of the S3 key.
- existing
Key NumberExpiry Time - The expiry of the old secret key in minutes. Optional. It will be applicable only if oldsecretkey is exist.
- old
Key NumberExpiry - The expiry of the old key. Computed.
- old
Key NumberTimestamp - The timestamp of the old key. Computed.
- old
Secret StringKey - The secret key of the old key. Computed.
- secret
Key String - The secret key of the key. Computed.
- secret
Key NumberTimestamp - The timestamp of the secret key. Computed.
- user String
- The username to create the S3 key. This resource will be recreated if the value of this field is changed.
- zone String
- The zone of the user. This resource will be recreated if the value of this field is changed.
Package Details
- Repository
- powerscale dell/terraform-provider-powerscale
- License
- Notes
- This Pulumi package is based on the
powerscale
Terraform Provider.