Docs Packages
  1. Packages
  2. AWS Classic
  3. API Docs
  4. paymentcryptography
  5. KeyAlias

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.42.0 published on Wednesday, Jun 26, 2024 by Pulumi
pulumi/pulumi-aws

aws.paymentcryptography.KeyAlias

Explore with Pulumi AI

aws logo

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.42.0 published on Wednesday, Jun 26, 2024 by Pulumi
pulumi/pulumi-aws

    Resource for managing an AWS Payment Cryptography Control Plane Key Alias.

    Example Usage

    Basic Usage

    Coming soon!

    Coming soon!

    Coming soon!

    Coming soon!

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.paymentcryptography.Key;
import com.pulumi.aws.paymentcryptography.KeyArgs;
import com.pulumi.aws.paymentcryptography.KeyAlias;
import com.pulumi.aws.paymentcryptography.KeyAliasArgs;
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 test = new Key("test", KeyArgs.builder()
            .exportable(true)
            .keyAttributes(KeyKeyAttributesArgs.builder()
                .keyAlgorithm("TDES_3KEY")
                .keyClass("SYMMETRIC_KEY")
                .keyUsage("TR31_P0_PIN_ENCRYPTION_KEY")
                .keyModesOfUse(KeyKeyAttributesKeyModesOfUseArgs.builder()
                    .decrypt(true)
                    .encrypt(true)
                    .wrap(true)
                    .unwrap(true)
                    .build())
                .build())
            .build());

        var testKeyAlias = new KeyAlias("testKeyAlias", KeyAliasArgs.builder()
            .aliasName("alias/test-alias")
            .keyArn(test.arn())
            .build());

    }
}

    resources:
  test:
    type: aws:paymentcryptography:Key
    properties:
      exportable: true
      keyAttributes:
        - keyAlgorithm: TDES_3KEY
          keyClass: SYMMETRIC_KEY
          keyUsage: TR31_P0_PIN_ENCRYPTION_KEY
          keyModesOfUse:
            - decrypt: true
              encrypt: true
              wrap: true
              unwrap: true
  testKeyAlias:
    type: aws:paymentcryptography:KeyAlias
    name: test
    properties:
      aliasName: alias/test-alias
      keyArn: ${test.arn}

    Create KeyAlias Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new KeyAlias(name: string, args: KeyAliasArgs, opts?: CustomResourceOptions);
    @overload
def KeyAlias(resource_name: str,
             args: KeyAliasArgs,
             opts: Optional[ResourceOptions] = None)

@overload
def KeyAlias(resource_name: str,
             opts: Optional[ResourceOptions] = None,
             alias_name: Optional[str] = None,
             key_arn: Optional[str] = None)
    func NewKeyAlias(ctx *Context, name string, args KeyAliasArgs, opts ...ResourceOption) (*KeyAlias, error)
    public KeyAlias(string name, KeyAliasArgs args, CustomResourceOptions? opts = null)
    public KeyAlias(String name, KeyAliasArgs args)
public KeyAlias(String name, KeyAliasArgs args, CustomResourceOptions options)

    type: aws:paymentcryptography:KeyAlias
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 KeyAliasArgs
    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 KeyAliasArgs
    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 KeyAliasArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args KeyAliasArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args KeyAliasArgs
    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 keyAliasResource = new Aws.PaymentCryptography.KeyAlias("keyAliasResource", new()
{
    AliasName = "string",
    KeyArn = "string",
});

    example, err := paymentcryptography.NewKeyAlias(ctx, "keyAliasResource", &paymentcryptography.KeyAliasArgs{
	AliasName: pulumi.String("string"),
	KeyArn:    pulumi.String("string"),
})

    var keyAliasResource = new KeyAlias("keyAliasResource", KeyAliasArgs.builder()
    .aliasName("string")
    .keyArn("string")
    .build());

    key_alias_resource = aws.paymentcryptography.KeyAlias("keyAliasResource",
    alias_name="string",
    key_arn="string")

    const keyAliasResource = new aws.paymentcryptography.KeyAlias("keyAliasResource", {
    aliasName: "string",
    keyArn: "string",
});

    type: aws:paymentcryptography:KeyAlias
properties:
    aliasName: string
    keyArn: string

    KeyAlias 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 KeyAlias resource accepts the following input properties:

    AliasName string

    Name of the Key Alias.

    The following arguments are optional:

    KeyArn string
    ARN of the key.
    AliasName string

    Name of the Key Alias.

    The following arguments are optional:

    KeyArn string
    ARN of the key.
    aliasName String

    Name of the Key Alias.

    The following arguments are optional:

    keyArn String
    ARN of the key.
    aliasName string

    Name of the Key Alias.

    The following arguments are optional:

    keyArn string
    ARN of the key.
    alias_name str

    Name of the Key Alias.

    The following arguments are optional:

    key_arn str
    ARN of the key.
    aliasName String

    Name of the Key Alias.

    The following arguments are optional:

    keyArn String
    ARN of the key.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the KeyAlias 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 KeyAlias Resource

    Get an existing KeyAlias 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?: KeyAliasState, opts?: CustomResourceOptions): KeyAlias
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        alias_name: Optional[str] = None,
        key_arn: Optional[str] = None) -> KeyAlias
    func GetKeyAlias(ctx *Context, name string, id IDInput, state *KeyAliasState, opts ...ResourceOption) (*KeyAlias, error)
    public static KeyAlias Get(string name, Input<string> id, KeyAliasState? state, CustomResourceOptions? opts = null)
    public static KeyAlias get(String name, Output<String> id, KeyAliasState 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:
    AliasName string

    Name of the Key Alias.

    The following arguments are optional:

    KeyArn string
    ARN of the key.
    AliasName string

    Name of the Key Alias.

    The following arguments are optional:

    KeyArn string
    ARN of the key.
    aliasName String

    Name of the Key Alias.

    The following arguments are optional:

    keyArn String
    ARN of the key.
    aliasName string

    Name of the Key Alias.

    The following arguments are optional:

    keyArn string
    ARN of the key.
    alias_name str

    Name of the Key Alias.

    The following arguments are optional:

    key_arn str
    ARN of the key.
    aliasName String

    Name of the Key Alias.

    The following arguments are optional:

    keyArn String
    ARN of the key.

    Import

    Using pulumi import, import Payment Cryptography Control Plane Key Alias using the alias/4681482429376900170. For example:

    $ pulumi import aws:paymentcryptography/keyAlias:KeyAlias example alias/4681482429376900170

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    AWS Classic pulumi/pulumi-aws
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the aws Terraform Provider.
    aws logo

    Try AWS Native preview for resources not in the classic version.

    AWS Classic v6.42.0 published on Wednesday, Jun 26, 2024 by Pulumi
    pulumi/pulumi-aws