endpoints

package
v3.12.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jun 30, 2020 License: Apache-2.0 Imports: 4 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Service 

type Service struct {
	pulumi.CustomResourceState

	// A list of API objects.
	Apis ServiceApiArrayOutput `pulumi:"apis"`
	// The autogenerated ID for the configuration that is rolled out as part of the creation of this resource. Must be provided
	// to compute engine instances as a tag.
	ConfigId pulumi.StringOutput `pulumi:"configId"`
	// The address at which the service can be found - usually the same as the service name.
	DnsAddress pulumi.StringOutput `pulumi:"dnsAddress"`
	// A list of Endpoint objects.
	Endpoints ServiceEndpointArrayOutput `pulumi:"endpoints"`
	// The full text of the Service Config YAML file (Example located here). If provided, must also provide
	// protoc_output_base64. open_api config must not be provided.
	GrpcConfig pulumi.StringPtrOutput `pulumi:"grpcConfig"`
	// The full text of the OpenAPI YAML configuration as described here. Either this, or both of grpc_config and
	// protoc_output_base64 must be specified.
	OpenapiConfig pulumi.StringPtrOutput `pulumi:"openapiConfig"`
	// The project ID that the service belongs to. If not provided, provider project is used.
	Project pulumi.StringOutput `pulumi:"project"`
	// The full contents of the Service Descriptor File generated by protoc. This should be a compiled .pb file,
	// base64-encoded.
	ProtocOutputBase64 pulumi.StringPtrOutput `pulumi:"protocOutputBase64"`
	// The name of the service. Usually of the form $apiname.endpoints.$projectid.cloud.goog.
	ServiceName pulumi.StringOutput `pulumi:"serviceName"`
}

This resource creates and rolls out a Cloud Endpoints service using OpenAPI or gRPC. View the relevant docs for [OpenAPI](https://cloud.google.com/endpoints/docs/openapi/) and [gRPC](https://cloud.google.com/endpoints/docs/grpc/).

func GetService 

func GetService(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *ServiceState, opts ...pulumi.ResourceOption) (*Service, error)

GetService gets an existing Service resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewService 

func NewService(ctx *pulumi.Context,
	name string, args *ServiceArgs, opts ...pulumi.ResourceOption) (*Service, error)

NewService registers a new resource with the given unique name, arguments, and options.

type ServiceApi 

type ServiceApi struct {
	Methods []ServiceApiMethod `pulumi:"methods"`
	Name    *string            `pulumi:"name"`
	Syntax  *string            `pulumi:"syntax"`
	Version *string            `pulumi:"version"`
}

type ServiceApiArgs 

type ServiceApiArgs struct {
	Methods ServiceApiMethodArrayInput `pulumi:"methods"`
	Name    pulumi.StringPtrInput      `pulumi:"name"`
	Syntax  pulumi.StringPtrInput      `pulumi:"syntax"`
	Version pulumi.StringPtrInput      `pulumi:"version"`
}

func (ServiceApiArgs) ElementType 

func (ServiceApiArgs) ElementType() reflect.Type

func (ServiceApiArgs) ToServiceApiOutput 

func (i ServiceApiArgs) ToServiceApiOutput() ServiceApiOutput

func (ServiceApiArgs) ToServiceApiOutputWithContext 

func (i ServiceApiArgs) ToServiceApiOutputWithContext(ctx context.Context) ServiceApiOutput

type ServiceApiArray 

type ServiceApiArray []ServiceApiInput

func (ServiceApiArray) ElementType 

func (ServiceApiArray) ElementType() reflect.Type

func (ServiceApiArray) ToServiceApiArrayOutput 

func (i ServiceApiArray) ToServiceApiArrayOutput() ServiceApiArrayOutput

func (ServiceApiArray) ToServiceApiArrayOutputWithContext 

func (i ServiceApiArray) ToServiceApiArrayOutputWithContext(ctx context.Context) ServiceApiArrayOutput

type ServiceApiArrayInput 

type ServiceApiArrayInput interface {
	pulumi.Input

	ToServiceApiArrayOutput() ServiceApiArrayOutput
	ToServiceApiArrayOutputWithContext(context.Context) ServiceApiArrayOutput
}

ServiceApiArrayInput is an input type that accepts ServiceApiArray and ServiceApiArrayOutput values. You can construct a concrete instance of `ServiceApiArrayInput` via: 

ServiceApiArray{ ServiceApiArgs{...} }

type ServiceApiArrayOutput 

type ServiceApiArrayOutput struct{ *pulumi.OutputState }

func (ServiceApiArrayOutput) ElementType 

func (ServiceApiArrayOutput) ElementType() reflect.Type

func (ServiceApiArrayOutput) Index 

func (o ServiceApiArrayOutput) Index(i pulumi.IntInput) ServiceApiOutput

func (ServiceApiArrayOutput) ToServiceApiArrayOutput 

func (o ServiceApiArrayOutput) ToServiceApiArrayOutput() ServiceApiArrayOutput

func (ServiceApiArrayOutput) ToServiceApiArrayOutputWithContext 

func (o ServiceApiArrayOutput) ToServiceApiArrayOutputWithContext(ctx context.Context) ServiceApiArrayOutput

type ServiceApiInput 

type ServiceApiInput interface {
	pulumi.Input

	ToServiceApiOutput() ServiceApiOutput
	ToServiceApiOutputWithContext(context.Context) ServiceApiOutput
}

ServiceApiInput is an input type that accepts ServiceApiArgs and ServiceApiOutput values. You can construct a concrete instance of `ServiceApiInput` via: 

ServiceApiArgs{...}

type ServiceApiMethod 

type ServiceApiMethod struct {
	Name         *string `pulumi:"name"`
	RequestType  *string `pulumi:"requestType"`
	ResponseType *string `pulumi:"responseType"`
	Syntax       *string `pulumi:"syntax"`
}

type ServiceApiMethodArgs 

type ServiceApiMethodArgs struct {
	Name         pulumi.StringPtrInput `pulumi:"name"`
	RequestType  pulumi.StringPtrInput `pulumi:"requestType"`
	ResponseType pulumi.StringPtrInput `pulumi:"responseType"`
	Syntax       pulumi.StringPtrInput `pulumi:"syntax"`
}

func (ServiceApiMethodArgs) ElementType 

func (ServiceApiMethodArgs) ElementType() reflect.Type

func (ServiceApiMethodArgs) ToServiceApiMethodOutput 

func (i ServiceApiMethodArgs) ToServiceApiMethodOutput() ServiceApiMethodOutput

func (ServiceApiMethodArgs) ToServiceApiMethodOutputWithContext 

func (i ServiceApiMethodArgs) ToServiceApiMethodOutputWithContext(ctx context.Context) ServiceApiMethodOutput

type ServiceApiMethodArray 

type ServiceApiMethodArray []ServiceApiMethodInput

func (ServiceApiMethodArray) ElementType 

func (ServiceApiMethodArray) ElementType() reflect.Type

func (ServiceApiMethodArray) ToServiceApiMethodArrayOutput 

func (i ServiceApiMethodArray) ToServiceApiMethodArrayOutput() ServiceApiMethodArrayOutput

func (ServiceApiMethodArray) ToServiceApiMethodArrayOutputWithContext 

func (i ServiceApiMethodArray) ToServiceApiMethodArrayOutputWithContext(ctx context.Context) ServiceApiMethodArrayOutput

type ServiceApiMethodArrayInput 

type ServiceApiMethodArrayInput interface {
	pulumi.Input

	ToServiceApiMethodArrayOutput() ServiceApiMethodArrayOutput
	ToServiceApiMethodArrayOutputWithContext(context.Context) ServiceApiMethodArrayOutput
}

ServiceApiMethodArrayInput is an input type that accepts ServiceApiMethodArray and ServiceApiMethodArrayOutput values. You can construct a concrete instance of `ServiceApiMethodArrayInput` via: 

ServiceApiMethodArray{ ServiceApiMethodArgs{...} }

type ServiceApiMethodArrayOutput 

type ServiceApiMethodArrayOutput struct{ *pulumi.OutputState }

func (ServiceApiMethodArrayOutput) ElementType 

func (ServiceApiMethodArrayOutput) ElementType() reflect.Type

func (ServiceApiMethodArrayOutput) Index 

func (o ServiceApiMethodArrayOutput) Index(i pulumi.IntInput) ServiceApiMethodOutput

func (ServiceApiMethodArrayOutput) ToServiceApiMethodArrayOutput 

func (o ServiceApiMethodArrayOutput) ToServiceApiMethodArrayOutput() ServiceApiMethodArrayOutput

func (ServiceApiMethodArrayOutput) ToServiceApiMethodArrayOutputWithContext 

func (o ServiceApiMethodArrayOutput) ToServiceApiMethodArrayOutputWithContext(ctx context.Context) ServiceApiMethodArrayOutput

type ServiceApiMethodInput 

type ServiceApiMethodInput interface {
	pulumi.Input

	ToServiceApiMethodOutput() ServiceApiMethodOutput
	ToServiceApiMethodOutputWithContext(context.Context) ServiceApiMethodOutput
}

ServiceApiMethodInput is an input type that accepts ServiceApiMethodArgs and ServiceApiMethodOutput values. You can construct a concrete instance of `ServiceApiMethodInput` via: 

ServiceApiMethodArgs{...}

type ServiceApiMethodOutput 

type ServiceApiMethodOutput struct{ *pulumi.OutputState }

func (ServiceApiMethodOutput) ElementType 

func (ServiceApiMethodOutput) ElementType() reflect.Type

func (ServiceApiMethodOutput) Name 

func (o ServiceApiMethodOutput) Name() pulumi.StringPtrOutput

func (ServiceApiMethodOutput) RequestType 

func (o ServiceApiMethodOutput) RequestType() pulumi.StringPtrOutput

func (ServiceApiMethodOutput) ResponseType 

func (o ServiceApiMethodOutput) ResponseType() pulumi.StringPtrOutput

func (ServiceApiMethodOutput) Syntax 

func (o ServiceApiMethodOutput) Syntax() pulumi.StringPtrOutput

func (ServiceApiMethodOutput) ToServiceApiMethodOutput 

func (o ServiceApiMethodOutput) ToServiceApiMethodOutput() ServiceApiMethodOutput

func (ServiceApiMethodOutput) ToServiceApiMethodOutputWithContext 

func (o ServiceApiMethodOutput) ToServiceApiMethodOutputWithContext(ctx context.Context) ServiceApiMethodOutput

type ServiceApiOutput 

type ServiceApiOutput struct{ *pulumi.OutputState }

func (ServiceApiOutput) ElementType 

func (ServiceApiOutput) ElementType() reflect.Type

func (ServiceApiOutput) Methods 

func (o ServiceApiOutput) Methods() ServiceApiMethodArrayOutput

func (ServiceApiOutput) Name 

func (o ServiceApiOutput) Name() pulumi.StringPtrOutput

func (ServiceApiOutput) Syntax 

func (o ServiceApiOutput) Syntax() pulumi.StringPtrOutput

func (ServiceApiOutput) ToServiceApiOutput 

func (o ServiceApiOutput) ToServiceApiOutput() ServiceApiOutput

func (ServiceApiOutput) ToServiceApiOutputWithContext 

func (o ServiceApiOutput) ToServiceApiOutputWithContext(ctx context.Context) ServiceApiOutput

func (ServiceApiOutput) Version 

func (o ServiceApiOutput) Version() pulumi.StringPtrOutput

type ServiceArgs 

type ServiceArgs struct {
	// The full text of the Service Config YAML file (Example located here). If provided, must also provide
	// protoc_output_base64. open_api config must not be provided.
	GrpcConfig pulumi.StringPtrInput
	// The full text of the OpenAPI YAML configuration as described here. Either this, or both of grpc_config and
	// protoc_output_base64 must be specified.
	OpenapiConfig pulumi.StringPtrInput
	// The project ID that the service belongs to. If not provided, provider project is used.
	Project pulumi.StringPtrInput
	// The full contents of the Service Descriptor File generated by protoc. This should be a compiled .pb file,
	// base64-encoded.
	ProtocOutputBase64 pulumi.StringPtrInput
	// The name of the service. Usually of the form $apiname.endpoints.$projectid.cloud.goog.
	ServiceName pulumi.StringInput
}

The set of arguments for constructing a Service resource.

func (ServiceArgs) ElementType 

func (ServiceArgs) ElementType() reflect.Type

type ServiceEndpoint 

type ServiceEndpoint struct {
	Address *string `pulumi:"address"`
	Name    *string `pulumi:"name"`
}

type ServiceEndpointArgs 

type ServiceEndpointArgs struct {
	Address pulumi.StringPtrInput `pulumi:"address"`
	Name    pulumi.StringPtrInput `pulumi:"name"`
}

func (ServiceEndpointArgs) ElementType 

func (ServiceEndpointArgs) ElementType() reflect.Type

func (ServiceEndpointArgs) ToServiceEndpointOutput 

func (i ServiceEndpointArgs) ToServiceEndpointOutput() ServiceEndpointOutput

func (ServiceEndpointArgs) ToServiceEndpointOutputWithContext 

func (i ServiceEndpointArgs) ToServiceEndpointOutputWithContext(ctx context.Context) ServiceEndpointOutput

type ServiceEndpointArray 

type ServiceEndpointArray []ServiceEndpointInput

func (ServiceEndpointArray) ElementType 

func (ServiceEndpointArray) ElementType() reflect.Type

func (ServiceEndpointArray) ToServiceEndpointArrayOutput 

func (i ServiceEndpointArray) ToServiceEndpointArrayOutput() ServiceEndpointArrayOutput

func (ServiceEndpointArray) ToServiceEndpointArrayOutputWithContext 

func (i ServiceEndpointArray) ToServiceEndpointArrayOutputWithContext(ctx context.Context) ServiceEndpointArrayOutput

type ServiceEndpointArrayInput 

type ServiceEndpointArrayInput interface {
	pulumi.Input

	ToServiceEndpointArrayOutput() ServiceEndpointArrayOutput
	ToServiceEndpointArrayOutputWithContext(context.Context) ServiceEndpointArrayOutput
}

ServiceEndpointArrayInput is an input type that accepts ServiceEndpointArray and ServiceEndpointArrayOutput values. You can construct a concrete instance of `ServiceEndpointArrayInput` via: 

ServiceEndpointArray{ ServiceEndpointArgs{...} }

type ServiceEndpointArrayOutput 

type ServiceEndpointArrayOutput struct{ *pulumi.OutputState }

func (ServiceEndpointArrayOutput) ElementType 

func (ServiceEndpointArrayOutput) ElementType() reflect.Type

func (ServiceEndpointArrayOutput) Index 

func (o ServiceEndpointArrayOutput) Index(i pulumi.IntInput) ServiceEndpointOutput

func (ServiceEndpointArrayOutput) ToServiceEndpointArrayOutput 

func (o ServiceEndpointArrayOutput) ToServiceEndpointArrayOutput() ServiceEndpointArrayOutput

func (ServiceEndpointArrayOutput) ToServiceEndpointArrayOutputWithContext 

func (o ServiceEndpointArrayOutput) ToServiceEndpointArrayOutputWithContext(ctx context.Context) ServiceEndpointArrayOutput

type ServiceEndpointInput 

type ServiceEndpointInput interface {
	pulumi.Input

	ToServiceEndpointOutput() ServiceEndpointOutput
	ToServiceEndpointOutputWithContext(context.Context) ServiceEndpointOutput
}

ServiceEndpointInput is an input type that accepts ServiceEndpointArgs and ServiceEndpointOutput values. You can construct a concrete instance of `ServiceEndpointInput` via: 

ServiceEndpointArgs{...}

type ServiceEndpointOutput 

type ServiceEndpointOutput struct{ *pulumi.OutputState }

func (ServiceEndpointOutput) Address 

func (o ServiceEndpointOutput) Address() pulumi.StringPtrOutput

func (ServiceEndpointOutput) ElementType 

func (ServiceEndpointOutput) ElementType() reflect.Type

func (ServiceEndpointOutput) Name 

func (o ServiceEndpointOutput) Name() pulumi.StringPtrOutput

func (ServiceEndpointOutput) ToServiceEndpointOutput 

func (o ServiceEndpointOutput) ToServiceEndpointOutput() ServiceEndpointOutput

func (ServiceEndpointOutput) ToServiceEndpointOutputWithContext 

func (o ServiceEndpointOutput) ToServiceEndpointOutputWithContext(ctx context.Context) ServiceEndpointOutput

type ServiceIamBinding 

type ServiceIamBinding struct {
	pulumi.CustomResourceState

	Condition ServiceIamBindingConditionPtrOutput `pulumi:"condition"`
	// (Computed) The etag of the IAM policy.
	Etag    pulumi.StringOutput      `pulumi:"etag"`
	Members pulumi.StringArrayOutput `pulumi:"members"`
	// The role that should be applied. Only one
	// `endpoints.ServiceIamBinding` can be used per role. Note that custom roles must be of the format
	// `[projects|organizations]/{parent-name}/roles/{role-name}`.
	Role pulumi.StringOutput `pulumi:"role"`
	// The name of the service. Used to find the parent resource to bind the IAM policy to
	ServiceName pulumi.StringOutput `pulumi:"serviceName"`
}

Three different resources help you manage your IAM policy for Cloud Endpoints Service. Each of these resources serves a different use case:

* `endpoints.ServiceIamPolicy`: Authoritative. Sets the IAM policy for the service and replaces any existing policy already attached. * `endpoints.ServiceIamBinding`: Authoritative for a given role. Updates the IAM policy to grant a role to a list of members. Other roles within the IAM policy for the service are preserved. * `endpoints.ServiceIamMember`: Non-authoritative. Updates the IAM policy to grant a role to a new member. Other members for the role for the service are preserved.

> **Note:** `endpoints.ServiceIamPolicy` **cannot** be used in conjunction with `endpoints.ServiceIamBinding` and `endpoints.ServiceIamMember` or they will fight over what your policy should be.

> **Note:** `endpoints.ServiceIamBinding` resources **can be** used in conjunction with `endpoints.ServiceIamMember` resources **only if** they do not grant privilege to the same role.

## google\_endpoints\_service\_iam\_policy

```go package main

import ( 

"github.com/pulumi/pulumi-gcp/sdk/v3/go/gcp/endpoints"
"github.com/pulumi/pulumi-gcp/sdk/v3/go/gcp/organizations"
"github.com/pulumi/pulumi/sdk/v2/go/pulumi"

) 

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		admin, err := organizations.LookupIAMPolicy(ctx, &organizations.LookupIAMPolicyArgs{
			Binding: []map[string]interface{}{
				map[string]interface{}{
					"role": "roles/viewer",
					"members": []string{
						"user:jane@example.com",
					},
				},
			},
		}, nil)
		if err != nil {
			return err
		}
		_, err = endpoints.NewServiceIamPolicy(ctx, "policy", &endpoints.ServiceIamPolicyArgs{
			ServiceName: pulumi.String(google_endpoints_service.Endpoints_service.Service_name),
			PolicyData:  pulumi.String(admin.PolicyData),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

```

## google\_endpoints\_service\_iam\_binding

```go package main

import ( 

"github.com/pulumi/pulumi-gcp/sdk/v3/go/gcp/endpoints"
"github.com/pulumi/pulumi/sdk/v2/go/pulumi"

) 

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err = endpoints.NewServiceIamBinding(ctx, "binding", &endpoints.ServiceIamBindingArgs{
			ServiceName: pulumi.String(google_endpoints_service.Endpoints_service.Service_name),
			Role:        pulumi.String("roles/viewer"),
			Members: pulumi.StringArray{
				pulumi.String("user:jane@example.com"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

```

## google\_endpoints\_service\_iam\_member

```go package main

import ( 

"github.com/pulumi/pulumi-gcp/sdk/v3/go/gcp/endpoints"
"github.com/pulumi/pulumi/sdk/v2/go/pulumi"

) 

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err = endpoints.NewServiceIamMember(ctx, "member", &endpoints.ServiceIamMemberArgs{
			ServiceName: pulumi.String(google_endpoints_service.Endpoints_service.Service_name),
			Role:        pulumi.String("roles/viewer"),
			Member:      pulumi.String("user:jane@example.com"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

```

func GetServiceIamBinding 

func GetServiceIamBinding(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *ServiceIamBindingState, opts ...pulumi.ResourceOption) (*ServiceIamBinding, error)

GetServiceIamBinding gets an existing ServiceIamBinding resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewServiceIamBinding 

func NewServiceIamBinding(ctx *pulumi.Context,
	name string, args *ServiceIamBindingArgs, opts ...pulumi.ResourceOption) (*ServiceIamBinding, error)

NewServiceIamBinding registers a new resource with the given unique name, arguments, and options.

type ServiceIamBindingArgs 

type ServiceIamBindingArgs struct {
	Condition ServiceIamBindingConditionPtrInput
	Members   pulumi.StringArrayInput
	// The role that should be applied. Only one
	// `endpoints.ServiceIamBinding` can be used per role. Note that custom roles must be of the format
	// `[projects|organizations]/{parent-name}/roles/{role-name}`.
	Role pulumi.StringInput
	// The name of the service. Used to find the parent resource to bind the IAM policy to
	ServiceName pulumi.StringInput
}

The set of arguments for constructing a ServiceIamBinding resource.

func (ServiceIamBindingArgs) ElementType 

func (ServiceIamBindingArgs) ElementType() reflect.Type

type ServiceIamBindingCondition 

type ServiceIamBindingCondition struct {
	Description *string `pulumi:"description"`
	Expression  string  `pulumi:"expression"`
	Title       string  `pulumi:"title"`
}

type ServiceIamBindingConditionArgs 

type ServiceIamBindingConditionArgs struct {
	Description pulumi.StringPtrInput `pulumi:"description"`
	Expression  pulumi.StringInput    `pulumi:"expression"`
	Title       pulumi.StringInput    `pulumi:"title"`
}

func (ServiceIamBindingConditionArgs) ElementType 

func (ServiceIamBindingConditionArgs) ElementType() reflect.Type

func (ServiceIamBindingConditionArgs) ToServiceIamBindingConditionOutput 

func (i ServiceIamBindingConditionArgs) ToServiceIamBindingConditionOutput() ServiceIamBindingConditionOutput

func (ServiceIamBindingConditionArgs) ToServiceIamBindingConditionOutputWithContext 

func (i ServiceIamBindingConditionArgs) ToServiceIamBindingConditionOutputWithContext(ctx context.Context) ServiceIamBindingConditionOutput

func (ServiceIamBindingConditionArgs) ToServiceIamBindingConditionPtrOutput 

func (i ServiceIamBindingConditionArgs) ToServiceIamBindingConditionPtrOutput() ServiceIamBindingConditionPtrOutput

func (ServiceIamBindingConditionArgs) ToServiceIamBindingConditionPtrOutputWithContext 

func (i ServiceIamBindingConditionArgs) ToServiceIamBindingConditionPtrOutputWithContext(ctx context.Context) ServiceIamBindingConditionPtrOutput

type ServiceIamBindingConditionInput 

type ServiceIamBindingConditionInput interface {
	pulumi.Input

	ToServiceIamBindingConditionOutput() ServiceIamBindingConditionOutput
	ToServiceIamBindingConditionOutputWithContext(context.Context) ServiceIamBindingConditionOutput
}

ServiceIamBindingConditionInput is an input type that accepts ServiceIamBindingConditionArgs and ServiceIamBindingConditionOutput values. You can construct a concrete instance of `ServiceIamBindingConditionInput` via: 

ServiceIamBindingConditionArgs{...}

type ServiceIamBindingConditionOutput 

type ServiceIamBindingConditionOutput struct{ *pulumi.OutputState }

func (ServiceIamBindingConditionOutput) Description 

func (o ServiceIamBindingConditionOutput) Description() pulumi.StringPtrOutput

func (ServiceIamBindingConditionOutput) ElementType 

func (ServiceIamBindingConditionOutput) ElementType() reflect.Type

func (ServiceIamBindingConditionOutput) Expression 

func (o ServiceIamBindingConditionOutput) Expression() pulumi.StringOutput

func (ServiceIamBindingConditionOutput) Title 

func (o ServiceIamBindingConditionOutput) Title() pulumi.StringOutput

func (ServiceIamBindingConditionOutput) ToServiceIamBindingConditionOutput 

func (o ServiceIamBindingConditionOutput) ToServiceIamBindingConditionOutput() ServiceIamBindingConditionOutput

func (ServiceIamBindingConditionOutput) ToServiceIamBindingConditionOutputWithContext 

func (o ServiceIamBindingConditionOutput) ToServiceIamBindingConditionOutputWithContext(ctx context.Context) ServiceIamBindingConditionOutput

func (ServiceIamBindingConditionOutput) ToServiceIamBindingConditionPtrOutput 

func (o ServiceIamBindingConditionOutput) ToServiceIamBindingConditionPtrOutput() ServiceIamBindingConditionPtrOutput

func (ServiceIamBindingConditionOutput) ToServiceIamBindingConditionPtrOutputWithContext 

func (o ServiceIamBindingConditionOutput) ToServiceIamBindingConditionPtrOutputWithContext(ctx context.Context) ServiceIamBindingConditionPtrOutput

type ServiceIamBindingConditionPtrInput 

type ServiceIamBindingConditionPtrInput interface {
	pulumi.Input

	ToServiceIamBindingConditionPtrOutput() ServiceIamBindingConditionPtrOutput
	ToServiceIamBindingConditionPtrOutputWithContext(context.Context) ServiceIamBindingConditionPtrOutput
}

ServiceIamBindingConditionPtrInput is an input type that accepts ServiceIamBindingConditionArgs, ServiceIamBindingConditionPtr and ServiceIamBindingConditionPtrOutput values. You can construct a concrete instance of `ServiceIamBindingConditionPtrInput` via: 

        ServiceIamBindingConditionArgs{...}

or:

        nil

func ServiceIamBindingConditionPtr 

func ServiceIamBindingConditionPtr(v *ServiceIamBindingConditionArgs) ServiceIamBindingConditionPtrInput

type ServiceIamBindingConditionPtrOutput 

type ServiceIamBindingConditionPtrOutput struct{ *pulumi.OutputState }

func (ServiceIamBindingConditionPtrOutput) Description 

func (o ServiceIamBindingConditionPtrOutput) Description() pulumi.StringPtrOutput

func (ServiceIamBindingConditionPtrOutput) Elem 

func (o ServiceIamBindingConditionPtrOutput) Elem() ServiceIamBindingConditionOutput

func (ServiceIamBindingConditionPtrOutput) ElementType 

func (ServiceIamBindingConditionPtrOutput) ElementType() reflect.Type

func (ServiceIamBindingConditionPtrOutput) Expression 

func (o ServiceIamBindingConditionPtrOutput) Expression() pulumi.StringPtrOutput

func (ServiceIamBindingConditionPtrOutput) Title 

func (o ServiceIamBindingConditionPtrOutput) Title() pulumi.StringPtrOutput

func (ServiceIamBindingConditionPtrOutput) ToServiceIamBindingConditionPtrOutput 

func (o ServiceIamBindingConditionPtrOutput) ToServiceIamBindingConditionPtrOutput() ServiceIamBindingConditionPtrOutput

func (ServiceIamBindingConditionPtrOutput) ToServiceIamBindingConditionPtrOutputWithContext 

func (o ServiceIamBindingConditionPtrOutput) ToServiceIamBindingConditionPtrOutputWithContext(ctx context.Context) ServiceIamBindingConditionPtrOutput

type ServiceIamBindingState 

type ServiceIamBindingState struct {
	Condition ServiceIamBindingConditionPtrInput
	// (Computed) The etag of the IAM policy.
	Etag    pulumi.StringPtrInput
	Members pulumi.StringArrayInput
	// The role that should be applied. Only one
	// `endpoints.ServiceIamBinding` can be used per role. Note that custom roles must be of the format
	// `[projects|organizations]/{parent-name}/roles/{role-name}`.
	Role pulumi.StringPtrInput
	// The name of the service. Used to find the parent resource to bind the IAM policy to
	ServiceName pulumi.StringPtrInput
}

func (ServiceIamBindingState) ElementType 

func (ServiceIamBindingState) ElementType() reflect.Type

type ServiceIamMember 

type ServiceIamMember struct {
	pulumi.CustomResourceState

	Condition ServiceIamMemberConditionPtrOutput `pulumi:"condition"`
	// (Computed) The etag of the IAM policy.
	Etag   pulumi.StringOutput `pulumi:"etag"`
	Member pulumi.StringOutput `pulumi:"member"`
	// The role that should be applied. Only one
	// `endpoints.ServiceIamBinding` can be used per role. Note that custom roles must be of the format
	// `[projects|organizations]/{parent-name}/roles/{role-name}`.
	Role pulumi.StringOutput `pulumi:"role"`
	// The name of the service. Used to find the parent resource to bind the IAM policy to
	ServiceName pulumi.StringOutput `pulumi:"serviceName"`
}

Three different resources help you manage your IAM policy for Cloud Endpoints Service. Each of these resources serves a different use case:

* `endpoints.ServiceIamPolicy`: Authoritative. Sets the IAM policy for the service and replaces any existing policy already attached. * `endpoints.ServiceIamBinding`: Authoritative for a given role. Updates the IAM policy to grant a role to a list of members. Other roles within the IAM policy for the service are preserved. * `endpoints.ServiceIamMember`: Non-authoritative. Updates the IAM policy to grant a role to a new member. Other members for the role for the service are preserved.

> **Note:** `endpoints.ServiceIamPolicy` **cannot** be used in conjunction with `endpoints.ServiceIamBinding` and `endpoints.ServiceIamMember` or they will fight over what your policy should be.

> **Note:** `endpoints.ServiceIamBinding` resources **can be** used in conjunction with `endpoints.ServiceIamMember` resources **only if** they do not grant privilege to the same role.

## google\_endpoints\_service\_iam\_policy

```go package main

import ( 

"github.com/pulumi/pulumi-gcp/sdk/v3/go/gcp/endpoints"
"github.com/pulumi/pulumi-gcp/sdk/v3/go/gcp/organizations"
"github.com/pulumi/pulumi/sdk/v2/go/pulumi"

) 

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		admin, err := organizations.LookupIAMPolicy(ctx, &organizations.LookupIAMPolicyArgs{
			Binding: []map[string]interface{}{
				map[string]interface{}{
					"role": "roles/viewer",
					"members": []string{
						"user:jane@example.com",
					},
				},
			},
		}, nil)
		if err != nil {
			return err
		}
		_, err = endpoints.NewServiceIamPolicy(ctx, "policy", &endpoints.ServiceIamPolicyArgs{
			ServiceName: pulumi.String(google_endpoints_service.Endpoints_service.Service_name),
			PolicyData:  pulumi.String(admin.PolicyData),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

```

## google\_endpoints\_service\_iam\_binding

```go package main

import ( 

"github.com/pulumi/pulumi-gcp/sdk/v3/go/gcp/endpoints"
"github.com/pulumi/pulumi/sdk/v2/go/pulumi"

) 

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err = endpoints.NewServiceIamBinding(ctx, "binding", &endpoints.ServiceIamBindingArgs{
			ServiceName: pulumi.String(google_endpoints_service.Endpoints_service.Service_name),
			Role:        pulumi.String("roles/viewer"),
			Members: pulumi.StringArray{
				pulumi.String("user:jane@example.com"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

```

## google\_endpoints\_service\_iam\_member

```go package main

import ( 

"github.com/pulumi/pulumi-gcp/sdk/v3/go/gcp/endpoints"
"github.com/pulumi/pulumi/sdk/v2/go/pulumi"

) 

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err = endpoints.NewServiceIamMember(ctx, "member", &endpoints.ServiceIamMemberArgs{
			ServiceName: pulumi.String(google_endpoints_service.Endpoints_service.Service_name),
			Role:        pulumi.String("roles/viewer"),
			Member:      pulumi.String("user:jane@example.com"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

```

func GetServiceIamMember 

func GetServiceIamMember(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *ServiceIamMemberState, opts ...pulumi.ResourceOption) (*ServiceIamMember, error)

GetServiceIamMember gets an existing ServiceIamMember resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewServiceIamMember 

func NewServiceIamMember(ctx *pulumi.Context,
	name string, args *ServiceIamMemberArgs, opts ...pulumi.ResourceOption) (*ServiceIamMember, error)

NewServiceIamMember registers a new resource with the given unique name, arguments, and options.

type ServiceIamMemberArgs 

type ServiceIamMemberArgs struct {
	Condition ServiceIamMemberConditionPtrInput
	Member    pulumi.StringInput
	// The role that should be applied. Only one
	// `endpoints.ServiceIamBinding` can be used per role. Note that custom roles must be of the format
	// `[projects|organizations]/{parent-name}/roles/{role-name}`.
	Role pulumi.StringInput
	// The name of the service. Used to find the parent resource to bind the IAM policy to
	ServiceName pulumi.StringInput
}

The set of arguments for constructing a ServiceIamMember resource.

func (ServiceIamMemberArgs) ElementType 

func (ServiceIamMemberArgs) ElementType() reflect.Type

type ServiceIamMemberCondition 

type ServiceIamMemberCondition struct {
	Description *string `pulumi:"description"`
	Expression  string  `pulumi:"expression"`
	Title       string  `pulumi:"title"`
}

type ServiceIamMemberConditionArgs 

type ServiceIamMemberConditionArgs struct {
	Description pulumi.StringPtrInput `pulumi:"description"`
	Expression  pulumi.StringInput    `pulumi:"expression"`
	Title       pulumi.StringInput    `pulumi:"title"`
}

func (ServiceIamMemberConditionArgs) ElementType 

func (ServiceIamMemberConditionArgs) ElementType() reflect.Type

func (ServiceIamMemberConditionArgs) ToServiceIamMemberConditionOutput 

func (i ServiceIamMemberConditionArgs) ToServiceIamMemberConditionOutput() ServiceIamMemberConditionOutput

func (ServiceIamMemberConditionArgs) ToServiceIamMemberConditionOutputWithContext 

func (i ServiceIamMemberConditionArgs) ToServiceIamMemberConditionOutputWithContext(ctx context.Context) ServiceIamMemberConditionOutput

func (ServiceIamMemberConditionArgs) ToServiceIamMemberConditionPtrOutput 

func (i ServiceIamMemberConditionArgs) ToServiceIamMemberConditionPtrOutput() ServiceIamMemberConditionPtrOutput

func (ServiceIamMemberConditionArgs) ToServiceIamMemberConditionPtrOutputWithContext 

func (i ServiceIamMemberConditionArgs) ToServiceIamMemberConditionPtrOutputWithContext(ctx context.Context) ServiceIamMemberConditionPtrOutput

type ServiceIamMemberConditionInput 

type ServiceIamMemberConditionInput interface {
	pulumi.Input

	ToServiceIamMemberConditionOutput() ServiceIamMemberConditionOutput
	ToServiceIamMemberConditionOutputWithContext(context.Context) ServiceIamMemberConditionOutput
}

ServiceIamMemberConditionInput is an input type that accepts ServiceIamMemberConditionArgs and ServiceIamMemberConditionOutput values. You can construct a concrete instance of `ServiceIamMemberConditionInput` via: 

ServiceIamMemberConditionArgs{...}

type ServiceIamMemberConditionOutput 

type ServiceIamMemberConditionOutput struct{ *pulumi.OutputState }

func (ServiceIamMemberConditionOutput) Description 

func (o ServiceIamMemberConditionOutput) Description() pulumi.StringPtrOutput

func (ServiceIamMemberConditionOutput) ElementType 

func (ServiceIamMemberConditionOutput) ElementType() reflect.Type

func (ServiceIamMemberConditionOutput) Expression 

func (o ServiceIamMemberConditionOutput) Expression() pulumi.StringOutput

func (ServiceIamMemberConditionOutput) Title 

func (o ServiceIamMemberConditionOutput) Title() pulumi.StringOutput

func (ServiceIamMemberConditionOutput) ToServiceIamMemberConditionOutput 

func (o ServiceIamMemberConditionOutput) ToServiceIamMemberConditionOutput() ServiceIamMemberConditionOutput

func (ServiceIamMemberConditionOutput) ToServiceIamMemberConditionOutputWithContext 

func (o ServiceIamMemberConditionOutput) ToServiceIamMemberConditionOutputWithContext(ctx context.Context) ServiceIamMemberConditionOutput

func (ServiceIamMemberConditionOutput) ToServiceIamMemberConditionPtrOutput 

func (o ServiceIamMemberConditionOutput) ToServiceIamMemberConditionPtrOutput() ServiceIamMemberConditionPtrOutput

func (ServiceIamMemberConditionOutput) ToServiceIamMemberConditionPtrOutputWithContext 

func (o ServiceIamMemberConditionOutput) ToServiceIamMemberConditionPtrOutputWithContext(ctx context.Context) ServiceIamMemberConditionPtrOutput

type ServiceIamMemberConditionPtrInput 

type ServiceIamMemberConditionPtrInput interface {
	pulumi.Input

	ToServiceIamMemberConditionPtrOutput() ServiceIamMemberConditionPtrOutput
	ToServiceIamMemberConditionPtrOutputWithContext(context.Context) ServiceIamMemberConditionPtrOutput
}

ServiceIamMemberConditionPtrInput is an input type that accepts ServiceIamMemberConditionArgs, ServiceIamMemberConditionPtr and ServiceIamMemberConditionPtrOutput values. You can construct a concrete instance of `ServiceIamMemberConditionPtrInput` via: 

        ServiceIamMemberConditionArgs{...}

or:

        nil

func ServiceIamMemberConditionPtr 

func ServiceIamMemberConditionPtr(v *ServiceIamMemberConditionArgs) ServiceIamMemberConditionPtrInput

type ServiceIamMemberConditionPtrOutput 

type ServiceIamMemberConditionPtrOutput struct{ *pulumi.OutputState }

func (ServiceIamMemberConditionPtrOutput) Description 

func (o ServiceIamMemberConditionPtrOutput) Description() pulumi.StringPtrOutput

func (ServiceIamMemberConditionPtrOutput) Elem 

func (o ServiceIamMemberConditionPtrOutput) Elem() ServiceIamMemberConditionOutput

func (ServiceIamMemberConditionPtrOutput) ElementType 

func (ServiceIamMemberConditionPtrOutput) ElementType() reflect.Type

func (ServiceIamMemberConditionPtrOutput) Expression 

func (o ServiceIamMemberConditionPtrOutput) Expression() pulumi.StringPtrOutput

func (ServiceIamMemberConditionPtrOutput) Title 

func (o ServiceIamMemberConditionPtrOutput) Title() pulumi.StringPtrOutput

func (ServiceIamMemberConditionPtrOutput) ToServiceIamMemberConditionPtrOutput 

func (o ServiceIamMemberConditionPtrOutput) ToServiceIamMemberConditionPtrOutput() ServiceIamMemberConditionPtrOutput

func (ServiceIamMemberConditionPtrOutput) ToServiceIamMemberConditionPtrOutputWithContext 

func (o ServiceIamMemberConditionPtrOutput) ToServiceIamMemberConditionPtrOutputWithContext(ctx context.Context) ServiceIamMemberConditionPtrOutput

type ServiceIamMemberState 

type ServiceIamMemberState struct {
	Condition ServiceIamMemberConditionPtrInput
	// (Computed) The etag of the IAM policy.
	Etag   pulumi.StringPtrInput
	Member pulumi.StringPtrInput
	// The role that should be applied. Only one
	// `endpoints.ServiceIamBinding` can be used per role. Note that custom roles must be of the format
	// `[projects|organizations]/{parent-name}/roles/{role-name}`.
	Role pulumi.StringPtrInput
	// The name of the service. Used to find the parent resource to bind the IAM policy to
	ServiceName pulumi.StringPtrInput
}

func (ServiceIamMemberState) ElementType 

func (ServiceIamMemberState) ElementType() reflect.Type

type ServiceIamPolicy 

type ServiceIamPolicy struct {
	pulumi.CustomResourceState

	// (Computed) The etag of the IAM policy.
	Etag pulumi.StringOutput `pulumi:"etag"`
	// The policy data generated by
	// a `organizations.getIAMPolicy` data source.
	PolicyData pulumi.StringOutput `pulumi:"policyData"`
	// The name of the service. Used to find the parent resource to bind the IAM policy to
	ServiceName pulumi.StringOutput `pulumi:"serviceName"`
}

Three different resources help you manage your IAM policy for Cloud Endpoints Service. Each of these resources serves a different use case:

* `endpoints.ServiceIamPolicy`: Authoritative. Sets the IAM policy for the service and replaces any existing policy already attached. * `endpoints.ServiceIamBinding`: Authoritative for a given role. Updates the IAM policy to grant a role to a list of members. Other roles within the IAM policy for the service are preserved. * `endpoints.ServiceIamMember`: Non-authoritative. Updates the IAM policy to grant a role to a new member. Other members for the role for the service are preserved.

> **Note:** `endpoints.ServiceIamPolicy` **cannot** be used in conjunction with `endpoints.ServiceIamBinding` and `endpoints.ServiceIamMember` or they will fight over what your policy should be.

> **Note:** `endpoints.ServiceIamBinding` resources **can be** used in conjunction with `endpoints.ServiceIamMember` resources **only if** they do not grant privilege to the same role.

## google\_endpoints\_service\_iam\_policy

```go package main

import ( 

"github.com/pulumi/pulumi-gcp/sdk/v3/go/gcp/endpoints"
"github.com/pulumi/pulumi-gcp/sdk/v3/go/gcp/organizations"
"github.com/pulumi/pulumi/sdk/v2/go/pulumi"

) 

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		admin, err := organizations.LookupIAMPolicy(ctx, &organizations.LookupIAMPolicyArgs{
			Binding: []map[string]interface{}{
				map[string]interface{}{
					"role": "roles/viewer",
					"members": []string{
						"user:jane@example.com",
					},
				},
			},
		}, nil)
		if err != nil {
			return err
		}
		_, err = endpoints.NewServiceIamPolicy(ctx, "policy", &endpoints.ServiceIamPolicyArgs{
			ServiceName: pulumi.String(google_endpoints_service.Endpoints_service.Service_name),
			PolicyData:  pulumi.String(admin.PolicyData),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

```

## google\_endpoints\_service\_iam\_binding

```go package main

import ( 

"github.com/pulumi/pulumi-gcp/sdk/v3/go/gcp/endpoints"
"github.com/pulumi/pulumi/sdk/v2/go/pulumi"

) 

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err = endpoints.NewServiceIamBinding(ctx, "binding", &endpoints.ServiceIamBindingArgs{
			ServiceName: pulumi.String(google_endpoints_service.Endpoints_service.Service_name),
			Role:        pulumi.String("roles/viewer"),
			Members: pulumi.StringArray{
				pulumi.String("user:jane@example.com"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

```

## google\_endpoints\_service\_iam\_member

```go package main

import ( 

"github.com/pulumi/pulumi-gcp/sdk/v3/go/gcp/endpoints"
"github.com/pulumi/pulumi/sdk/v2/go/pulumi"

) 

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err = endpoints.NewServiceIamMember(ctx, "member", &endpoints.ServiceIamMemberArgs{
			ServiceName: pulumi.String(google_endpoints_service.Endpoints_service.Service_name),
			Role:        pulumi.String("roles/viewer"),
			Member:      pulumi.String("user:jane@example.com"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

```

func GetServiceIamPolicy 

func GetServiceIamPolicy(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *ServiceIamPolicyState, opts ...pulumi.ResourceOption) (*ServiceIamPolicy, error)

GetServiceIamPolicy gets an existing ServiceIamPolicy resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewServiceIamPolicy 

func NewServiceIamPolicy(ctx *pulumi.Context,
	name string, args *ServiceIamPolicyArgs, opts ...pulumi.ResourceOption) (*ServiceIamPolicy, error)

NewServiceIamPolicy registers a new resource with the given unique name, arguments, and options.

type ServiceIamPolicyArgs 

type ServiceIamPolicyArgs struct {
	// The policy data generated by
	// a `organizations.getIAMPolicy` data source.
	PolicyData pulumi.StringInput
	// The name of the service. Used to find the parent resource to bind the IAM policy to
	ServiceName pulumi.StringInput
}

The set of arguments for constructing a ServiceIamPolicy resource.

func (ServiceIamPolicyArgs) ElementType 

func (ServiceIamPolicyArgs) ElementType() reflect.Type

type ServiceIamPolicyState 

type ServiceIamPolicyState struct {
	// (Computed) The etag of the IAM policy.
	Etag pulumi.StringPtrInput
	// The policy data generated by
	// a `organizations.getIAMPolicy` data source.
	PolicyData pulumi.StringPtrInput
	// The name of the service. Used to find the parent resource to bind the IAM policy to
	ServiceName pulumi.StringPtrInput
}

func (ServiceIamPolicyState) ElementType 

func (ServiceIamPolicyState) ElementType() reflect.Type

type ServiceState 

type ServiceState struct {
	// A list of API objects.
	Apis ServiceApiArrayInput
	// The autogenerated ID for the configuration that is rolled out as part of the creation of this resource. Must be provided
	// to compute engine instances as a tag.
	ConfigId pulumi.StringPtrInput
	// The address at which the service can be found - usually the same as the service name.
	DnsAddress pulumi.StringPtrInput
	// A list of Endpoint objects.
	Endpoints ServiceEndpointArrayInput
	// The full text of the Service Config YAML file (Example located here). If provided, must also provide
	// protoc_output_base64. open_api config must not be provided.
	GrpcConfig pulumi.StringPtrInput
	// The full text of the OpenAPI YAML configuration as described here. Either this, or both of grpc_config and
	// protoc_output_base64 must be specified.
	OpenapiConfig pulumi.StringPtrInput
	// The project ID that the service belongs to. If not provided, provider project is used.
	Project pulumi.StringPtrInput
	// The full contents of the Service Descriptor File generated by protoc. This should be a compiled .pb file,
	// base64-encoded.
	ProtocOutputBase64 pulumi.StringPtrInput
	// The name of the service. Usually of the form $apiname.endpoints.$projectid.cloud.goog.
	ServiceName pulumi.StringPtrInput
}

func (ServiceState) ElementType 

func (ServiceState) ElementType() reflect.Type

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.