pulumi/tests/testdata/codegen/external-resource-schema/docs/component/_index.md

88 KiB


title: "Component" title_tag: "example.Component" meta_desc: "Documentation for the example.Component resource with examples, input properties, output properties, lookup functions, and supporting types." layout: api no_edit_this_page: true

Create Component Resource

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

Constructor syntax

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

@overload
def Component(resource_name: str,
              opts: Optional[ResourceOptions] = None,
              required_metadata: Optional[pulumi_kubernetes.meta.v1.ObjectMetaArgs] = None,
              required_metadata_array: Optional[Sequence[pulumi_kubernetes.meta.v1.ObjectMetaArgs]] = None,
              required_metadata_map: Optional[Mapping[str, pulumi_kubernetes.meta.v1.ObjectMetaArgs]] = None,
              metadata: Optional[pulumi_kubernetes.meta.v1.ObjectMetaArgs] = None,
              metadata_array: Optional[Sequence[pulumi_kubernetes.meta.v1.ObjectMetaArgs]] = None,
              metadata_map: Optional[Mapping[str, pulumi_kubernetes.meta.v1.ObjectMetaArgs]] = None)
func NewComponent(ctx *Context, name string, args ComponentArgs, opts ...ResourceOption) (*Component, error)
public Component(string name, ComponentArgs args, CustomResourceOptions? opts = null)
public Component(String name, ComponentArgs args)
public Component(String name, ComponentArgs args, CustomResourceOptions options)
type: example:Component
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 ComponentArgs
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 ComponentArgs
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 ComponentArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args ComponentArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name String
The unique name of the resource.
args ComponentArgs
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 componentResource = new Example.Component("componentResource", new()
{
    RequiredMetadata = new Kubernetes.Types.Inputs.Meta.V1.ObjectMetaArgs
    {
        Annotations = 
        {
            { "string", "string" },
        },
        ClusterName = "string",
        CreationTimestamp = "string",
        DeletionGracePeriodSeconds = 0,
        DeletionTimestamp = "string",
        Finalizers = new[]
        {
            "string",
        },
        GenerateName = "string",
        Generation = 0,
        Labels = 
        {
            { "string", "string" },
        },
        ManagedFields = new[]
        {
            new Kubernetes.Types.Inputs.Meta.V1.ManagedFieldsEntryArgs
            {
                ApiVersion = "string",
                FieldsType = "string",
                FieldsV1 = "{}",
                Manager = "string",
                Operation = "string",
                Subresource = "string",
                Time = "string",
            },
        },
        Name = "string",
        Namespace = "string",
        OwnerReferences = new[]
        {
            new Kubernetes.Types.Inputs.Meta.V1.OwnerReferenceArgs
            {
                ApiVersion = "string",
                Kind = "string",
                Name = "string",
                Uid = "string",
                BlockOwnerDeletion = false,
                Controller = false,
            },
        },
        ResourceVersion = "string",
        SelfLink = "string",
        Uid = "string",
    },
    RequiredMetadataArray = new[]
    {
        new Kubernetes.Types.Inputs.Meta.V1.ObjectMetaArgs
        {
            Annotations = 
            {
                { "string", "string" },
            },
            ClusterName = "string",
            CreationTimestamp = "string",
            DeletionGracePeriodSeconds = 0,
            DeletionTimestamp = "string",
            Finalizers = new[]
            {
                "string",
            },
            GenerateName = "string",
            Generation = 0,
            Labels = 
            {
                { "string", "string" },
            },
            ManagedFields = new[]
            {
                new Kubernetes.Types.Inputs.Meta.V1.ManagedFieldsEntryArgs
                {
                    ApiVersion = "string",
                    FieldsType = "string",
                    FieldsV1 = "{}",
                    Manager = "string",
                    Operation = "string",
                    Subresource = "string",
                    Time = "string",
                },
            },
            Name = "string",
            Namespace = "string",
            OwnerReferences = new[]
            {
                new Kubernetes.Types.Inputs.Meta.V1.OwnerReferenceArgs
                {
                    ApiVersion = "string",
                    Kind = "string",
                    Name = "string",
                    Uid = "string",
                    BlockOwnerDeletion = false,
                    Controller = false,
                },
            },
            ResourceVersion = "string",
            SelfLink = "string",
            Uid = "string",
        },
    },
    RequiredMetadataMap = 
    {
        { "string", new Kubernetes.Types.Inputs.Meta.V1.ObjectMetaArgs
        {
            Annotations = 
            {
                { "string", "string" },
            },
            ClusterName = "string",
            CreationTimestamp = "string",
            DeletionGracePeriodSeconds = 0,
            DeletionTimestamp = "string",
            Finalizers = new[]
            {
                "string",
            },
            GenerateName = "string",
            Generation = 0,
            Labels = 
            {
                { "string", "string" },
            },
            ManagedFields = new[]
            {
                new Kubernetes.Types.Inputs.Meta.V1.ManagedFieldsEntryArgs
                {
                    ApiVersion = "string",
                    FieldsType = "string",
                    FieldsV1 = "{}",
                    Manager = "string",
                    Operation = "string",
                    Subresource = "string",
                    Time = "string",
                },
            },
            Name = "string",
            Namespace = "string",
            OwnerReferences = new[]
            {
                new Kubernetes.Types.Inputs.Meta.V1.OwnerReferenceArgs
                {
                    ApiVersion = "string",
                    Kind = "string",
                    Name = "string",
                    Uid = "string",
                    BlockOwnerDeletion = false,
                    Controller = false,
                },
            },
            ResourceVersion = "string",
            SelfLink = "string",
            Uid = "string",
        } },
    },
    Metadata = new Kubernetes.Types.Inputs.Meta.V1.ObjectMetaArgs
    {
        Annotations = 
        {
            { "string", "string" },
        },
        ClusterName = "string",
        CreationTimestamp = "string",
        DeletionGracePeriodSeconds = 0,
        DeletionTimestamp = "string",
        Finalizers = new[]
        {
            "string",
        },
        GenerateName = "string",
        Generation = 0,
        Labels = 
        {
            { "string", "string" },
        },
        ManagedFields = new[]
        {
            new Kubernetes.Types.Inputs.Meta.V1.ManagedFieldsEntryArgs
            {
                ApiVersion = "string",
                FieldsType = "string",
                FieldsV1 = "{}",
                Manager = "string",
                Operation = "string",
                Subresource = "string",
                Time = "string",
            },
        },
        Name = "string",
        Namespace = "string",
        OwnerReferences = new[]
        {
            new Kubernetes.Types.Inputs.Meta.V1.OwnerReferenceArgs
            {
                ApiVersion = "string",
                Kind = "string",
                Name = "string",
                Uid = "string",
                BlockOwnerDeletion = false,
                Controller = false,
            },
        },
        ResourceVersion = "string",
        SelfLink = "string",
        Uid = "string",
    },
    MetadataArray = new[]
    {
        new Kubernetes.Types.Inputs.Meta.V1.ObjectMetaArgs
        {
            Annotations = 
            {
                { "string", "string" },
            },
            ClusterName = "string",
            CreationTimestamp = "string",
            DeletionGracePeriodSeconds = 0,
            DeletionTimestamp = "string",
            Finalizers = new[]
            {
                "string",
            },
            GenerateName = "string",
            Generation = 0,
            Labels = 
            {
                { "string", "string" },
            },
            ManagedFields = new[]
            {
                new Kubernetes.Types.Inputs.Meta.V1.ManagedFieldsEntryArgs
                {
                    ApiVersion = "string",
                    FieldsType = "string",
                    FieldsV1 = "{}",
                    Manager = "string",
                    Operation = "string",
                    Subresource = "string",
                    Time = "string",
                },
            },
            Name = "string",
            Namespace = "string",
            OwnerReferences = new[]
            {
                new Kubernetes.Types.Inputs.Meta.V1.OwnerReferenceArgs
                {
                    ApiVersion = "string",
                    Kind = "string",
                    Name = "string",
                    Uid = "string",
                    BlockOwnerDeletion = false,
                    Controller = false,
                },
            },
            ResourceVersion = "string",
            SelfLink = "string",
            Uid = "string",
        },
    },
    MetadataMap = 
    {
        { "string", new Kubernetes.Types.Inputs.Meta.V1.ObjectMetaArgs
        {
            Annotations = 
            {
                { "string", "string" },
            },
            ClusterName = "string",
            CreationTimestamp = "string",
            DeletionGracePeriodSeconds = 0,
            DeletionTimestamp = "string",
            Finalizers = new[]
            {
                "string",
            },
            GenerateName = "string",
            Generation = 0,
            Labels = 
            {
                { "string", "string" },
            },
            ManagedFields = new[]
            {
                new Kubernetes.Types.Inputs.Meta.V1.ManagedFieldsEntryArgs
                {
                    ApiVersion = "string",
                    FieldsType = "string",
                    FieldsV1 = "{}",
                    Manager = "string",
                    Operation = "string",
                    Subresource = "string",
                    Time = "string",
                },
            },
            Name = "string",
            Namespace = "string",
            OwnerReferences = new[]
            {
                new Kubernetes.Types.Inputs.Meta.V1.OwnerReferenceArgs
                {
                    ApiVersion = "string",
                    Kind = "string",
                    Name = "string",
                    Uid = "string",
                    BlockOwnerDeletion = false,
                    Controller = false,
                },
            },
            ResourceVersion = "string",
            SelfLink = "string",
            Uid = "string",
        } },
    },
});
example, err := example.NewComponent(ctx, "componentResource", &example.ComponentArgs{
	RequiredMetadata: &metav1.ObjectMetaArgs{
		Annotations: pulumi.StringMap{
			"string": pulumi.String("string"),
		},
		ClusterName:                pulumi.String("string"),
		CreationTimestamp:          pulumi.String("string"),
		DeletionGracePeriodSeconds: pulumi.Int(0),
		DeletionTimestamp:          pulumi.String("string"),
		Finalizers: pulumi.StringArray{
			pulumi.String("string"),
		},
		GenerateName: pulumi.String("string"),
		Generation:   pulumi.Int(0),
		Labels: pulumi.StringMap{
			"string": pulumi.String("string"),
		},
		ManagedFields: metav1.ManagedFieldsEntryArray{
			&metav1.ManagedFieldsEntryArgs{
				ApiVersion:  pulumi.String("string"),
				FieldsType:  pulumi.String("string"),
				FieldsV1:    pulumi.Any("{}"),
				Manager:     pulumi.String("string"),
				Operation:   pulumi.String("string"),
				Subresource: pulumi.String("string"),
				Time:        pulumi.String("string"),
			},
		},
		Name:      pulumi.String("string"),
		Namespace: pulumi.String("string"),
		OwnerReferences: metav1.OwnerReferenceArray{
			&metav1.OwnerReferenceArgs{
				ApiVersion:         pulumi.String("string"),
				Kind:               pulumi.String("string"),
				Name:               pulumi.String("string"),
				Uid:                pulumi.String("string"),
				BlockOwnerDeletion: pulumi.Bool(false),
				Controller:         pulumi.Bool(false),
			},
		},
		ResourceVersion: pulumi.String("string"),
		SelfLink:        pulumi.String("string"),
		Uid:             pulumi.String("string"),
	},
	RequiredMetadataArray: metav1.ObjectMetaArray{
		&metav1.ObjectMetaArgs{
			Annotations: pulumi.StringMap{
				"string": pulumi.String("string"),
			},
			ClusterName:                pulumi.String("string"),
			CreationTimestamp:          pulumi.String("string"),
			DeletionGracePeriodSeconds: pulumi.Int(0),
			DeletionTimestamp:          pulumi.String("string"),
			Finalizers: pulumi.StringArray{
				pulumi.String("string"),
			},
			GenerateName: pulumi.String("string"),
			Generation:   pulumi.Int(0),
			Labels: pulumi.StringMap{
				"string": pulumi.String("string"),
			},
			ManagedFields: metav1.ManagedFieldsEntryArray{
				&metav1.ManagedFieldsEntryArgs{
					ApiVersion:  pulumi.String("string"),
					FieldsType:  pulumi.String("string"),
					FieldsV1:    pulumi.Any("{}"),
					Manager:     pulumi.String("string"),
					Operation:   pulumi.String("string"),
					Subresource: pulumi.String("string"),
					Time:        pulumi.String("string"),
				},
			},
			Name:      pulumi.String("string"),
			Namespace: pulumi.String("string"),
			OwnerReferences: metav1.OwnerReferenceArray{
				&metav1.OwnerReferenceArgs{
					ApiVersion:         pulumi.String("string"),
					Kind:               pulumi.String("string"),
					Name:               pulumi.String("string"),
					Uid:                pulumi.String("string"),
					BlockOwnerDeletion: pulumi.Bool(false),
					Controller:         pulumi.Bool(false),
				},
			},
			ResourceVersion: pulumi.String("string"),
			SelfLink:        pulumi.String("string"),
			Uid:             pulumi.String("string"),
		},
	},
	RequiredMetadataMap: metav1.ObjectMetaMap{
		"string": &metav1.ObjectMetaArgs{
			Annotations: pulumi.StringMap{
				"string": pulumi.String("string"),
			},
			ClusterName:                pulumi.String("string"),
			CreationTimestamp:          pulumi.String("string"),
			DeletionGracePeriodSeconds: pulumi.Int(0),
			DeletionTimestamp:          pulumi.String("string"),
			Finalizers: pulumi.StringArray{
				pulumi.String("string"),
			},
			GenerateName: pulumi.String("string"),
			Generation:   pulumi.Int(0),
			Labels: pulumi.StringMap{
				"string": pulumi.String("string"),
			},
			ManagedFields: metav1.ManagedFieldsEntryArray{
				&metav1.ManagedFieldsEntryArgs{
					ApiVersion:  pulumi.String("string"),
					FieldsType:  pulumi.String("string"),
					FieldsV1:    pulumi.Any("{}"),
					Manager:     pulumi.String("string"),
					Operation:   pulumi.String("string"),
					Subresource: pulumi.String("string"),
					Time:        pulumi.String("string"),
				},
			},
			Name:      pulumi.String("string"),
			Namespace: pulumi.String("string"),
			OwnerReferences: metav1.OwnerReferenceArray{
				&metav1.OwnerReferenceArgs{
					ApiVersion:         pulumi.String("string"),
					Kind:               pulumi.String("string"),
					Name:               pulumi.String("string"),
					Uid:                pulumi.String("string"),
					BlockOwnerDeletion: pulumi.Bool(false),
					Controller:         pulumi.Bool(false),
				},
			},
			ResourceVersion: pulumi.String("string"),
			SelfLink:        pulumi.String("string"),
			Uid:             pulumi.String("string"),
		},
	},
	Metadata: &metav1.ObjectMetaArgs{
		Annotations: pulumi.StringMap{
			"string": pulumi.String("string"),
		},
		ClusterName:                pulumi.String("string"),
		CreationTimestamp:          pulumi.String("string"),
		DeletionGracePeriodSeconds: pulumi.Int(0),
		DeletionTimestamp:          pulumi.String("string"),
		Finalizers: pulumi.StringArray{
			pulumi.String("string"),
		},
		GenerateName: pulumi.String("string"),
		Generation:   pulumi.Int(0),
		Labels: pulumi.StringMap{
			"string": pulumi.String("string"),
		},
		ManagedFields: metav1.ManagedFieldsEntryArray{
			&metav1.ManagedFieldsEntryArgs{
				ApiVersion:  pulumi.String("string"),
				FieldsType:  pulumi.String("string"),
				FieldsV1:    pulumi.Any("{}"),
				Manager:     pulumi.String("string"),
				Operation:   pulumi.String("string"),
				Subresource: pulumi.String("string"),
				Time:        pulumi.String("string"),
			},
		},
		Name:      pulumi.String("string"),
		Namespace: pulumi.String("string"),
		OwnerReferences: metav1.OwnerReferenceArray{
			&metav1.OwnerReferenceArgs{
				ApiVersion:         pulumi.String("string"),
				Kind:               pulumi.String("string"),
				Name:               pulumi.String("string"),
				Uid:                pulumi.String("string"),
				BlockOwnerDeletion: pulumi.Bool(false),
				Controller:         pulumi.Bool(false),
			},
		},
		ResourceVersion: pulumi.String("string"),
		SelfLink:        pulumi.String("string"),
		Uid:             pulumi.String("string"),
	},
	MetadataArray: metav1.ObjectMetaArray{
		&metav1.ObjectMetaArgs{
			Annotations: pulumi.StringMap{
				"string": pulumi.String("string"),
			},
			ClusterName:                pulumi.String("string"),
			CreationTimestamp:          pulumi.String("string"),
			DeletionGracePeriodSeconds: pulumi.Int(0),
			DeletionTimestamp:          pulumi.String("string"),
			Finalizers: pulumi.StringArray{
				pulumi.String("string"),
			},
			GenerateName: pulumi.String("string"),
			Generation:   pulumi.Int(0),
			Labels: pulumi.StringMap{
				"string": pulumi.String("string"),
			},
			ManagedFields: metav1.ManagedFieldsEntryArray{
				&metav1.ManagedFieldsEntryArgs{
					ApiVersion:  pulumi.String("string"),
					FieldsType:  pulumi.String("string"),
					FieldsV1:    pulumi.Any("{}"),
					Manager:     pulumi.String("string"),
					Operation:   pulumi.String("string"),
					Subresource: pulumi.String("string"),
					Time:        pulumi.String("string"),
				},
			},
			Name:      pulumi.String("string"),
			Namespace: pulumi.String("string"),
			OwnerReferences: metav1.OwnerReferenceArray{
				&metav1.OwnerReferenceArgs{
					ApiVersion:         pulumi.String("string"),
					Kind:               pulumi.String("string"),
					Name:               pulumi.String("string"),
					Uid:                pulumi.String("string"),
					BlockOwnerDeletion: pulumi.Bool(false),
					Controller:         pulumi.Bool(false),
				},
			},
			ResourceVersion: pulumi.String("string"),
			SelfLink:        pulumi.String("string"),
			Uid:             pulumi.String("string"),
		},
	},
	MetadataMap: metav1.ObjectMetaMap{
		"string": &metav1.ObjectMetaArgs{
			Annotations: pulumi.StringMap{
				"string": pulumi.String("string"),
			},
			ClusterName:                pulumi.String("string"),
			CreationTimestamp:          pulumi.String("string"),
			DeletionGracePeriodSeconds: pulumi.Int(0),
			DeletionTimestamp:          pulumi.String("string"),
			Finalizers: pulumi.StringArray{
				pulumi.String("string"),
			},
			GenerateName: pulumi.String("string"),
			Generation:   pulumi.Int(0),
			Labels: pulumi.StringMap{
				"string": pulumi.String("string"),
			},
			ManagedFields: metav1.ManagedFieldsEntryArray{
				&metav1.ManagedFieldsEntryArgs{
					ApiVersion:  pulumi.String("string"),
					FieldsType:  pulumi.String("string"),
					FieldsV1:    pulumi.Any("{}"),
					Manager:     pulumi.String("string"),
					Operation:   pulumi.String("string"),
					Subresource: pulumi.String("string"),
					Time:        pulumi.String("string"),
				},
			},
			Name:      pulumi.String("string"),
			Namespace: pulumi.String("string"),
			OwnerReferences: metav1.OwnerReferenceArray{
				&metav1.OwnerReferenceArgs{
					ApiVersion:         pulumi.String("string"),
					Kind:               pulumi.String("string"),
					Name:               pulumi.String("string"),
					Uid:                pulumi.String("string"),
					BlockOwnerDeletion: pulumi.Bool(false),
					Controller:         pulumi.Bool(false),
				},
			},
			ResourceVersion: pulumi.String("string"),
			SelfLink:        pulumi.String("string"),
			Uid:             pulumi.String("string"),
		},
	},
})
var componentResource = new Component("componentResource", ComponentArgs.builder()
    .requiredMetadata(ObjectMetaArgs.builder()
        .annotations(Map.of("string", "string"))
        .clusterName("string")
        .creationTimestamp("string")
        .deletionGracePeriodSeconds(0)
        .deletionTimestamp("string")
        .finalizers("string")
        .generateName("string")
        .generation(0)
        .labels(Map.of("string", "string"))
        .managedFields(ManagedFieldsEntryArgs.builder()
            .apiVersion("string")
            .fieldsType("string")
            .fieldsV1("{}")
            .manager("string")
            .operation("string")
            .subresource("string")
            .time("string")
            .build())
        .name("string")
        .namespace("string")
        .ownerReferences(OwnerReferenceArgs.builder()
            .apiVersion("string")
            .kind("string")
            .name("string")
            .uid("string")
            .blockOwnerDeletion(false)
            .controller(false)
            .build())
        .resourceVersion("string")
        .selfLink("string")
        .uid("string")
        .build())
    .requiredMetadataArray(ObjectMetaArgs.builder()
        .annotations(Map.of("string", "string"))
        .clusterName("string")
        .creationTimestamp("string")
        .deletionGracePeriodSeconds(0)
        .deletionTimestamp("string")
        .finalizers("string")
        .generateName("string")
        .generation(0)
        .labels(Map.of("string", "string"))
        .managedFields(ManagedFieldsEntryArgs.builder()
            .apiVersion("string")
            .fieldsType("string")
            .fieldsV1("{}")
            .manager("string")
            .operation("string")
            .subresource("string")
            .time("string")
            .build())
        .name("string")
        .namespace("string")
        .ownerReferences(OwnerReferenceArgs.builder()
            .apiVersion("string")
            .kind("string")
            .name("string")
            .uid("string")
            .blockOwnerDeletion(false)
            .controller(false)
            .build())
        .resourceVersion("string")
        .selfLink("string")
        .uid("string")
        .build())
    .requiredMetadataMap(Map.of("string", Map.ofEntries(
        Map.entry("annotations", Map.of("string", "string")),
        Map.entry("clusterName", "string"),
        Map.entry("creationTimestamp", "string"),
        Map.entry("deletionGracePeriodSeconds", 0),
        Map.entry("deletionTimestamp", "string"),
        Map.entry("finalizers", "string"),
        Map.entry("generateName", "string"),
        Map.entry("generation", 0),
        Map.entry("labels", Map.of("string", "string")),
        Map.entry("managedFields", Map.ofEntries(
            Map.entry("apiVersion", "string"),
            Map.entry("fieldsType", "string"),
            Map.entry("fieldsV1", "{}"),
            Map.entry("manager", "string"),
            Map.entry("operation", "string"),
            Map.entry("subresource", "string"),
            Map.entry("time", "string")
        )),
        Map.entry("name", "string"),
        Map.entry("namespace", "string"),
        Map.entry("ownerReferences", Map.ofEntries(
            Map.entry("apiVersion", "string"),
            Map.entry("kind", "string"),
            Map.entry("name", "string"),
            Map.entry("uid", "string"),
            Map.entry("blockOwnerDeletion", false),
            Map.entry("controller", false)
        )),
        Map.entry("resourceVersion", "string"),
        Map.entry("selfLink", "string"),
        Map.entry("uid", "string")
    )))
    .metadata(ObjectMetaArgs.builder()
        .annotations(Map.of("string", "string"))
        .clusterName("string")
        .creationTimestamp("string")
        .deletionGracePeriodSeconds(0)
        .deletionTimestamp("string")
        .finalizers("string")
        .generateName("string")
        .generation(0)
        .labels(Map.of("string", "string"))
        .managedFields(ManagedFieldsEntryArgs.builder()
            .apiVersion("string")
            .fieldsType("string")
            .fieldsV1("{}")
            .manager("string")
            .operation("string")
            .subresource("string")
            .time("string")
            .build())
        .name("string")
        .namespace("string")
        .ownerReferences(OwnerReferenceArgs.builder()
            .apiVersion("string")
            .kind("string")
            .name("string")
            .uid("string")
            .blockOwnerDeletion(false)
            .controller(false)
            .build())
        .resourceVersion("string")
        .selfLink("string")
        .uid("string")
        .build())
    .metadataArray(ObjectMetaArgs.builder()
        .annotations(Map.of("string", "string"))
        .clusterName("string")
        .creationTimestamp("string")
        .deletionGracePeriodSeconds(0)
        .deletionTimestamp("string")
        .finalizers("string")
        .generateName("string")
        .generation(0)
        .labels(Map.of("string", "string"))
        .managedFields(ManagedFieldsEntryArgs.builder()
            .apiVersion("string")
            .fieldsType("string")
            .fieldsV1("{}")
            .manager("string")
            .operation("string")
            .subresource("string")
            .time("string")
            .build())
        .name("string")
        .namespace("string")
        .ownerReferences(OwnerReferenceArgs.builder()
            .apiVersion("string")
            .kind("string")
            .name("string")
            .uid("string")
            .blockOwnerDeletion(false)
            .controller(false)
            .build())
        .resourceVersion("string")
        .selfLink("string")
        .uid("string")
        .build())
    .metadataMap(Map.of("string", Map.ofEntries(
        Map.entry("annotations", Map.of("string", "string")),
        Map.entry("clusterName", "string"),
        Map.entry("creationTimestamp", "string"),
        Map.entry("deletionGracePeriodSeconds", 0),
        Map.entry("deletionTimestamp", "string"),
        Map.entry("finalizers", "string"),
        Map.entry("generateName", "string"),
        Map.entry("generation", 0),
        Map.entry("labels", Map.of("string", "string")),
        Map.entry("managedFields", Map.ofEntries(
            Map.entry("apiVersion", "string"),
            Map.entry("fieldsType", "string"),
            Map.entry("fieldsV1", "{}"),
            Map.entry("manager", "string"),
            Map.entry("operation", "string"),
            Map.entry("subresource", "string"),
            Map.entry("time", "string")
        )),
        Map.entry("name", "string"),
        Map.entry("namespace", "string"),
        Map.entry("ownerReferences", Map.ofEntries(
            Map.entry("apiVersion", "string"),
            Map.entry("kind", "string"),
            Map.entry("name", "string"),
            Map.entry("uid", "string"),
            Map.entry("blockOwnerDeletion", false),
            Map.entry("controller", false)
        )),
        Map.entry("resourceVersion", "string"),
        Map.entry("selfLink", "string"),
        Map.entry("uid", "string")
    )))
    .build());
component_resource = example.Component("componentResource",
    required_metadata={
        "annotations": {
            "string": "string",
        },
        "cluster_name": "string",
        "creation_timestamp": "string",
        "deletion_grace_period_seconds": 0,
        "deletion_timestamp": "string",
        "finalizers": ["string"],
        "generate_name": "string",
        "generation": 0,
        "labels": {
            "string": "string",
        },
        "managed_fields": [{
            "api_version": "string",
            "fields_type": "string",
            "fields_v1": "{}",
            "manager": "string",
            "operation": "string",
            "subresource": "string",
            "time": "string",
        }],
        "name": "string",
        "namespace": "string",
        "owner_references": [{
            "api_version": "string",
            "kind": "string",
            "name": "string",
            "uid": "string",
            "block_owner_deletion": False,
            "controller": False,
        }],
        "resource_version": "string",
        "self_link": "string",
        "uid": "string",
    },
    required_metadata_array=[{
        "annotations": {
            "string": "string",
        },
        "cluster_name": "string",
        "creation_timestamp": "string",
        "deletion_grace_period_seconds": 0,
        "deletion_timestamp": "string",
        "finalizers": ["string"],
        "generate_name": "string",
        "generation": 0,
        "labels": {
            "string": "string",
        },
        "managed_fields": [{
            "api_version": "string",
            "fields_type": "string",
            "fields_v1": "{}",
            "manager": "string",
            "operation": "string",
            "subresource": "string",
            "time": "string",
        }],
        "name": "string",
        "namespace": "string",
        "owner_references": [{
            "api_version": "string",
            "kind": "string",
            "name": "string",
            "uid": "string",
            "block_owner_deletion": False,
            "controller": False,
        }],
        "resource_version": "string",
        "self_link": "string",
        "uid": "string",
    }],
    required_metadata_map={
        "string": {
            "annotations": {
                "string": "string",
            },
            "cluster_name": "string",
            "creation_timestamp": "string",
            "deletion_grace_period_seconds": 0,
            "deletion_timestamp": "string",
            "finalizers": ["string"],
            "generate_name": "string",
            "generation": 0,
            "labels": {
                "string": "string",
            },
            "managed_fields": [{
                "api_version": "string",
                "fields_type": "string",
                "fields_v1": "{}",
                "manager": "string",
                "operation": "string",
                "subresource": "string",
                "time": "string",
            }],
            "name": "string",
            "namespace": "string",
            "owner_references": [{
                "api_version": "string",
                "kind": "string",
                "name": "string",
                "uid": "string",
                "block_owner_deletion": False,
                "controller": False,
            }],
            "resource_version": "string",
            "self_link": "string",
            "uid": "string",
        },
    },
    metadata={
        "annotations": {
            "string": "string",
        },
        "cluster_name": "string",
        "creation_timestamp": "string",
        "deletion_grace_period_seconds": 0,
        "deletion_timestamp": "string",
        "finalizers": ["string"],
        "generate_name": "string",
        "generation": 0,
        "labels": {
            "string": "string",
        },
        "managed_fields": [{
            "api_version": "string",
            "fields_type": "string",
            "fields_v1": "{}",
            "manager": "string",
            "operation": "string",
            "subresource": "string",
            "time": "string",
        }],
        "name": "string",
        "namespace": "string",
        "owner_references": [{
            "api_version": "string",
            "kind": "string",
            "name": "string",
            "uid": "string",
            "block_owner_deletion": False,
            "controller": False,
        }],
        "resource_version": "string",
        "self_link": "string",
        "uid": "string",
    },
    metadata_array=[{
        "annotations": {
            "string": "string",
        },
        "cluster_name": "string",
        "creation_timestamp": "string",
        "deletion_grace_period_seconds": 0,
        "deletion_timestamp": "string",
        "finalizers": ["string"],
        "generate_name": "string",
        "generation": 0,
        "labels": {
            "string": "string",
        },
        "managed_fields": [{
            "api_version": "string",
            "fields_type": "string",
            "fields_v1": "{}",
            "manager": "string",
            "operation": "string",
            "subresource": "string",
            "time": "string",
        }],
        "name": "string",
        "namespace": "string",
        "owner_references": [{
            "api_version": "string",
            "kind": "string",
            "name": "string",
            "uid": "string",
            "block_owner_deletion": False,
            "controller": False,
        }],
        "resource_version": "string",
        "self_link": "string",
        "uid": "string",
    }],
    metadata_map={
        "string": {
            "annotations": {
                "string": "string",
            },
            "cluster_name": "string",
            "creation_timestamp": "string",
            "deletion_grace_period_seconds": 0,
            "deletion_timestamp": "string",
            "finalizers": ["string"],
            "generate_name": "string",
            "generation": 0,
            "labels": {
                "string": "string",
            },
            "managed_fields": [{
                "api_version": "string",
                "fields_type": "string",
                "fields_v1": "{}",
                "manager": "string",
                "operation": "string",
                "subresource": "string",
                "time": "string",
            }],
            "name": "string",
            "namespace": "string",
            "owner_references": [{
                "api_version": "string",
                "kind": "string",
                "name": "string",
                "uid": "string",
                "block_owner_deletion": False,
                "controller": False,
            }],
            "resource_version": "string",
            "self_link": "string",
            "uid": "string",
        },
    })
const componentResource = new example.Component("componentResource", {
    requiredMetadata: {
        annotations: {
            string: "string",
        },
        clusterName: "string",
        creationTimestamp: "string",
        deletionGracePeriodSeconds: 0,
        deletionTimestamp: "string",
        finalizers: ["string"],
        generateName: "string",
        generation: 0,
        labels: {
            string: "string",
        },
        managedFields: [{
            apiVersion: "string",
            fieldsType: "string",
            fieldsV1: "{}",
            manager: "string",
            operation: "string",
            subresource: "string",
            time: "string",
        }],
        name: "string",
        namespace: "string",
        ownerReferences: [{
            apiVersion: "string",
            kind: "string",
            name: "string",
            uid: "string",
            blockOwnerDeletion: false,
            controller: false,
        }],
        resourceVersion: "string",
        selfLink: "string",
        uid: "string",
    },
    requiredMetadataArray: [{
        annotations: {
            string: "string",
        },
        clusterName: "string",
        creationTimestamp: "string",
        deletionGracePeriodSeconds: 0,
        deletionTimestamp: "string",
        finalizers: ["string"],
        generateName: "string",
        generation: 0,
        labels: {
            string: "string",
        },
        managedFields: [{
            apiVersion: "string",
            fieldsType: "string",
            fieldsV1: "{}",
            manager: "string",
            operation: "string",
            subresource: "string",
            time: "string",
        }],
        name: "string",
        namespace: "string",
        ownerReferences: [{
            apiVersion: "string",
            kind: "string",
            name: "string",
            uid: "string",
            blockOwnerDeletion: false,
            controller: false,
        }],
        resourceVersion: "string",
        selfLink: "string",
        uid: "string",
    }],
    requiredMetadataMap: {
        string: {
            annotations: {
                string: "string",
            },
            clusterName: "string",
            creationTimestamp: "string",
            deletionGracePeriodSeconds: 0,
            deletionTimestamp: "string",
            finalizers: ["string"],
            generateName: "string",
            generation: 0,
            labels: {
                string: "string",
            },
            managedFields: [{
                apiVersion: "string",
                fieldsType: "string",
                fieldsV1: "{}",
                manager: "string",
                operation: "string",
                subresource: "string",
                time: "string",
            }],
            name: "string",
            namespace: "string",
            ownerReferences: [{
                apiVersion: "string",
                kind: "string",
                name: "string",
                uid: "string",
                blockOwnerDeletion: false,
                controller: false,
            }],
            resourceVersion: "string",
            selfLink: "string",
            uid: "string",
        },
    },
    metadata: {
        annotations: {
            string: "string",
        },
        clusterName: "string",
        creationTimestamp: "string",
        deletionGracePeriodSeconds: 0,
        deletionTimestamp: "string",
        finalizers: ["string"],
        generateName: "string",
        generation: 0,
        labels: {
            string: "string",
        },
        managedFields: [{
            apiVersion: "string",
            fieldsType: "string",
            fieldsV1: "{}",
            manager: "string",
            operation: "string",
            subresource: "string",
            time: "string",
        }],
        name: "string",
        namespace: "string",
        ownerReferences: [{
            apiVersion: "string",
            kind: "string",
            name: "string",
            uid: "string",
            blockOwnerDeletion: false,
            controller: false,
        }],
        resourceVersion: "string",
        selfLink: "string",
        uid: "string",
    },
    metadataArray: [{
        annotations: {
            string: "string",
        },
        clusterName: "string",
        creationTimestamp: "string",
        deletionGracePeriodSeconds: 0,
        deletionTimestamp: "string",
        finalizers: ["string"],
        generateName: "string",
        generation: 0,
        labels: {
            string: "string",
        },
        managedFields: [{
            apiVersion: "string",
            fieldsType: "string",
            fieldsV1: "{}",
            manager: "string",
            operation: "string",
            subresource: "string",
            time: "string",
        }],
        name: "string",
        namespace: "string",
        ownerReferences: [{
            apiVersion: "string",
            kind: "string",
            name: "string",
            uid: "string",
            blockOwnerDeletion: false,
            controller: false,
        }],
        resourceVersion: "string",
        selfLink: "string",
        uid: "string",
    }],
    metadataMap: {
        string: {
            annotations: {
                string: "string",
            },
            clusterName: "string",
            creationTimestamp: "string",
            deletionGracePeriodSeconds: 0,
            deletionTimestamp: "string",
            finalizers: ["string"],
            generateName: "string",
            generation: 0,
            labels: {
                string: "string",
            },
            managedFields: [{
                apiVersion: "string",
                fieldsType: "string",
                fieldsV1: "{}",
                manager: "string",
                operation: "string",
                subresource: "string",
                time: "string",
            }],
            name: "string",
            namespace: "string",
            ownerReferences: [{
                apiVersion: "string",
                kind: "string",
                name: "string",
                uid: "string",
                blockOwnerDeletion: false,
                controller: false,
            }],
            resourceVersion: "string",
            selfLink: "string",
            uid: "string",
        },
    },
});
type: example:Component
properties:
    metadata:
        annotations:
            string: string
        clusterName: string
        creationTimestamp: string
        deletionGracePeriodSeconds: 0
        deletionTimestamp: string
        finalizers:
            - string
        generateName: string
        generation: 0
        labels:
            string: string
        managedFields:
            - apiVersion: string
              fieldsType: string
              fieldsV1: '{}'
              manager: string
              operation: string
              subresource: string
              time: string
        name: string
        namespace: string
        ownerReferences:
            - apiVersion: string
              blockOwnerDeletion: false
              controller: false
              kind: string
              name: string
              uid: string
        resourceVersion: string
        selfLink: string
        uid: string
    metadataArray:
        - annotations:
            string: string
          clusterName: string
          creationTimestamp: string
          deletionGracePeriodSeconds: 0
          deletionTimestamp: string
          finalizers:
            - string
          generateName: string
          generation: 0
          labels:
            string: string
          managedFields:
            - apiVersion: string
              fieldsType: string
              fieldsV1: '{}'
              manager: string
              operation: string
              subresource: string
              time: string
          name: string
          namespace: string
          ownerReferences:
            - apiVersion: string
              blockOwnerDeletion: false
              controller: false
              kind: string
              name: string
              uid: string
          resourceVersion: string
          selfLink: string
          uid: string
    metadataMap:
        string:
            annotations:
                string: string
            clusterName: string
            creationTimestamp: string
            deletionGracePeriodSeconds: 0
            deletionTimestamp: string
            finalizers:
                - string
            generateName: string
            generation: 0
            labels:
                string: string
            managedFields:
                - apiVersion: string
                  fieldsType: string
                  fieldsV1: '{}'
                  manager: string
                  operation: string
                  subresource: string
                  time: string
            name: string
            namespace: string
            ownerReferences:
                - apiVersion: string
                  blockOwnerDeletion: false
                  controller: false
                  kind: string
                  name: string
                  uid: string
            resourceVersion: string
            selfLink: string
            uid: string
    requiredMetadata:
        annotations:
            string: string
        clusterName: string
        creationTimestamp: string
        deletionGracePeriodSeconds: 0
        deletionTimestamp: string
        finalizers:
            - string
        generateName: string
        generation: 0
        labels:
            string: string
        managedFields:
            - apiVersion: string
              fieldsType: string
              fieldsV1: '{}'
              manager: string
              operation: string
              subresource: string
              time: string
        name: string
        namespace: string
        ownerReferences:
            - apiVersion: string
              blockOwnerDeletion: false
              controller: false
              kind: string
              name: string
              uid: string
        resourceVersion: string
        selfLink: string
        uid: string
    requiredMetadataArray:
        - annotations:
            string: string
          clusterName: string
          creationTimestamp: string
          deletionGracePeriodSeconds: 0
          deletionTimestamp: string
          finalizers:
            - string
          generateName: string
          generation: 0
          labels:
            string: string
          managedFields:
            - apiVersion: string
              fieldsType: string
              fieldsV1: '{}'
              manager: string
              operation: string
              subresource: string
              time: string
          name: string
          namespace: string
          ownerReferences:
            - apiVersion: string
              blockOwnerDeletion: false
              controller: false
              kind: string
              name: string
              uid: string
          resourceVersion: string
          selfLink: string
          uid: string
    requiredMetadataMap:
        string:
            annotations:
                string: string
            clusterName: string
            creationTimestamp: string
            deletionGracePeriodSeconds: 0
            deletionTimestamp: string
            finalizers:
                - string
            generateName: string
            generation: 0
            labels:
                string: string
            managedFields:
                - apiVersion: string
                  fieldsType: string
                  fieldsV1: '{}'
                  manager: string
                  operation: string
                  subresource: string
                  time: string
            name: string
            namespace: string
            ownerReferences:
                - apiVersion: string
                  blockOwnerDeletion: false
                  controller: false
                  kind: string
                  name: string
                  uid: string
            resourceVersion: string
            selfLink: string
            uid: string

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

RequiredMetadata Pulumi.Kubernetes.Types.Inputs.Meta.V1.ObjectMeta
This type is defined in the Kubernetes package.
RequiredMetadataArray List<Pulumi.Kubernetes.Types.Inputs.Meta.V1.ObjectMeta>
RequiredMetadataMap Dictionary<string, Pulumi.Kubernetes.Types.Inputs.Meta.V1.ObjectMetaArgs>
Metadata Pulumi.Kubernetes.Types.Inputs.Meta.V1.ObjectMeta
This type is defined in the Kubernetes package.
MetadataArray List<Pulumi.Kubernetes.Types.Inputs.Meta.V1.ObjectMeta>
MetadataMap Dictionary<string, Pulumi.Kubernetes.Types.Inputs.Meta.V1.ObjectMetaArgs>
RequiredMetadata ObjectMetaArgs
This type is defined in the Kubernetes package.
RequiredMetadataArray ObjectMetaArgs
RequiredMetadataMap ObjectMetaArgs
Metadata ObjectMetaArgs
This type is defined in the Kubernetes package.
MetadataArray ObjectMetaArgs
MetadataMap ObjectMetaArgs
requiredMetadata ObjectMeta
This type is defined in the Kubernetes package.
requiredMetadataArray List<ObjectMeta>
requiredMetadataMap Map<String,ObjectMetaArgs>
metadata ObjectMeta
This type is defined in the Kubernetes package.
metadataArray List<ObjectMeta>
metadataMap Map<String,ObjectMetaArgs>
requiredMetadata pulumiKubernetestypesinputmetav1ObjectMeta
This type is defined in the Kubernetes package.
requiredMetadataArray pulumiKubernetestypesinputmetav1ObjectMeta[]
requiredMetadataMap {[key: string]: pulumiKubernetestypesinputmetav1ObjectMeta}
metadata pulumiKubernetestypesinputmetav1ObjectMeta
This type is defined in the Kubernetes package.
metadataArray pulumiKubernetestypesinputmetav1ObjectMeta[]
metadataMap {[key: string]: pulumiKubernetestypesinputmetav1ObjectMeta}
required_metadata pulumi_kubernetes.meta.v1.ObjectMetaArgs
This type is defined in the Kubernetes package.
required_metadata_array Sequence[pulumi_kubernetes.meta.v1.ObjectMetaArgs]
required_metadata_map Mapping[str, pulumi_kubernetes.meta.v1.ObjectMetaArgs]
metadata pulumi_kubernetes.meta.v1.ObjectMetaArgs
This type is defined in the Kubernetes package.
metadata_array Sequence[pulumi_kubernetes.meta.v1.ObjectMetaArgs]
metadata_map Mapping[str, pulumi_kubernetes.meta.v1.ObjectMetaArgs]
requiredMetadata Property Map
This type is defined in the Kubernetes package.
requiredMetadataArray List<Property Map>
requiredMetadataMap Map<Property Map>
metadata Property Map
This type is defined in the Kubernetes package.
metadataArray List<Property Map>
metadataMap Map<Property Map>

Outputs

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

Id string
The provider-assigned unique ID for this managed resource.
SecurityGroup Pulumi.Aws.Ec2.SecurityGroup
This type is defined in the AWS Classic package.
Provider Pulumi.Kubernetes.Provider
This type is defined in the pulumi package.
StorageClasses Dictionary<string, Pulumi.Kubernetes.Storage.V1.StorageClass>
Id string
The provider-assigned unique ID for this managed resource.
SecurityGroup SecurityGroup
This type is defined in the AWS Classic package.
Provider Provider
This type is defined in the pulumi package.
StorageClasses StorageClass
id String
The provider-assigned unique ID for this managed resource.
securityGroup SecurityGroup
This type is defined in the AWS Classic package.
provider Provider
This type is defined in the pulumi package.
storageClasses Map<String,StorageClass>
id string
The provider-assigned unique ID for this managed resource.
securityGroup pulumiAwsec2SecurityGroup
This type is defined in the AWS Classic package.
provider pulumiKubernetesProvider
This type is defined in the pulumi package.
storageClasses {[key: string]: pulumiKubernetesstoragev1StorageClass}
id str
The provider-assigned unique ID for this managed resource.
security_group pulumi_aws.ec2.SecurityGroup
This type is defined in the AWS Classic package.
provider pulumi_kubernetes.Provider
This type is defined in the pulumi package.
storage_classes Mapping[str, pulumi_kubernetes.storage.v1.StorageClass]
id String
The provider-assigned unique ID for this managed resource.
securityGroup aws:ec2:SecurityGroup
This type is defined in the AWS Classic package.
provider pulumi:providers:kubernetes
This type is defined in the pulumi package.
storageClasses Map<kubernetes:storage.k8s.io/v1:StorageClass>

Package Details

Repository
example
License