AWS Proton-Beispiele zur Verwendung von AWS CLI

Die folgenden Codebeispiele zeigen, wie Sie Aktionen durchführen und gängige Szenarien implementieren, indem Sie AWS Command Line Interface mit AWS Proton nutzen.

Aktionen sind Codeauszüge aus größeren Programmen und müssen im Kontext ausgeführt werden. Während Aktionen Ihnen zeigen, wie Sie einzelne Service-Funktionen aufrufen, können Sie Aktionen im Kontext der zugehörigen Szenarien anzeigen.

Jedes Beispiel enthält einen Link zum vollständigen Quellcode, wo Sie Anleitungen zum Einrichten und Ausführen des Codes im Kontext finden.

Themen

Aktionen

Aktionen

Das folgende Codebeispiel zeigt, wie cancel-service-instance-deployment verwendet wird.

AWS CLI

So löschen Sie eine Bereitstellung von Service-Instances

Im folgenden Beispiel für cancel-service-instance-deployment wird die Bereitstellung einer Service-Instance gelöscht.


aws proton cancel-service-instance-deployment \
    --service-instance-name "instance-one" \
    --service-name "simple-svc"

Ausgabe:


{
    "serviceInstance": {
        "arn": "arn:aws:proton:region-id:123456789012:service/simple-svc/service-instance/instance-one",
        "createdAt": "2021-04-02T21:29:59.962000+00:00",
        "deploymentStatus": "CANCELLING",
        "environmentName": "simple-env",
        "lastDeploymentAttemptedAt": "2021-04-02T21:45:15.406000+00:00",
        "lastDeploymentSucceededAt": "2021-04-02T21:38:00.823000+00:00",
        "name": "instance-one",
        "serviceName": "simple-svc",
        "spec": "proton: ServiceSpec\npipeline:\n  my_sample_pipeline_optional_input: abc\n  my_sample_pipeline_required_input: '123'\ninstances:\n- name: my-instance\n  environment: MySimpleEnv\n  spec:\n    my_sample_service_instance_optional_input: def\n    my_sample_service_instance_required_input: '456'\n- name: my-other-instance\n  environment: MySimpleEnv\n  spec:\n    my_sample_service_instance_required_input: '789'\n",
        "templateMajorVersion": "1",
        "templateMinorVersion": "1",
        "templateName": "svc-simple"
    }
}

Weitere Informationen finden Sie unter Aktualisieren einer Service-Instance im AWS-Proton-Administratorhandbuch oder Aktualisieren einer Service-Instance im AWS-Proton-Benutzerhandbuch.

API-Details finden Sie unter CancelServiceInstanceDeployment in der AWS CLI-Befehlsreferenz.

Das folgende Codebeispiel zeigt, wie cancel-service-pipeline-deployment verwendet wird.

AWS CLI

So löschen Sie eine Bereitstellung von Service-Pipelines

Im folgenden Beispiel für cancel-service-pipeline-deployment wird die Bereitstellung einer Service-Pipeline gelöscht.


aws proton cancel-service-pipeline-deployment \
    --service-name "simple-svc"

Ausgabe:


{
    "pipeline": {
        "arn": "arn:aws:proton:region-id:123456789012:service/simple-svc/pipeline",
        "createdAt": "2021-04-02T21:29:59.962000+00:00",
        "deploymentStatus": "CANCELLING",
        "lastDeploymentAttemptedAt": "2021-04-02T22:02:45.095000+00:00",
        "lastDeploymentSucceededAt": "2021-04-02T21:39:28.991000+00:00",
        "templateMajorVersion": "1",
        "templateMinorVersion": "1",
        "templateName": "svc-simple"
    }
}

Weitere Informationen finden Sie unter Aktualisieren einer Service-Pipeline im AWS-Proton-Administratorhandbuch oder Aktualisieren einer Service-Pipeline im AWS-Proton-Benutzerhandbuch.

API-Details finden Sie unter CancelServicePipelineDeployment in der AWS CLI-Befehlsreferenz.

Das folgende Codebeispiel zeigt, wie create-service verwendet wird.

AWS CLI

So erstellen Sie einen Service

Im folgenden Beispiel für create-service wird ein Service mit einer Service-Pipeline erstellt.


aws proton create-service \
    --name "MySimpleService" \
    --template-name "fargate-service" \
    --template-major-version "1" \
    --branch-name "mainline" \
    --repository-connection-arn "arn:aws:codestar-connections:region-id:account-id:connection/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111" \
    --repository-id "myorg/myapp" \
    --spec file://spec.yaml

Inhalt von spec.yaml:


proton: ServiceSpec

pipeline:
    my_sample_pipeline_required_input: "hello"
    my_sample_pipeline_optional_input: "bye"

instances:
    - name: "acme-network-dev"
        environment: "ENV_NAME"
        spec:
            my_sample_service_instance_required_input: "hi"
            my_sample_service_instance_optional_input: "ho"

Ausgabe:


{
    "service": {
        "arn": "arn:aws:proton:region-id:123456789012:service/MySimpleService",
        "createdAt": "2020-11-18T19:50:27.460000+00:00",
        "lastModifiedAt": "2020-11-18T19:50:27.460000+00:00",
        "name": "MySimpleService",
        "repositoryConnectionArn": "arn:aws:codestar-connections:region-id:123456789012connection/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
        "repositoryId": "myorg/myapp",
        "status": "CREATE_IN_PROGRESS",
        "templateName": "fargate-service"
    }
}

Weitere Informationen finden Sie unter Einen Service erstellen im AWS-Proton-Administratorhandbuch oder Einen Service erstellen im AWS-Proton-Benutzerhandbuch.

API-Details finden Sie unter CreateService in der AWS CLI-Befehlsreferenz.

Das folgende Codebeispiel zeigt, wie delete-service verwendet wird.

AWS CLI

So löschen Sie einen Service

Im folgenden Beispiel für delete-service wird ein Service gelöscht.


aws proton delete-service \
    --name "simple-svc"

Ausgabe:


{
    "service": {
        "arn": "arn:aws:proton:region-id:123456789012:service/simple-svc",
        "branchName": "mainline",
        "createdAt": "2020-11-28T22:40:50.512000+00:00",
        "description": "Edit by updating description",
        "lastModifiedAt": "2020-11-29T00:30:39.248000+00:00",
        "name": "simple-svc",
        "repositoryConnectionArn": "arn:aws:codestar-connections:region-id:123456789012:connection/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
        "repositoryId": "myorg/myapp",
        "status": "DELETE_IN_PROGRESS",
        "templateName": "fargate-service"
    }
}

Weitere Informationen finden Sie unter Einen Service löschen im AWS-Proton-Administratorhandbuch.

API-Details finden Sie unter DeleteService in der AWS CLI-Befehlsreferenz.

Das folgende Codebeispiel zeigt, wie get-service-instance verwendet wird.

AWS CLI

So rufen Sie Details der Service-Instance ab

Im folgenden Beispiel für get-service-instance werden Detaildaten für eine Service-Instance abgerufen.


aws proton get-service-instance \
    --name "instance-one" \
    --service-name "simple-svc"

Ausgabe:


{
    "serviceInstance": {
        "arn": "arn:aws:proton:region-id:123456789012:service/simple-svc/service-instance/instance-one",
        "createdAt": "2020-11-28T22:40:50.512000+00:00",
        "deploymentStatus": "SUCCEEDED",
        "environmentName": "simple-env",
        "lastDeploymentAttemptedAt": "2020-11-28T22:40:50.512000+00:00",
        "lastDeploymentSucceededAt": "2020-11-28T22:40:50.512000+00:00",
        "name": "instance-one",
        "serviceName": "simple-svc",
        "spec": "proton: ServiceSpec\npipeline:\n  my_sample_pipeline_optional_input: hello world\n  my_sample_pipeline_required_input: pipeline up\ninstances:\n- name: instance-one\n  environment: my-simple-env\n  spec:\n    my_sample_service_instance_optional_input: Ola\n    my_sample_service_instance_required_input: Ciao\n",
        "templateMajorVersion": "1",
        "templateMinorVersion": "0",
        "templateName": "svc-simple"
    }
}

Weitere Informationen finden Sie unter Servicedaten anzeigen im AWS-Proton-Administratorhandbuch oder Servicedaten anzeigen im AWS-Proton-Benutzerhandbuch.

API-Details finden Sie unter GetServiceInstance in der AWS CLI-Befehlsreferenz.

Das folgende Codebeispiel zeigt, wie get-service verwendet wird.

AWS CLI

So rufen Sie Servicedetails ab

Im folgenden Beispiel für get-service werden Detaildaten für einen Service abgerufen.


aws proton get-service \
    --name "simple-svc"

Ausgabe:


{
    "service": {
        "arn": "arn:aws:proton:region-id:123456789012:service/simple-svc",
        "branchName": "mainline",
        "createdAt": "2020-11-28T22:40:50.512000+00:00",
        "lastModifiedAt": "2020-11-28T22:44:51.207000+00:00",
        "name": "simple-svc",
        "pipeline": {
            "arn": "arn:aws:proton:region-id:123456789012:service/simple-svc/pipeline/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
            "createdAt": "2020-11-28T22:40:50.512000+00:00",
            "deploymentStatus": "SUCCEEDED",
            "lastDeploymentAttemptedAt": "2020-11-28T22:40:50.512000+00:00",
            "lastDeploymentSucceededAt": "2020-11-28T22:40:50.512000+00:00",
            "spec": "proton: ServiceSpec\npipeline:\n  my_sample_pipeline_required_input: hello\n  my_sample_pipeline_optional_input: bye\ninstances:\n- name: instance-svc-simple\n  environment: my-simple-env\n  spec:\n    my_sample_service_instance_required_input: hi\n    my_sample_service_instance_optional_input: ho\n",
            "templateMajorVersion": "1",
            "templateMinorVersion": "1",
            "templateName": "svc-simple"
        },
        "repositoryConnectionArn": "arn:aws:codestar-connections:region-id:123456789012:connection/a1b2c3d4-5678-90ab-cdef-EXAMPLE22222",
        "repositoryId": "myorg/myapp",
        "spec": "proton: ServiceSpec\npipeline:\n  my_sample_pipeline_required_input: hello\n  my_sample_pipeline_optional_input: bye\ninstances:\n- name: instance-svc-simple\n  environment: my-simple-env\n  spec:\n    my_sample_service_instance_required_input: hi\n    my_sample_service_instance_optional_input: ho\n",
        "status": "ACTIVE",
        "templateName": "svc-simple"
    }
}

Weitere Informationen finden Sie unter Servicedaten anzeigen im AWS-Proton-Administratorhandbuch oder Servicedaten anzeigen im AWS-Proton-Benutzerhandbuch.

API-Details finden Sie unter GetService in der AWS CLI-Befehlsreferenz.

Das folgende Codebeispiel zeigt, wie list-service-instances verwendet wird.

AWS CLI

Beispiel 1: So listen Sie alle Service-Instances auf

Im folgenden Beispiel für list-service-instances werden die Service-Instances aufgelistet.


aws proton list-service-instances

Ausgabe:


{
    "serviceInstances": [
        {
            "arn": "arn:aws:proton:region-id:123456789012:service/simple-svc/service-instance/instance-one",
            "createdAt": "2020-11-28T22:40:50.512000+00:00",
            "deploymentStatus": "SUCCEEDED",
            "environmentArn": "arn:aws:proton:region-id:123456789012:environment/simple-env",
            "lastDeploymentAttemptedAt": "2020-11-28T22:40:50.512000+00:00",
            "lastDeploymentSucceededAt": "2020-11-28T22:40:50.512000+00:00",
            "name": "instance-one",
            "serviceName": "simple-svc",
            "templateMajorVersion": "1",
            "templateMinorVersion": "0",
            "templateName": "fargate-service"
        }
    ]
}

Weitere Informationen finden Sie unter Daten der Service-Instance anzeigen im AWS-Proton-Administratorhandbuch oder Daten der Service-Instance anzeigen im AWS-Proton-Benutzerhandbuch.

Beispiel 2: So listen Sie die angegebene Service-Instance auf

Im folgenden Beispiel für get-service-instance wird eine Service-Instance abgerufen.


aws proton get-service-instance \
    --name "instance-one" \
    --service-name "simple-svc"

Ausgabe:


{
    "serviceInstance": {
        "arn": "arn:aws:proton:region-id:123456789012:service/simple-svc/service-instance/instance-one",
        "createdAt": "2020-11-28T22:40:50.512000+00:00",
        "deploymentStatus": "SUCCEEDED",
        "environmentName": "simple-env",
        "lastDeploymentAttemptedAt": "2020-11-28T22:40:50.512000+00:00",
        "lastDeploymentSucceededAt": "2020-11-28T22:40:50.512000+00:00",
        "name": "instance-one",
        "serviceName": "simple-svc",
        "spec": "proton: ServiceSpec\npipeline:\n  my_sample_pipeline_optional_input: hello world\n  my_sample_pipeline_required_input: pipeline up\ninstances:\n- name: instance-one\n  environment: my-simple-env\n  spec:\n    my_sample_service_instance_optional_input: Ola\n    my_sample_service_instance_required_input: Ciao\n",
        "templateMajorVersion": "1",
        "templateMinorVersion": "0",
        "templateName": "svc-simple"
    }
}

Weitere Informationen finden Sie unter Daten der Service-Instance anzeigen im AWS-Proton-Administratorhandbuch oder Daten der Service-Instance anzeigen im AWS-Proton-Benutzerhandbuch.

API-Details finden Sie unter ListServiceInstances in der AWS CLI-Befehlsreferenz.

Das folgende Codebeispiel zeigt, wie update-service-instance verwendet wird.

AWS CLI

So aktualisieren Sie eine Service-Instance auf eine neue Nebenversion

Im folgenden Beispiel für update-service-instance wird eine Service-Instance auf eine neue Nebenversion ihrer Servicevorlage aktualisiert, die eine neue Instance namens „my-other-instance“ mit einer neuen erforderlichen Eingabe hinzufügt.


aws proton update-service-instance \
    --service-name "simple-svc" \
    --spec "file://service-spec.yaml " \
    --template-major-version "1" \
    --template-minor-version "1" \
    --deployment-type "MINOR_VERSION" \
    --name "instance-one"

Inhalt von service-spec.yaml:


proton: ServiceSpec
pipeline:
    my_sample_pipeline_optional_input: "abc"
    my_sample_pipeline_required_input: "123"
instances:
    - name: "instance-one"
        environment: "simple-env"
        spec:
            my_sample_service_instance_optional_input: "def"
            my_sample_service_instance_required_input: "456"
    - name: "my-other-instance"
        environment: "simple-env"
        spec:
            my_sample_service_instance_required_input: "789"

Ausgabe:


{
    "serviceInstance": {
        "arn": "arn:aws:proton:region-id:123456789012:service/simple-svc/service-instance/instance-one",
        "createdAt": "2021-04-02T21:29:59.962000+00:00",
        "deploymentStatus": "IN_PROGRESS",
        "environmentName": "arn:aws:proton:region-id:123456789012:environment/simple-env",
        "lastDeploymentAttemptedAt": "2021-04-02T21:38:00.823000+00:00",
        "lastDeploymentSucceededAt": "2021-04-02T21:29:59.962000+00:00",
        "name": "instance-one",
        "serviceName": "simple-svc",
        "templateMajorVersion": "1",
        "templateMinorVersion": "0",
        "templateName": "svc-simple"
    }
}

Weitere Informationen finden Sie unter Aktualisieren einer Service-Instance im AWS-Proton-Administratorhandbuch oder Aktualisieren einer Service-Instance im AWS-Proton-Benutzerhandbuch.

API-Details finden Sie unter UpdateServiceInstance in der AWS CLI-Befehlsreferenz.

Das folgende Codebeispiel zeigt, wie update-service-pipeline verwendet wird.

AWS CLI

So aktualisieren Sie eine Service-Pipeline

Im folgenden Beispiel für update-service-pipeline wird eine Service-Pipeline auf eine neue Nebenversion ihrer Servicevorlage aktualisiert.


aws proton update-service-pipeline \
    --service-name "simple-svc" \
    --spec "file://service-spec.yaml" \
    --template-major-version "1" \
    --template-minor-version "1" \
    --deployment-type "MINOR_VERSION"

Ausgabe:


{
    "pipeline": {
        "arn": "arn:aws:proton:region-id:123456789012:service/simple-svc/pipeline/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
        "createdAt": "2021-04-02T21:29:59.962000+00:00",
        "deploymentStatus": "IN_PROGRESS",
        "lastDeploymentAttemptedAt": "2021-04-02T21:39:28.991000+00:00",
        "lastDeploymentSucceededAt": "2021-04-02T21:29:59.962000+00:00",
        "spec": "proton: ServiceSpec\n\npipeline:\n  my_sample_pipeline_optional_input: \"abc\"\n  my_sample_pipeline_required_input: \"123\"\n\ninstances:\n  - name: \"my-instance\"\n    environment: \"MySimpleEnv\"\n    spec:\n      my_sample_service_instance_optional_input: \"def\"\n      my_sample_service_instance_required_input: \"456\"\n  - name: \"my-other-instance\"\n    environment: \"MySimpleEnv\"\n    spec:\n      my_sample_service_instance_required_input: \"789\"\n",
        "templateMajorVersion": "1",
        "templateMinorVersion": "0",
        "templateName": "svc-simple"
    }
}

Weitere Informationen finden Sie unter Aktualisieren einer Service-Pipeline im AWS-Proton-Administratorhandbuch oder Aktualisieren einer Service-Pipeline im AWS-Proton-Benutzerhandbuch.

API-Details finden Sie unter UpdateServicePipeline in der AWS CLI-Befehlsreferenz.

Das folgende Codebeispiel zeigt, wie update-service verwendet wird.

AWS CLI

So aktualisieren Sie einen Service

Im folgenden Beispiel für update-service wird eine Servicebeschreibung bearbeitet.


aws proton update-service \
    --name "MySimpleService" \
    --description "Edit by updating description"

Ausgabe:


{
    "service": {
        "arn": "arn:aws:proton:region-id:123456789012:service/MySimpleService",
        "branchName": "mainline",
        "createdAt": "2021-03-12T22:39:42.318000+00:00",
        "description": "Edit by updating description",
        "lastModifiedAt": "2021-03-12T22:44:21.975000+00:00",
        "name": "MySimpleService",
        "repositoryConnectionArn": "arn:aws:codestar-connections:region-id:123456789012:connection/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
        "repositoryId": "myorg/myapp",
        "status": "ACTIVE",
        "templateName": "fargate-service"
    }
}

Weitere Informationen finden Sie unter Service bearbeiten im AWS-Proton-Administratorhandbuch oder Service bearbeiten im AWS-Proton-Benutzerhandbuch.

API-Details finden Sie unter UpdateService in der AWS CLI-Befehlsreferenz.

Warnung JavaScript ist in Ihrem Browser nicht verfügbar oder deaktiviert.

Zur Nutzung der AWS-Dokumentation muss JavaScript aktiviert sein. Weitere Informationen finden auf den Hilfe-Seiten Ihres Browsers.

Dokumentkonventionen

AWS Private CA

QLDB